Quotes

FL3XX API (1.0.0)

FL3XX API allows partners to access flight information, airport details, and a vast array of aviation services.

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.fl3xx.com
FL3XX Integration Support integrations@fl3xx.com
License MIT
Languages
Servers
Mock server
https://developer.fl3xx.com/_mock/reference/
Sandbox server
https://test.fl3xx.com/

Accounting

Operations related to accounting.

Operations

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

Operations related to aircraft.

Operations

Booking Itinerary (Legs)

Operations related to flight itinerary legs.

Operations

Crew

Operations related to crew details.

Operations

Empty Legs

Operations related to empty leg flights.

Operations

Flights

Operations related to flights.

Operations

Flight Animals

Operations related flight animals.

Operations

Flight Cargo

Operations related to flight cargo.

Operations

Flight Crew

Operations related to crew for individual flights.

Operations

Flight Fixed Base Operator (FBO)

Operations related to FBO.

Operations

Flight Fuels

Operations related to fuel for flights.

Operations

Flight Ground Services

Operations related to ground services.

Operations

Flight Luggage

Operations related to luggage for flights.

Operations

Flight Migration

Operations related to migrations.

Operations

Flight Notifications

Operations related to notifications for flights.

Operations

Flight Passengers

Operations related to passenger for flights.

Operations

Flight PAX Details

Operations related to PAX details.

Operations

Flight Planning Notes

Operations related to planning notes for flights.

Operations

Flight Post Flight

Operations related to post-flight activities.

Operations

Flight Pre Flight

Operations related to pre-flight operations.

Operations

Flight Sanction List

Operations related to flight sanctions and approvals.

Operations

Flight Travel Authorization

Operations related to travel authorization.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

Operations related to flight quotes.

Operations

Generate Quote

Request

Creates a new quote

Bodyapplication/json

quoteObject

aircraftstringrequired
customerobject(UserDto)required
customer.​externalReferencestring

External reference

Example: "665321646"
customer.​firstNamestring

First Name

Example: "Luke"
customer.​lastNamestring

Last name

Example: "Joe"
customer.​genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
customer.​birthDatestring(date)

Date of birth

Example: "1988-03-18"
customer.​birthPlacestring

Place of birth

Example: "Conroe"
customer.​acronymstring

Acronym

Example: "LJ"
customer.​birthCountrystring

Country of birth

Example: "US"
customer.​accountobject(AccountDto)
customer.​addressobject(AddressDto)
customer.​emailstring

Email address

Example: "myemail@fl3xx.com"
customer.​documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
customer.​documentExternalReferenceinteger(int64)

Document reference

Example: 69905
customer.​documentNumberstring

Document number

Example: "CC4AA3390294NJ"
customer.​documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
customer.​issueCountrystring

Country of issue

Example: "USA"
customer.​issueDatestring(date)

Issuance date

Example: "2020-04-02"
customer.​linksobject(Links)
customer.​logNamestring
customer.​mobilestring

Mobile phone number

Example: 1111111111
customer.​nationalitystring

Nationality

Example: "US"
customer.​personnelNumberstring

Personnel number

Example: 996659598
customer.​phonestring

Phone number

Example: 11111111111
customer.​radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
customer.​salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
customer.​siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
customer.​statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
customer.​weightnumber(float)

Weight

