Front-end API
API Endpoint
https://mobile-ws.govirtuo.com/v37API Changelog
The minimum supported API version for the expert app is in the file
front-end/lib/middleware/router.ts.
v39
Init route before v39 won’t send Stripe in payment.provider,
as it is not implemented on the mobile apps before v38.
Affected routes:
GET /v…/init
v38
Filter ‘assistance’ from emergencies
GET /v…/init
v37
Mobile apps will have the provider at every request that needs an interaction with an SDK.
Route GET /v…/creditcard-token will now have the provider sent.
Affected routes:
-
GET /v…/init -
POST /v…/creditcard-token
https://github.com/govirtuo/front-end/pull/2524
v36
Provide all delivery zones no matter their enabling status with actual nested enabled attribute.
Affected routes:
GET /v…/init
https://github.com/govirtuo/front-end/pull/2435
v35
Replace the flight_train property sent on body requests to comes_by_train property
Affected routes:
-
POST /v…/voucher/code…/burn -
POST /v…/booking -
PUT /v…/booking -
POST /v…/search/flight -
POST /v…/booking/modification
https://github.com/govirtuo/front-end/pull/1954
v34
For the following endpoints, the properties named vehicle_position in request bodies
is no longer supported, and vehicle_position_details should be used instead. This
change affects request bodies only, and not response bodies. Affected endpoints are:
-
PUT /v…/conveyor/convoy -
POST /v…/inspection -
POST /v…/preparator/inspection -
PUT /v…/booking
https://github.com/govirtuo/front-end/pull/1692
v33
Removed virtuo_badge and parking_badge from API responses that send preparations
(interventions). Affected routes:
-
POST /v…/preparator/intervention -
DELETE /v…/preparator/intervention -
POST /v…/preparator/inspection
https://github.com/govirtuo/front-end/pull/1732
-
v32: POST /creditcard, new field
source_token- @QuentinChoupin #1532 -
v31: POST /creditcard, processout card token expected - @QuentinChoupin #1111
-
v30: POST /identity/documents, recaptcha assessment - @omartin #1275
-
v29: PUT /booking confirmation,
travel_reasonfield mandatory in some V4B case (see - API) - @ludwigdn #1236 -
v28: POST /booking, new mandatory fields in delivery address for DnC (see API) - @motet-a #1147
-
v27: GET /init, new field hidden on locations to closed_to_new_pickup_bookings - @motet-a #1175
-
v26: POST /user & PUT /user, recaptcha assessment - @omartin #1077
Authentication ¶
(…)
Authentication ¶
(…)
Headers
Content-Type: application/jsonBody
{
"login": "test@example.com",
"password": "thomas",
"invitation_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"login": {
"type": "string"
},
"password": {
"type": "string"
},
"invitation_id": {
"type": "string",
"description": "Required only within the BusinessInvitation flow"
}
},
"required": [
"login",
"password"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Authenticate userPOST/auth
This endpoint is used to log a user via login/password.
Optional: if an invitation_id is provided, the user falls in the BusinessInvitation flow, thus leading the account to be link to a company specified in the invitation.
Errors
| code | http code | description |
|---|---|---|
| account-not-found | 404 | User about to be linked could not be found |
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
Authentication ¶
(…)
Headers
Content-Type: application/jsonBody
{
"token": "5829a335b15bef1000eacbe8",
"invitation_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string"
},
"invitation_id": {
"type": "string",
"description": "Required only within the BusinessInvitation flow"
}
},
"required": [
"token"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Authenticate user from a unique tokenPOST/auth-token
This endpoint is to log a user via a token.
Optional: if an invitation_id is provided, the user falls in the BusinessInvitation flow, thus leading the account to be link to a company specified in the invitation.
Errors
| code | http code | description |
|---|---|---|
| account-not-found | 404 | User about to be linked could not be found |
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
Authentication ¶
(…)
Headers
Content-Type: application/jsonBody
{
"token": "5829a335b15bef1000eacbe8",
"code": 9778,
"invitation_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string"
},
"code": {
"type": "number"
},
"invitation_id": {
"type": "string",
"description": "Required only within the BusinessInvitation flow"
}
},
"required": [
"token",
"code"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Authenticate user by responding to a challengePOST/auth-challenge
This endpoint is to validate an authentication challenge to log a user.
Optional: if an invitation_id is provided, the user falls in the BusinessInvitation flow, thus leading the account to be link to a company specified in the invitation.
Errors
| code | http code | description |
|---|---|---|
| account-not-found | 404 | User about to be linked could not be found |
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
Authentication ¶
(…)
Headers
Content-Type: application/jsonBody
{
"google_id_token": "5829a335b15bef1000eacbe8",
"password": "saymyname",
"invitation_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"google_id_token": {
"type": "string"
},
"password": {
"type": "string",
"description": "Required only when account already exists"
},
"invitation_id": {
"type": "string",
"description": "Required only within the BusinessInvitation flow"
}
},
"required": [
"google_id_token"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Authenticate user from a google signin tokenPOST/auth-googleid
This endpoint is to log a user via google signin.
Optional: account-already-exists or google-signin-register errors may occurs depending on the account
Errors
| code | http code | description |
|---|---|---|
| account-already-exists | 403 | Password is required to auth the existing account |
| google-signin-register | 403 | All register params are required (mobile, …) |
| account-not-found | 404 | User about to be linked could not be found |
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
Sessions ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"sessions": [
"session_id: `1cxKSRbJOoL2jEQTeUlQwI1Zqvaasp-T`",
"user_agent: node",
false
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sessions": {
"type": "array"
}
}
}List SessionsGET/sessions
(…)
Sessions disconnect ¶
(…)
Headers
Content-Type: application/jsonBody
{
"user_id": "1234",
"session_ids": "['123', '456']"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"session_ids": {
"type": "string"
}
},
"required": [
"user_id",
"session_ids"
]
}Headers
Content-Type: application/json; charset=utf-8Disconnect SessionsPOST/sessions/disconnect
(…)
Bookings ¶
Carbon offset properties
Each booking retrieved from the API will have a property called carbon_offset that is populated when the booking has ended.
On the list endpoints, a pending_carbon_offset property is added to allow a fast retrieval of the last carbon offset to be paid.
It is populated only when a carbon offset payment is pending for one of the customer’s booking. It will be the last booking they ended.
The carbon offset payment won’t be pending if the amount is lower than the minimal payment amount, if the car was changed, if the booking has ended more than 14 days ago or if the carbon offset has been paid.
Bookings ¶
Return bookings based on filters.
Headers
Content-Type: application/json; charset=utf-8Body
{
"bookinglist": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"count": 0,
"status": ""
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bookinglist": {
"type": "array"
},
"count": {
"type": "number"
},
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "bad-booking-status-parameter",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
}
}List bookingsGET/bookings?device_id={device_id}&status={status}&page={page}&limit={limit}
device_id is required when asking for a status different from ended or canceled or no status is given
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | Bad limit or page parameter sent |
| missing-field | 400 | Missing device_id field when status is not ended or canceled |
| bad-booking-status-parameter | 400 | Bad status parameter sent (ended or canceled accepted) |
- device_id
string(optional) Example: 5829a335b15bef1000eacbe8- status
string(optional) Example: ended- page
number(optional) Example: 1- limit
number(optional) Example: 10- sort
string(optional) Example: has_unpaid_invoicesBooking property to sort on
- order
string(optional) Example: ascdefault to
desc
Bookings ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"bookings": {
"future": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"past": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"pending": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"active": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"pending_carbon_offset": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"guest": [
{
"id": "5829a335b15bef1000eacbe8",
"user_id": "5829a335b15bef1000eacbe8",
"user_name": "Karim Kaddoura",
"user_firstname": "Karim",
"user_lastname": "Kaddoura",
"user_thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"from": "2018-09-17T20:21:48.052Z",
"to": "2018-09-17T20:21:48.052Z",
"country": "'FR'",
"vehicle_code": "a_class",
"status": "confirmed",
"status_description": "",
"plate": "VI-001-TO",
"package_distance": 150,
"mileage": 462,
"mileage_start": 42,
"energy": 0.5,
"energy_start": 1,
"badge_code": "",
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"vehicle_position_details": {},
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"should_refund_fuel": false,
"energy_price": 187,
"ev_charging_price_per_mileage": 187,
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"under_repair": false,
"is_requesting_key": false,
"key_status": "key-end-validity-error",
"end_rental_image_url": null,
"end_rental_description": "",
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bookings": {
"type": "object",
"properties": {
"future": {
"type": "array"
},
"past": {
"type": "array"
},
"pending": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"active": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"pending_carbon_offset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"guest": {
"type": "array"
}
},
"required": [
"future",
"past"
]
}
}
}List current bookingsGET/bookings/current
(…)
Bookings ¶
List ended bookings for user
Headers
Content-Type: application/json; charset=utf-8Body
{
"bookings": {
"future": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"past": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"pending": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"active": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"pending_carbon_offset": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"guest": [
{
"id": "5829a335b15bef1000eacbe8",
"user_id": "5829a335b15bef1000eacbe8",
"user_name": "Karim Kaddoura",
"user_firstname": "Karim",
"user_lastname": "Kaddoura",
"user_thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"from": "2018-09-17T20:21:48.052Z",
"to": "2018-09-17T20:21:48.052Z",
"country": "'FR'",
"vehicle_code": "a_class",
"status": "confirmed",
"status_description": "",
"plate": "VI-001-TO",
"package_distance": 150,
"mileage": 462,
"mileage_start": 42,
"energy": 0.5,
"energy_start": 1,
"badge_code": "",
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"vehicle_position_details": {},
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"should_refund_fuel": false,
"energy_price": 187,
"ev_charging_price_per_mileage": 187,
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"under_repair": false,
"is_requesting_key": false,
"key_status": "key-end-validity-error",
"end_rental_image_url": null,
"end_rental_description": "",
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bookings": {
"type": "object",
"properties": {
"future": {
"type": "array"
},
"past": {
"type": "array"
},
"pending": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"active": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"pending_carbon_offset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"guest": {
"type": "array"
}
},
"required": [
"future",
"past"
]
}
}
}List ended bookingsGET/bookings/ended
DEPRECATED in favor of GET /bookings
Bookings ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"bookings": {
"future": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"past": [
{
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"pending": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"active": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"pending_carbon_offset": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"guest": [
{
"id": "5829a335b15bef1000eacbe8",
"user_id": "5829a335b15bef1000eacbe8",
"user_name": "Karim Kaddoura",
"user_firstname": "Karim",
"user_lastname": "Kaddoura",
"user_thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"from": "2018-09-17T20:21:48.052Z",
"to": "2018-09-17T20:21:48.052Z",
"country": "'FR'",
"vehicle_code": "a_class",
"status": "confirmed",
"status_description": "",
"plate": "VI-001-TO",
"package_distance": 150,
"mileage": 462,
"mileage_start": 42,
"energy": 0.5,
"energy_start": 1,
"badge_code": "",
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"vehicle_position_details": {},
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"should_refund_fuel": false,
"energy_price": 187,
"ev_charging_price_per_mileage": 187,
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"under_repair": false,
"is_requesting_key": false,
"key_status": "key-end-validity-error",
"end_rental_image_url": null,
"end_rental_description": "",
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bookings": {
"type": "object",
"properties": {
"future": {
"type": "array"
},
"past": {
"type": "array"
},
"pending": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"active": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"pending_carbon_offset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"guest": {
"type": "array"
}
},
"required": [
"future",
"past"
]
}
}
}List paid bookingsGET/bookings/paid
DEPRECATED, has been replaced by /bookings/ended
Booking ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Get a bookingGET/booking
(…)
Headers
Content-Type: application/jsonBody
{
"delivery_address": {
"address_line1": "Hello, world!",
"address_line2": "Hello, world!",
"additional_note": "Hello, world!",
"latitude": 1,
"longitude": 1,
"street_number": "Hello, world!",
"street": "Hello, world!",
"zip_code": "Hello, world!",
"city": "Hello, world!",
"region": "Hello, world!",
"country_code": "Hello, world!"
},
"mode": "perso"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"mode": {
"type": "string",
"enum": [
"perso",
"pro",
"business"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
}
}
}Create a bookingPOST/booking
(…)
Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"creditcard_id": "card_j7m8khq142phci2sibvzetz7"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"creditcard_id": {
"type": "string"
}
},
"required": [
"booking_id",
"creditcard_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"promotional_code": "spdn"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"promotional_code": {
"type": "string"
}
},
"required": [
"booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"flight_terminal": "1A",
"flight_train": "4242",
"comes_by_train": true,
"flight_number": "AF1234",
"flight_origin": "Bamako",
"flight_company": "Air France",
"hotel_code": "4242"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string"
},
"comes_by_train": {
"type": "boolean"
},
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"hotel_code": {
"type": "string"
}
},
"required": [
"booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"status": "confirmed",
"device_id": "5829a335b15bef1000eacbe8",
"travel_reason: `ABC123` (optional, string) - From v29 onwards. Mandatory if user.company_travel_reason_enabled and user.company_travel_reason_mandatory are true.": "Hello, world!",
"legal_ids": [
"ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"ff5207c7210a6d8d186d89e5962b0928b66c53fe"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"status": {
"type": "string"
},
"device_id": {
"type": "string"
},
"travel_reason: `ABC123` (optional, string) - From v29 onwards. Mandatory if user.company_travel_reason_enabled and user.company_travel_reason_mandatory are true.": {
"type": "string"
},
"legal_ids": {
"type": "array"
}
},
"required": [
"booking_id",
"device_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"status": "canceled"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"status": "started",
"event_at": "2017-02-17T20:21:48.052Z",
"mileage": 1664,
"energy": 0.42
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"status": {
"type": "string"
},
"event_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"mileage": {
"type": "number"
},
"energy": {
"type": "number"
}
},
"required": [
"booking_id",
"event_at"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"to": "2017-02-17T20:21:48.052Z",
"package_distance": "150",
"options": [
"5829a335b15bef1000eacbe8"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"package_distance": {
"type": "string"
},
"options": {
"type": "array"
}
},
"required": [
"booking_id",
"to",
"package_distance"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}On accident process, it will create a MANAGER key on the badge independently of the booking
Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"badge_code": "4242"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"badge_code": {
"type": "string"
}
},
"required": [
"booking_id",
"badge_code"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"badge_code": "Hello, world!",
"device_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"badge_code": {
"type": "string"
},
"device_id": {
"type": "string"
}
},
"required": [
"booking_id",
"badge_code",
"device_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"review": "C'était trop cool !",
"rating": 5,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"keywords": [
"Propreté voiture"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"keywords": {
"type": "array",
"description": "max length 64 chars by keyword"
}
},
"required": [
"booking_id",
"review",
"rating"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"additional_drivers": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"mobile": "+33612437373",
"name": "Monsieur Kaddoura"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"additional_drivers": {
"type": "array"
}
},
"required": [
"booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"notification": "Uw verhuur is verlengd."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"notification": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Driver not in the contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Update a bookingPUT/booking
(…)
Headers
Content-Type: application/jsonBody
{}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-unconfirmed",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Delete a bookingDELETE/booking
(…)
Booking warranty ¶
Retry deposit for booking
Headers
Content-Type: application/jsonBody
{
booking_id: "12345667",
trigger_authentication_challenge: true
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}WarrantyPOST/booking/warranty
Booking modification ¶
Headers
Content-Type: application/jsonBody
{
"booking_id": "Hello, world!",
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"deliveryzone_id: `5829a335b15bef1000eacbe8` (optional, string) - either deliveryzone_id or location_id is required": "Hello, world!",
"location_id: `5829a335b15bef1000eacbe8` (optional, string) - either deliveryzone_id or location_id is required": "Hello, world!",
"package_distance": 150,
"vehicle_code: a_class": "Hello, world!",
"flight_terminal": "1A",
"flight_train": "4242",
"comes_by_train": true,
"flight_number": "AF1234",
"flight_origin": "Bamako",
"flight_company": "Air France",
"hotel_code": "4242",
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"mobile_search_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"deliveryzone_id: `5829a335b15bef1000eacbe8` (optional, string) - either deliveryzone_id or location_id is required": {
"type": "string"
},
"location_id: `5829a335b15bef1000eacbe8` (optional, string) - either deliveryzone_id or location_id is required": {
"type": "string"
},
"package_distance": {
"type": "number"
},
"vehicle_code: a_class": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string"
},
"comes_by_train": {
"type": "boolean"
},
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"hotel_code": {
"type": "string"
},
"search_snapshot_id": {
"type": "string"
},
"mobile_search_id": {
"type": "string"
}
},
"required": [
"booking_id",
"from",
"to",
"package_distance",
"vehicle_code: a_class",
"mobile_search_id"
]
}Headers
Content-Type: application/jsonHeaders
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Create booking modificationPOST/booking/modification
Headers
Content-Type: application/jsonBody
{
"booking_modification_id": "Hello, world!",
"promotional_code": "Hello, world!",
"status": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_modification_id": {
"type": "string"
},
"promotional_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"booking_modification_id",
"status"
]
}Headers
Content-Type: application/jsonUpdate booking modificationPUT/booking/modification
Booking quotation ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"total": 4900,
"total_diff": 4900,
"modification_total": 3000,
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"to": "2017-02-15T13:00:00+0100",
"package_distance": 150,
"from": "2017-02-15T13:00:00+0100",
"max_distance": 800,
"price_per_km": 10,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"instalments": {
"amount_due": 150
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"total": {
"type": "number"
},
"total_diff": {
"type": "number"
},
"modification_total": {
"type": "number"
},
"charges": {
"type": "array"
},
"to": {
"type": "string"
},
"package_distance": {
"type": "number"
},
"from": {
"type": "string"
},
"max_distance": {
"type": "number"
},
"price_per_km": {
"type": "number"
},
"min_distance_per_day": {
"type": "number"
},
"max_distance_per_day": {
"type": "number"
},
"instalments": {
"type": "object",
"properties": {
"amount_due": {
"type": "number"
}
},
"required": [
"amount_due"
]
}
},
"required": [
"total",
"total_diff",
"modification_total",
"to",
"package_distance",
"from",
"max_distance",
"price_per_km",
"min_distance_per_day",
"max_distance_per_day"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "The option is not manageable in the current context",
"error_code": "option-not-manageable-in-context",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error",
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}QuotationGET/booking/quotation{?booking_id,option_id,to,package_distance}
- booking_id
string(required) Example: 5829a335b15bef1000eacbe8- option_id
string(optional) Example: 5829a335b15bef1000eacbe8- to
string(optional) Example: 2017-02-15T13:00:00+0100- package_distance
number(optional) Example: 150
Booking inspection ¶
(…)
Headers
Content-Type: application/jsonBody
{
"damages": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"zone_id": "5829a335b15bef1000eacbe8",
"created_at": "2017-02-17T20:21:48.052Z",
"preparator_status": "validated"
}
],
"stage": "checkin",
"booking_id": "5829a335b15bef1000eacbe8",
"energy": 0.42,
"mileage": 1664,
"event_at": "2017-02-17T20:21:48.052Z",
"key_present": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"damages": {
"type": "array"
},
"stage": {
"type": "string",
"enum": [
"checkin",
"in-rental",
"checkout",
"after-rental",
"accident-in-rental"
]
},
"booking_id": {
"type": "string"
},
"energy": {
"type": "number"
},
"mileage": {
"type": "number"
},
"event_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_present": {
"type": "boolean"
}
},
"required": [
"stage",
"booking_id",
"energy",
"mileage",
"event_at"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"images": [
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"images": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"damages": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"zone_id": "5829a335b15bef1000eacbe8",
"created_at": "2017-02-17T20:21:48.052Z",
"preparator_status": "validated"
}
],
"stage": "checkin",
"booking_id": "5829a335b15bef1000eacbe8",
"event_at": "2017-02-17T20:21:48.052Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"damages": {
"type": "array"
},
"stage": {
"type": "string",
"enum": [
"checkin",
"in-rental",
"checkout",
"after-rental",
"accident-in-rental"
]
},
"booking_id": {
"type": "string"
},
"event_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"stage",
"booking_id",
"event_at"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"images": [
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"images": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User not a driver in contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"damages": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"zone_id": "5829a335b15bef1000eacbe8",
"created_at": "2017-02-17T20:21:48.052Z",
"preparator_status": "validated"
}
],
"dropoffreports": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"code": "front",
"created_at": "2017-02-17T20:21:48.052Z"
}
],
"skip_dropoffreport": true,
"stage": "checkin",
"booking_id": "5829a335b15bef1000eacbe8",
"energy": 0.42,
"mileage": 1664,
"vehicle_checkout_position": {
"captured_at": "2017-02-17T20:21:48.052Z",
"latitude": 48.885929,
"longitude": 2.310133
},
"vehicle_position_details": {
"terminal": "2B",
"parking": "Sud",
"level": "-1",
"aisle": "F",
"place": "42",
"address": "12 rue machin",
"longitude": "xx.xxxxx",
"latitude": "yy.yyyyy"
},
"event_at": "2017-02-17T20:21:48.052Z",
"collect_address": {
"address_line1": "114 rue Cardinet",
"address_line2": "75017 Paris",
"additional_note": "Pas très loin des Amateurs",
"latitude": 48.885929,
"longitude": 2.310133,
"street_number": "Hello, world!",
"street": "Hello, world!",
"zip_code": "Hello, world!",
"city": "Hello, world!",
"region": "Hello, world!",
"country_code": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"damages": {
"type": "array"
},
"dropoffreports": {
"type": "array"
},
"skip_dropoffreport": {
"type": "boolean",
"description": "Mark (explicitly in db) the dropoffreport as skipped, default false"
},
"stage": {
"type": "string",
"enum": [
"checkin",
"in-rental",
"checkout",
"after-rental",
"accident-in-rental"
]
},
"booking_id": {
"type": "string"
},
"energy": {
"type": "number"
},
"mileage": {
"type": "number"
},
"vehicle_checkout_position": {
"type": "object",
"properties": {
"captured_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
},
"required": [
"captured_at",
"latitude",
"longitude"
]
},
"vehicle_position_details": {
"type": "object",
"properties": {
"terminal": {
"type": "string"
},
"parking": {
"type": "string"
},
"level": {
"type": "string"
},
"aisle": {
"type": "string"
},
"place": {
"type": "string"
},
"address": {
"type": "string"
},
"longitude": {
"type": "string"
},
"latitude": {
"type": "string"
}
}
},
"event_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string",
"description": "Required before v28. Not needed from v28 onwards."
},
"address_line2": {
"type": "string",
"description": "Required before v28. Not needed from v28 onwards."
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string",
"description": "From v28 onwards. Optional."
},
"street": {
"type": "string",
"description": "From v28 onwards. Required."
},
"zip_code": {
"type": "string",
"description": "From v28 onwards. Required."
},
"city": {
"type": "string",
"description": "From v28 onwards. Required."
},
"region": {
"type": "string",
"description": "From v28 onwards. Optional."
},
"country_code": {
"type": "string",
"description": "From v28 onwards. Required (but ignored in requests)."
}
},
"required": [
"latitude",
"longitude"
]
}
},
"required": [
"stage",
"booking_id",
"energy",
"mileage",
"vehicle_position_details",
"event_at"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"images": [
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"images": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User not a driver in contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/jsonBody
{
"booking_id": "5829a335b15bef1000eacbe8",
"damages": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"zone_id": "5829a335b15bef1000eacbe8",
"created_at": "2017-02-17T20:21:48.052Z",
"preparator_status": "validated"
}
],
"event_at": "2017-02-17T20:21:48.052Z",
"stage": "checkin",
"support_case_number": "AZE123345",
"incident_type": "non",
"accident_types": [
"bodywork"
],
"accident_description": "Hello, world!",
"external_assistance": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"damages": {
"type": "array"
},
"event_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"stage": {
"type": "string",
"enum": [
"checkin",
"in-rental",
"checkout",
"after-rental",
"accident-in-rental"
]
},
"support_case_number": {
"type": "string"
},
"incident_type": {
"type": "string",
"enum": [
"non",
"rolling",
"breakdown",
"non-rolling"
]
},
"accident_types": {
"type": "array"
},
"accident_description": {
"type": "string"
},
"external_assistance": {
"type": "boolean"
}
},
"required": [
"booking_id",
"event_at",
"stage",
"incident_type",
"accident_description"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
},
"images": [
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
},
"images": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User not an active additionnal driver"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}InspectionPOST/inspection
(…)
Headers
Content-Type: application/pdfGet Inspection PDFGET/inspection/{booking_id}/pdf
Get Booking Inspection PDF
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Booking document ¶
Headers
Content-Type: application/json; charset=utf-8Headers
Content-Type: application/pdfBody
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User is not a driver in contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User is not a driver in contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "bad-booking-status",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}DocumentGET/booking/document?booking_id={booking_id}&key={key}
Get car document for a specified booking
Errors
| code | http code | description |
|---|---|---|
| user-not-in-contract | 403 | User is not a driver in contract |
| booking-not-found | 404 | Booking not found |
| bad-booking-status | 500 | Statuses allowed started and warranty_held |
| no-assigned-vehicle | 500 | No vehicle_id found on booking |
| key-not-found | 500 | Key not found |
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
- key
string(required) Example: GQ-248-DP.insurance.jpgFile name, coming from
GET /booking/documents
Booking documents ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"documents": {
"insurance": "https://media-exp2.licdn.com/mpr/mpr/shrinknp_200_200/AAEAAQAAAAAAAAuuAAAAJGI4ZTk1NDM2LTkxYjUtNDU2My1hMWYzLWYwODkyZTdiMzhkYw.jpg",
"registration": "https://avatars2.githubusercontent.com/u/520890?s=460&v=4"
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User is not a driver in contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "bad-booking-status",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}DocumentsGET/booking/documents
Get car documents for a specified booking
Errors
| code | http code | description |
|---|---|---|
| user-not-in-contract | 403 | User is not a driver in contract |
| booking-not-found | 404 | Booking not found |
| bad-booking-status | 500 | Statuses allowed started and warranty_held |
| no-assigned-vehicle | 500 | No vehicle_id found on booking |
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Booking damages ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"currency_code": "EUR",
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"damages": {
"type": "array"
},
"currency_code": {
"type": "string"
},
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "Wrong parameter",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}DamagesGET/damages{?booking_id}
Get damages for a specified booking
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Booking damagereport ¶
(…)
Headers
Content-Type: application/pdfDamagereport PDFGET/booking/{booking_id}/damagereport/pdf
Get Booking Damagereport PDF
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Booking fees ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"fees": [
{
"code": "damaged",
"name": "damaged",
"zones": [
{
"name": "Front Mercedes-Benz Logo",
"price": 2570
}
]
}
],
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"fees": {
"type": "array"
},
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "Wrong parameter",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}FeesGET/fees?{booking_id}
Get fees for a specified booking
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Booking invoice ¶
(…)
Headers
Content-Type: application/pdfInvoiceGET/invoice/{booking_id}/pdf
Get invoice for a specified booking
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Get last vehicle's synthesis ¶
Headers
Content-Type: application/jsonBody
{
"synthesis": {
"captured_at": "2021-08-06T12:25:19.000Z",
"doors_state": "ALL_UNLOCKED",
"energy": {
"captured_at": "2021-08-06T12:25:19.000Z",
"type": "FUEL",
"unit": "LITER",
"value": 35
},
"mileage": {
"captured_at": "2021-08-06T12:25:19.000Z",
"unit": "KM",
"value": 9666
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"synthesis": {
"type": "object",
"properties": {
"captured_at": {
"type": "string",
"description": "Synthesis capture date"
},
"doors_state": {
"type": "string",
"enum": [
"ALL_UNLOCKED",
"LOCKED",
"NONE"
],
"description": "Doors state"
},
"energy": {
"type": "object",
"properties": {
"captured_at": {
"type": "string",
"description": "Energy capture date"
},
"type": {
"type": "string",
"enum": [
"FUEL",
"ELECTRIC",
"UNKNOW"
],
"description": "Energy type"
},
"unit": {
"type": "string",
"enum": [
"LITER",
"GALON",
"PERCENTAGE",
"UNKNOWN"
],
"description": "Energy unit"
},
"value": {
"type": "number",
"description": "Energy value"
}
},
"required": [
"captured_at",
"type",
"unit",
"value"
]
},
"mileage": {
"type": "object",
"properties": {
"captured_at": {
"type": "string",
"description": "Mileage capture date"
},
"unit": {
"type": "string",
"enum": [
"KM",
"MILES",
"UNKNOWN"
],
"description": "Mileage unit"
},
"value": {
"type": "number",
"description": "Mileage value"
}
},
"required": [
"captured_at",
"unit",
"value"
]
}
},
"required": [
"captured_at",
"doors_state"
]
}
}
}Fetch booking's vehicle last synthesisGET/booking/last-vehicle-synthesis{?booking_id}
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3Booking identifier
Get vehicle current_state ¶
Headers
Content-Type: application/jsonBody
{
"current_state": {
"vehicle_id": "5829a335b15bef1000eacbe8",
"adblue_level": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "percentage",
"value": 0.2
},
"adblue_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": 0
},
"battery_level": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "volt",
"value": 14.8
},
"battery_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": true
},
"brake_fluid_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": false
},
"brake_pads_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": false
},
"connected_to_charger": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": true
},
"coolant_level": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "percentage",
"value": 0.3
},
"coolant_temp": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "celsius",
"value": 78
},
"coolant_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": false
},
"door_fl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"door_fr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"door_rr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"front_trunk": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"trunk": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"hood": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"tank_cap": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"door_lock_fl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "LOCKED"
},
"door_lock_fr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "LOCKED"
},
"door_lock_rl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "LOCKED"
},
"door_lock_rr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "LOCKED"
},
"due_service": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "km",
"value": 2352
},
"due_service_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": true
},
"engine_oil_level": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "percentage",
"value": 0.4
},
"engine_oil_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": false
},
"engine_running": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "ON"
},
"fuel_level": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "percentage",
"value": 0.5
},
"state_of_charge": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "percentage",
"value": 0.2
},
"latitude": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": 44.234235
},
"longitude": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": 1.234235
},
"odometer": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "km",
"value": 13489
},
"one_interior_light": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "ON"
},
"tire_pressure_level_fl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "bar",
"value": 2.4
},
"tire_pressure_level_fr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "bar",
"value": 2.4
},
"tire_pressure_level_rl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "bar",
"value": 2.4
},
"tire_pressure_level_rr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "bar",
"value": 2.4
},
"tire_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": true
},
"vehicle_speed": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "kmh",
"value": 123
},
"washer_fluid_warning": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": true
},
"window_fl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"window_fr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"window_rl": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
},
"window_rr": {
"captured_at": "2021-08-06T12:25:19.000Z",
"source": "Provider",
"unit": "undefined",
"value": "OPEN"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"current_state": {
"type": "object",
"properties": {
"vehicle_id": {
"type": "string"
},
"adblue_level": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"adblue_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"battery_level": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"battery_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"brake_fluid_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"brake_pads_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"connected_to_charger": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"coolant_level": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"coolant_temp": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"coolant_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_fr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_fl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_rr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"front_trunk": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"trunk": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"hood": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tank_cap": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_lock_fl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"LOCKED",
"UNLOCKED"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_lock_fr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"LOCKED",
"UNLOCKED"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_lock_rl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"LOCKED",
"UNLOCKED"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"door_lock_rr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"LOCKED",
"UNLOCKED"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"due_service": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"due_service_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"engine_oil_level": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"engine_oil_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"engine_running": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"ON",
"OFF"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"fuel_level": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"state_of_charge": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"latitude": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"longitude": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"odometer": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"one_interior_light": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"ON",
"OFF"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tire_pressure_level_fl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tire_pressure_level_fr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tire_pressure_level_rl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tire_pressure_level_rr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"tire_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"vehicle_speed": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "number"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"washer_fluid_warning": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"window_fl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"window_fr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"window_rl": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
},
"window_rr": {
"type": "object",
"properties": {
"captured_at": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"Provider",
"Manufacturer"
]
},
"unit": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string",
"enum": [
"OPEN",
"CLOSE"
]
}
},
"required": [
"captured_at",
"source",
"unit",
"value"
]
}
},
"required": [
"vehicle_id"
]
}
}
}Get vehicle current_stateGET/booking/vehicle-current-state{?booking_id}
- booking_id
string(required) Example: 58cbc00d5d717b00114158c3booking identifier
Booking Max Extension Date ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"maximum_extension_date": "2023-03-23T20:21:48.052Z",
"status": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"maximum_extension_date": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"status": {
"type": "string"
}
},
"required": [
"maximum_extension_date"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "Hello, world!",
"error_code": "Hello, world!",
"status": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "Hello, world!",
"status": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
}
}Booking Extension DateGET/booking/extension-date?booking_id={booking_id}
Return booking max extension date.
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | Not a booking |
| booking-not-found | 404 | Rental not found |
- booking_id
string(required) Example: 5829a335b15bef1000eacbe8Booking identifier
Booking Available Modifications ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"result": {
"context": "modification",
"available_modifications": [
"start-date"
],
"modification_rules": {
"end-date": {
"max": "2023-04-04T20:00:00.000Z"
},
"mileage-package": {
"max": 200
},
"options": {
"items": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
]
}
},
"search_results": []
},
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"context": {
"type": "string",
"enum": [
"modification",
"late-modification",
"extension",
"late-extension"
]
},
"available_modifications": {
"type": "array"
},
"modification_rules": {
"type": "object",
"properties": {
"end-date": {
"type": "object",
"properties": {
"max": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"max"
]
},
"mileage-package": {
"type": "object",
"properties": {
"max": {
"type": "number",
"description": "The max mileage package available"
}
},
"required": [
"max"
]
},
"options": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
}
}
},
"search_results": {
"description": "Field present for `modification` and `late-modification` contexts only"
}
},
"required": [
"context",
"available_modifications",
"modification_rules"
],
"description": "The booking available modifications"
},
"status": {
"type": "string"
}
},
"required": [
"result",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "bad-parameter",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "bad-booking-status",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Booking Available ModificationsGET/booking/available-modifications?booking_id={booking_id}
Return booking available modifications
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | Not a booking |
| bad-booking-status | 403 | Status not allowed |
| booking-modification-not-allowed | 403 | Booking modification is not allowed (can be because of the context |
| booking-not-found | 404 | Rental not found |
- booking_id
string(required) Example: 5829a335b15bef1000eacbe8Booking identifier
- search_snapshot_id
string(optional) Example: 645275c53340120006de328bSearch snapshot id should be send for each new search during the same flow
Request a payment plan proposal ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"proposal": [
{
"amount": 123,
"proceed_at": "2024-05-19T20:21:48.052Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"proposal": {
"type": "array"
}
}
}Request a payment plan proposalPOST/booking/:booking_id/payment-plan/proposal
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| invoice-already-has-payment-plan | 403 |
- booking_id
string(required) Example: card7m8khq142phci2sibvzetz7
Create a payment plan ¶
Headers
Content-Type: application/jsonBody
{
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": "Hello, world!",
"travel_reason": "ABC123",
"legal_ids": [
"ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"ff5207c7210a6d8d186d89e5962b0928b66c53fe"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": {
"type": "string"
},
"travel_reason": {
"type": "string"
},
"legal_ids": {
"type": "array"
}
},
"required": [
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`",
"legal_ids"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"payment_plan": {
"id": "5829a335b15bef1000eacbea",
"booking_id": "7829a335b15bef1000eacbe3",
"currency": "1129a335b15bef1000eacbea",
"status": "started",
"type": "invoice",
"current_creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": "Hello, world!",
"cvc_check": "pass",
"holder_name": "Jérôme Kerviel",
"code": "1234",
"year": 2016,
"month": 5,
"type": {
"Visa": "Hello, world!",
"American Express": "Hello, world!",
"MasterCard": "Hello, world!",
"paypal": "Hello, world!"
},
"title": "Kerviel",
"source": {
"apple_pay": "Hello, world!",
"google_pay": "Hello, world!",
"processout_apm": "Hello, world!"
},
"country": "FR",
"funding": "credit",
"is_authenticated": {
"auto": "Hello, world!",
"manual": "Hello, world!"
},
"is_business": true,
"is_deleted": false,
"three_d_secure_support": true
},
"ref": "Hello, world!",
"rents": [
{
"id": "5829a335b15bef1000eacbea",
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"status": "pending",
"succeeded_at": "2024-05-19T20:21:48.052Z"
}
],
"has_payment_error": true,
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"account_id: `acct_1234`": "Hello, world!",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id: `tok_1234`": "Hello, world!",
"invoice_id: `iv_12345`": "Hello, world!"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment_plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"currency": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"started",
"completed",
"abandoned",
"started"
]
},
"type": {
"type": "string",
"enum": [
"invoice",
"booking",
"invoice"
]
},
"current_creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": {
"type": "string"
},
"cvc_check": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "object",
"properties": {
"Visa": {
"type": "string"
},
"American Express": {
"type": "string"
},
"MasterCard": {
"type": "string"
},
"paypal": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"apple_pay": {
"type": "string"
},
"google_pay": {
"type": "string"
},
"processout_apm": {
"type": "string"
}
},
"description": "Can also be null"
},
"country": {
"type": "string"
},
"funding": {
"type": "string"
},
"is_authenticated": {
"type": "object",
"properties": {
"auto": {
"type": "string"
},
"manual": {
"type": "string"
}
},
"description": "Can also be false"
},
"is_business": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
},
"three_d_secure_support": {
"type": "boolean"
}
},
"required": [
"id",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type",
"title",
"country",
"funding",
"is_deleted",
"three_d_secure_support"
]
},
"ref": {
"type": "string"
},
"rents": {
"type": "array"
},
"has_payment_error": {
"type": "boolean"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
}
},
"required": [
"provider"
]
}
},
"required": [
"id",
"booking_id",
"currency",
"current_creditcard",
"ref",
"rents",
"has_payment_error"
]
}
}
}Create a payment planPOST/booking/:booking/payment-plan/create
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| booking-already-has-payment-plan | 403 | |
| card-expired | 403 | Card must be valid until the last proceed_at date |
- booking_id
string(required) Example: card7m8khq142phci2sibvzetz7
BusinessInvitations ¶
(…)
Accept Business Invitation ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"business_invitation": {
"id": "62b32b2f4ee9eb1d221cce58",
"company_id": "588b73713324bc001139082d",
"company_name": "Virtuo",
"email": "test05034@govirtuo.com",
"firstname": "test",
"language": "fr",
"lastname": "user",
"sent_by_admin_id": "5c7d60a9ab47420015fe2e54",
"used_by": "62b32f77e636ad1c93519718"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"business_invitation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"language": {
"type": "string"
},
"lastname": {
"type": "string"
},
"sent_by_admin_id": {
"type": "string"
},
"used_by": {
"type": "string"
}
}
}
}
}Accept Business Invitation (default user)POST/invitation/:id/accept
The user doesn’t need to be logged in to use this endpoint.
This endpoint is used when the user receives a Business Invitation from a V4B admin. It lets them accept the invitation, thus linking the user account tied to the invitation’s email address. This account is thus linked to the company of the admin, by add a business profile to it.
Errors
| code | http code | description |
|---|---|---|
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| account-not-found | 404 | User about to be linked could not be found |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
- id
string(required) Example: 5829a335b15bef1000eacbe8
Headers
Content-Type: application/json; charset=utf-8Body
{
"business_invitation": {
"id": "62b32b2f4ee9eb1d221cce58",
"company_id": "588b73713324bc001139082d",
"company_name": "Virtuo",
"email": "test05034@govirtuo.com",
"firstname": "test",
"language": "fr",
"lastname": "user",
"sent_by_admin_id": "5c7d60a9ab47420015fe2e54",
"used_by": "62b32f77e636ad1c93519718"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"business_invitation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"language": {
"type": "string"
},
"lastname": {
"type": "string"
},
"sent_by_admin_id": {
"type": "string"
},
"used_by": {
"type": "string"
}
}
}
}
}Accept Business Invitation (current user)POST/invitation/:id/accept/user
The user must be logged in to use this endpoint.
This endpoint is used when the user receives a Business Invitation from a V4B admin. It lets them accept the invitation, thus linking their personal account, with which they are logged in, to the company of the admin, by add a business profile to it.
Errors
| code | http code | description |
|---|---|---|
| business-invitation-not-found | 404 | The business invitation could not be found |
| business-invitation-already-used | 403 | The business invitation has already been accepted |
| account-not-found | 404 | User about to be linked could not be found |
| cannot-accept-invitation-already-linked-to-other-company | 403 | The user does already belong to another company |
- id
string(required) Example: 5829a335b15bef1000eacbe8
Carbon Offset ¶
(…)
List active carbon offset projects by country ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"carbonoffsetprojects": [
{
"id": "5829a335b15bef1000eacbe8",
"name": "Hello, world!",
"title": "Hello, world!",
"description": "Hello, world!"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"carbonoffsetprojects": {
"type": "array"
}
}
}List active carbon offset projects by countryGET/carbonoffset/projects/{country_code}
This endpoint lists a maximum of 4 projects prioritized for the country, and keep this priority order. When there’s no project for the country, or when the country isn’t configured, it returns an empty array.
When a project is missing the required translation or is disabled, then it won’t be present in the response.
- country_code
string(required) Example: FRCode for a country
This endpoint handles the payment when a customer decides to offset their carbon ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"bookingcarbonoffset": {
"id": "booking-carbon-offset-id",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id": "token-id",
"invoice_id": "invoice-id"
},
"threedsecure_redirect_url": "https://bank.example.com/3ds"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bookingcarbonoffset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id": {
"type": "string"
},
"invoice_id": {
"type": "string"
}
},
"required": [
"provider"
]
},
"threedsecure_redirect_url": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}This endpoint handles the payment when a customer decides to offset their carbonPOST/carbonoffset/paid/{booking_id}/{project_id}
- booking_id
string(required) Example: 5d10fc7d0580f40cbdb30a34- project_id
string(required) Example: 5d10fc7d0580f40cbdb30a34
Claims ¶
(…)
Claim ¶
(…)
Headers
Content-Type: application/jsonBody
{
"code": "parking-refund",
"content": "Hello, world!",
"booking_id": "5829a335b15bef1000eacbe8",
"invoice_id: `5829a335b15bef1000eacbe8` (optional, string) - used with name=instalment-request and booking_id provided": "Hello, world!",
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"parking-refund",
"invoice-inquiry",
"instalment-request",
"account-not-validated",
"lost-item"
],
"description": "The claim type code"
},
"content": {
"type": "string",
"description": "The customer message"
},
"booking_id": {
"type": "string",
"description": "The related booking ID"
},
"invoice_id: `5829a335b15bef1000eacbe8` (optional, string) - used with name=instalment-request and booking_id provided": {
"type": "string"
},
"pictures": {
"type": "array"
}
},
"required": [
"code",
"content"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"claim": {
"id": "5829a335b15bef1000eacbe8",
"code": "parking-refund",
"content": "Hello, I have lost something in the car",
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg"
}
],
"booking_id": "5829a335b15bef1000eacbe8",
"invoice_id": "5829a335b15bef1000eacbe8",
"user_id": "5829a335b15bef1000eacbe8",
"updated_at": "2020-02-27T11:15:48.052Z",
"created_at": "2020-02-27T11:12:30.052Z"
},
"images": [
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"claim": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string",
"enum": [
"parking-refund",
"invoice-inquiry",
"instalment-request",
"account-not-validated",
"lost-item"
]
},
"content": {
"type": "string"
},
"pictures": {
"type": "array"
},
"booking_id": {
"type": "string"
},
"invoice_id": {
"type": "string",
"description": "only for `instalment-request`"
},
"user_id": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"id",
"code",
"content",
"user_id"
]
},
"images": {
"type": "array"
}
}
}Create a claimPOST/claim
(…)
Company ¶
(…)
Company ¶
The user’s company.
Headers
Content-Type: application/json; charset=utf-8Body
{
"company": {
"id": "5829a335b15bef1000eacbe8",
"logo_url": "'https://s3.eu",
"background_url": "null",
"name": "Virtuo",
"managed_by_partner_id": "Hello, world!",
"business_address": {
"street_address": "16 boulevard de la Bastille",
"zip_code": "75012",
"region": "null",
"city": "Paris",
"country": "FR"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"logo_url": {
"type": "string",
"description": "central-1.amazonaws.com/virtuo-user-files-test/56f1779703103e11004d290e/588b73713324bc001139082e-1485534091935-bo.jpg' (required, string)"
},
"background_url": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"managed_by_partner_id": {
"type": [
"string",
"null"
]
},
"business_address": {
"type": "object",
"properties": {
"street_address": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"region": {
"type": [
"string",
"null"
]
},
"city": {
"type": "string"
},
"country": {
"type": "string"
}
},
"required": [
"region"
]
}
},
"required": [
"id",
"background_url",
"name",
"business_address"
]
}
}
}Get a companyGET/company
(…)
Content ¶
(…)
Page ¶
(…)
Headers
Content-Type: application/jsonBody
{}Get a pageGET/page
(…)
View ¶
(…)
Headers
Content-Type: application/jsonBody
{}Render a viewGET/^\/([a-z-]+).html$/
(…)
Credit cards ¶
(…)
Credit cards ¶
Return credits cards for user
Headers
Content-Type: application/json; charset=utf-8Body
{
"creditcards": [
{
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcards": {
"type": "array"
}
}
}List credit cardsGET/creditcards
Credit card ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
}
}
}Get a credit cardGET/creditcard{?creditcard_id}
- creditcard_id
string(required) Example: card...
Headers
Content-Type: application/jsonBody
{
"creditcard_id": "tok_19TGFKATL9zpwulWOxjlJts3"
"source_token": "gway_req_V2UncmUgaGlyaW5nIQ=="
"account_id": "acct_12345654432"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
}
}
}Create a credit cardPOST/creditcard
(…)
Headers
Content-Type: application/jsonBody
{
"creditcard_id": "card_j7m8khq142phci2sibvzetz7",
"title": "EISENBERG"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
}
}
}Update a credit cardPUT/creditcard
Headers
Content-Type: application/jsonBody
{
"creditcard_id": "card_j7m8khq142phci2sibvzetz7"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
}
}
}Delete a credit cardDELETE/creditcard
Validate 3dsecure ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{}3dsecureGET/threedsecure/validate
Credit card token ¶
Token requested to verify the creditcard
Headers
Content-Type: application/json; charset=utf-8Body
{
"token": {
"token_id: `tok_12356732`": "Hello, world!",
"customer_id: `cust_xxxx`": "Hello, world!",
"provider": "stripe"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "object",
"properties": {
"token_id: `tok_12356732`": {
"type": "string"
},
"customer_id: `cust_xxxx`": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"stripe",
"processout"
]
}
}
}
}
}Get a credit card tokenPOST/creditcard-token
- Body
- user_id:
13245(string, required)
- user_id:
Credits ¶
Credit route ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"credits": [
{
"id": "credit_j7m8khq142phci2sibvzetz7",
"currency": "GBP",
"amount": 500,
"type": "rental",
"label": "Invoice Mistake",
"issued_at": "2017-02-17T20:21:48.052Z"
}
],
"count": 1,
"amount": 1,
"status": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"credits": {
"type": "array"
},
"count": {
"type": "number"
},
"amount": {
"type": "number"
},
"status": {
"type": "string"
}
}
}List credits @deprecatedGET/user/credit
Credits route ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"creditdetail": {
"active_credits": [
{
"burnt": 200,
"user_id": "ci_qnvroct0eiaig0x1q0d97910",
"type": "rental",
"currency": "GBP",
"amount": 500,
"redemptions": [
{
"date": "2017-02-17T20:21:48.052Z",
"amount": 500,
"booking_id": "bo_qnvroct0eiaig0x1q0d97910"
}
],
"remaining": 300,
"label": {
"nl": "translation",
"de": "translation",
"es": "translation",
"ca": "translation",
"it": "translation",
"fr": "translation",
"en": "translation"
},
"id": "credit_j7m8khq142phci2sibvzetz7",
"expired_at": "2021-10-25T10:41:28.234Z",
"issued_at": "2021-10-25T10:41:28.234Z"
}
],
"active_credits_count": 1,
"unactive_credits": [
{
"burnt": 200,
"user_id": "ci_qnvroct0eiaig0x1q0d97910",
"type": "rental",
"currency": "GBP",
"amount": 500,
"redemptions": [
{
"date": "2017-02-17T20:21:48.052Z",
"amount": 500,
"booking_id": "bo_qnvroct0eiaig0x1q0d97910"
}
],
"remaining": 300,
"label": {
"nl": "translation",
"de": "translation",
"es": "translation",
"ca": "translation",
"it": "translation",
"fr": "translation",
"en": "translation"
},
"id": "credit_j7m8khq142phci2sibvzetz7",
"expired_at": "2021-10-25T10:41:28.234Z",
"issued_at": "2021-10-25T10:41:28.234Z"
}
],
"unactive_credits_count": 1,
"amount": 2000
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditdetail": {
"type": "object",
"properties": {
"active_credits": {
"type": "array"
},
"active_credits_count": {
"type": "number"
},
"unactive_credits": {
"type": "array"
},
"unactive_credits_count": {
"type": "number"
},
"amount": {
"type": "number"
}
},
"required": [
"active_credits_count",
"unactive_credits_count",
"amount"
]
}
}
}List creditsGET/user/credit-detail{?active_page,active_limit,unactive_page,unactive_limit}
- active_page
number(optional) Example: 1...- active_limit
number(optional) Example: 10...- unactive_page
number(optional) Example: 1...- unactive_limit
number(optional) Example: 10...
Dunasys Synthesis ¶
Store Dunasys syntheses ¶
Body
{
"dunasys_vehicle_id": "60e5d2a12914c338e0cb1ad3",
"syntheses": [
{
"captured_at": 1633505539,
"doors": {
"door_front_left_state": "closed",
"door_front_right_state": "closed",
"door_rear_left_state": "closed",
"door_rear_right_state": "closed",
"car_trunk_state": "closed"
},
"apc": true,
"engine_speed": 750,
"speed": 88,
"energy_type": "fuel",
"fuel": {
"value": 35,
"unit": "liters",
"captured_at": 1633505539
},
"mileage": {
"value": 1256,
"unit": "km",
"captured_at": 1633505539
},
"battery_voltage": 12.4,
"vin": "DUNASYSVIRTUOC001",
"gps": {
"latitude": 48.887756,
"longitude": 2.295464,
"accuracy": 3,
"captured_at": 1633505539
},
"network_operator": "Orange",
"network_strength": 4,
"key_activated": false,
"nfc_reader_connected": true
}
]
}Schema
{
"type": "object",
"properties": {
"dunasys_vehicle_id": {
"type": "string",
"description": "Dunasys vehicle ID"
},
"syntheses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"captured_at": {
"type": "number",
"description": "UNIX timestamp"
},
"doors": {
"type": "object",
"properties": {
"door_front_left_state": {
"enum": [
"closed",
"open",
"unknown"
]
},
"door_front_right_state": {
"enum": [
"closed",
"open",
"unknown"
]
},
"door_rear_left_state": {
"enum": [
"closed",
"open",
"unknown"
]
},
"door_rear_right_state": {
"enum": [
"closed",
"open",
"unknown"
]
},
"car_trunk_state": {
"enum": [
"closed",
"open",
"unknown"
]
}
}
},
"apc": {
"type": "boolean"
},
"engine_speed": {
"type": "number"
},
"speed": {
"type": "number"
},
"energy_type": {
"enum": [
"fuel",
"electric"
]
},
"fuel": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"unit": {
"enum": [
"liters",
"percent"
]
},
"captured_at": {
"type": "number",
"description": "UNIX timestamp"
}
}
},
"mileage": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"unit": {
"enum": [
"km",
"mi"
]
},
"captured_at": {
"type": "number",
"description": "UNIX timestamp"
}
}
},
"battery_voltage": {
"type": "number"
},
"vin": {
"type": "string"
},
"gps": {
"type": "object",
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"accuracy": {
"type": "number"
},
"captured_at": {
"type": "number",
"description": "UNIX timestamp"
}
}
},
"network_operator": {
"type": "string"
},
"network_strength": {
"type": "number"
},
"key_activated": {
"type": "boolean"
},
"nfc_reader_connected": {
"type": "boolean"
}
}
},
"description": "Dunasys syntheses"
}
},
"required": [
"dunasys_vehicle_id",
"syntheses"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"status": "ok"
}Store Dunasys synthesesPOST/dunasys/syntheses
Stores Dunasys vehicle syntheses
Mobile Syntheses ¶
Store Mobile syntheses ¶
Body
{
"booking_id": "60e5d2a12914c338e0cb1ad3",
"syntheses": [
{
"vehicle_id": "6062e2c8adc64c000675c461",
"type": "event",
"event": "vehicle_unlocked",
"captured_at": "2023-06-12T08:30:00.000Z",
"provider_key_id": "co635mlqylmo",
"synthesis": {
"door_lock_fl": {
"value": "LOCKED",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_lock_fr": {
"value": "LOCKED",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_lock_rl": {
"value": "LOCKED",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_lock_rr": {
"value": "LOCKED",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_fl": {
"value": "OPEN",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_fr": {
"value": "OPEN",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_rl": {
"value": "OPEN",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"door_rr": {
"value": "OPEN",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"fuel_level": {
"value": 0.35,
"captured_at": "2023-06-12T07:35:05.000Z"
},
"odometer": {
"value": 629,
"captured_at": "2023-06-12T07:35:05.000Z"
},
"engine_running": {
"value": "ON",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"connected_to_charger": {
"value": "false",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"vehicle_speed": {
"value": "92",
"captured_at": "2023-06-12T07:35:05.000Z"
},
"battery_level": {
"value": "12.4",
"captured_at": "2023-06-12T07:35:05.000Z"
}
}
}
]
}Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"description": "Booking ID"
},
"syntheses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"vehicle_id": {
"type": "string"
},
"type": {
"enum": [
"event"
]
},
"event": {
"enum": [
"vehicle_unlocked",
"vehicle_locked",
"bluetooth_connected",
"bluetooth_disconnected"
]
},
"captured_at": {
"type": "string",
"description": "ISO Date"
},
"provider_key_id": {
"type": "string"
},
"synthesis": {
"type": "object",
"properties": {
"door_lock_fl": {
"type": "object",
"properties": {
"value": {
"enum": [
"LOCKED",
"UNLOCKED"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_lock_fr": {
"type": "object",
"properties": {
"value": {
"enum": [
"LOCKED",
"UNLOCKED"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_lock_rl": {
"type": "object",
"properties": {
"value": {
"enum": [
"LOCKED",
"UNLOCKED"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_lock_rr": {
"type": "object",
"properties": {
"value": {
"enum": [
"LOCKED",
"UNLOCKED"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_fl": {
"type": "object",
"properties": {
"value": {
"enum": [
"OPEN",
"CLOSE"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_fr": {
"type": "object",
"properties": {
"value": {
"enum": [
"OPEN",
"CLOSE"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_rl": {
"type": "object",
"properties": {
"value": {
"enum": [
"OPEN",
"CLOSE"
]
},
"captured_at": {
"type": "string"
}
}
},
"door_rr": {
"type": "object",
"properties": {
"value": {
"enum": [
"OPEN",
"CLOSE"
]
},
"captured_at": {
"type": "string"
}
}
},
"fuel_level": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Fuel level in percentage"
},
"captured_at": {
"type": "string"
}
}
},
"odometer": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Mileage in kilometers per hour"
},
"captured_at": {
"type": "string"
}
}
},
"engine_running": {
"type": "object",
"properties": {
"value": {
"enum": [
"ON",
"OFF"
]
},
"captured_at": {
"type": "string"
}
}
},
"connected_to_charger": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"captured_at": {
"type": "string"
}
}
},
"vehicle_speed": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"captured_at": {
"type": "string"
}
}
},
"battery_level": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"captured_at": {
"type": "string"
}
}
}
}
}
},
"required": [
"vehicle_id",
"captured_at"
]
},
"description": "Mobile syntheses"
}
},
"required": [
"booking_id",
"syntheses"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"status": "ok"
}Store Mobile synthesesPOST/mobile/syntheses
Stores Mobile vehicle syntheses
Help ¶
(…)
Question rating ¶
Headers
Content-Type: application/jsonBody
{
"helpful": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"helpful": {
"type": "boolean"
}
},
"required": [
"helpful"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Question helpfulnessPOST/question/:code
(…)
Image ¶
(…)
Image ¶
(…)
Headers
Content-Type: multipart/form-dataBody
{
"image_id": "5829a335b15bef1000eacbe8"
}Schema
{
"type": "object",
"properties": {
"image_id": {
"type": "string"
}
},
"required": [
"image_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string"
},
"sha1": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"sha1",
"id"
]
}Headers
Content-Type: multipart/form-dataBody
{
"name": "identification"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string"
},
"sha1": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"sha1",
"id"
]
}Headers
Content-Type: multipart/form-dataBody
{
"name": "security_selfie",
"booking_id": "5829a335b15bef1000eacbe8"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"name",
"booking_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string"
},
"sha1": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"sha1",
"id"
]
}Upload an imagePOST/image
(…)
Incident ¶
Post Incident ¶
Headers
Content-Type: application/jsonBody
{
"booking_id": "619e51ddd5aae600067fd658",
"description": "Lorem ipsum dolor",
"assistance_request": {
"breakdown_spot": {
"car_location": "OFF_ROAD",
"city": "Paris",
"country": "France",
"latitude": 1,
"longitude": 1,
"postal_code": 75017,
"state": "Hello, world!",
"street": "114 Rue Cardinet"
},
"incident_details": {
"is_car_overturned": false,
"problem_description": "Some description of the incident here"
},
"passengers_data": {
"passengers_children": 1,
"passengers_notes": "Hello, world!",
"passengers_number": 3,
"special_requirenment": "Hello, world!"
}
},
"is_assistance_needed": false,
"is_third_party_involved": false,
"reported_at": "2024-10-01T11:15:48.052Z",
"type": "breakdown",
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"code": "report"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"description": {
"type": "string"
},
"assistance_request": {
"type": "object",
"properties": {
"breakdown_spot": {
"type": "object",
"properties": {
"car_location": {
"type": "string",
"enum": [
"OFF_ROAD",
"ON_THE_ROAD",
"HIGHWAY",
"UNDERGROUND_GARAGE",
"SURVEILLED_PARKING",
"OTHER"
]
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"postal_code": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"car_location",
"latitude",
"longitude"
]
},
"incident_details": {
"type": "object",
"properties": {
"is_car_overturned": {
"type": "boolean"
},
"problem_description": {
"type": "string"
}
},
"required": [
"is_car_overturned"
]
},
"passengers_data": {
"type": "object",
"properties": {
"passengers_children": {
"type": "number"
},
"passengers_notes": {
"type": "string"
},
"passengers_number": {
"type": "number"
},
"special_requirenment": {
"type": "string"
}
},
"required": [
"passengers_children",
"passengers_number"
]
}
}
},
"is_assistance_needed": {
"type": "boolean"
},
"is_third_party_involved": {
"type": "boolean"
},
"reported_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"type": {
"type": "string",
"enum": [
"breakdown",
"accident_body_damage",
"dashboard_signal",
"tyre_puncture",
"connectivity",
"fire",
"running_out_of_gas"
]
},
"pictures": {
"type": "array"
}
},
"required": [
"booking_id",
"description",
"is_assistance_needed",
"is_third_party_involved",
"reported_at",
"type"
]
}Headers
Content-Type: application/jsonBody
{
"incident": {
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"description": "Lorem dolor sit amet",
"assistance_request": {
"breakdown_spot": {
"car_location": "OFF_ROAD",
"city": "Paris",
"country": "France",
"latitude": 1,
"longitude": 1,
"postal_code": 75017,
"state": "Hello, world!",
"street": "114 Rue Cardinet"
},
"incident_details": {
"is_car_overturned": false,
"problem_description": "Some description of the incident here"
},
"passengers_data": {
"passengers_children": 1,
"passengers_notes": "Hello, world!",
"passengers_number": 3,
"special_requirenment": "Hello, world!"
}
},
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"description": {
"type": "string"
},
"assistance_request": {
"type": "object",
"properties": {
"breakdown_spot": {
"type": "object",
"properties": {
"car_location": {
"type": "string",
"enum": [
"OFF_ROAD",
"ON_THE_ROAD",
"HIGHWAY",
"UNDERGROUND_GARAGE",
"SURVEILLED_PARKING",
"OTHER"
]
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"postal_code": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"car_location",
"latitude",
"longitude"
]
},
"incident_details": {
"type": "object",
"properties": {
"is_car_overturned": {
"type": "boolean"
},
"problem_description": {
"type": "string"
}
},
"required": [
"is_car_overturned"
]
},
"passengers_data": {
"type": "object",
"properties": {
"passengers_children": {
"type": "number"
},
"passengers_notes": {
"type": "string"
},
"passengers_number": {
"type": "number"
},
"special_requirenment": {
"type": "string"
}
},
"required": [
"passengers_children",
"passengers_number"
]
}
}
},
"is_assistance_needed": {
"type": "boolean"
},
"is_third_party_involved": {
"type": "boolean"
},
"pictures": {
"type": "array"
},
"reported_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"type": {
"type": "string",
"enum": [
"breakdown",
"accident_body_damage",
"dashboard_signal",
"tyre_puncture",
"connectivity",
"fire",
"running_out_of_gas"
]
},
"unavailability_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"vehicle_id": {
"type": "string"
}
}
}
}
}Create IncidentPOST/incident
Put Incident ¶
Headers
Content-Type: application/jsonBody
{
"description": "Lorem ipsum dolor",
"assistance_request": {
"breakdown_spot": {
"car_location": "OFF_ROAD",
"city": "Paris",
"country": "France",
"latitude": 1,
"longitude": 1,
"postal_code": 75017,
"state": "Hello, world!",
"street": "114 Rue Cardinet"
},
"incident_details": {
"is_car_overturned": false,
"problem_description": "Some description of the incident here"
},
"passengers_data": {
"passengers_children": 1,
"passengers_notes": "Hello, world!",
"passengers_number": 3,
"special_requirenment": "Hello, world!"
}
},
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"code": "report"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"assistance_request": {
"type": "object",
"properties": {
"breakdown_spot": {
"type": "object",
"properties": {
"car_location": {
"type": "string",
"enum": [
"OFF_ROAD",
"ON_THE_ROAD",
"HIGHWAY",
"UNDERGROUND_GARAGE",
"SURVEILLED_PARKING",
"OTHER"
]
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"postal_code": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"car_location",
"latitude",
"longitude"
]
},
"incident_details": {
"type": "object",
"properties": {
"is_car_overturned": {
"type": "boolean"
},
"problem_description": {
"type": "string"
}
},
"required": [
"is_car_overturned"
]
},
"passengers_data": {
"type": "object",
"properties": {
"passengers_children": {
"type": "number"
},
"passengers_notes": {
"type": "string"
},
"passengers_number": {
"type": "number"
},
"special_requirenment": {
"type": "string"
}
},
"required": [
"passengers_children",
"passengers_number"
]
}
}
},
"is_assistance_needed": {
"type": "boolean"
},
"is_third_party_involved": {
"type": "boolean"
},
"pictures": {
"type": "array"
}
}
}Headers
Content-Type: application/jsonBody
{
"incident": {
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"description": "Lorem dolor sit amet",
"assistance_request": {
"breakdown_spot": {
"car_location": "OFF_ROAD",
"city": "Paris",
"country": "France",
"latitude": 1,
"longitude": 1,
"postal_code": 75017,
"state": "Hello, world!",
"street": "114 Rue Cardinet"
},
"incident_details": {
"is_car_overturned": false,
"problem_description": "Some description of the incident here"
},
"passengers_data": {
"passengers_children": 1,
"passengers_notes": "Hello, world!",
"passengers_number": 3,
"special_requirenment": "Hello, world!"
}
},
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"description": {
"type": "string"
},
"assistance_request": {
"type": "object",
"properties": {
"breakdown_spot": {
"type": "object",
"properties": {
"car_location": {
"type": "string",
"enum": [
"OFF_ROAD",
"ON_THE_ROAD",
"HIGHWAY",
"UNDERGROUND_GARAGE",
"SURVEILLED_PARKING",
"OTHER"
]
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"postal_code": {
"type": "number"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"car_location",
"latitude",
"longitude"
]
},
"incident_details": {
"type": "object",
"properties": {
"is_car_overturned": {
"type": "boolean"
},
"problem_description": {
"type": "string"
}
},
"required": [
"is_car_overturned"
]
},
"passengers_data": {
"type": "object",
"properties": {
"passengers_children": {
"type": "number"
},
"passengers_notes": {
"type": "string"
},
"passengers_number": {
"type": "number"
},
"special_requirenment": {
"type": "string"
}
},
"required": [
"passengers_children",
"passengers_number"
]
}
}
},
"is_assistance_needed": {
"type": "boolean"
},
"is_third_party_involved": {
"type": "boolean"
},
"pictures": {
"type": "array"
},
"reported_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"type": {
"type": "string",
"enum": [
"breakdown",
"accident_body_damage",
"dashboard_signal",
"tyre_puncture",
"connectivity",
"fire",
"running_out_of_gas"
]
},
"unavailability_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"vehicle_id": {
"type": "string"
}
}
}
}
}Update IncidentPUT/incident/:incident_id
Init ¶
(…)
Init ¶
(…)
Headers
Content-Type: application/jsonBody
{
"static": {
"user_agreement": "{HOST}/page?code=legal",
"how_it_works": "{HOST}/page?code=how-it-works",
"faq": "{HOST}/page?code=faq",
"insurance": "{HOST}/page?code=insurance"
},
"damages": {},
"appstore_id": "1057590323",
"jpeg_compression_quality": 0.7,
"maximum_rental_period": 28,
"search_window_in_months": 6,
"search_nearby_stations_max_radius_in_kilometers": 40,
"validation_open_hour": "2017-02-17T08:00:48.052Z",
"validation_close_hour": "2017-02-17T20:00:48.052Z",
"urls": {
"store": ""
},
"stripe": {
"pub_key": ""
},
"ota_env": "sandbox",
"minimum_version": "1.0.2",
"airport_detection_radius": 10000,
"emergencies": [
{
"id": "5829a335b15bef1000eacbe8",
"name": "Virtuo chat",
"number": "+33 1 23 45 67 89",
"email": "contact@govirtuo.com",
"code": "virtuo-chat",
"updated_at": "2017-02-17T20:21:48.052Z"
}
],
"vehicles": [
{
"id": "5829a335b15bef1000eacbe8",
"alternative_carmodels": [
"['bmw_s1']"
],
"code": "a_class",
"model": "Classe A",
"brand": "Mercedes-Benz",
"tank_capacity": 50,
"automatic_gearbox": true,
"seats_count": 5,
"luggage_count": 3,
"has_gps": true,
"has_bluetooth": true,
"has_leather_trim": true,
"doors_count": 5,
"energy_type": "diesel",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"thumb_mobile": "https://www.govirtuo.com/virtuo.jpg",
"day_price": 49,
"indicative_day_price": [
"IndicativeDayPriceCountries"
],
"presentation_page_subtitle": "C’est un endroit qui ressemble à la Louisiane",
"presentation_page_paragraph_0": "À *l’Italie*",
"presentation_page_paragraph_1": "Il y a du *linge étendu* sur la terrasse",
"presentation_page_paragraph_2": "Et c’est *joli*",
"highlighted_features": [
"Aileron et boomer 18 pouces dans le coffre"
],
"max_additional_drivers": 4,
"characteristics": {
"bodywork_category": "sedan",
"fuelling_side": "left",
"range": "access",
"snow_equipment_position": "front"
},
"visible": true,
"is_new_model": true,
"is_highlighted_model": true,
"new_model_countries": [
"FR"
],
"available_countries": [
"FR"
],
"ev_max_distance": {
"mi": 358,
"km": 602
},
"settings": {
"dunasys": {
"battery_voltage_threshold": 10,
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true
},
"fake": {
"battery_voltage_threshold": 10,
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true
},
"invers": {
"battery_voltage_threshold": 10,
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true
}
}
}
],
"carmodelcharacteristics": [
{
"code": "bodywork_category",
"values": [
{
"code": "compact",
"name": "Compacte",
"position": 0
}
]
}
],
"currencies": [
{
"code": "EUR",
"name": "Euro",
"symbol": "€"
}
],
"agglomerations": [
{
"country": "FR",
"currency_code": "EUR",
"lat": 48.856978,
"long": 2.346287,
"locations": [
{
"address": "Place des Cinq Martyrs du Lycée Buffon",
"city": "Paris",
"description": "",
"franchisors": [
{
"id": "5829a335b15bef1000eacbe8",
"name": "Sixt",
"logo_url": "https://www.govirtuo.com/virtuo.jpg"
}
],
"has_hotel": false,
"has_train_station": false,
"id": "5829a335b15bef1000eacbe8",
"lat 48.870867": 0,
"level": "-1",
"licence_plate_recognition": false,
"long": 2.324443,
"motorized_access": [
{
"lat": 48.870978,
"long": 2.324323,
"address": "21 Place de la Madeleine",
"zip_code": "75008",
"city": "PARIS",
"thumb": "https://www.govirtuo.com/virtuo.jpg"
}
],
"name": "Gare Montparnasse",
"owner": "Parking Effia • Montparnasse Pasteur",
"opening_hours": {
"close": {},
"open": "",
"minutes": 30,
"hours": 4
},
"parkings": [
"P0",
"P1",
"P2",
"P3"
],
"parking_spots": "Places n°604, 605, 606, 607 et 608",
"pedestrian_access": [
{
"lat": 48.870978,
"long": 2.324323,
"address": "21 Place de la Madeleine",
"zip_code": "75008",
"city": "PARIS",
"thumb": "https://www.govirtuo.com/virtuo.jpg"
}
],
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"type": "station",
"zip_code": "75015",
"zoom": 17,
"has_parking_refund": false,
"hidden": false,
"valet": {
"provider": "valet24"
},
"support_base": {
"latitude": 0,
"longitude": 0
}
}
],
"name": "Paris",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"timezone": "Europe/Paris"
}
],
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"fees_catalog": [
{
"code": "smoking-prohibition",
"fee": [
{
"country": "FR",
"currency": "EUR",
"price": 5000
}
]
}
],
"deliveryzones": [
{
"id": "5da861ab5a5a6315f259b728",
"name": "D&C Zone MVP",
"delivery_hours (required, array, fixed) - Deprecated use delivery_hours_rulesets": {},
"timezone": "Europe/Paris",
"zone": {
"type": "Polygon",
"coordinates": [
[
[
-0.249824,
51.416094
]
]
]
},
"location_ids": [
"570baa66edf04c273edabfed",
"5c582be669e1ae002debc991"
],
"agglomeration_id": "5829a335b15bef1000eacbe8",
"additional_fee": {
"amount `2000`": 0,
"currency `EUR`": ""
},
"last_minute_delivery_hours (array, fixed) - Deprecated use delivery_hours_rulesets": {},
"last_minute_low_bound (HoursMinutes) - Deprecated use delivery_hours_rulesets": "",
"last_minute_high_bound (HoursMinutes) - Deprecated use delivery_hours_rulesets": "",
"delivery_hours_rulesets": [
{
"low_bound": {
"hours": 8,
"minutes": 30
},
"high_bound": {
"hours": 8,
"minutes": 30
},
"weekly_openings": [
{
"from": {
"hours": 8,
"minutes": 30
},
"to": {
"hours": 8,
"minutes": 30
}
}
]
}
],
"enabled": false
}
],
"payment": {
"provider": "stripe|processout",
"key": "public_provider_key"
},
"countries": [
{
"code": "FR",
"is_closed": false,
"mileage_unit": "km",
"badge_digits_min": 4,
"badge_digits_max": 10,
"maximum_rental_period": 90
}
],
"password_rules": "^(?=.*[A-Za-z])(?=.*\\d)[A-Za-z\\d]{8,}$",
"late_return_fee": {
"hours_threshold_after_booking_end": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"static": {
"type": "object",
"properties": {
"user_agreement": {
"type": "string"
},
"how_it_works": {
"type": "string"
},
"faq": {
"type": "string"
},
"insurance": {
"type": "string"
}
},
"required": [
"user_agreement",
"how_it_works",
"faq",
"insurance"
]
},
"damages": {
"type": "object",
"properties": {}
},
"appstore_id": {
"type": "string"
},
"jpeg_compression_quality": {
"type": "number"
},
"maximum_rental_period": {
"type": "number"
},
"search_window_in_months": {
"type": "number",
"description": "Number of months in which search can be performed"
},
"search_nearby_stations_max_radius_in_kilometers": {
"type": "number",
"description": "Maximum search radius for nearby Virtuo stations in kilometers"
},
"validation_open_hour": {
"type": "string"
},
"validation_close_hour": {
"type": "string"
},
"urls": {
"type": "object",
"properties": {
"store": {
"type": "string"
}
},
"required": [
"store"
]
},
"stripe": {
"type": "object",
"properties": {
"pub_key": {
"type": "string"
}
},
"required": [
"pub_key"
]
},
"ota_env": {
"type": "string",
"enum": [
"sandbox",
"production"
]
},
"minimum_version": {
"type": "string"
},
"airport_detection_radius": {
"type": "number"
},
"emergencies": {
"type": "array"
},
"vehicles": {
"type": "array"
},
"carmodelcharacteristics": {
"type": "array"
},
"currencies": {
"type": "array"
},
"agglomerations": {
"type": "array"
},
"legals": {
"type": "array"
},
"fees_catalog": {
"type": "array"
},
"deliveryzones": {
"type": "array"
},
"payment": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"provider",
"key"
]
},
"countries": {
"type": "array"
},
"password_rules": {
"type": "string"
},
"late_return_fee": {
"type": "object",
"properties": {
"hours_threshold_after_booking_end": {
"type": "number"
}
}
}
},
"required": [
"static",
"appstore_id",
"jpeg_compression_quality",
"maximum_rental_period",
"search_window_in_months",
"search_nearby_stations_max_radius_in_kilometers",
"validation_open_hour",
"validation_close_hour",
"minimum_version",
"airport_detection_radius",
"late_return_fee"
]
}Get initial dataGET/init
(…)
Device ¶
(…)
Headers
Content-Type: application/jsonBody
{
"ota_access_device_token": "kRHMzbnY6zEu45Jh2cmfHRimOd812345"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"id": "57c02c77ee3bb70f000d2276",
"ota_token": "yKlVpeAkaaO1wqURFvmARb0123456789"
}DevicePOST/device
(…)
Headers
Content-Type: application/jsonBody
{
"device_id": "56f1751c35cc736500903efb",
"provider": "ota",
"access_device_token": "kRHMzbnY6zEu45Jh2cmfHRimOd8abcde"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"id": "57c02c77ee3bb70f000d2276",
"provider_token": "kRHMzbnY6zEu45Jh2cmfHRi123456789"
}DevicePUT/device
(…)
Invoices ¶
(…)
Recover invoice ¶
(…)
Headers
Content-Type: application/jsonBody
{
"invoice_id": "5829a335b15bef1000eacbe8",
"creditcard_id": "card7m8khq142phci2sibvzetz7"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"invoice_id": {
"type": "string"
},
"creditcard_id": {
"type": "string"
}
},
"required": [
"invoice_id",
"creditcard_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"invoice": {
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"threedsecure_redirect_url": {
"type": "string"
},
"ref": {
"type": "string"
},
"label": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"booking",
"damage",
"extra",
"gov",
"asset",
"other",
"damage"
]
},
"paid": {
"type": "boolean"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"url": {
"type": "string"
},
"amount": {
"type": "number"
},
"amount_due": {
"type": "number"
},
"debt_collection": {
"type": "boolean",
"description": "No attribute when false"
},
"instalments": {
"type": "object",
"properties": {}
}
},
"required": [
"id",
"ref",
"label",
"source",
"paid",
"url",
"amount",
"amount_due"
]
}
}
}Headers
Content-Type: application/jsonBody
{
"invoice_id": "5829a335b15bef1000eacbe8",
"token_id": "tknj7m8khq142phci2sibvzetz7"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"invoice_id": {
"type": "string"
},
"token_id": {
"type": "string"
}
},
"required": [
"invoice_id",
"token_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"invoice": {
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"threedsecure_redirect_url": {
"type": "string"
},
"ref": {
"type": "string"
},
"label": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"booking",
"damage",
"extra",
"gov",
"asset",
"other",
"damage"
]
},
"paid": {
"type": "boolean"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"url": {
"type": "string"
},
"amount": {
"type": "number"
},
"amount_due": {
"type": "number"
},
"debt_collection": {
"type": "boolean",
"description": "No attribute when false"
},
"instalments": {
"type": "object",
"properties": {}
}
},
"required": [
"id",
"ref",
"label",
"source",
"paid",
"url",
"amount",
"amount_due"
]
}
}
}InvoicePOST/invoice/recover
Request a payment plan proposal ¶
Headers
Content-Type: application/jsonBody
{
"rents": 3,
"start_date": "2024-05-22T20:21:48.052Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"rents": {
"type": "number",
"description": "Must be between 2 and 6 included"
},
"start_date": {
"type": "string",
"description": "The date/time (ISO8601 format) of the first rent to be proceeded"
}
},
"required": [
"rents",
"start_date"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"proposal": [
{
"amount": 123,
"proceed_at": "2024-05-19T20:21:48.052Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"proposal": {
"type": "array"
}
}
}Request a payment plan proposalPOST/invoice/:invoice_id/payment-plan/proposal
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| invoice-already-has-payment-plan | 403 | |
| invalid-rents | 400 | |
| invalid-start-date | 400 |
- invoice_id
string(required) Example: card7m8khq142phci2sibvzetz7
Create a payment plan ¶
Headers
Content-Type: application/jsonBody
{
"rents": 3,
"start_date": "2024-05-22T20:21:48.052Z",
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"rents": {
"type": "number",
"description": "Must be between 2 and 6 included"
},
"start_date": {
"type": "string",
"description": "The date/time (ISO8601 format) of the first rent to be proceeded"
},
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": {
"type": "string"
}
},
"required": [
"rents",
"start_date",
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"payment_plan": {
"id": "5829a335b15bef1000eacbea",
"booking_id": "7829a335b15bef1000eacbe3",
"currency": "1129a335b15bef1000eacbea",
"status": "started",
"type": "invoice",
"current_creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": "Hello, world!",
"cvc_check": "pass",
"holder_name": "Jérôme Kerviel",
"code": "1234",
"year": 2016,
"month": 5,
"type": {
"Visa": "Hello, world!",
"American Express": "Hello, world!",
"MasterCard": "Hello, world!",
"paypal": "Hello, world!"
},
"title": "Kerviel",
"source": {
"apple_pay": "Hello, world!",
"google_pay": "Hello, world!",
"processout_apm": "Hello, world!"
},
"country": "FR",
"funding": "credit",
"is_authenticated": {
"auto": "Hello, world!",
"manual": "Hello, world!"
},
"is_business": true,
"is_deleted": false,
"three_d_secure_support": true
},
"ref": "Hello, world!",
"rents": [
{
"id": "5829a335b15bef1000eacbea",
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"status": "pending",
"succeeded_at": "2024-05-19T20:21:48.052Z"
}
],
"invoice_id": "5829a335b15bef1000eacbe9",
"has_payment_error": true,
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"account_id: `acct_1234`": "Hello, world!",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id: `tok_1234`": "Hello, world!",
"invoice_id: `iv_12345`": "Hello, world!"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment_plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"currency": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"started",
"completed",
"abandoned",
"started"
]
},
"type": {
"type": "string",
"enum": [
"invoice",
"booking",
"invoice"
]
},
"current_creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": {
"type": "string"
},
"cvc_check": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "object",
"properties": {
"Visa": {
"type": "string"
},
"American Express": {
"type": "string"
},
"MasterCard": {
"type": "string"
},
"paypal": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"apple_pay": {
"type": "string"
},
"google_pay": {
"type": "string"
},
"processout_apm": {
"type": "string"
}
},
"description": "Can also be null"
},
"country": {
"type": "string"
},
"funding": {
"type": "string"
},
"is_authenticated": {
"type": "object",
"properties": {
"auto": {
"type": "string"
},
"manual": {
"type": "string"
}
},
"description": "Can also be false"
},
"is_business": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
},
"three_d_secure_support": {
"type": "boolean"
}
},
"required": [
"id",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type",
"title",
"country",
"funding",
"is_deleted",
"three_d_secure_support"
]
},
"ref": {
"type": "string"
},
"rents": {
"type": "array"
},
"invoice_id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
}
},
"required": [
"provider"
]
}
},
"required": [
"id",
"booking_id",
"currency",
"current_creditcard",
"ref",
"rents",
"has_payment_error"
]
}
}
}Create a payment planPOST/invoice/:invoice_id/payment-plan/create
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| invoice-already-has-payment-plan | 403 | |
| card-expired | 403 | Card must be valid until the last proceed_at date |
| invalid-rents | 400 | |
| invalid-start-date | 400 |
- invoice_id
string(required) Example: card7m8khq142phci2sibvzetz7
Get payment plan ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"payment_plan": {
"id": "5829a335b15bef1000eacbea",
"booking_id": "7829a335b15bef1000eacbe3",
"currency": "1129a335b15bef1000eacbea",
"status": "started",
"type": "invoice",
"current_creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": "Hello, world!",
"cvc_check": "pass",
"holder_name": "Jérôme Kerviel",
"code": "1234",
"year": 2016,
"month": 5,
"type": {
"Visa": "Hello, world!",
"American Express": "Hello, world!",
"MasterCard": "Hello, world!",
"paypal": "Hello, world!"
},
"title": "Kerviel",
"source": {
"apple_pay": "Hello, world!",
"google_pay": "Hello, world!",
"processout_apm": "Hello, world!"
},
"country": "FR",
"funding": "credit",
"is_authenticated": {
"auto": "Hello, world!",
"manual": "Hello, world!"
},
"is_business": true,
"is_deleted": false,
"three_d_secure_support": true
},
"ref": "Hello, world!",
"rents": [
{
"id": "5829a335b15bef1000eacbea",
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"status": "pending",
"succeeded_at": "2024-05-19T20:21:48.052Z"
}
],
"invoice_id": "5829a335b15bef1000eacbe9",
"has_payment_error": true,
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"account_id: `acct_1234`": "Hello, world!",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id: `tok_1234`": "Hello, world!",
"invoice_id: `iv_12345`": "Hello, world!"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment_plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"currency": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"started",
"completed",
"abandoned",
"started"
]
},
"type": {
"type": "string",
"enum": [
"invoice",
"booking",
"invoice"
]
},
"current_creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": {
"type": "string"
},
"cvc_check": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "object",
"properties": {
"Visa": {
"type": "string"
},
"American Express": {
"type": "string"
},
"MasterCard": {
"type": "string"
},
"paypal": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"apple_pay": {
"type": "string"
},
"google_pay": {
"type": "string"
},
"processout_apm": {
"type": "string"
}
},
"description": "Can also be null"
},
"country": {
"type": "string"
},
"funding": {
"type": "string"
},
"is_authenticated": {
"type": "object",
"properties": {
"auto": {
"type": "string"
},
"manual": {
"type": "string"
}
},
"description": "Can also be false"
},
"is_business": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
},
"three_d_secure_support": {
"type": "boolean"
}
},
"required": [
"id",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type",
"title",
"country",
"funding",
"is_deleted",
"three_d_secure_support"
]
},
"ref": {
"type": "string"
},
"rents": {
"type": "array"
},
"invoice_id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
}
},
"required": [
"provider"
]
}
},
"required": [
"id",
"booking_id",
"currency",
"current_creditcard",
"ref",
"rents",
"has_payment_error"
]
}
}
}Get payment planGET/payment-plan/:payment_plan_id
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| payment-plan-not-found | 404 |
- payment_plan_id
string(required) Example: tknj7m8khq142phci2sibvzetz7
Update a payment plan creditcard ¶
Headers
Content-Type: application/jsonBody
{
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": {
"type": "string"
}
},
"required": [
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"payment_plan": {
"id": "5829a335b15bef1000eacbea",
"booking_id": "7829a335b15bef1000eacbe3",
"currency": "1129a335b15bef1000eacbea",
"status": "started",
"type": "invoice",
"current_creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": "Hello, world!",
"cvc_check": "pass",
"holder_name": "Jérôme Kerviel",
"code": "1234",
"year": 2016,
"month": 5,
"type": {
"Visa": "Hello, world!",
"American Express": "Hello, world!",
"MasterCard": "Hello, world!",
"paypal": "Hello, world!"
},
"title": "Kerviel",
"source": {
"apple_pay": "Hello, world!",
"google_pay": "Hello, world!",
"processout_apm": "Hello, world!"
},
"country": "FR",
"funding": "credit",
"is_authenticated": {
"auto": "Hello, world!",
"manual": "Hello, world!"
},
"is_business": true,
"is_deleted": false,
"three_d_secure_support": true
},
"ref": "Hello, world!",
"rents": [
{
"id": "5829a335b15bef1000eacbea",
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"status": "pending",
"succeeded_at": "2024-05-19T20:21:48.052Z"
}
],
"invoice_id": "5829a335b15bef1000eacbe9",
"has_payment_error": true,
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"account_id: `acct_1234`": "Hello, world!",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id: `tok_1234`": "Hello, world!",
"invoice_id: `iv_12345`": "Hello, world!"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment_plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"currency": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"started",
"completed",
"abandoned",
"started"
]
},
"type": {
"type": "string",
"enum": [
"invoice",
"booking",
"invoice"
]
},
"current_creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": {
"type": "string"
},
"cvc_check": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "object",
"properties": {
"Visa": {
"type": "string"
},
"American Express": {
"type": "string"
},
"MasterCard": {
"type": "string"
},
"paypal": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"apple_pay": {
"type": "string"
},
"google_pay": {
"type": "string"
},
"processout_apm": {
"type": "string"
}
},
"description": "Can also be null"
},
"country": {
"type": "string"
},
"funding": {
"type": "string"
},
"is_authenticated": {
"type": "object",
"properties": {
"auto": {
"type": "string"
},
"manual": {
"type": "string"
}
},
"description": "Can also be false"
},
"is_business": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
},
"three_d_secure_support": {
"type": "boolean"
}
},
"required": [
"id",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type",
"title",
"country",
"funding",
"is_deleted",
"three_d_secure_support"
]
},
"ref": {
"type": "string"
},
"rents": {
"type": "array"
},
"invoice_id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
}
},
"required": [
"provider"
]
}
},
"required": [
"id",
"booking_id",
"currency",
"current_creditcard",
"ref",
"rents",
"has_payment_error"
]
}
}
}Update a payment planPUT/payment-plan/:payment_plan_id
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| payment-plan-not-found | 404 | |
| card-expired | 403 | Card must be valid until the last proceed_at date |
- payment_plan_id
string(required) Example: tknj7m8khq142phci2sibvzetz7
Retry payment for a payment plan rent ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"payment_plan": {
"id": "5829a335b15bef1000eacbea",
"booking_id": "7829a335b15bef1000eacbe3",
"currency": "1129a335b15bef1000eacbea",
"status": "started",
"type": "invoice",
"current_creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": "Hello, world!",
"cvc_check": "pass",
"holder_name": "Jérôme Kerviel",
"code": "1234",
"year": 2016,
"month": 5,
"type": {
"Visa": "Hello, world!",
"American Express": "Hello, world!",
"MasterCard": "Hello, world!",
"paypal": "Hello, world!"
},
"title": "Kerviel",
"source": {
"apple_pay": "Hello, world!",
"google_pay": "Hello, world!",
"processout_apm": "Hello, world!"
},
"country": "FR",
"funding": "credit",
"is_authenticated": {
"auto": "Hello, world!",
"manual": "Hello, world!"
},
"is_business": true,
"is_deleted": false,
"three_d_secure_support": true
},
"ref": "Hello, world!",
"rents": [
{
"id": "5829a335b15bef1000eacbea",
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"status": "pending",
"succeeded_at": "2024-05-19T20:21:48.052Z"
}
],
"invoice_id": "5829a335b15bef1000eacbe9",
"has_payment_error": true,
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"account_id: `acct_1234`": "Hello, world!",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"token_id: `tok_1234`": "Hello, world!",
"invoice_id: `iv_12345`": "Hello, world!"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment_plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"currency": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"started",
"completed",
"abandoned",
"started"
]
},
"type": {
"type": "string",
"enum": [
"invoice",
"booking",
"invoice"
]
},
"current_creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`": {
"type": "string"
},
"cvc_check": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "object",
"properties": {
"Visa": {
"type": "string"
},
"American Express": {
"type": "string"
},
"MasterCard": {
"type": "string"
},
"paypal": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"apple_pay": {
"type": "string"
},
"google_pay": {
"type": "string"
},
"processout_apm": {
"type": "string"
}
},
"description": "Can also be null"
},
"country": {
"type": "string"
},
"funding": {
"type": "string"
},
"is_authenticated": {
"type": "object",
"properties": {
"auto": {
"type": "string"
},
"manual": {
"type": "string"
}
},
"description": "Can also be false"
},
"is_business": {
"type": "boolean"
},
"is_deleted": {
"type": "boolean"
},
"three_d_secure_support": {
"type": "boolean"
}
},
"required": [
"id",
"customer_id: `cus_qnvroct0eiaig0x1q0d97910`",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type",
"title",
"country",
"funding",
"is_deleted",
"three_d_secure_support"
]
},
"ref": {
"type": "string"
},
"rents": {
"type": "array"
},
"invoice_id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
}
},
"required": [
"provider"
]
}
},
"required": [
"id",
"booking_id",
"currency",
"current_creditcard",
"ref",
"rents",
"has_payment_error"
]
}
}
}Retry payment plan rent paymentPUT/payment-plan/:payment_plan_id/pay/:rent_id
(…)
Errors
| code | http code | description |
|---|---|---|
| bad-parameter | 400 | |
| payment-plan-not-found | 404 | |
| bad-payment-plan-status | 403 | Payment plan must be in status “started” |
| rent-not-found | 404 | |
| bad-rent-status | 403 | Rent must be in status “failed” |
| invoice-not-found | 404 | |
| transaction-creation-error | 500 | |
| unable-to-charge | 403 | PSP transcaction failed, unable to charge |
| unable-to-take-deposit | 403 | PSP transcaction failed, unable to take deposit |
| transaction-status-error | 500 |
- payment_plan_id
string(required) Example: 5829a335b15bef1000eacbe8- rent_id
string(required) Example: 1129a335b15bef1000eacbe3
Key Request ¶
(…)
Request a key ¶
Request a new key owner. Can be himself for an additional driver or the main driver to get back the key or designate a new owner.
Headers
Content-Type: application/jsonBody
{
"booking_id": "58cbc00d5d717b00114158c3",
"user_id": "58cbc00d5d717b00114158c3"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"description": "Booking ID"
},
"user_id": {
"type": "string",
"description": "Additional or main driver ID"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"booking": {
"id": "5829a335b15bef1000eacbe8",
"ask_security_selfie": false,
"user_id": "5829a335b15bef1000eacbe8",
"user_language": "fr",
"voucher_partner_name": "carbookr",
"voucher_partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"company_id": "5829a335b15bef1000eacbe8",
"company_name": "company",
"company_payment": "individual-card",
"user_name": "Foo Bar",
"user_firstname": "Foo",
"user_lastname": "Bar",
"user_email": "test@example.com",
"user_mobile": "+33610551252",
"agglomeration_id": "5829a335b15bef1000eacbe8",
"location_id": "5829a335b15bef1000eacbe8",
"agglomeration_name": "Paris",
"location_name": "Gare Montparnasse",
"deliveryzone_id": "5829a335b15bef1000eacbe8",
"delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": "",
"vehicle_readiness": {
"status": "not-ready",
"convoy_status_description": "canceled"
},
"dvla_status": "not-applicable",
"original_delivery_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"collect_address": {
"address_line1": "",
"address_line2": "",
"latitude": 0,
"longitude": 0,
"country_code": ""
},
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"confirmed_at": "2017-02-17T20:21:48.052Z",
"canceled_at": "2017-02-17T20:21:48.052Z",
"started_at": "2017-02-17T20:21:48.052Z",
"returned_at": "2017-02-17T20:21:48.052Z",
"vehicle_code: a_class": "",
"show_similar_carmodel": true,
"carmodel_name": "Mercedes",
"charges": [
{
"label": "Chaines neige",
"quantity": 1,
"price": 42,
"unit": 1,
"code": "snow-chains",
"extension": false
}
],
"stages": [
{
"code": "key",
"proceed_at": "2017-02-15T13:00:00+0100",
"status": "succeeded",
"title": "",
"label": "",
"required_action": true
}
],
"damages": [
{
"zone_id": "5829a335b15bef1000eacbe8",
"type_id": "5829a335b15bef1000eacbe8",
"image_id": "5829a335b15bef1000eacbe8",
"image_url": "https://www.govirtuo.com/virtuo.jpg",
"created_at": "2017-02-17T20:21:48.052Z",
"is_reported_by_user": "true",
"preparator_status": "pending"
}
],
"total": 34300,
"refunded_amount_after_cancelation": 18800,
"inspection_free": false,
"currency_code": "EUR",
"timezone": "Europe/Paris",
"plate": "VI",
"status": "confirmed",
"status_description": "",
"cancelation_reason": "",
"creditcard": {
"id": "card_j7m8khq142phci2sibvzetz7",
"customer_id": "cus_qnvroct0eiaig0x1q0d97910",
"cvc_check": false,
"holder_name": "JOHN SMITH",
"code": "1234",
"year": 2016,
"month": 5,
"type": "visa",
"title": "EISENBERG",
"source": "null"
},
"end_position": {
"address": "72 rue du Test, 75012",
"latitude": 34.366819,
"longitude": 132.456665
},
"ev_charging_price_per_mileage": 30,
"should_collect_end_position": false,
"package_distance": 150,
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"label": "Chaines neige",
"description": "",
"inspection_free": false,
"day_price": 900,
"code": "snow-chains",
"insurance_type": "none",
"is_physical": false,
"franchise_price": 10000,
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"price": {
"day": 12,
"total": 120
},
"features": {
"existings": "",
"missings": ""
}
}
],
"mileage": 150,
"mileage_start": 150,
"vehicle_energy_type": "diesel",
"vehicle_tank_capacity": 50,
"vehicle_mechanical_key": true,
"vehicle_assistances": [
{
"label": "",
"phone_number": "",
"description": {}
}
],
"vehicle_usb_cable": "jaym",
"energy": 0.15,
"energy_start": 0.15,
"price_per_liter_refueled": 15,
"badge_code": "4242",
"key": "'150'",
"key_start_at": "2017-02-17T20:21:48.052Z",
"key_status": "key-end-validity-error",
"key_user_id": "5829a335b15bef1000eacbe8",
"key_downloaded": false,
"is_multi_key": false,
"review": "C'était trop génial !",
"rating": 5,
"required_battery_level_percentage_when_returned": 10,
"reviewitems": [
"5829a335b15bef1000eacbe8"
],
"contract_pdf_url": "{HOST}/contract/5829a335b15bef1000eacbe8/pdf",
"contract_pdf_urls": [
"{HOST}/contract-doc/5829a335b15bef1000eacbe8/5829a335b15bef1000ergobv/pdf"
],
"damagereport_pdf_url": {
"damagereport_url": "{HOST}/booking/5829a335b15bef1000eacbe8/damagereport/pdf",
"damagereport_title": "Damage report- VI-001-TO"
},
"inspection_pdf_urls": [
{
"inspection_url": "{HOST}/inspection/5829a335b15bef1000eacbe8/pdf",
"inspection_title": "VI-001-TO - Damage report"
}
],
"vehicle_position": "Terminal Ouest/West Niveau -2 Allée L Place n°047",
"updated_at": "2017-02-17T20:21:48.052Z",
"created_at": "2017-02-17T20:21:48.052Z",
"threedsecure_redirect_url": "https://bank.example.com/3ds",
"threedsecure": {
"provider": "stripe",
"callback_url": "https://nanan/threedsecure/validate",
"redirect_url": "https://bank.example.com/3ds",
"client_secret": "secret",
"network": "visa"
},
"invoices": [
{
"id": "5829a335b15bef1000eacbe8",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000001",
"label": "Location",
"source": "damage",
"paid": true,
"created_at": "2017-02-17T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 4200,
"amount_due": 0,
"debt_collection": true
},
{
"id": "5829a335b15bef1000eacbe9",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000002",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-18T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 30000,
"amount_due": 9010,
"instalments": {
"proposal": {
"max_date": "2024-06-30T11:59:59.999Z",
"info_message": "optional i18n messsage explaning why instalments are limited to N rents",
"rents": [
[
"4505",
"4505"
],
[
"3004",
"3003",
"3003"
]
]
}
}
},
{
"id": "5829a335b15bef1000eacbea",
"threedsecure_redirect_url": "https://www.form.com/threedsecure",
"ref": "IFRA2024-0000003",
"label": "Location",
"source": "extra",
"paid": false,
"created_at": "2017-02-19T20:21:48.052Z",
"url": "{HOST}/invoice/5829a335b15bef1000eacbe8/pdf",
"amount": 20000,
"amount_due": 10000,
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false
}
}
],
"digicodes": {
"from": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
},
"to": {
"pedestrian": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
],
"motorized": [
{
"access_id": "5829a335b15bef1000eacbe8",
"code": "4242"
}
]
}
},
"additional_drivers": {
"pendings": [
{
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"name": "Monsieur Kaddoura",
"mobile": "+33612437373"
}
],
"actives": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": false
}
]
},
"on_hold": false,
"location_access_directions": "",
"end_rental_description": "",
"end_rental_image_url": null,
"access_direction_steps": [
{
"description": "Go to the parking door located at...",
"image_url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg"
}
],
"carbon_offset": {
"price": 0,
"estimated_co2_emissions_in_grams": 0,
"status": "offset-pending"
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"payment_methods": [
{
"type": "apple_pay",
"label": "'Apple pay'",
"code": "'apple_pay'",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "'paypal'",
"provider": "'processout'"
}
],
"instalments": {
"id": "5829a335b15bef1000eacbe9",
"has_payment_error": false,
"rents": [
{
"amount": 42,
"proceed_at": "2024-05-19T20:21:48.052Z",
"statge_status": "idle"
}
]
},
"instalment_request": {
"claim_id": ""
},
"mode": "business",
"flight_informations": {
"flight_number": "AF1234",
"flight_origin": "London",
"flight_company": "Air France",
"flight_terminal": "T2",
"flight_train": "8044",
"comes_by_train": true,
"hotel_code": "Ibis"
},
"risk_params": {
"user_risk_score": "score_a",
"deposit_multiplier": 1
},
"badge_enabled": false,
"review_item_type": "delivery",
"carmodel_settings": {
"enable_start_at_connection": false,
"fuel_level_tolerance": 3,
"should_close_doors_to_allow_start": true,
"can_open_door_for_checkin": true,
"check_doors_on_lock": true,
"check_engine_on_lock": true,
"check_park_on_lock": true,
"close_windows_after_checkout": true,
"check_lock_state_after_locking": true,
"can_open_door_after_checkout": true,
"nfc_availability": true,
"state_settings": {
"adblue_level": true,
"adblue_warning": true,
"battery_level": true,
"battery_warning": true,
"brake_fluid_warning": true,
"brake_pads_warning": true,
"connected_to_charger": true,
"coolant_level": true,
"coolant_temp": true,
"coolant_warning": true,
"door_fr": true,
"door_fl": true,
"door_rr": true,
"front_trunk": true,
"trunk": true,
"hood": true,
"tank_cap": true,
"door_lock_fl": true,
"door_lock_fr": true,
"door_lock_rl": true,
"door_lock_rr": true,
"due_service": true,
"due_service_warning": true,
"engine_oil_level": true,
"engine_oil_warning": true,
"engine_running": true,
"fuel_level": true,
"state_of_charge": true,
"latitude": true,
"longitude": true,
"odometer": true,
"one_interior_light": true,
"tire_pressure_level_fl": true,
"tire_pressure_level_fr": true,
"tire_pressure_level_rl": true,
"tire_pressure_level_rr": true,
"tire_warning": true,
"vehicle_speed": true,
"washer_fluid_warning": true,
"window_fl": true,
"window_fr": true,
"window_rl": true,
"window_rr": true
}
},
"incidents": [
{
"id": "5829a335b15bef1000eacbe8",
"booking_id": "66b0a0fd02cbc9dedd21946e",
"damagereport_id": "66e84d4657bf378024e28623",
"description": "Lorem dolor sit amet",
"is_assistance_needed": false,
"is_third_party_involved": false,
"pictures": [
{
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3",
"image_id": "5829a335b15bef1000eacbe8",
"code": "report",
"url": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/56f1751b35cc736500903edf.jpg",
"created_at": "2024-12-01T11:15:48.052Z"
}
],
"reported_at": "2024-10-01T11:15:48.052Z",
"status": "pending",
"type": "breakdown",
"unavailability_id": "66b0a0ec02cbc9dedd21576e",
"user_id": "606dc75eefc7030007f8d811",
"vehicle_id": "60c35151bfc9ad000670c9f2"
}
],
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ask_security_selfie": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"user_language": {
"type": "string"
},
"voucher_partner_name": {
"type": "string"
},
"voucher_partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"user_name": {
"type": "string"
},
"user_firstname": {
"type": "string"
},
"user_lastname": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_mobile": {
"type": "string"
},
"agglomeration_id": {
"type": "string"
},
"location_id": {
"type": "string"
},
"agglomeration_name": {
"type": "string"
},
"location_name": {
"type": "string"
},
"deliveryzone_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"delivery_status (optional, string) - Deprecated in favor of vehicle_readiness": {
"type": "string"
},
"vehicle_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"not-ready",
"ready"
]
},
"convoy_status_description": {
"type": "string",
"enum": [
"canceled",
"done",
"meet",
"not-started",
"ongoing"
]
},
"convoy_ended_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"status"
]
},
"dvla_status": {
"type": "string",
"enum": [
"not-applicable",
"expired",
"required",
"valid"
]
},
"dvla_pending_validation": {
"type": "boolean",
"description": "Deprecated in favor of dvla_status"
},
"original_delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"collect_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
},
"from": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"to": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"confirmed_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"canceled_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"started_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"returned_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"vehicle_code: a_class": {
"type": "string"
},
"show_similar_carmodel": {
"type": "boolean",
"description": "Whether we should display the \"or similar\" suffix"
},
"carmodel_name": {
"type": "string",
"description": "Benz Class A"
},
"charges": {
"type": "array"
},
"stages": {
"type": "array"
},
"damages": {
"type": "array"
},
"total": {
"type": "number"
},
"refunded_amount_after_cancelation": {
"type": "number"
},
"inspection_free": {
"type": "boolean"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Nairobi",
"Africa/Algiers",
"Africa/Lagos",
"Africa/Bissau",
"Africa/Maputo",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/El_Aaiun",
"Africa/Johannesburg",
"Africa/Khartoum",
"Africa/Monrovia",
"Africa/Ndjamena",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Port_of_Spain",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Curacao",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Panama",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Tijuana",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Toronto",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port",
"America/Rio_Branco",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Johns",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Pacific/Auckland",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Europe/Oslo",
"Asia/Riyadh",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Qatar",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Kolkata",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Shanghai",
"Asia/Colombo",
"Asia/Dhaka",
"Asia/Damascus",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Europe/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Urumqi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Ust",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/Stanley",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lord_Howe",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Perth",
"CET",
"CST6CDT",
"Pacific/Easter",
"EET",
"EST",
"EST5EDT",
"Europe/Dublin",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT",
"Etc/UCT",
"Etc/UTC",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/London",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Prague",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Zurich",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Gibraltar",
"Europe/Helsinki",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Paris",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zaporozhye",
"HST",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Reunion",
"Pacific/Kwajalein",
"MET",
"MST",
"MST7MDT",
"Pacific/Chatham",
"PST8PDT",
"Pacific/Apia",
"Pacific/Bougainville",
"Pacific/Chuuk",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Pago_Pago",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"WET",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Atlantic/St_Helena",
"Egypt",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Juba",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Niamey",
"Africa/Porto",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Addis_Ababa",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Kampala",
"Africa/Mogadishu",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Libya",
"America/Atka",
"US/Aleutian",
"US/Alaska",
"America/Buenos_Aires",
"America/Argentina/ComodRivadavia",
"America/Catamarca",
"America/Cordoba",
"America/Rosario",
"America/Jujuy",
"America/Mendoza",
"America/Coral_Harbour",
"US/Central",
"America/Aruba",
"America/Kralendijk",
"America/Lower_Princes",
"America/Shiprock",
"Navajo",
"US/Mountain",
"US/Michigan",
"Canada/Mountain",
"America/Indiana/Indianapolis",
"America/Indianapolis",
"US/East",
"Canada/Atlantic",
"Cuba",
"America/Knox_IN",
"US/Indiana",
"Jamaica",
"America/Louisville",
"US/Pacific",
"US/Pacific",
"Brazil/West",
"Mexico/BajaSur",
"Mexico/General",
"US/Eastern",
"Brazil/DeNoronha",
"America/Cayman",
"US/Arizona",
"America/Anguilla",
"America/Antigua",
"America/Dominica",
"America/Grenada",
"America/Guadeloupe",
"America/Marigot",
"America/Montserrat",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"America/Virgin",
"Canada/East",
"Canada/Saskatchewan",
"America/Porto_Acre",
"Brazil/Acre",
"Chile/Continental",
"Brazil/East",
"Canada/Newfoundland",
"America/Ensenada",
"America/Santa_Isabel",
"Mexico/BajaNorte",
"America/Montreal",
"Canada/Eastern",
"Canada/Pacific",
"Canada/Yukon",
"Canada/Central",
"Asia/Ashkhabad",
"Asia/Phnom_Penh",
"Asia/Vientiane",
"Asia/Dacca",
"Asia/Muscat",
"Asia/Saigon",
"Hongkong",
"Asia/Tel_Aviv",
"Israel",
"Asia/Katmandu",
"Asia/Calcutta",
"Asia/Macao",
"Asia/Ujung_Pandang",
"Europe/Nicosia",
"Asia/Bahrain",
"Asia/Yangon",
"Asia/Aden",
"Asia/Kuwait",
"ROK",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Harbin",
"PRC",
"Singapore",
"ROC",
"Iran",
"Asia/Thimbu",
"Japan",
"Asia/Ulan_Bator",
"Asia/Kashgar",
"Atlantic/Faeroe",
"Iceland",
"Australia/South",
"Australia/Queensland",
"Australia/Yancowinna",
"Australia/North",
"Australia/Tasmania",
"Australia/LHI",
"Australia/Victoria",
"Australia/West",
"Australia/ACT",
"Australia/Canberra",
"Australia/NSW",
"Etc/GMT",
"Etc/GMT",
"Etc/GMT0",
"Etc/Greenwich",
"GMT",
"GMT+0",
"GMT",
"GMT0",
"Greenwich",
"UCT",
"Etc/Universal",
"Etc/Zulu",
"UTC",
"Universal",
"Zulu",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Zagreb",
"Europe/Tiraspol",
"Eire",
"Europe/Mariehamn",
"Asia/Istanbul",
"Turkey",
"Portugal",
"Europe/Belfast",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"GB",
"GB",
"W",
"Arctic/Longyearbyen",
"Atlantic/Jan_Mayen",
"Europe/Bratislava",
"Europe/San_Marino",
"Europe/Vatican",
"Poland",
"Europe/Busingen",
"Europe/Vaduz",
"Antarctica/McMurdo",
"Antarctica/South_Pole",
"NZ",
"NZ",
"Pacific/Truk",
"Pacific/Yap",
"Chile/EasterIsland",
"Pacific/Saipan",
"Pacific/Johnston",
"US/Hawaii",
"Kwajalein",
"Pacific/Midway",
"Pacific/Samoa",
"US/Samoa",
"Pacific/Ponape",
"Europe/Paris"
]
},
"plate": {
"type": "string",
"description": "001-TO (required, string)"
},
"status": {
"type": "string",
"enum": [
"unconfirmed",
"confirmed",
"warranty_held",
"started",
"ended",
"canceled",
"confirmed"
]
},
"status_description": {
"type": "string"
},
"cancelation_reason": {
"type": "string"
},
"creditcard": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"cvc_check": {
"type": "boolean"
},
"holder_name": {
"type": "string"
},
"code": {
"type": "string"
},
"year": {
"type": "number"
},
"month": {
"type": "number"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"customer_id",
"cvc_check",
"holder_name",
"code",
"year",
"month",
"type"
]
},
"end_position": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"ev_charging_price_per_mileage": {
"type": "number"
},
"should_collect_end_position": {
"type": "boolean",
"description": "Deprecated"
},
"package_distance": {
"type": "number"
},
"options": {
"type": "array"
},
"mileage": {
"type": "number"
},
"mileage_start": {
"type": "number"
},
"vehicle_energy_type": {
"type": "string"
},
"vehicle_tank_capacity": {
"type": "number"
},
"vehicle_mechanical_key": {
"type": "boolean"
},
"vehicle_assistances": {
"type": "array"
},
"vehicle_usb_cable": {
"type": "string",
"enum": [
"jaym",
"marco_the_polo",
"unknown"
]
},
"vehicle_plate_country": {
"type": "string"
},
"energy": {
"type": "number"
},
"energy_start": {
"type": "number"
},
"price_per_liter_refueled": {
"type": "number",
"description": "The current price of fuel per liter fee for gasoline and diesel vehicles in cents"
},
"badge_code": {
"type": "string"
},
"key": {
"type": "string"
},
"key_start_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"key_status": {
"type": "string",
"enum": [
"key",
"key",
"key",
"key",
"key-end-validity-error"
]
},
"key_status_message": {
"type": "string"
},
"key_user_id": {
"type": "string"
},
"key_downloaded": {
"type": "boolean"
},
"is_multi_key": {
"type": "boolean"
},
"review": {
"type": "string"
},
"rating": {
"type": "number"
},
"required_battery_level_percentage_when_returned": {
"type": "number"
},
"reviewitems": {
"type": "array"
},
"contract_pdf_url": {
"type": "string",
"description": "the pdf contract available one hour before booking start time"
},
"contract_pdf_urls": {
"type": "array",
"description": "array of all contracts generated"
},
"damagereport_pdf_url": {
"type": "object",
"properties": {
"damagereport_url": {
"type": "string"
},
"damagereport_title": {
"type": "string"
}
},
"description": "Will get the final damagereport pdf url, when available for the booking"
},
"inspection_pdf_urls": {
"type": "array",
"description": "array of all the pdf inspections available when the first inspection has been made"
},
"vehicle_position": {
"type": "string"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"created_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"threedsecure_redirect_url": {
"type": "string"
},
"threedsecure": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"stripe",
"processout",
"stripe"
]
},
"account_id: `acct_1234`": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token_id: `tok_1234`": {
"type": "string"
},
"invoice_id: `iv_12345`": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"visa",
"mastercard",
"cartes_bancaires",
"visa"
]
}
},
"required": [
"provider"
]
},
"invoices": {
"type": "array"
},
"digicodes": {
"type": "object",
"properties": {
"from": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
},
"to": {
"type": "object",
"properties": {
"pedestrian": {
"type": "array"
},
"motorized": {
"type": "array"
}
}
}
}
},
"additional_drivers": {
"type": "object",
"properties": {
"pendings": {
"type": "array"
},
"actives": {
"type": "array"
}
}
},
"on_hold": {
"type": "boolean"
},
"location_access_directions": {
"type": "string"
},
"end_rental_description": {
"type": "string"
},
"end_rental_image_url": {
"type": [
"string",
"null"
]
},
"access_direction_steps": {
"type": "array"
},
"carbon_offset": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"estimated_co2_emissions_in_grams": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"offset-pending",
"offset-car-change",
"offset-not-paid",
"offset-paid"
]
},
"project_id": {
"type": "string"
},
"project_title": {
"type": "string"
}
}
},
"legals": {
"type": "array"
},
"payment_methods": {
"type": "array"
},
"car_considered_late_for_start": {
"type": "boolean"
},
"instalments": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_payment_error": {
"type": "boolean"
},
"rents": {
"type": "array"
}
},
"required": [
"id",
"has_payment_error"
]
},
"payment_plan_id": {
"type": "string"
},
"instalment_request": {
"type": "object",
"properties": {
"claim_id": {
"type": "string"
},
"at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
},
"required": [
"claim_id"
]
},
"mode": {
"type": "string",
"enum": [
"business",
"pro",
"perso"
]
},
"flight_informations": {
"type": "object",
"properties": {
"flight_number": {
"type": "string"
},
"flight_origin": {
"type": "string"
},
"flight_company": {
"type": "string"
},
"flight_terminal": {
"type": "string"
},
"flight_train": {
"type": "string",
"description": "Deprecated"
},
"comes_by_train": {
"type": "boolean"
},
"hotel_code": {
"type": "string"
}
}
},
"risk_params": {
"type": "object",
"properties": {
"user_risk_score": {
"type": "string"
},
"deposit_multiplier": {
"type": "number"
}
}
},
"badge_enabled": {
"type": "boolean"
},
"review_item_type": {
"type": "string",
"enum": [
"airport",
"delivery",
"pickup",
"delivery"
]
},
"carmodel_settings": {
"type": "object",
"properties": {
"enable_start_at_connection": {
"type": "boolean"
},
"fuel_level_tolerance": {
"type": "number"
},
"should_close_doors_to_allow_start": {
"type": "boolean"
},
"can_open_door_for_checkin": {
"type": "boolean"
},
"check_doors_on_lock": {
"type": "boolean"
},
"check_engine_on_lock": {
"type": "boolean"
},
"check_park_on_lock": {
"type": "boolean"
},
"close_windows_after_checkout": {
"type": "boolean"
},
"check_lock_state_after_locking": {
"type": "boolean"
},
"can_open_door_after_checkout": {
"type": "boolean"
},
"nfc_availability": {
"type": "boolean"
},
"state_settings": {
"type": "object",
"properties": {
"adblue_level": {
"type": "boolean"
},
"adblue_warning": {
"type": "boolean"
},
"battery_level": {
"type": "boolean"
},
"battery_warning": {
"type": "boolean"
},
"brake_fluid_warning": {
"type": "boolean"
},
"brake_pads_warning": {
"type": "boolean"
},
"connected_to_charger": {
"type": "boolean"
},
"coolant_level": {
"type": "boolean"
},
"coolant_temp": {
"type": "boolean"
},
"coolant_warning": {
"type": "boolean"
},
"door_fr": {
"type": "boolean"
},
"door_fl": {
"type": "boolean"
},
"door_rr": {
"type": "boolean"
},
"front_trunk": {
"type": "boolean"
},
"trunk": {
"type": "boolean"
},
"hood": {
"type": "boolean"
},
"tank_cap": {
"type": "boolean"
},
"door_lock_fl": {
"type": "boolean"
},
"door_lock_fr": {
"type": "boolean"
},
"door_lock_rl": {
"type": "boolean"
},
"door_lock_rr": {
"type": "boolean"
},
"due_service": {
"type": "boolean"
},
"due_service_warning": {
"type": "boolean"
},
"engine_oil_level": {
"type": "boolean"
},
"engine_oil_warning": {
"type": "boolean"
},
"engine_running": {
"type": "boolean"
},
"fuel_level": {
"type": "boolean"
},
"state_of_charge": {
"type": "boolean"
},
"latitude": {
"type": "boolean"
},
"longitude": {
"type": "boolean"
},
"odometer": {
"type": "boolean"
},
"one_interior_light": {
"type": "boolean"
},
"tire_pressure_level_fl": {
"type": "boolean"
},
"tire_pressure_level_fr": {
"type": "boolean"
},
"tire_pressure_level_rl": {
"type": "boolean"
},
"tire_pressure_level_rr": {
"type": "boolean"
},
"tire_warning": {
"type": "boolean"
},
"vehicle_speed": {
"type": "boolean"
},
"washer_fluid_warning": {
"type": "boolean"
},
"window_fl": {
"type": "boolean"
},
"window_fr": {
"type": "boolean"
},
"window_rl": {
"type": "boolean"
},
"window_rr": {
"type": "boolean"
}
},
"required": [
"adblue_level",
"adblue_warning",
"battery_level",
"battery_warning",
"brake_fluid_warning",
"brake_pads_warning",
"connected_to_charger",
"coolant_level",
"coolant_temp",
"coolant_warning",
"door_fl",
"door_fr",
"door_fl",
"door_rr",
"front_trunk",
"trunk",
"hood",
"tank_cap",
"door_lock_fl",
"door_lock_fr",
"door_lock_rl",
"door_lock_rr",
"due_service",
"due_service_warning",
"engine_oil_level",
"engine_oil_warning",
"engine_running",
"fuel_level",
"state_of_charge",
"latitude",
"longitude",
"odometer",
"one_interior_light",
"tire_pressure_level_fl",
"tire_pressure_level_fr",
"tire_pressure_level_rl",
"tire_pressure_level_rr",
"tire_warning",
"vehicle_speed",
"washer_fluid_warning",
"window_fl",
"window_fr",
"window_rl",
"window_rr"
]
}
},
"required": [
"fuel_level_tolerance"
]
},
"incidents": {
"type": "array"
},
"cancellation_context": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
},
"modifiers": {
"type": "object",
"properties": {
"option_flexible_cancelation": {
"type": "object",
"properties": {
"cancel_free_deadline": {
"type": "string",
"description": "ISO8601 formatted deadline"
},
"cancel_offset": {
"type": "number",
"description": "Hours before rental start"
},
"policy": {
"type": "string",
"enum": [
"confirm_p24h",
"start_m24h",
"start_m48h",
"free",
"confirm_p24h"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"option_flexible_cancelation"
]
}
},
"required": [
"cancel_free_deadline",
"cancel_offset",
"policy"
]
}
},
"required": [
"id",
"user_id",
"user_language",
"user_name",
"user_email",
"user_mobile",
"vehicle_readiness",
"dvla_status",
"from",
"to",
"vehicle_code: a_class",
"show_similar_carmodel",
"total",
"inspection_free",
"currency_code",
"timezone",
"package_distance",
"vehicle_tank_capacity",
"vehicle_mechanical_key",
"vehicle_usb_cable",
"key_user_id",
"end_rental_description",
"access_direction_steps",
"flight_informations",
"incidents",
"cancellation_context"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User not a driver in booking contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Keyrequest creationPOST/keyrequest
Get list of keyrequest ¶
Headers
Content-Type: application/jsonBody
{
"booking_id": "58cbc00d5d717b00114158c3"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"description": "Booking ID"
}
}
}Headers
Content-Type: application/json; charset=utf-8Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "user-not-in-contract",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "User not a driver in booking contract"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Keyrequest listGET/keyrequests
Key ¶
Mark key as downloaded ¶
Headers
Content-Type: application/jsonBody
{
"key_id": "30582456",
"provider": "ota",
"way": "",
"automatic": "",
"manually": ""
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key_id": {
"type": "string"
},
"provider": {
"type": "string"
},
"way": {},
"automatic": {
"type": "string"
},
"manually": {
"type": "string"
}
},
"required": [
"key_id",
"provider"
]
}Headers
Content-Type: application/jsonBody
{
"status": "ok"
}Mark key as downloadedPUT/key/downloaded
Set key downloaded
Release key ¶
Headers
Content-Type: application/jsonBody
{
"booking_id": "5bc8ae3cb6bfd49d020730df"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
}
},
"required": [
"booking_id"
]
}Headers
Content-Type: application/jsonBody
{
"status": "ok"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "booking-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Booking not found"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"status"
]
}Release keyPUT/key/release
Release key
Enable Dunasys key ¶
Headers
Content-Type: application/jsonBody
{
"key": {
"id": "5e3af8836d52c5aa393f1c46",
"channel": 0,
"counter": 27,
"status": "created",
"begin_date": "2021-06-08T12:00:00.000Z",
"end_date": "2021-06-18T12:00:00.000Z",
"pem": "-----BEGIN EC PRIVATE KEY-----MIIBEwIBAQQgQHZPUPeYUVg8++BrXZf1OG5zTjWT5TsCUAznARDF80yggaUwgaICAQEwLAYHKoZIzj0BAQIhAP////////////////////////////////////7///wvMAYEAQAEAQcEQQR5vmZ++dy7rFWgYpXOhwsHApv82y3OKNlZ8oFbFvgXmEg62ncmo8RlXaT7/A4RCKj9F7RIpoVUGZxH0I/7ENS4AiEA/////////////////////rqu3OavSKA7v9JejNA2QUECAQGhRANCAAQ7WB7yvSqiEqAmbnFeUeHxjgYPG7biF+hYKbqkjKv/6jWn09BD7zSv5F2Q3C6PqWzydHtyD1DVha5L4+b+FqeO-----END EC PRIVATE KEY-----",
"crt": "-----BEGIN CERTIFICATE-----MIIChTCCAisCCQDa2kLkzy0HaTAKBggqhkjOPQQDAjB2MQswCQYDVQQGEwJGUjEWMBQGA1UECAwNSWxlLWRlLUZyYW5jZTEOMAwGA1UEBwwFUGFyaXMxHDAaBgNVBAoME1ZpcnR1byBUZWNobm9sb2dpZXMxITAfBgNVBAMMGFZpcnR1byBEVU5BU1lTVEVTVDAwMDAwMTAeFw0yMTA2MDgxNTU2MzBaFw0yMjA2MDgxNTU2MzBaMIGBMQswCQYDVQQGEwJGUjEWMBQGA1UECAwNSWxlLWRlLUZyYW5jZTEOMAwGA1UEBwwFUGFyaXMxHDAaBgNVBAoME1ZpcnR1byBUZWNobm9sb2dpZXMxLDAqBgNVBAMMI1ZpcnR1byBLZXkgNjBiZjkyYTczZWY1M2U2ZGY1NDA2M2UyMIH1MIGuBgcqhkjOPQIBMIGiAgEBMCwGByqGSM49AQECIQD////////////////////////////////////+///8LzAGBAEABAEHBEEEeb5mfvncu6xVoGKVzocLBwKb/NstzijZWfKBWxb4F5hIOtp3JqPEZV2k+/wOEQio/Re0SKaFVBmcR9CP+xDUuAIhAP////////////////////66rtzmr0igO7/SXozQNkFBAgEBA0IABDtYHvK9KqISoCZucV5R4fGOBg8btuIX6FgpuqSMq//qNafT0EPvNK/kXZDcLo+pbPJ0e3IPUNWFrkvj5v4Wp44wCgYIKoZIzj0EAwIDSAAwRQIgX/CqjzbCqNh4m1G9LGVONlUpPQj7AD6ftfRekE0QYNYCIQC5+f+RVzBYmIqwvqHLJ8Sob6xuLjH4oNY9S+C3jESIsg==-----END CERTIFICATE-----",
"box_id": "0F0DC355801083535912345"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"channel": {
"type": "number",
"enum": [
0,
1
],
"description": "Key channel (0=Customer, 1=Manager)"
},
"counter": {
"type": "number",
"description": "Key counter"
},
"status": {
"type": "string",
"enum": [
"created",
"active",
"revoked",
"active"
],
"description": "Key status"
},
"begin_date": {
"type": "string",
"description": "Key theorical start date"
},
"end_date": {
"type": "string",
"description": "Key theorical end date"
},
"pem": {
"type": "string",
"description": "Key private key"
},
"crt": {
"type": "string",
"description": "Key certificate"
},
"box_id": {
"type": "string"
}
},
"required": [
"id",
"channel",
"counter",
"status",
"begin_date",
"end_date"
]
}
}
}Enable Dunasys keyPOST/key/dunasys/{id}/enable
Activates a Dunasys key and generate certificates
- id
string(required) Example: 60bf92a73ef53e6df54063e2
Enable Invers key ¶
Headers
Content-Type: application/jsonBody
{
"key": "string"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key": {
"type": "string"
}
}
}Enable Invers keyPOST/key/dunasys/{id}/enable
Activates an Invers key
- id
string(required) Example: 60bf92a73ef53e6df54063e2
Enable 2hire key ¶
Headers
Content-Type: application/jsonBody
{
"key": "string"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key": {
"type": "string"
}
}
}Enable 2hire keyPOST/key/twohire/{id}/enable
Activates a 2hire key
- id
string(required) Example: 60bf92a73ef53e6df54063e2
Legal ¶
(…)
Legal ¶
(…)
Headers
Content-Type: application/pdfLegalGET/legal/code/{legal_code}/{legal_id}/pdf?country={country}?carmodel_code={carmodel_code}
Returns the legal document as a pdf : in the context of a booking, carmodel_code can be specified to reduce the size of the file.
- legal_code
LegalCode(required) Example: rental-terms-and-conditionsCode of document
- legal_id
string(required) Example: 58cbc00d5d717b00114158c3Legal identifier
- country
LegalCountry(required) Example: FRCountry code of the document
- carmodel_code
string(optional) Example: a_classCar model beeing rented
Password ¶
(…)
... ¶
(…)
...POST/password/send
(…)
... ¶
(…)
Headers
Content-Type: application/jsonBody
{
"email": "Hello, world!",
"driver_license": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string"
},
"driver_license": {
"type": "string"
}
},
"required": [
"email"
]
}Headers
Content-Type: application/jsonBody
{
"notification": "Er is zojuist een E-mail naar u verzonden met een link om uw paswoord opnieuw in te voeren."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"notification": {
"type": "string"
}
},
"required": [
"notification"
]
}...POST/password/forgotten
... ¶
(…)
Headers
Content-Type: application/jsonBody
{
"password": "Hello, world!",
"password_token": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"password": {
"type": "string"
},
"password_token": {
"type": "string"
}
},
"required": [
"password",
"password_token"
]
}Headers
Content-Type: application/jsonBody
{
"notification": "Uw paswoord is succesvol geüpdate."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"notification": {
"type": "string"
}
},
"required": [
"notification"
]
}...POST/password/forgotten/update
Search ¶
(…)
Search ¶
(…)
Headers
Content-Type: application/jsonBody
{
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"nearest_locations": [
{
"id": "5829a335b15bef1000eacbe8",
"name": "Gare Montparnasse - Location Name",
"type": "nearby",
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"distance": 1,
"sister_location_price_description": "Hello, world!"
}
],
"nearest_dates": [
{
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"location_id": "5829a335b15bef1000eacbe8",
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
},
"nearest_locations": {
"type": "array"
},
"nearest_dates": {
"type": "array"
}
}
}SearchGET/search?from={from}&to={to}&location_id={location_id}&mobile_search_id={mobile_search_id}&search_snapshot_id={search_snapshot_id}
(…)
Errors
| code | http code | description |
|---|---|---|
| search-snapshot-expired | 403 | User’s snapshot expired |
| search-snapshot-not-found | 404 | User’s snapshot not found |
- from
string(required) Example: 2017-02-17T20:00:00.000Z- to
string(required) Example: 2017-02-18T20:00:00.000Z- location_id
string(required) Example: 5829a335b15bef1000eacbe8- mobile_search_id
string(required) Example: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22- search_snapshot_id
string(optional) Example: 5829a335b15bef1000eacbe8
Search ¶
(…)
Headers
Content-Type: application/jsonBody
{
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"nearest_locations": [
{
"id": "5829a335b15bef1000eacbe8",
"name": "Gare Montparnasse - Location Name",
"type": "nearby",
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
],
"distance": 1,
"sister_location_price_description": "Hello, world!"
}
],
"nearest_dates": [
{
"from": "2017-02-17T20:21:48.052Z",
"to": "2017-02-17T20:21:48.052Z",
"location_id": "5829a335b15bef1000eacbe8",
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
},
"nearest_locations": {
"type": "array"
},
"nearest_dates": {
"type": "array"
}
}
}Search - booking modificationGET/search?from={from}&to={to}&location_id={location_id}&booking_id={booking_id}&mobile_search_id={mobile_search_id}
Errors
| code | http code | description |
|---|---|---|
| booking-not-found | 404 | User’s booking not found |
- from
string(required) Example: 2017-02-17T20:00:00.000Z- to
string(required) Example: 2017-02-18T20:00:00.000Z- location_id
string(required) Example: 5829a335b15bef1000eacbe8- booking_id
string(required) Example: 5acb29beb97e4c31a5f75624- mobile_search_id
string(required) Example: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22
Search D&C ¶
(…)
Headers
Content-Type: application/jsonBody
{
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
}
}
}Search D&CGET/search/dnc{?from,to,deliveryzone_id,search_snapshot_id,mobile_search_id,delivery_address}
(…)
Errors
| code | http code | description |
|---|---|---|
| search-snapshot-expired | 403 | User’s snapshot expired |
| search-snapshot-not-found | 404 | User’s snapshot not found |
- from
string(required) Example: 2017-02-17T20:00:00.000Z- to
string(required) Example: 2017-02-18T20:00:00.000Z- deliveryzone_id
string(required) Example: 5829a335b15bef1000eacbe8- mobile_search_id
string(required) Example: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22- search_snapshot_id
string(optional) Example: 5829a335b15bef1000eacbe8- delivery_address
object(required) Example: {"longitude": 49.0, "latitude": 2.0}GPS coordinates of the delivery
-
longitude:
49.0(number, required) - Longitude of the coordinates -
latitude:
42.0(number, required) - Latitude of the coordinates
-
Search D&C ¶
(…)
Headers
Content-Type: application/jsonBody
{
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
}
}
}Search - booking modificationGET/search/dnc?{from,to,deliveryzone_id,booking_id,mobile_search_id,delivery_address}
Errors
| code | http code | description |
|---|---|---|
| booking-not-found | 404 | User’s booking not found |
- from
string(required) Example: 2017-02-17T20:00:00.000Z- to
string(required) Example: 2017-02-18T20:00:00.000Z- deliveryzone_id
string(required) Example: 5829a335b15bef1000eacbe8- booking_id
string(required) Example: 5acb29beb97e4c31a5f75624- mobile_search_id
string(required) Example: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22- delivery_address
object(required) Example: {"longitude": 49.0, "latitude": 2.0}GPS coordinates of the delivery
-
longitude:
49.0(number, required) - Longitude of the coordinates -
latitude:
42.0(number, required) - Latitude of the coordinates
-
Search D&C fail intent ¶
(…)
Body
{
"from": "2017-02-17T20:00:00.000Z",
"to": "2017-02-18T20:00:00.000Z",
"booking_id": "5acb29beb97e4c31a5f75624",
"mobile_search_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
"delivery_address": {
"address_line1": "Hello, world!",
"address_line2": "Hello, world!",
"additional_note": "Hello, world!",
"latitude": 1,
"longitude": 1,
"street_number": "Hello, world!",
"street": "Hello, world!",
"zip_code": "Hello, world!",
"city": "Hello, world!",
"region": "Hello, world!",
"country_code": "Hello, world!"
}
}Schema
{
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"mobile_search_id": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"additional_note": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"city": {
"type": "string"
},
"region": {
"type": "string"
},
"country_code": {
"type": "string"
}
},
"required": [
"address_line1",
"address_line2",
"latitude",
"longitude",
"country_code"
]
}
},
"required": [
"from",
"to",
"booking_id",
"mobile_search_id",
"delivery_address"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonSearch - fail intentPOST/search/dnc/fail-intent
Search Voucher ¶
(…)
Headers
Content-Type: application/jsonBody
{
"results": [
{
"options": [
{
"id": "5829a335b15bef1000eacbe8",
"insurance_type": "none",
"available_for_young_driver": true,
"carmodel_code": "a_class",
"code": "baby-seat",
"description": "Hello, world!",
"franchise_price": 36000,
"gift": true,
"inspection_free": false,
"label": "Chaînes neige",
"mandatory": true,
"is_physical": true,
"quantity_is_day_count": true,
"max_price": 36000,
"max_unit": 1,
"additional_information_text": "Additional information",
"additional_information_category": "warning",
"price": {
"day": 900,
"total": 2800
},
"deposit": {
"amount_in_cents": 30000,
"currency_code": "EUR"
},
"recommended": true,
"features": {
"existings": "Hello, world!",
"missings": "Hello, world!"
}
}
],
"vehicle_code": "a_class",
"currency_code": "EUR",
"package_distance": 150,
"price_per_km": 10,
"price_per_extra_km": 10,
"max_distance": 400,
"min_distance_per_day": 150,
"max_distance_per_day": 400,
"price": {
"total": 13800,
"day": 6900,
"diff": 800
},
"is_new_model": true,
"is_highlighted_model": true,
"is_new_carmodel_in_country": true,
"is_highlighted_carmodel_in_country": true,
"energy_type": "Hello, world!",
"additional_price_per_km": 1,
"search_snapshot_id": "5829a335b15bef1000eacbe8",
"has_yd_restriction": true,
"yd_restriction_message": "Vous devez avoir au moins 25 ans et 3 années de permis pour pouvoir réserver ce modèle",
"available_vehicle_count": 3,
"display_available_vehicle_warning": true,
"cancellation_context": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h",
"modifiers": {
"option_flexible_cancelation": {
"cancel_free_deadline": "2024-03-20T14:30:00Z",
"cancel_offset": 24,
"policy": "confirm_p24h"
}
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
}
}
}Search VoucherGET/search/voucher?from={from}&to={to}&voucher_code={voucher_code}
(…)
Errors
| code | http code | description |
|---|---|---|
| voucher-invalid-status-cancelled | 403 | Voucher is already cancelled |
| voucher-invalid-status-used | 403 | Voucher is already used |
| voucher-invalid-status-pending | 403 | Voucher is pending |
| voucher-out-of-date | 403 | Voucher is out of date |
| voucher-wrong-user-email | 403 | User’s email isn’t the same of the voucher |
| voucher-not-found | 404 | Voucher not found |
| voucher-code-invalid-format | 400 | The voucher code has an invalid format |
- from
string(required) Example: 2017-02-17T20:00:00.000Z- to
string(required) Example: 2017-02-18T20:00:00.000Z- voucher_code
string(required) Example: abcd23
Search flight ¶
(…)
Headers
Content-Type: application/jsonBody
{
"flight_informations": {
"origin": "ORAN",
"departure_at": "on 03/22/2017 at 15:20",
"arrival": "Paris-Charles de Gaulle",
"terminal": "2A",
"arrival_at": "2017-03-22T16:25:00.000Z"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flight_informations": {
"type": "object",
"properties": {
"origin": {
"type": "string"
},
"departure_at": {
"type": "string"
},
"arrival": {
"type": "string"
},
"terminal": {
"type": "string"
},
"arrival_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
}
}
}Search flightPOST/search/flight
(…)
Sponsorship ¶
(…)
User sponsorship ¶
The current authenticated customer.
Headers
Content-Type: application/jsonBody
{
"sha1s": [
{
"sha1": "0a3a19b981f8b1d3c12ebb047806556b635b8ac4",
"fullname": "Antoine Motet"
},
{
"sha1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
"fullname": "Guillaume Moizan"
}
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Affiliate a mobile sha1POST/user/affiliate
Headers
Content-Type: application/jsonHeaders
Content-Type: application/json; charset=utf-8Body
{
"status": "ok",
"affiliation": [
{
"mobile_sha1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
"fullname": "Guillaume Moizan",
"target": {
"converted": false
}
},
{
"mobile_sha1": "0a3a19b981f8b1d3c12ebb047806556b635b8ac4",
"fullname": "Antoine Motet",
"target": {
"user_id": "5a61c8eabbe5801d2bfc3864",
"sponsor_user_id": "5a61c8eabbe5801d2bfc3866",
"thumb": "https://via.placeholder.com/300",
"converted": true
}
}
]
}Get mobile sha1 affiliation listGET/user/affiliate
Headers
Content-Type: application/jsonBody
{
"sha1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Delete affiliated mobile sha1DELETE/user/affiliate
Status ¶
(…)
Status ¶
(…)
Headers
Content-Type: application/jsonBody
{
"status": "ok",
"uptime": 42428116
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
},
"uptime": {
"type": "number"
}
},
"required": [
"status",
"uptime"
]
}Get statusGET/status
(…)
Term ¶
(…)
Rental term ¶
Accept or refuse rental term
Headers
Content-Type: application/jsonBody
{
"version": 1,
"accepted": true
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Accept rental termPOST/term/rental/accept
App Update ¶
Get App Update ¶
Headers
Content-Type: application/jsonBody
{
"app_version": "4.0.16",
"os_version": "14.8.1",
"os_type": "ios",
"booking_id": "61d81e40d223390006e00dd3",
"model": "iPhone13,2"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"app_version": {
"type": "string"
},
"os_version": {
"type": "string"
},
"os_type": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"model": {
"type": "string"
}
},
"required": [
"app_version",
"os_version",
"os_type",
"booking_id",
"model"
]
}Headers
Content-Type: application/jsonBody
{
"status": "ok",
"is_update_required": true,
"should_update": true,
}Get App UpdateGET/app-update
Get app update
User ¶
(…)
User ¶
The current authenticated customer.
Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Get a userGET/user
Depending of the country and the user document ID we need to ask them their codice_fiscale if needed (an Italian administrative information). The field codice_fiscale_status tell you if you need to ask the codice to the user.
“codice_fiscale_status” possible values:
-
not_needed -
optional -
required(the CF is empty, but we need it) -
declared_as_not_needed(user declared “I don’t have CF”) -
filled(we have the CF, everything is ok)
Headers
Content-Type: application/jsonBody
{
"legal_ids": [
"ff5207c7210a6d8d186d89e5962b0928b66c53fe"
]
}Headers
Content-Type: application/jsonBody
{}Create a userPOST/user
(…)
Headers
Content-Type: application/jsonBody
{}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Update a userPUT/user
(…)
Headers
Content-Type: application/jsonBody
{
"name": "codice-fiscale",
"value": "RNELTP97E12D751I"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "bad-codice-fiscale-format",
"status": "nok"
}Headers
Content-Type: application/jsonBody
{
"name": "nif",
"not_needed": true
}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Update fiscal codePUT/user/fiscal-code
Update the user’s fiscal code.
name identify the fiscal code name you want to update (see user.fiscalities[*].name in /user response to see all supported fiscal code names).
To change it, use value parameter and to declare it as not needed not_needed=true. This two attributes are self excluding.
Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Delete a userDELETE/user
(…)
Image ¶
(…)
Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Delete an imageDELETE/user/image
(…)
Contacts ¶
Headers
Content-Type: application/jsonBody
{
"sha1s": [
"ff5207c7210a6d8d186d89e5962b0928b66c53fe"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sha1s": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"contacts": [
{
"firstname": "Karim",
"flags": {
"is_refused": false,
"is_validated": true,
"is_young_driver": true,
"is_very_young_driver": true
},
"id": "58a75b589acc820023dd16b6",
"in_contract": true,
"is_confirmation_needed": false,
"is_addable": false,
"lastname": "Kaddoura",
"mobile": "+33612437373",
"sha1": "ff5207c7210a6d8d186d89e5962b0928b66c53fe",
"thumb": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-prod/5679eca627e4a09b0fb80907/5679eca027e4a09b0fb8089e-1486300263011.jpg",
"is_requesting_key": true
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"contacts": {
"type": "array"
}
}
}Search for contactsPOST/user/contacts
Search for registred contact, mainly used for additionnal driver.
DVLA ¶
DVLA ¶
The current authenticated customer.
Headers
Content-Type: application/jsonBody
{
"code": "XXXXX"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"dvla": {
"id": "5b23793c6e4d0b0801df89e2",
"user_id": "5ae346542919272096deaa70",
"code": "wJ2XmM6R",
"status": "succeeded",
"metas": {
"holder_name": "Mr CARL EDOUARD GURDJIAN",
"driving_licence": "XXXXXXXX302CE9NK",
"licence_issue": 38,
"valid_from": "2023-04-30T23:00:00.000Z",
"check_code": "wJ 2X mM 6R",
"driving_status": "Current full licence",
"offences": 0,
"points": 0,
"category_b_start_at": "2001-02-12T00:00:00.000Z",
"category_b_end_at": "2052-12-29T00:00:00.000Z"
},
"updated_at": "2018-06-15T08:30:52.834Z",
"created_at": "2018-06-15T08:30:52.834Z"
},
"status": "ok"
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error": "driver-license-not-found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Add DVLAPOST/user/dvla
Code must be unique. Adding a code twice will throw an error.
Headers
Content-Type: application/json; charset=utf-8Body
{
"dvlas": [
{
"id": "5b1581d6a6a509662e2c8fa1",
"user_id": "5ae346542919272096deaa70",
"code": "M6MTWqcS",
"status": "succeeded",
"metas": {
"category_b_end_at": "2052-12-29T00:00:00.000Z",
"category_b_start_at": "2001-02-12T00:00:00.000Z",
"check_code": "M6 MT Wq cS",
"driving_licence": "XXXXXXXX302CE9NK",
"driving_status": "Current full licence",
"holder_name": "Mr CARL EDOUARD GURDJIAN",
"licence_issue": 38,
"offences": 0,
"points": 0,
"valid_from": "2023-04-30T23:00:00.000Z"
},
"updated_at": "2018-06-04T18:15:50.958Z",
"created_at": "2018-06-04T18:15:50.584Z"
},
{
"id": "53b9256ef79b0fff5e981924",
"user_id": "5ae346542919272096deaa70",
"code": "qcSM6MTW",
"status": "pending",
"updated_at": "2018-05-31T13:57:50.231Z",
"created_at": "2018-05-31T13:57:50.231Z"
},
{
"id": "5b0fff5e9819243b9256ef79",
"user_id": "5ae346542919272096deaa70",
"code": "TWqcSM6M",
"status": "error",
"updated_at": "2018-05-31T13:57:50.231Z",
"created_at": "2018-05-31T13:57:50.231Z"
}
],
"status": "ok"
}List DVLAsGET/user/dvla
DVLA detail ¶
Headers
Content-Type: application/json; charset=utf-8Body
{
"dvla": {
"id": "5b1581d6a6a509662e2c8fa1",
"user_id": "5ae346542919272096deaa70",
"code": "M6MTWqcS",
"status": "succeeded",
"metas": {
"category_b_end_at": "2052-12-29T00:00:00.000Z",
"category_b_start_at": "2001-02-12T00:00:00.000Z",
"check_code": "M6 MT Wq cS",
"driving_licence": "XXXXXXXX302CE9NK",
"driving_status": "Current full licence",
"holder_name": "Mr CARL EDOUARD GURDJIAN",
"licence_issue": 38,
"offences": 0,
"points": 0,
"valid_from": "2023-04-30T23:00:00.000Z"
},
"updated_at": "2018-06-04T18:15:50.958Z",
"created_at": "2018-06-04T18:15:50.584Z"
},
"status": "ok"
}Get DVLA detailGET/user/dvla/:id
Vehicle ¶
Command REBOOT_ALL ¶
Headers
Content-Type: application/jsonHeaders
Content-Type: application/jsonBody
{
"status": "ok"
}Command REBOOT_ALLPOST/vehicle/:id/command/reboot
Reboot vehicle telematic box
Find Vehicles ¶
Headers
Content-Type: application/jsonBody
{
"search": "VINNNNNNNNNNTEST4"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"search": {
"type": "string"
}
},
"required": [
"search"
]
}Headers
Content-Type: application/jsonBody
{
"vehicles": [
{
"vin": "VINNNNNNNNNNTEST4",
"plate": "00-PLATE-04",
"carmodel_code": "a_class_2019"
},
{
"vin": "VINNNNNNNNNNTEST5",
"plate": "00-PLATE-05",
"carmodel_code": "a_class_2019"
}
],
"status": "ok",
}Find VehiclesGET/vehicle
Find vehicles by plate or vin
Vehicle Feedback ¶
Get Vehicle feedback categories ¶
Headers
Content-Type: application/jsonBody
{
"vehicle_feedback_categories": [
"adblue_warning",
"tire_warning",
"washer_fluid_warning",
"engine_oil_warning"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vehicle_feedback_categories": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
}
}
}Fetch Vehicle feedback categoriesGET/vehiclefeedback/categories
Post Vehicle feedback ¶
Headers
Content-Type: application/jsonBody
{
"vehicle_id": "619e51ddd5aae600067fd658",
"booking_id": "234e51ddd5aae600067fd6sds",
"convoy_id": "234e51ddd5aae600067fd6sds",
"intervention_id": "234e51ddd5aae600067fd6sds",
"message": "message",
"value": true,
"captured_at": "2024-01-09T12:25:19.000Z",
"pictures": [
null
],
"category": "adblue_warning"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vehicle_id": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"convoy_id": {
"type": "string"
},
"intervention_id": {
"type": "string"
},
"message": {
"type": "string"
},
"value": {
"type": "boolean"
},
"captured_at": {
"type": "string"
},
"pictures": {
"type": "array"
},
"category": {
"type": "string",
"enum": [
"adblue_warning",
"tire_warning",
"washer_fluid_warning",
"engine_oil_warning"
]
}
},
"required": [
"vehicle_id",
"value",
"captured_at",
"category"
]
}Create Vehicle feedbackPOST/vehiclefeedback
Selfie ¶
Post Selfie ¶
Headers
Content-Type: application/jsonBody
{
"booking_id": "619e51ddd5aae600067fd658",
"is_blocking": true,
"is_selfie_v2": true,
"image_sha1": "3eabcae23dbea83ee1755a0d9ad79f70bccf8ad3"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_id": {
"type": "string"
},
"is_blocking": {
"type": "boolean"
},
"is_selfie_v2": {
"type": "boolean"
},
"image_sha1": {
"type": "string"
}
},
"required": [
"booking_id",
"image_sha1"
]
}Headers
Content-Type: application/jsonBody
{
"id": "619e51ddd5aae600067fd658",
"is_blocking": false,
"upload_selfie_at": "2017-02-17T20:21:48.052Z",
"status": "validated",
"image": {
"url": "https://www.govirtuo.com/virtuo.jpg",
"sha1": "658b821f194cd126853a828c015d9c185320fbb6",
"id": "5829a335b15bef1000eacbe8"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_blocking": {
"type": "boolean"
},
"upload_selfie_at": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"validated",
"outdated",
"pending",
"refused"
]
},
"image": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"sha1": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"sha1",
"id"
]
}
},
"required": [
"id",
"is_blocking",
"image"
]
}Create SelfiePOST/selfie
Get Selfie Status ¶
Headers
Content-Type: application/jsonBody
{
"status": "validated"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"validated",
"outdated",
"pending",
"refused"
]
}
}
}Get Selfie StatusGET/selfie/{selfie_id}/status
- selfie_id
string(required) Example: 619e51ddd5aae600067fd658
Conversation ¶
Post Conversation ¶
Headers
Content-Type: application/jsonBody
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Headers
Content-Type: application/jsonBody
{
"conversation": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Create ConversationPOST/conversation
List conversations ¶
Headers
Content-Type: application/jsonBody
{
"page": 1,
"limit": 10
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
}
}
}Headers
Content-Type: application/jsonBody
{
"conversations": [
{
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversations": {
"type": "array"
}
}
}List conversationsGET/conversations
Post Conversation ¶
Headers
Content-Type: application/jsonBody
{
"content": "Hello !"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}Headers
Content-Type: application/jsonBody
{
"content": "\"Hello I'm domino\""
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}New messagePOST/conversation/{conversation_id}/new-message
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Post Conversation ¶
Headers
Content-Type: application/jsonBody
{
"content": "Hello !"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}Headers
Content-Type: application/jsonBody
{
"content": "\"Hello Vee\""
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}Virtuocom new messagePOST/conversation/{conversation_id}/virtuocom/new-message
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Post Conversation Rate ¶
Headers
Content-Type: application/jsonBody
{
"rating": 5,
"feedback": "Some feedback"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
}
},
"required": [
"rating"
]
}Headers
Content-Type: application/jsonBody
{
"conversation": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Rate conversationPOST/conversation/{conversation_id}/rate
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Get conversation ¶
Headers
Content-Type: application/jsonBody
{
"conversations": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversations": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Get conversationGET/conversation/{conversation_id}
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Post mark conversation as read ¶
Headers
Content-Type: application/jsonBody
{
"conversation": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Mark conversation as readPOST/conversation/{conversation_id}/mark-as-read
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Post mark conversation as virtuocom ¶
Headers
Content-Type: application/jsonBody
{
"conversation": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Mark conversation as virtuocomPOST/conversation/{conversation_id}/mark-as-virtuocom
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Post mark conversation as virtuocom ¶
Headers
Content-Type: application/jsonBody
{
"conversation": {
"id": "619e51ddd5aae600067fd658",
"is_virtuocom": false,
"messages": [
{
"content": "Hello",
"created_at": "2024-02-27T11:12:30.052Z",
"role": "user",
"tool": {
"args": {},
"result": {},
"state": "result",
"toolCallId": "call_id",
"toolName": "get_customer_service"
},
"read_at": "2024-02-27T15:12:30.052Z",
"read_status": "unread",
"attachment": "https://s3.eu-central-1.amazonaws.com/virtuo-user-files-test/5a1c1691288bce0014e6e934/5a1c1691288bce0014e6e937-1531225720359.jpg",
"agent_firstname": "John",
"agent_lastname": "Doe"
}
],
"rating": 1,
"status": "open",
"agent_firstname": "John",
"agent_lastname": "Doe",
"booking_id": "619e51ddd5aae600067fd658"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"conversation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_virtuocom": {
"type": "boolean"
},
"messages": {
"type": "array"
},
"rating": {
"type": "number"
},
"feedback": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"has_user_read": {
"type": "boolean"
},
"agent_firstname": {
"type": "string"
},
"agent_lastname": {
"type": "string"
},
"booking_id": {
"type": "string"
}
},
"required": [
"id",
"is_virtuocom",
"status"
]
}
}
}Add attachment to conversationPOST/conversation/{conversation_id}/attachment
- conversation_id
string(required) Example: 5829a335b15bef1000eacbe8
Verify ¶
(…)
Pin ¶
(…)
Headers
Content-Type: application/jsonBody
{}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Verify pin codePOST/pin/verify
(…)
Identity verify ¶
(…)
Headers
Content-Type: application/jsonBody
{}Headers
Content-Type: application/json; charset=utf-8Body
{
"user": {
"address": "5 rue Fontaine Pottier",
"floor": "A1",
"flat_number": "A42",
"city": "37100",
"company_id": "58a75b589acc820023dd16b6",
"company_name": "Virtuo",
"company_payment": "individual-card",
"country": "FR",
"email": "test@example.com",
"firstname": "Foo",
"flags": 47192,
"id": "5829a335b15bef1000eacbe8",
"image_id": "58a75b559acc820023dd16b0",
"lastname": "Bar",
"mobile": "+33610551252",
"mobile_region": "FR",
"required_documents": [
"ID_CARD",
"DRIVER_LICENSE"
],
"on_hold_check_documents": [
"SELFIE_WITH_CREDIT_CARD",
"UNSPECIFIED"
],
"documents_submission_date": "2017-02-11T12:32:48.052Z",
"on_hold": false,
"sponsorship_amount": 1000,
"sponsorship_balance": 0,
"sponsorship_code": "spzq4bd",
"sponsorship_currency": "EUR",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"updated_at": "2017-02-17T20:21:48.052Z",
"zip_code": "TOURS",
"rental_term": {
"accepted": true,
"version": 1
},
"dvla": {
"status": "succeeded",
"expired_at": "2017-02-17T20:21:48.052Z",
"verified_at": "2017-02-17T20:21:48.052Z"
},
"driver_license": {
"acquired_on": "2017-02-17T20:21:48.052Z",
"country": "FR",
"date_of_birth": "2017-02-17T20:21:48.052Z"
},
"archived_email": "test@example.com",
"archived_mobile": "+33610551252",
"fiscalities": [
{
"name": "codice-fiscale",
"title": "Codice fiscale",
"value": "RNELTP97E12D751I",
"country": "IT",
"status": "required",
"declared_as_not_needed": false,
"can_start_booking": [
"perso",
"pro",
"v4b"
]
}
],
"codice_fiscale": "BRTSPS90M03F205J",
"codice_fiscale_status": "filled",
"company_business_booking_disabled": false,
"company_travel_reason_enabled": false,
"company_travel_reason_mandatory": false,
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"is_country_language": true,
"code": "cookies-policy",
"version": 2,
"context": "user",
"title": "Titre",
"published_at": "2017-02-17T08:00:48.052Z",
"url": "https://mobile-api.com/id/pdf",
"countries": [
{
"code": "FR",
"url": "https://mobile-api.com/id/pdf?country=FR"
}
]
}
],
"marketing_consent": true,
"expert_company_roles": [
"manager"
],
"unpaid_invoices": [
{
"amount_due": 200,
"booking_id": "58a75b589acc820023dd123b4",
"currency_code": "EUR",
"debt_collection": true,
"id": "58a75b589acc820023dd56bt8",
"legal_id": "1234",
"total": 500,
"url": "'`{HOST}/invoice/5829a335b15bef1000eacbe8/pdf`'"
}
],
"plate `BG-733-WW`": "Hello, world!"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"floor": {
"type": "string"
},
"flat_number": {
"type": "string"
},
"city": {
"type": "string"
},
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_payment": {
"type": "string",
"enum": [
"individual-card",
"company-card",
"bank-withdrawal",
"individual-card"
]
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"firstname": {
"type": "string"
},
"flags": {
"type": "number"
},
"id": {
"type": "string"
},
"image_id": {
"type": "string",
"description": "Image ID to change user's profile picture"
},
"lastname": {
"type": "string"
},
"mobile": {
"type": "string"
},
"mobile_region": {
"type": "string"
},
"required_documents": {
"type": "array"
},
"on_hold_check_documents": {
"type": "array"
},
"documents_submission_date": {
"type": "string",
"description": "The required documents submission date (ISO8601 format)"
},
"on_hold": {
"type": "boolean"
},
"sponsorship_amount": {
"type": "number",
"description": "Asset amount"
},
"sponsorship_balance": {
"type": "number",
"description": "Actual credit"
},
"sponsorship_code": {
"type": "string",
"description": "Referral code"
},
"sponsorship_currency": {
"type": "string"
},
"thumb": {
"type": "string",
"description": "User's profile picture"
},
"updated_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"zip_code": {
"type": "string"
},
"rental_term": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"version": {
"type": "number"
}
}
},
"dvla": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"expired_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"verified_at": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"driver_license": {
"type": "object",
"properties": {
"acquired_on": {
"type": "string",
"description": "The date/time (ISO8601 format)"
},
"country": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"description": "The date/time (ISO8601 format)"
}
}
},
"archived_email": {
"type": "string"
},
"archived_mobile": {
"type": "string"
},
"fiscalities": {
"type": "array"
},
"codice_fiscale": {
"type": "string"
},
"codice_fiscale_status": {
"type": "string"
},
"company_business_booking_disabled": {
"type": "boolean"
},
"company_travel_reason_enabled": {
"type": "boolean",
"description": "From v29 onwards"
},
"company_travel_reason_mandatory": {
"type": "boolean",
"description": "From v29 onwards"
},
"legals": {
"type": "array"
},
"marketing_consent": {
"type": "boolean"
},
"expert_company_roles": {
"type": "array"
},
"unpaid_invoices": {
"type": "array"
},
"plate `BG-733-WW`": {
"type": "string"
}
},
"required": [
"email",
"firstname",
"id",
"image_id",
"lastname",
"mobile",
"mobile_region",
"on_hold",
"sponsorship_amount",
"sponsorship_code",
"sponsorship_currency",
"codice_fiscale_status",
"expert_company_roles"
]
}
}
}Verify identityPOST/identity/verify
(…)
Identity documents ¶
Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "ID_CARD",
"country": "FRA",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ID_CARD"
]
},
"country": {
"type": "string",
"enum": [
"FRA"
],
"description": "alpha-3"
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"country",
"front_image_id",
"back_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "DRIVER_LICENSE",
"country": "FRA",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DRIVER_LICENSE"
]
},
"country": {
"type": "string",
"enum": [
"FRA"
],
"description": "alpha-3"
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"country",
"front_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "PASSPORT",
"country": "FRA",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PASSPORT"
]
},
"country": {
"type": "string",
"enum": [
"FRA"
],
"description": "alpha-3"
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"country",
"front_image_id",
"back_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "RESIDENCE_PERMIT",
"country": "FRA",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RESIDENCE_PERMIT"
]
},
"country": {
"type": "string",
"enum": [
"FRA"
],
"description": "alpha-3"
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"country",
"front_image_id",
"back_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "UNSPECIFIED",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"UNSPECIFIED"
]
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"front_image_id",
"back_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}Headers
Content-Type: application/jsonBody
{
"documents": [
{
"type": "SELFIE_WITH_CREDIT_CARD",
"front_image_id": "5829a335b15bef1000eacbe8",
"back_image_id": "5829a335b15bef1000eacbe8",
"faces": [
{
"image_id": "5829a335b15bef1000eacbe8",
"liveness_detection_skipped": true,
"position": "left"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SELFIE_WITH_CREDIT_CARD"
]
},
"front_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"back_image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"faces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"enum": [
"5829a335b15bef1000eacbe8"
]
},
"liveness_detection_skipped": {
"type": "boolean",
"enum": [
false
]
},
"position": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"image_id",
"liveness_detection_skipped",
"position"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"front_image_id",
"back_image_id",
"faces"
],
"additionalProperties": false
}
}
},
"required": [
"documents"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}documentsPOST/identity/documents
Voucher ¶
A voucher is a pre-reservation made on a partner site.
Voucher codes must match the following regular expression: ^[2-9a-hjkmnp-z]{6,10}$.
In other words, a valid voucher code has between 6 and 10 ASCII characters among
23456789abcdefghjkmnpqrstuvwxyz (characters like 1, i, l, O, o are not
included to avoid confusions).
Get voucher ¶
Headers
Content-Type: application/jsonBody
{
"id": "5e3af8836d52c5aa393f1c46",
"firstname": "Foo",
"lastname": "Bar",
"email": "test@example.com",
"code": "82ehb6",
"start_date": "2020-02-10T09:16:51.919Z",
"status": "pending",
"end_date": "2020-02-13T09:16:51.919Z",
"location_id": "5679eca027e4a09b0fb80866",
"partner_id": "5e3af87ffc769637563fb0cc",
"carmodel_code": "black_box",
"partner_rules": {
"credit_card_required": true,
"extension_allowed": true,
"pro_account_allowed": true,
"booking_modification_allowed": true,
"booking_modification_after_burn_allowed": true,
"must_pay_for_booking": true
},
"payment_methods": [
{
"type": "stripe",
"account_id: `acct_123456`": "Hello, world!",
"label": "'Apple pay'",
"code": "processout",
"provider": "stripe"
},
{
"type": "processout_apm",
"gateway_id": "gway_conf_1234",
"label": "'Paypal'",
"code": "processout",
"provider": "stripe"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string",
"description": "Voucher's email"
},
"code": {
"type": "string",
"description": "Voucher code"
},
"start_date": {
"type": "string",
"description": "Start of the Voucher (Not returned when user not connected !)"
},
"status": {
"type": "string",
"description": "Voucher status (Not returned when user not connected !)"
},
"end_date": {
"type": "string",
"description": "End of the Voucher (Not returned when user not connected !)"
},
"location_id": {
"type": "string",
"description": "(Not returned when user not connected !)"
},
"partner_id": {
"type": "string",
"description": "(Not returned when user not connected !)"
},
"carmodel_code": {
"type": "string",
"description": "(Not returned when user not connected !)"
},
"partner_rules": {
"type": "object",
"properties": {
"credit_card_required": {
"type": "boolean",
"description": "show/hide credit card step"
},
"extension_allowed": {
"type": "boolean"
},
"pro_account_allowed": {
"type": "boolean",
"description": "show/hide credit pro account step"
},
"booking_modification_allowed": {
"type": "boolean",
"description": "show/hide booking upsell step"
},
"booking_modification_after_burn_allowed": {
"type": "boolean",
"description": "Allow modification of booking after burn"
},
"must_pay_for_booking": {
"type": "boolean",
"description": "User must pay for booking (not paid on partner side)"
}
},
"required": [
"credit_card_required",
"extension_allowed",
"pro_account_allowed",
"booking_modification_allowed",
"booking_modification_after_burn_allowed",
"must_pay_for_booking"
]
},
"payment_methods": {
"type": "array"
}
},
"required": [
"id",
"firstname",
"lastname",
"email",
"code",
"status"
]
}Get voucherPOST/voucher/${code}
Some properties of the response will be present only if the user is logged in and matches the voucher email.
Errors
| code | http code | description |
|---|---|---|
| voucher-wrong-user-email | 403 | User’s email does not match voucher’s email |
| voucher-out-of-date | 403 | Voucher is outdated |
| voucher-invalid-status-cancelled | 403 | Voucher is already cancelled |
| voucher-invalid-status-used | 403 | Voucher is already used |
| voucher-invalid-status-pending | 403 | Voucher is pending |
| voucher-account-refused | 403 | User’s account is refused |
| voucher-unpaid-invoice | 403 | User has open unpaid invoices on their account |
| voucher-car-restriction | 403 | User is subject to carmodel restrictions |
| voucher-uk-car-restriction | 403 | Wrong voucher status |
| voucher-not-found | 404 | Voucher not found |
| voucher-code-invalid-format | 400 | The voucher code has an invalid format |
Side Effects
Voucher get canceled on ‘voucher-account-refused’, ‘voucher-unpaid-invoice’, ‘voucher-car-restriction’ & ‘voucher-uk-car-restriction’
- code
string(required) Example: ab4aa3
Marketplace ¶
(…)
Get stations from marketplace partners ¶
Get the 5 nearest stations where virtuo isn’t implemented, with BSP-auto as partner Return a list with urls generated to redirect the user with a pre-filled search
Headers
Content-Type: application/json; charset=utf-8Body
[
{
results: [
{
id: '66950bceefafb4eab56270f6',
address: '318 Federal Cir',
coordinates: { lat: 40.65915, long: -73.801872 },
country_code: 'US',
distance_from_origin_in_meters: 2437,
interated_booking: true,
station_code: 123,
station_name: 'New York Airport John F Kennedy JFK',
station_type: 'airport',
url: 'https://www.bsp-auto.com/virtuorentauto/list.asp?ag_depart=13232&ag_retour=13232&date_a=19/07/2024&date_d=26/07/2024&heure_a=10:53&heure_d=10:53'
}
],
partner_code: 'bsp-auto.com'
},
]Get stationsGET/marketplace/search/stations?from=${from}&to=${to}&lat={lat}&long={long}
- from
dateString(required) Example: 2017-02-17T20:00:00.000Z- to
dateString(required) Example: 2017-02-18T20:00:00.000Z- lat
number(required) Example: 40.65915- long
number(required) Example: -73.801872
Get carmodels from marketplace partners ¶
Search the carmodels available at the provided location for the dates selected
Headers
Content-Type: application/json; charset=utf-8Body
{
"results": [
{
"carmodel": {
"automatic_gearbox": true,
"category": "vehicle category",
"doors_count": 5,
"electric": true,
"name": "Class A Mercedes-Benz",
"seats_count": 5,
"thumb": "https://www.govirtuo.com/virtuo.jpg"
},
"day_count": 1,
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"policies": [
{
"type": "fuel",
"details": {
"policy_type": "Full",
"label": "Hello, world!"
}
}
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"rating": 10,
"renter": {
"address": "C. Baños, 2, 02004 Albacete",
"name": "avis",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"coordinates": {
"lat": 49.1664,
"long": 3
}
},
"station": {
"address": "318 Federal Cir",
"code": 13232,
"coordinates": {
"lat": 49.1664,
"long": 3
},
"country_code": "US",
"name": "New York Aeroport John F Kennedy JFK",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"type": "airport"
},
"yd_restriction": {
"maximum_age": 80,
"minimum_age": 25,
"minimum_dl_years": 3
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"results": {
"type": "array"
}
}
}Search Marketplace CarmodelsGET/marketplace/search/carmodels?from=${from}&to=${to}&location_id=
- from
dateString(required) Example: 2017-02-17T20:00:00.000Z- to
dateString(required) Example: 2017-02-18T20:00:00.000Z- station_code
number(required) Example: 123
Get a Booking ¶
Headers
Content-Type: application/jsonBody
{
"marketplace_booking_id": "5829a335b15bef1000eacbe8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking_id": {
"type": "string",
"description": "The ID of the marketplace booking to get."
}
},
"required": [
"marketplace_booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"marketplace_booking": {
"created_at": "2025-03-31T00:00:00.000Z",
"updated_at": "2025-03-31T00:00:00.000Z",
"confirmed_at": "2025-03-31T00:00:00.000Z",
"canceled_at": "2025-03-31T00:00:00.000Z",
"id": "5829a335b15bef1000eacbe8",
"offer": {
"carmodel": {
"automatic_gearbox": true,
"category": "vehicle category",
"doors_count": 5,
"electric": true,
"name": "Class A Mercedes-Benz",
"seats_count": 5,
"thumb": "https://www.govirtuo.com/virtuo.jpg"
},
"day_count": 1,
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"policies": [
{
"type": "fuel",
"details": {
"policy_type": "Full",
"label": "Hello, world!"
}
}
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"rating": 10,
"renter": {
"address": "C. Baños, 2, 02004 Albacete",
"name": "avis",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"coordinates": {
"lat": 49.1664,
"long": 3
}
},
"station": {
"address": "318 Federal Cir",
"code": 13232,
"coordinates": {
"lat": 49.1664,
"long": 3
},
"country_code": "US",
"name": "New York Aeroport John F Kennedy JFK",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"type": "airport"
},
"yd_restriction": {
"maximum_age": 80,
"minimum_age": 25,
"minimum_dl_years": 3
}
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"code": "marketplace-bsp-rental-terms-and-conditions",
"version": 1,
"published_at": "2025-03-31T00:00:00.000Z",
"url": "https://www.example.com/legal/marketplace-bsp-rental-terms-and-conditions/5829a335b15bef1000eacbe8/pdf"
}
],
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"quantity": 1,
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"status": "UNCONFIRMED",
"status_description": "Hello, world!",
"is_cancellable": false,
"is_modifiable": false,
"charges": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"charges_counter": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"totals": {
"main": 9800,
"estimated": 10000,
"counter": 200
},
"external_reference": {
"partner": "111222333555",
"renter": "AX11BZ568"
},
"creditcard": {
"code": "1234",
"customer_id": "63c4fab33cb766000750c994",
"holder_name": "John Doe",
"id": "63c69dccee027e00070c76b6",
"is_business": false,
"month": 12,
"source": "apple_pay",
"title": "Personal",
"type": "Visa",
"year": 2025
},
"threedsecure": {
"account_id": "acct_1GqIC8HYgolSBA35",
"callback_url": "https://example.com/callback",
"client_secret": "sk_test_4eC39HqLyjWDarjtT1zdp7dc",
"id": "threed_123456",
"network": "visa",
"provider": "stripe",
"redirect_url": "https://example.com/redirect",
"source": "apple_pay"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time of the booking creation"
},
"updated_at": {
"type": "string",
"description": "The date and time of the booking update"
},
"confirmed_at": {
"type": "string",
"description": "The date and time of the booking confirmation"
},
"canceled_at": {
"type": "string",
"description": "The date and time of the booking cancellation"
},
"id": {
"type": "string"
},
"offer": {
"type": "object",
"properties": {
"carmodel": {
"type": "object",
"properties": {
"automatic_gearbox": {
"type": "boolean"
},
"category": {
"type": "string"
},
"doors_count": {
"type": "number"
},
"electric": {
"type": "boolean"
},
"name": {
"type": "string"
},
"seats_count": {
"type": "number"
},
"thumb": {
"type": "string"
}
},
"required": [
"automatic_gearbox",
"category",
"doors_count",
"electric",
"name",
"seats_count"
]
},
"day_count": {
"type": "number",
"description": "the number of days of the rental"
},
"options": {
"type": "array"
},
"policies": {
"type": "array"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"rental",
"day",
"day"
],
"description": "The price type. Can be per `day` or per `rental`"
}
},
"required": [
"amount",
"currency_code",
"type"
]
},
"rating": {
"type": "number"
},
"renter": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
},
"thumb": {
"type": "string"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
]
},
"tel": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
}
}
},
"required": [
"address",
"name",
"opening_hours",
"coordinates"
]
},
"station": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The station address"
},
"code": {
"type": "number",
"description": "The station code"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"description": "The station coordinates"
},
"country_code": {
"type": "string",
"description": "The country code of the station"
},
"name": {
"type": "string",
"description": "The station name"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
],
"description": "The station opening hours"
},
"tel": {
"type": "string",
"description": "The station phone number"
},
"type": {
"type": "string",
"description": "The station type"
}
},
"required": [
"address",
"code",
"coordinates",
"country_code",
"name",
"opening_hours",
"type"
]
},
"yd_restriction": {
"type": "object",
"properties": {
"maximum_age": {
"type": "number"
},
"minimum_age": {
"type": "number"
},
"minimum_dl_years": {
"type": "number"
}
},
"required": [
"maximum_age",
"minimum_age",
"minimum_dl_years"
]
}
},
"required": [
"carmodel",
"day_count",
"options",
"policies",
"price",
"rating",
"renter",
"station"
]
},
"legals": {
"type": "array"
},
"options": {
"type": "array"
},
"status": {
"type": "string",
"description": "'UNCONFIRMED' | 'CONFIRMED' | 'REQUESTED' | 'CANCELLED'"
},
"status_description": {
"type": "string",
"description": "A description of the status"
},
"is_cancellable": {
"type": "boolean",
"description": "Whether the booking can be cancelled by user"
},
"is_modifiable": {
"type": "boolean",
"description": "Whether the booking can be modified by user"
},
"charges": {
"type": "array"
},
"charges_counter": {
"type": "array"
},
"totals": {
"type": "object",
"properties": {
"main": {
"type": "number",
"description": "total amount in cents to pay now"
},
"estimated": {
"type": "number",
"description": "estimated total amount in cents"
},
"counter": {
"type": "number",
"description": "total amount in cents to pay at counter"
}
},
"required": [
"main",
"estimated",
"counter"
]
},
"external_reference": {
"type": "object",
"properties": {
"partner": {
"type": "string"
},
"renter": {
"type": "string"
}
},
"required": [
"partner",
"renter"
]
},
"creditcard": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The credit card code"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"holder_name": {
"type": "string",
"description": "The card holder's name"
},
"id": {
"type": "string",
"description": "The card ID"
},
"is_business": {
"type": "boolean",
"description": "Whether the card is a business card"
},
"month": {
"type": "number",
"description": "The expiration month"
},
"source": {
"type": "string",
"description": "The payment source"
},
"title": {
"type": "string",
"description": "The card title"
},
"type": {
"type": "string",
"description": "The card type"
},
"year": {
"type": "number",
"description": "The expiration year"
}
},
"required": [
"code",
"customer_id",
"holder_name",
"id",
"is_business",
"month",
"title",
"type",
"year"
],
"description": "The credit card used for the booking"
},
"threedsecure": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The account ID"
},
"callback_url": {
"type": "string",
"description": "The callback URL"
},
"client_secret": {
"type": "string",
"description": "The client secret"
},
"id": {
"type": "string",
"description": "The 3DS authentication ID"
},
"network": {
"type": "string",
"description": "The card network"
},
"provider": {
"type": "string",
"description": "The 3DS provider"
},
"redirect_url": {
"type": "string",
"description": "The redirect URL"
},
"source": {
"type": "string",
"description": "The payment source"
}
},
"required": [
"callback_url",
"client_secret",
"id",
"provider",
"redirect_url",
"source"
],
"description": "3D Secure authentication information for the booking"
}
},
"required": [
"created_at",
"updated_at",
"id",
"offer",
"legals",
"options",
"status",
"is_cancellable",
"is_modifiable",
"charges",
"charges_counter",
"totals"
],
"description": "The booking retrieved."
}
}
}Get a bookingGET/marketplace/booking
Create a Booking ¶
Headers
Content-Type: application/jsonBody
{
"option_codes": [
"booster-seat"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"option_codes": {
"type": "array",
"description": "List of selected option codes."
}
},
"required": [
"option_codes"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"marketplace_booking": {
"created_at": "2025-03-31T00:00:00.000Z",
"updated_at": "2025-03-31T00:00:00.000Z",
"confirmed_at": "2025-03-31T00:00:00.000Z",
"canceled_at": "2025-03-31T00:00:00.000Z",
"id": "5829a335b15bef1000eacbe8",
"offer": {
"carmodel": {
"automatic_gearbox": true,
"category": "vehicle category",
"doors_count": 5,
"electric": true,
"name": "Class A Mercedes-Benz",
"seats_count": 5,
"thumb": "https://www.govirtuo.com/virtuo.jpg"
},
"day_count": 1,
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"policies": [
{
"type": "fuel",
"details": {
"policy_type": "Full",
"label": "Hello, world!"
}
}
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"rating": 10,
"renter": {
"address": "C. Baños, 2, 02004 Albacete",
"name": "avis",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"coordinates": {
"lat": 49.1664,
"long": 3
}
},
"station": {
"address": "318 Federal Cir",
"code": 13232,
"coordinates": {
"lat": 49.1664,
"long": 3
},
"country_code": "US",
"name": "New York Aeroport John F Kennedy JFK",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"type": "airport"
},
"yd_restriction": {
"maximum_age": 80,
"minimum_age": 25,
"minimum_dl_years": 3
}
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"code": "marketplace-bsp-rental-terms-and-conditions",
"version": 1,
"published_at": "2025-03-31T00:00:00.000Z",
"url": "https://www.example.com/legal/marketplace-bsp-rental-terms-and-conditions/5829a335b15bef1000eacbe8/pdf"
}
],
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"quantity": 1,
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"status": "UNCONFIRMED",
"status_description": "Hello, world!",
"is_cancellable": false,
"is_modifiable": false,
"charges": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"charges_counter": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"totals": {
"main": 9800,
"estimated": 10000,
"counter": 200
},
"external_reference": {
"partner": "111222333555",
"renter": "AX11BZ568"
},
"creditcard": {
"code": "1234",
"customer_id": "63c4fab33cb766000750c994",
"holder_name": "John Doe",
"id": "63c69dccee027e00070c76b6",
"is_business": false,
"month": 12,
"source": "apple_pay",
"title": "Personal",
"type": "Visa",
"year": 2025
},
"threedsecure": {
"account_id": "acct_1GqIC8HYgolSBA35",
"callback_url": "https://example.com/callback",
"client_secret": "sk_test_4eC39HqLyjWDarjtT1zdp7dc",
"id": "threed_123456",
"network": "visa",
"provider": "stripe",
"redirect_url": "https://example.com/redirect",
"source": "apple_pay"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time of the booking creation"
},
"updated_at": {
"type": "string",
"description": "The date and time of the booking update"
},
"confirmed_at": {
"type": "string",
"description": "The date and time of the booking confirmation"
},
"canceled_at": {
"type": "string",
"description": "The date and time of the booking cancellation"
},
"id": {
"type": "string"
},
"offer": {
"type": "object",
"properties": {
"carmodel": {
"type": "object",
"properties": {
"automatic_gearbox": {
"type": "boolean"
},
"category": {
"type": "string"
},
"doors_count": {
"type": "number"
},
"electric": {
"type": "boolean"
},
"name": {
"type": "string"
},
"seats_count": {
"type": "number"
},
"thumb": {
"type": "string"
}
},
"required": [
"automatic_gearbox",
"category",
"doors_count",
"electric",
"name",
"seats_count"
]
},
"day_count": {
"type": "number",
"description": "the number of days of the rental"
},
"options": {
"type": "array"
},
"policies": {
"type": "array"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"rental",
"day",
"day"
],
"description": "The price type. Can be per `day` or per `rental`"
}
},
"required": [
"amount",
"currency_code",
"type"
]
},
"rating": {
"type": "number"
},
"renter": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
},
"thumb": {
"type": "string"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
]
},
"tel": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
}
}
},
"required": [
"address",
"name",
"opening_hours",
"coordinates"
]
},
"station": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The station address"
},
"code": {
"type": "number",
"description": "The station code"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"description": "The station coordinates"
},
"country_code": {
"type": "string",
"description": "The country code of the station"
},
"name": {
"type": "string",
"description": "The station name"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
],
"description": "The station opening hours"
},
"tel": {
"type": "string",
"description": "The station phone number"
},
"type": {
"type": "string",
"description": "The station type"
}
},
"required": [
"address",
"code",
"coordinates",
"country_code",
"name",
"opening_hours",
"type"
]
},
"yd_restriction": {
"type": "object",
"properties": {
"maximum_age": {
"type": "number"
},
"minimum_age": {
"type": "number"
},
"minimum_dl_years": {
"type": "number"
}
},
"required": [
"maximum_age",
"minimum_age",
"minimum_dl_years"
]
}
},
"required": [
"carmodel",
"day_count",
"options",
"policies",
"price",
"rating",
"renter",
"station"
]
},
"legals": {
"type": "array"
},
"options": {
"type": "array"
},
"status": {
"type": "string",
"description": "'UNCONFIRMED' | 'CONFIRMED' | 'REQUESTED' | 'CANCELLED'"
},
"status_description": {
"type": "string",
"description": "A description of the status"
},
"is_cancellable": {
"type": "boolean",
"description": "Whether the booking can be cancelled by user"
},
"is_modifiable": {
"type": "boolean",
"description": "Whether the booking can be modified by user"
},
"charges": {
"type": "array"
},
"charges_counter": {
"type": "array"
},
"totals": {
"type": "object",
"properties": {
"main": {
"type": "number",
"description": "total amount in cents to pay now"
},
"estimated": {
"type": "number",
"description": "estimated total amount in cents"
},
"counter": {
"type": "number",
"description": "total amount in cents to pay at counter"
}
},
"required": [
"main",
"estimated",
"counter"
]
},
"external_reference": {
"type": "object",
"properties": {
"partner": {
"type": "string"
},
"renter": {
"type": "string"
}
},
"required": [
"partner",
"renter"
]
},
"creditcard": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The credit card code"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"holder_name": {
"type": "string",
"description": "The card holder's name"
},
"id": {
"type": "string",
"description": "The card ID"
},
"is_business": {
"type": "boolean",
"description": "Whether the card is a business card"
},
"month": {
"type": "number",
"description": "The expiration month"
},
"source": {
"type": "string",
"description": "The payment source"
},
"title": {
"type": "string",
"description": "The card title"
},
"type": {
"type": "string",
"description": "The card type"
},
"year": {
"type": "number",
"description": "The expiration year"
}
},
"required": [
"code",
"customer_id",
"holder_name",
"id",
"is_business",
"month",
"title",
"type",
"year"
],
"description": "The credit card used for the booking"
},
"threedsecure": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The account ID"
},
"callback_url": {
"type": "string",
"description": "The callback URL"
},
"client_secret": {
"type": "string",
"description": "The client secret"
},
"id": {
"type": "string",
"description": "The 3DS authentication ID"
},
"network": {
"type": "string",
"description": "The card network"
},
"provider": {
"type": "string",
"description": "The 3DS provider"
},
"redirect_url": {
"type": "string",
"description": "The redirect URL"
},
"source": {
"type": "string",
"description": "The payment source"
}
},
"required": [
"callback_url",
"client_secret",
"id",
"provider",
"redirect_url",
"source"
],
"description": "3D Secure authentication information for the booking"
}
},
"required": [
"created_at",
"updated_at",
"id",
"offer",
"legals",
"options",
"status",
"is_cancellable",
"is_modifiable",
"charges",
"charges_counter",
"totals"
],
"description": "The booking created with a `UNCONFIRMED` status"
}
}
}Create a new bookingPOST/marketplace/booking
- snapshot_id
string(required) Example: 12345The ID of the snapshot to book.
Confirm a Booking ¶
Headers
Content-Type: application/jsonBody
{
"marketplace_booking_id": [
"5829a335b15bef1000eacbe8"
],
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": "Hello, world!",
"legal_ids": [
"5829a335b15bef1000eacbe8"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking_id": {
"type": "array",
"description": "The ID of the marketplace booking to confirm."
},
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`": {
"type": "string",
"description": "The ID of the credit card to confirm."
},
"legal_ids": {
"type": "array",
"description": "The IDs of the legal documents to confirm."
}
},
"required": [
"marketplace_booking_id",
"creditcard_id: `card_j7m8khq142phci2sibvzetz7`"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"marketplace_booking": {
"created_at": "2025-03-31T00:00:00.000Z",
"updated_at": "2025-03-31T00:00:00.000Z",
"confirmed_at": "2025-03-31T00:00:00.000Z",
"canceled_at": "2025-03-31T00:00:00.000Z",
"id": "5829a335b15bef1000eacbe8",
"offer": {
"carmodel": {
"automatic_gearbox": true,
"category": "vehicle category",
"doors_count": 5,
"electric": true,
"name": "Class A Mercedes-Benz",
"seats_count": 5,
"thumb": "https://www.govirtuo.com/virtuo.jpg"
},
"day_count": 1,
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"policies": [
{
"type": "fuel",
"details": {
"policy_type": "Full",
"label": "Hello, world!"
}
}
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"rating": 10,
"renter": {
"address": "C. Baños, 2, 02004 Albacete",
"name": "avis",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"coordinates": {
"lat": 49.1664,
"long": 3
}
},
"station": {
"address": "318 Federal Cir",
"code": 13232,
"coordinates": {
"lat": 49.1664,
"long": 3
},
"country_code": "US",
"name": "New York Aeroport John F Kennedy JFK",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"type": "airport"
},
"yd_restriction": {
"maximum_age": 80,
"minimum_age": 25,
"minimum_dl_years": 3
}
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"code": "marketplace-bsp-rental-terms-and-conditions",
"version": 1,
"published_at": "2025-03-31T00:00:00.000Z",
"url": "https://www.example.com/legal/marketplace-bsp-rental-terms-and-conditions/5829a335b15bef1000eacbe8/pdf"
}
],
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"quantity": 1,
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"status": "UNCONFIRMED",
"status_description": "Hello, world!",
"is_cancellable": false,
"is_modifiable": false,
"charges": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"charges_counter": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"totals": {
"main": 9800,
"estimated": 10000,
"counter": 200
},
"external_reference": {
"partner": "111222333555",
"renter": "AX11BZ568"
},
"creditcard": {
"code": "1234",
"customer_id": "63c4fab33cb766000750c994",
"holder_name": "John Doe",
"id": "63c69dccee027e00070c76b6",
"is_business": false,
"month": 12,
"source": "apple_pay",
"title": "Personal",
"type": "Visa",
"year": 2025
},
"threedsecure": {
"account_id": "acct_1GqIC8HYgolSBA35",
"callback_url": "https://example.com/callback",
"client_secret": "sk_test_4eC39HqLyjWDarjtT1zdp7dc",
"id": "threed_123456",
"network": "visa",
"provider": "stripe",
"redirect_url": "https://example.com/redirect",
"source": "apple_pay"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time of the booking creation"
},
"updated_at": {
"type": "string",
"description": "The date and time of the booking update"
},
"confirmed_at": {
"type": "string",
"description": "The date and time of the booking confirmation"
},
"canceled_at": {
"type": "string",
"description": "The date and time of the booking cancellation"
},
"id": {
"type": "string"
},
"offer": {
"type": "object",
"properties": {
"carmodel": {
"type": "object",
"properties": {
"automatic_gearbox": {
"type": "boolean"
},
"category": {
"type": "string"
},
"doors_count": {
"type": "number"
},
"electric": {
"type": "boolean"
},
"name": {
"type": "string"
},
"seats_count": {
"type": "number"
},
"thumb": {
"type": "string"
}
},
"required": [
"automatic_gearbox",
"category",
"doors_count",
"electric",
"name",
"seats_count"
]
},
"day_count": {
"type": "number",
"description": "the number of days of the rental"
},
"options": {
"type": "array"
},
"policies": {
"type": "array"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"rental",
"day",
"day"
],
"description": "The price type. Can be per `day` or per `rental`"
}
},
"required": [
"amount",
"currency_code",
"type"
]
},
"rating": {
"type": "number"
},
"renter": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
},
"thumb": {
"type": "string"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
]
},
"tel": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
}
}
},
"required": [
"address",
"name",
"opening_hours",
"coordinates"
]
},
"station": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The station address"
},
"code": {
"type": "number",
"description": "The station code"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"description": "The station coordinates"
},
"country_code": {
"type": "string",
"description": "The country code of the station"
},
"name": {
"type": "string",
"description": "The station name"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
],
"description": "The station opening hours"
},
"tel": {
"type": "string",
"description": "The station phone number"
},
"type": {
"type": "string",
"description": "The station type"
}
},
"required": [
"address",
"code",
"coordinates",
"country_code",
"name",
"opening_hours",
"type"
]
},
"yd_restriction": {
"type": "object",
"properties": {
"maximum_age": {
"type": "number"
},
"minimum_age": {
"type": "number"
},
"minimum_dl_years": {
"type": "number"
}
},
"required": [
"maximum_age",
"minimum_age",
"minimum_dl_years"
]
}
},
"required": [
"carmodel",
"day_count",
"options",
"policies",
"price",
"rating",
"renter",
"station"
]
},
"legals": {
"type": "array"
},
"options": {
"type": "array"
},
"status": {
"type": "string",
"description": "'UNCONFIRMED' | 'CONFIRMED' | 'REQUESTED' | 'CANCELLED'"
},
"status_description": {
"type": "string",
"description": "A description of the status"
},
"is_cancellable": {
"type": "boolean",
"description": "Whether the booking can be cancelled by user"
},
"is_modifiable": {
"type": "boolean",
"description": "Whether the booking can be modified by user"
},
"charges": {
"type": "array"
},
"charges_counter": {
"type": "array"
},
"totals": {
"type": "object",
"properties": {
"main": {
"type": "number",
"description": "total amount in cents to pay now"
},
"estimated": {
"type": "number",
"description": "estimated total amount in cents"
},
"counter": {
"type": "number",
"description": "total amount in cents to pay at counter"
}
},
"required": [
"main",
"estimated",
"counter"
]
},
"external_reference": {
"type": "object",
"properties": {
"partner": {
"type": "string"
},
"renter": {
"type": "string"
}
},
"required": [
"partner",
"renter"
]
},
"creditcard": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The credit card code"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"holder_name": {
"type": "string",
"description": "The card holder's name"
},
"id": {
"type": "string",
"description": "The card ID"
},
"is_business": {
"type": "boolean",
"description": "Whether the card is a business card"
},
"month": {
"type": "number",
"description": "The expiration month"
},
"source": {
"type": "string",
"description": "The payment source"
},
"title": {
"type": "string",
"description": "The card title"
},
"type": {
"type": "string",
"description": "The card type"
},
"year": {
"type": "number",
"description": "The expiration year"
}
},
"required": [
"code",
"customer_id",
"holder_name",
"id",
"is_business",
"month",
"title",
"type",
"year"
],
"description": "The credit card used for the booking"
},
"threedsecure": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The account ID"
},
"callback_url": {
"type": "string",
"description": "The callback URL"
},
"client_secret": {
"type": "string",
"description": "The client secret"
},
"id": {
"type": "string",
"description": "The 3DS authentication ID"
},
"network": {
"type": "string",
"description": "The card network"
},
"provider": {
"type": "string",
"description": "The 3DS provider"
},
"redirect_url": {
"type": "string",
"description": "The redirect URL"
},
"source": {
"type": "string",
"description": "The payment source"
}
},
"required": [
"callback_url",
"client_secret",
"id",
"provider",
"redirect_url",
"source"
],
"description": "3D Secure authentication information for the booking"
}
},
"required": [
"created_at",
"updated_at",
"id",
"offer",
"legals",
"options",
"status",
"is_cancellable",
"is_modifiable",
"charges",
"charges_counter",
"totals"
],
"description": "The booking confirmed with a `CONFIRMED` or `REQUESTED` status."
}
}
}Confirm a bookingPOST/marketplace/booking/confirm
Cancel a Booking ¶
Headers
Content-Type: application/jsonBody
{
"marketplace_booking_id": [
"5829a335b15bef1000eacbe8"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking_id": {
"type": "array",
"description": "The ID of the marketplace booking to confirm."
}
},
"required": [
"marketplace_booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"marketplace_booking": {
"created_at": "2025-03-31T00:00:00.000Z",
"updated_at": "2025-03-31T00:00:00.000Z",
"confirmed_at": "2025-03-31T00:00:00.000Z",
"canceled_at": "2025-03-31T00:00:00.000Z",
"id": "5829a335b15bef1000eacbe8",
"offer": {
"carmodel": {
"automatic_gearbox": true,
"category": "vehicle category",
"doors_count": 5,
"electric": true,
"name": "Class A Mercedes-Benz",
"seats_count": 5,
"thumb": "https://www.govirtuo.com/virtuo.jpg"
},
"day_count": 1,
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"policies": [
{
"type": "fuel",
"details": {
"policy_type": "Full",
"label": "Hello, world!"
}
}
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"rating": 10,
"renter": {
"address": "C. Baños, 2, 02004 Albacete",
"name": "avis",
"thumb": "https://www.govirtuo.com/virtuo.jpg",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"coordinates": {
"lat": 49.1664,
"long": 3
}
},
"station": {
"address": "318 Federal Cir",
"code": 13232,
"coordinates": {
"lat": 49.1664,
"long": 3
},
"country_code": "US",
"name": "New York Aeroport John F Kennedy JFK",
"opening_hours": {
"m_o1": "08h00",
"m_o2": "08h00",
"m_o3": "08h00",
"m_o4": "08h00",
"m_o5": "08h00",
"m_o6": "08h00",
"m_o7": "08h00",
"m_f1": "12h00",
"m_f2": "12h00",
"m_f3": "12h00",
"m_f4": "12h00",
"m_f5": "12h00",
"m_f6": "12h00",
"m_f7": "12h00",
"s_o1": "13h00",
"s_o2": "13h00",
"s_o3": "13h00",
"s_o4": "13h00",
"s_o5": "13h00",
"s_o6": "13h00",
"s_o7": "13h00",
"s_f1": "19h00",
"s_f2": "19h00",
"s_f3": "19h00",
"s_f4": "19h00",
"s_f5": "19h00",
"s_f6": "19h00",
"s_f7": "19h00"
},
"tel": "0123456789",
"type": "airport"
},
"yd_restriction": {
"maximum_age": 80,
"minimum_age": 25,
"minimum_dl_years": 3
}
},
"legals": [
{
"id": "5829a335b15bef1000eacbe8",
"code": "marketplace-bsp-rental-terms-and-conditions",
"version": 1,
"published_at": "2025-03-31T00:00:00.000Z",
"url": "https://www.example.com/legal/marketplace-bsp-rental-terms-and-conditions/5829a335b15bef1000eacbe8/pdf"
}
],
"options": [
{
"code": "gps",
"label": "Hello, world!",
"description": "Hello, world!",
"features": [
"Hello, world!"
],
"price": {
"amount": 10200,
"currency_code": "EUR",
"type": "rental"
},
"provider": {
"code": "allianz",
"legal_url": "https://www.bsp-auto.com/pdf/allianz-fr.pdf"
},
"quantity": 1,
"selection_type": "single",
"max_quantity": 1,
"requires_counter_purchase": true
}
],
"status": "UNCONFIRMED",
"status_description": "Hello, world!",
"is_cancellable": false,
"is_modifiable": false,
"charges": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"charges_counter": [
{
"code": "day",
"label": "Rental day",
"price": 4900,
"quantity": 7,
"subprice": 4083,
"tax_amount": 817,
"tax_percent": 20
}
],
"totals": {
"main": 9800,
"estimated": 10000,
"counter": 200
},
"external_reference": {
"partner": "111222333555",
"renter": "AX11BZ568"
},
"creditcard": {
"code": "1234",
"customer_id": "63c4fab33cb766000750c994",
"holder_name": "John Doe",
"id": "63c69dccee027e00070c76b6",
"is_business": false,
"month": 12,
"source": "apple_pay",
"title": "Personal",
"type": "Visa",
"year": 2025
},
"threedsecure": {
"account_id": "acct_1GqIC8HYgolSBA35",
"callback_url": "https://example.com/callback",
"client_secret": "sk_test_4eC39HqLyjWDarjtT1zdp7dc",
"id": "threed_123456",
"network": "visa",
"provider": "stripe",
"redirect_url": "https://example.com/redirect",
"source": "apple_pay"
}
},
"cancellation_status": "We're sorry you weren't able to book this time. We hope to see you again soon!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time of the booking creation"
},
"updated_at": {
"type": "string",
"description": "The date and time of the booking update"
},
"confirmed_at": {
"type": "string",
"description": "The date and time of the booking confirmation"
},
"canceled_at": {
"type": "string",
"description": "The date and time of the booking cancellation"
},
"id": {
"type": "string"
},
"offer": {
"type": "object",
"properties": {
"carmodel": {
"type": "object",
"properties": {
"automatic_gearbox": {
"type": "boolean"
},
"category": {
"type": "string"
},
"doors_count": {
"type": "number"
},
"electric": {
"type": "boolean"
},
"name": {
"type": "string"
},
"seats_count": {
"type": "number"
},
"thumb": {
"type": "string"
}
},
"required": [
"automatic_gearbox",
"category",
"doors_count",
"electric",
"name",
"seats_count"
]
},
"day_count": {
"type": "number",
"description": "the number of days of the rental"
},
"options": {
"type": "array"
},
"policies": {
"type": "array"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"rental",
"day",
"day"
],
"description": "The price type. Can be per `day` or per `rental`"
}
},
"required": [
"amount",
"currency_code",
"type"
]
},
"rating": {
"type": "number"
},
"renter": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
},
"thumb": {
"type": "string"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
]
},
"tel": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
}
}
},
"required": [
"address",
"name",
"opening_hours",
"coordinates"
]
},
"station": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The station address"
},
"code": {
"type": "number",
"description": "The station code"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"description": "The station coordinates"
},
"country_code": {
"type": "string",
"description": "The country code of the station"
},
"name": {
"type": "string",
"description": "The station name"
},
"opening_hours": {
"type": "object",
"properties": {
"m_o1": {
"type": "string"
},
"m_o2": {
"type": "string"
},
"m_o3": {
"type": "string"
},
"m_o4": {
"type": "string"
},
"m_o5": {
"type": "string"
},
"m_o6": {
"type": "string"
},
"m_o7": {
"type": "string"
},
"m_f1": {
"type": "string"
},
"m_f2": {
"type": "string"
},
"m_f3": {
"type": "string"
},
"m_f4": {
"type": "string"
},
"m_f5": {
"type": "string"
},
"m_f6": {
"type": "string"
},
"m_f7": {
"type": "string"
},
"s_o1": {
"type": "string"
},
"s_o2": {
"type": "string"
},
"s_o3": {
"type": "string"
},
"s_o4": {
"type": "string"
},
"s_o5": {
"type": "string"
},
"s_o6": {
"type": "string"
},
"s_o7": {
"type": "string"
},
"s_f1": {
"type": "string"
},
"s_f2": {
"type": "string"
},
"s_f3": {
"type": "string"
},
"s_f4": {
"type": "string"
},
"s_f5": {
"type": "string"
},
"s_f6": {
"type": "string"
},
"s_f7": {
"type": "string"
}
},
"required": [
"m_o1",
"m_o2",
"m_o3",
"m_o4",
"m_o5",
"m_o6",
"m_o7",
"m_f1",
"m_f2",
"m_f3",
"m_f4",
"m_f5",
"m_f6",
"m_f7",
"s_o1",
"s_o2",
"s_o3",
"s_o4",
"s_o5",
"s_o6",
"s_o7",
"s_f1",
"s_f2",
"s_f3",
"s_f4",
"s_f5",
"s_f6",
"s_f7"
],
"description": "The station opening hours"
},
"tel": {
"type": "string",
"description": "The station phone number"
},
"type": {
"type": "string",
"description": "The station type"
}
},
"required": [
"address",
"code",
"coordinates",
"country_code",
"name",
"opening_hours",
"type"
]
},
"yd_restriction": {
"type": "object",
"properties": {
"maximum_age": {
"type": "number"
},
"minimum_age": {
"type": "number"
},
"minimum_dl_years": {
"type": "number"
}
},
"required": [
"maximum_age",
"minimum_age",
"minimum_dl_years"
]
}
},
"required": [
"carmodel",
"day_count",
"options",
"policies",
"price",
"rating",
"renter",
"station"
]
},
"legals": {
"type": "array"
},
"options": {
"type": "array"
},
"status": {
"type": "string",
"description": "'UNCONFIRMED' | 'CONFIRMED' | 'REQUESTED' | 'CANCELLED'"
},
"status_description": {
"type": "string",
"description": "A description of the status"
},
"is_cancellable": {
"type": "boolean",
"description": "Whether the booking can be cancelled by user"
},
"is_modifiable": {
"type": "boolean",
"description": "Whether the booking can be modified by user"
},
"charges": {
"type": "array"
},
"charges_counter": {
"type": "array"
},
"totals": {
"type": "object",
"properties": {
"main": {
"type": "number",
"description": "total amount in cents to pay now"
},
"estimated": {
"type": "number",
"description": "estimated total amount in cents"
},
"counter": {
"type": "number",
"description": "total amount in cents to pay at counter"
}
},
"required": [
"main",
"estimated",
"counter"
]
},
"external_reference": {
"type": "object",
"properties": {
"partner": {
"type": "string"
},
"renter": {
"type": "string"
}
},
"required": [
"partner",
"renter"
]
},
"creditcard": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The credit card code"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"holder_name": {
"type": "string",
"description": "The card holder's name"
},
"id": {
"type": "string",
"description": "The card ID"
},
"is_business": {
"type": "boolean",
"description": "Whether the card is a business card"
},
"month": {
"type": "number",
"description": "The expiration month"
},
"source": {
"type": "string",
"description": "The payment source"
},
"title": {
"type": "string",
"description": "The card title"
},
"type": {
"type": "string",
"description": "The card type"
},
"year": {
"type": "number",
"description": "The expiration year"
}
},
"required": [
"code",
"customer_id",
"holder_name",
"id",
"is_business",
"month",
"title",
"type",
"year"
],
"description": "The credit card used for the booking"
},
"threedsecure": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The account ID"
},
"callback_url": {
"type": "string",
"description": "The callback URL"
},
"client_secret": {
"type": "string",
"description": "The client secret"
},
"id": {
"type": "string",
"description": "The 3DS authentication ID"
},
"network": {
"type": "string",
"description": "The card network"
},
"provider": {
"type": "string",
"description": "The 3DS provider"
},
"redirect_url": {
"type": "string",
"description": "The redirect URL"
},
"source": {
"type": "string",
"description": "The payment source"
}
},
"required": [
"callback_url",
"client_secret",
"id",
"provider",
"redirect_url",
"source"
],
"description": "3D Secure authentication information for the booking"
}
},
"required": [
"created_at",
"updated_at",
"id",
"offer",
"legals",
"options",
"status",
"is_cancellable",
"is_modifiable",
"charges",
"charges_counter",
"totals"
],
"description": "The booking cancelled with a `CANCELLED` status"
},
"cancellation_status": {
"type": "string",
"description": "The description of the cancellation request."
}
},
"required": [
"cancellation_status"
]
}Cancel a bookingPOST/marketplace/booking/cancel
Delete a Booking ¶
Headers
Content-Type: application/jsonBody
{
"marketplace_booking_id": [
"5829a335b15bef1000eacbe8"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"marketplace_booking_id": {
"type": "array",
"description": "The ID of the marketplace booking to delete."
}
},
"required": [
"marketplace_booking_id"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"deletion_status": "Your booking has been deleted successfully."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"deletion_status": {
"type": "string",
"description": "Confirmation message of the deletion."
}
},
"required": [
"deletion_status"
]
}Delete a bookingPOST/marketplace/booking/delete
Init ¶
(…)
Help center ¶
(…)
Headers
Content-Type: application/jsonBody
{
"question": "Quelle est la motorisation de la fiat 500 ?",
"locale": "fr"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"question": {
"type": "string"
},
"locale": {
"type": "string"
}
},
"required": [
"question",
"locale"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{ "answer": "La Fiat 500 est disponible avec une motorisation essence 1.2 69 ch.", "rich_answer: "La **Fiat 500** est disponible avec une motorisation essence 1.2 69ch." }Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "invalid-request",
"error": "The request was invalid",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "answer-not-found",
"error": "The answer was not found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Get answer from questionPOST/help-center/answers
Ex: https://etl.virtuo.tools/fr/openai/answers
Errors
| code | http code | description |
|---|---|---|
| invalid-request | 400 | A parameter is missing in the request |
| search-hit-not-found | 404 | No document was found in ElasticSearch |
| question-not-found | 404 | The question was not found in ElasticSearch |
| answer-not-found | 404 | The answer was not found for this question |
| answer-not-finished | 404 | The answer was too long |
Help center contact ¶
Headers
Content-Type: application/jsonBody
{
"history": [
{
"content": "Quelle est la motorisation de la fiat 500 ?",
"role": "user"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"history": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "invalid-request",
"error": "The request was invalid",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "summary-not-found",
"error": "The summary was not found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Contact customer service after a conversation with the smart help centerPOST/help-center/contact
Creates a user note on Intercom with the summary of the conversation with the smart help center.
Errors
| code | http code | description |
|---|---|---|
| invalid-field | 400 | A parameter is missing in the request |
| invalid-request | 400 | A parameter is missing in the request |
| summary-not-found | 404 | The summary was not found |
| summary-not-finished | 404 | The summary response was too long |
Help center keywords ¶
Headers
Content-Type: application/jsonBody
{
"question": "Quelle est la motorisation de la fiat 500 ?"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"question": {
"type": "string"
}
},
"required": [
"question"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"keywords": [
"Fiat 500",
"Motorisation"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "invalid-request",
"error": "The request was invalid",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "keywords-not-found",
"error": "The keywords was not found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Get keywords from questionPOST/help-center/keywords
Ex: https://etl.virtuo.tools/fr/openai/keywords
Errors
| code | http code | description |
|---|---|---|
| invalid-request | 400 | A parameter is missing in the request |
| keywords-not-found | 404 | The keywords was not found |
| keywords-not-finished | 404 | The keywords response was too long |
Help center summary ¶
Headers
Content-Type: application/jsonBody
{
"history": [
{
"content": "Quelle est la motorisation de la fiat 500 ?",
"role": "user"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"history": {
"type": "array"
}
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"summary": "The customer asked what the engine specifications are for the Fiat 500."
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "invalid-request",
"error": "The request was invalid",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "summary-not-found",
"error": "The summary was not found",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Get summary from historyPOST/help-center/summary
Ex: https://etl.virtuo.tools/fr/openai/summary
Errors
| code | http code | description |
|---|---|---|
| invalid-request | 400 | A parameter is missing in the request |
| summary-not-found | 404 | The summary was not found |
| summary-not-finished | 404 | The summary response was too long |
Help center usefulness ¶
https://data.eu.amplitude.com/virtuo/Smart Help Center - Dev/events/main/latest
Headers
Content-Type: application/jsonBody
{
"question": "Quelle est la motorisation de la fiat 500 ?",
"answer": "La Fiat 500 est disponible avec une motorisation essence 1.2 69 ch.",
"locale": "fr",
"useful": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"question": {
"type": "string"
},
"answer": {
"type": "string"
},
"locale": {
"type": "string"
},
"useful": {
"type": "boolean"
}
},
"required": [
"question",
"answer",
"locale",
"useful"
]
}Headers
Content-Type: application/json; charset=utf-8Body
{
"useful": true
}Headers
Content-Type: application/json; charset=utf-8Body
{
"error_code": "invalid-request",
"error": "The request was invalid",
"status": "nok"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"error": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"error_code",
"error",
"status"
]
}Track answer usefulnessPOST/help-center/usefulness
Ex: https://etl.virtuo.tools/fr/openai/answers
Errors
| code | http code | description |
|---|---|---|
| invalid-request | 400 | A parameter is missing in the request |
Generated by aglio on 05 Feb 2026