Example: 80.5
legsArray of objects(LegDto_3)required
legs[].​aircraftstring
legs[].​arrivalAirportstring
legs[].​arrivalAirportObjobject(AirportDto)
legs[].​arrivalDatestring
legs[].​arrivalDateUTCstring
legs[].​blockTimeinteger(int32)
legs[].​commentsstring
legs[].​crewArray of objects(FlightCrewDto_1)
legs[].​departureAirportstring
legs[].​departureAirportObjobject(AirportDto)
legs[].​departureDatestring
legs[].​departureDateUTCstring
legs[].​distancenumber(float)
legs[].​flightInfoobject(FlightInfo)
legs[].​flightTimeinteger(int32)
legs[].​fplTypestring
Enum"N""G""X""M""S"
legs[].​fuelStopboolean
legs[].​idstring
legs[].​notesstring
legs[].​paxinteger(int32)
legs[].​planningNotesstring
legs[].​postFlightClosedboolean
legs[].​requestedAircraftTypestring
Enum"CJ3""PC12""PC24""PC12/CJ3""PC12/PC24""CHART""SF50"
legs[].​seatsAfterinteger(int32)
legs[].​snapshotOfLegIdinteger(int64)
legs[].​statusstring
Enum"OK""CANCELED"
legs[].​taskTypestring
Enum"MAINTENANCE""RESERVED""AOG""CREW_UNAVAILABLE""NOTE""FLIGHT""UNSCHEDULED_MAINTENANCE""LOCATION"
legs[].​techStopboolean
legs[].​tripNumberinteger(int64)
legs[].​warningsArray of objects(WarningDto)
legs[].​workflowstring
Enum"COMMERCIAL""MAINTENANCE""PRIVATE""TRAINING""OWNER""INTERNAL""RESERVED""CHARTER""SUBCHARTER""SCHEDULED"
legs[].​workflowCustomNamestring
accountPriceobject(PriceDto)
autoCreatePosFlightsboolean
avinodeQuoteIdstring
bookingidinteger(int64)
commentstring
externalReferencestring
originstring
Enum"AVINODE""FAX""EMAIL""PHONE""WEB""EXTERNAL_DISPATCH""IMPORT""DISPATCH""FLY_EASY_MARKETPLACE""FLY_EASY_WEB"
priceobject(PriceDto)
quoteNumberstring
quotePriceobject(PriceDto)
rootBookingidinteger(int64)
salesPersonobject(UserDto)
sourcingBookingIdinteger(int64)
sourcingBookingReferencestring
workflowstring
Enum"COMMERCIAL""MAINTENANCE""PRIVATE""TRAINING""OWNER""INTERNAL""RESERVED""CHARTER""SUBCHARTER""SCHEDULED"
curl -i -X POST \
  https://developer.fl3xx.com/_mock/reference/api/external/quote \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "accountPrice": {
      "charterCost": 0,
      "currency": "USD",
      "exchangeRate": 1,
      "fet": 0,
      "gross": 141785,
      "invoiceDate": "2024-10-24T15:56",
      "invoiceNumber": "4568ASEF854",
      "net": 141785,
      "tax": 385,
      "vat": 0,
      "vatPerc": 0
    },
    "aircraft": "string",
    "autoCreatePosFlights": true,
    "avinodeQuoteId": "string",
    "bookingid": 0,
    "comment": "string",
    "customer": {
      "externalReference": "665321646",
      "firstName": "Luke",
      "lastName": "Joe",
      "gender": "MALE",
      "birthDate": "1988-03-18",
      "birthPlace": "Conroe",
      "acronym": "LJ",
      "birthCountry": "US",
      "account": {
        "accountNumber": 1111,
        "email": "email@fl3xx.com",
        "externalReference": "669665849-f120-4f65-6325-11111",
        "mobile": 111111111,
        "name": "Account",
        "notes": "Notes",
        "phone": 111111111,
        "vatNumber": "A11111111111",
        "address": {
          "buildingDetails": "14th",
          "city": "Lisbon",
          "country": "Portugal",
          "externalReference": "External ref",
          "latitude": 0.1,
          "links": {
            "empty": true
          },
          "longitude": 0.1,
          "recipient": "Recipient",
          "street": "My Street",
          "type": "WORK",
          "zip": 111111
        },
        "links": {
          "empty": true
        }
      },
      "address": {
        "buildingDetails": "14th",
        "city": "Lisbon",
        "country": "Portugal",
        "externalReference": "External ref",
        "latitude": 0.1,
        "links": {
          "empty": true
        },
        "longitude": 0.1,
        "recipient": "Recipient",
        "street": "My Street",
        "type": "WORK",
        "zip": 111111
      },
      "email": "myemail@fl3xx.com",
      "documentExpiration": "2030-04-03",
      "documentExternalReference": 69905,
      "documentNumber": "CC4AA3390294NJ",
      "documentType": "PASSPORT",
      "issueCountry": "USA",
      "issueDate": "2020-04-02",
      "links": {
        "empty": true
      },
      "logName": "string",
      "mobile": 1111111111,
      "nationality": "US",
      "personnelNumber": 996659598,
      "phone": 11111111111,
      "radiationProtectionRegistryId": 1112221112221,
      "salutation": "Mr",
      "siflType": "CONTROL",
      "status": "ACTIVE",
      "weight": 80.5
    },
    "externalReference": "string",
    "legs": [
      {
        "aircraft": "string",
        "arrivalAirport": "string",
        "arrivalAirportObj": {
          "aid": "APT-QAPF-UXNM",
          "faa": "null",
          "iata": "null",
          "icao": "OTBD",
          "id": 22024,
          "localIdentifier": "null",
          "name": "Doha International Airport"
        },
        "arrivalDate": "string",
        "arrivalDateUTC": "string",
        "blockTime": 0,
        "comments": "string",
        "crew": [
          {
            "crewPosition": {
              "id": 0,
              "role": "CMD",
              "name": "string",
              "code": "string",
              "crewType": "FLIGHT_DECK",
              "disableFtFdpCalculation": true,
              "assignable": true,
              "typeRatingRelated": true
            },
            "email": "string",
            "externalReference": "string",
            "firstName": "string",
            "gender": "FEMALE",
            "isPilotLanding": true,
            "isPilotTakeoff": true,
            "lastName": "string",
            "logName": "string",
            "luggageUnit": "KILOGRAM",
            "luggageWeight": 0.1,
            "middleName": "string",
            "mobile": "string",
            "personnelNumber": "string",
            "phone": "string",
            "pilotId": 0,
            "role": "string",
            "trigram": "string",
            "weight": 0.1,
            "weightUnit": "KILOGRAM"
          }
        ],
        "departureAirport": "string",
        "departureAirportObj": {
          "aid": "APT-QAPF-UXNM",
          "faa": "null",
          "iata": "null",
          "icao": "OTBD",
          "id": 22024,
          "localIdentifier": "null",
          "name": "Doha International Airport"
        },
        "departureDate": "string",
        "departureDateUTC": "string",
        "distance": 0.1,
        "flightInfo": {
          "dossierNumber": "string",
          "flightId": 0,
          "flightType": "CARGO",
          "referenceNumber": "string"
        },
        "flightTime": 0,
        "fplType": "N",
        "fuelStop": true,
        "id": "string",
        "notes": "string",
        "pax": 0,
        "planningNotes": "string",
        "postFlightClosed": true,
        "requestedAircraftType": "CJ3",
        "seatsAfter": 0,
        "snapshotOfLegId": 0,
        "status": "OK",
        "taskType": "MAINTENANCE",
        "techStop": true,
        "tripNumber": 0,
        "warnings": [
          {
            "type": "OK"
          }
        ],
        "workflow": "COMMERCIAL",
        "workflowCustomName": "string"
      }
    ],
    "origin": "AVINODE",
    "price": {
      "charterCost": 0,
      "currency": "USD",
      "exchangeRate": 1,
      "fet": 0,
      "gross": 141785,
      "invoiceDate": "2024-10-24T15:56",
      "invoiceNumber": "4568ASEF854",
      "net": 141785,
      "tax": 385,
      "vat": 0,
      "vatPerc": 0
    },
    "quoteNumber": "string",
    "quotePrice": {
      "charterCost": 0,
      "currency": "USD",
      "exchangeRate": 1,
      "fet": 0,
      "gross": 141785,
      "invoiceDate": "2024-10-24T15:56",
      "invoiceNumber": "4568ASEF854",
      "net": 141785,
      "tax": 385,
      "vat": 0,
      "vatPerc": 0
    },
    "rootBookingid": 0,
    "salesPerson": {
      "externalReference": "665321646",
      "firstName": "Luke",
      "lastName": "Joe",
      "gender": "MALE",
      "birthDate": "1988-03-18",
      "birthPlace": "Conroe",
      "acronym": "LJ",
      "birthCountry": "US",
      "account": {
        "accountNumber": 1111,
        "email": "email@fl3xx.com",
        "externalReference": "669665849-f120-4f65-6325-11111",
        "mobile": 111111111,
        "name": "Account",
        "notes": "Notes",
        "phone": 111111111,
        "vatNumber": "A11111111111",
        "address": {
          "buildingDetails": "14th",
          "city": "Lisbon",
          "country": "Portugal",
          "externalReference": "External ref",
          "latitude": 0.1,
          "links": {
            "empty": true
          },
          "longitude": 0.1,
          "recipient": "Recipient",
          "street": "My Street",
          "type": "WORK",
          "zip": 111111
        },
        "links": {
          "empty": true
        }
      },
      "address": {
        "buildingDetails": "14th",
        "city": "Lisbon",
        "country": "Portugal",
        "externalReference": "External ref",
        "latitude": 0.1,
        "links": {
          "empty": true
        },
        "longitude": 0.1,
        "recipient": "Recipient",
        "street": "My Street",
        "type": "WORK",
        "zip": 111111
      },
      "email": "myemail@fl3xx.com",
      "documentExpiration": "2030-04-03",
      "documentExternalReference": 69905,
      "documentNumber": "CC4AA3390294NJ",
      "documentType": "PASSPORT",
      "issueCountry": "USA",
      "issueDate": "2020-04-02",
      "links": {
        "empty": true
      },
      "logName": "string",
      "mobile": 1111111111,
      "nationality": "US",
      "personnelNumber": 996659598,
      "phone": 11111111111,
      "radiationProtectionRegistryId": 1112221112221,
      "salutation": "Mr",
      "siflType": "CONTROL",
      "status": "ACTIVE",
      "weight": 80.5
    },
    "sourcingBookingId": 0,
    "sourcingBookingReference": "string",
    "workflow": "COMMERCIAL"
  }'

Responses

Success

Bodyapplication/json
accountPriceobject(PriceDto)
aircraftstring

Aircraft registration

Example: "A7-XYZ"
aircraftObjobject(AircraftExtDto)
autoCreatePosFlightsboolean

When set to true the positioning flights will be included.

avinodeQuoteIdstring

Avinode RFQ id

Example: "A7BJU89"
bookingDateUTCstring(date-time)

The booking's date

bookingIdentifierstring

Booking identifier

Example: "SAEHD"
bookingidinteger(int64)

FL3XX's booking ID

Example: 5263654
commentstring

Notes about the booking

Example: "Booking comments"
createdDatestring(date-time)

Booking's creation date in milliseconds

customerobject(UserDto)
externalReferencestring
Example: ""
internalIdinteger(int64)
legsArray of objects(LegDto_2)
linksobject(Links)
originstring

Indicates what is the origin of the Quote

Enum"AVINODE""FAX""EMAIL""PHONE""WEB""EXTERNAL_DISPATCH""IMPORT""DISPATCH""FLY_EASY_MARKETPLACE""FLY_EASY_WEB"
Example: "DISPATCH"
postFlightClosedboolean

Indicates whether the Post Flight has been closed

Example: true
priceobject(PriceDto)
quoteNumberstring
Example: ""
quotePriceobject(PriceDto)
rootBookingidinteger(int64)
salesPersonobject(UserDto)
sourcingBookingIdinteger(int64)
sourcingBookingReferencestring
Example: ""
statusstring
Example: ""
tripNumberinteger(int64)
workflowstring

Indicates what is the type workflow of the leg

Enum"COMMERCIAL""MAINTENANCE""PRIVATE""TRAINING""OWNER""INTERNAL""RESERVED""CHARTER""SUBCHARTER""SCHEDULED"
Example: "CHARTER"
workflowCustomNamestring

Indicates what is the name of the leg's workflow

Example: "704"
Response
application/json
{
  "accountPrice": {
    "charterCost": 0,
    "currency": "USD",
    "exchangeRate": 1,
    "fet": 0,
    "gross": 141785,
    "invoiceDate": "2024-10-24T15:56",
    "invoiceNumber": "4568ASEF854",
    "net": 141785,
    "tax": 385,
    "vat": 0,
    "vatPerc": 0
  },
  "aircraft": "A7-XYZ",
  "aircraftObj": {
    "aircraftName": "G650",
    "ambulance": true,
    "aocNumber": "test-aoc-number",
    "bedsN": 3,
    "beltedToilet": false,
    "cabinCrew": 1,
    "cabinHeight": 1.85,
    "cabinLength": 14.76,
    "cabinWidth": 2.49,
    "cargo": true,
    "category": "ULTRA_LONG_RANGE_JET",
    "equipment": { … },
    "externalHeight": 0,
    "externalLength": 0,
    "flightNumberToken": "FLX001",
    "homebase": "LOWW",
    "id": 2141,
    "keyAccountManager": { … },
    "manufacturingDate": 2009,
    "maxFuel": 0,
    "model": "G-7 Gulfstream G500",
    "numberOfSeats": 13,
    "ownersApprovalRequired": false,
    "refurbished": 2016,
    "refurbishedInt": 2024,
    "status": "ACTIVE",
    "subcharter": false,
    "tailNumber": "A7-XYZ",
    "type": "GA5C",
    "typeName": "G650",
    "wingSpan": 0
  },
  "autoCreatePosFlights": true,
  "avinodeQuoteId": "A7BJU89",
  "bookingDateUTC": "2019-08-24T14:15:22Z",
  "bookingIdentifier": "SAEHD",
  "bookingid": 5263654,
  "comment": "Booking comments",
  "createdDate": "2019-08-24T14:15:22Z",
  "customer": {