Get Non-Booked Quotes

Accounting

These group of endpoints are designed to manage accounting operations such as invoice management, payment processing, and general ledger entries. These endpoints are essential for ensuring accurate financial records and efficient financial operations.

Key Features

Invoice Management: Create, retrieve, and update invoices.
Payment Processing: Handle payment transactions and manage payment records.
General Ledger: Access and update general ledger entries for comprehensive financial tracking.

Business Value

Financial Accuracy: Ensures accurate and up-to-date financial records, minimizing errors and discrepancies.
Operational Efficiency: Streamlines financial operations, reducing the time and effort required to manage accounting tasks.
Compliance: Helps meet regulatory requirements by maintaining detailed and accurate financial records.

Use Cases

Financial Management: Efficiently manage financial transactions and records, ensuring all financial data is current and accurate.
Audit Preparation: Maintain detailed financial records to facilitate audit processes and ensure compliance.
Budgeting and Forecasting: Use financial data to create budgets and forecast future financial performance.

Why Use These Endpoints

Utilizing the endpoints under the Accounting tag helps to streamline financial operations by ensuring data integrity and accuracy. They are essential tools for maintaining financial health and compliance within the organization.

Operations

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

These group of endpoints are designed to manage aircraft details, maintenance schedules, and pricing information. These endpoints are essential for ensuring the efficient operation and management of aircraft within the aviation industry.

Key Features

Details Management: Access and update detailed information about aircraft, including specifications and configurations.
Maintenance: Manage maintenance schedules and records to ensure aircraft are in optimal condition.
Pricing: Retrieve and update pricing information for aircraft operations and services.

Business Value

Operational Efficiency: Streamlines the management of aircraft details and maintenance, reducing downtime and operational disruptions.
Cost Management: Provides accurate and up-to-date pricing information, aiding in financial planning and cost control.
Compliance: Ensures that maintenance schedules and records are up-to-date, helping to meet regulatory requirements.

Use Cases

Fleet Management: Efficiently manage a fleet of aircraft, ensuring all details and maintenance records are current.
Maintenance Planning: Schedule and track maintenance activities to minimize aircraft downtime and ensure safety.
Financial Planning: Use pricing information to forecast operational costs and manage budgets effectively.

Why Use These Endpoints

Utilizing the endpoints under the Aircraft tag helps to streamline the management of aircraft operations by ensuring data integrity and accuracy. They are essential tools for maintaining operational efficiency and compliance within the aviation industry.

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

These endpoints are designed to manage passenger details for flights. They allow for the retrieval, updating, and deletion of passenger information associated with specific flight tickets.

Key Features

Passenger Management: Add, retrieve, update, and delete passenger details for flights.
Data Accuracy: Ensures that passenger information is accurate and up-to-date.

Business Value

Operational Efficiency: Streamlines the process of managing passenger information, reducing manual effort.
Customer Service: Enhances the ability to provide timely and accurate information to passengers and stakeholders.
Compliance: Helps maintain accurate records of passenger details for regulatory and operational purposes.

Use Cases

Flight Operations: Quickly access and manage passenger details for flight management and operations.
Customer Support: Assist passengers with inquiries about their flight details and ticket information.
Regulatory Compliance: Maintain accurate and up-to-date passenger records for each flight.

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

These endpoints are designed to manage travel authorization details for passengers on flights.

Key Features

Travel Authorization Status: Check and update the travel authorization status for passengers.

Business Value

Compliance: Helps to meet regulatory requirements.
Operational Efficiency: Streamlines the process of managing travel authorizations, reducing the time and effort required.
Risk Management: Minimizes the risk of travel disruptions due to missing or invalid travel documents.

Use Cases

Flight Operations Management: Review and manage travel authorization details for passengers on specific flights.
Customer Service: Assist passengers in ensuring they have the necessary travel documents for their journey.
Regulatory Compliance: Maintain accurate records of travel authorizations to meet regulatory requirements.

Why Use These Endpoints

The Flight Travel Authorization endpoints are essential tools for maintaining compliance and operational efficiency within the aviation industry.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

These group of endpoints are designed to manage the creation, retrieval, and updating of flight quotes. These endpoints are essential for streamlining the quoting process, ensuring accuracy, and enhancing operational efficiency.

Key Features

Creation: Generate new quotes with detailed information.
Retrieval: Access existing quotes and their details.
Updating: Modify existing quotes to reflect changes in requirements or pricing.
Notification: Automatically notify operators upon successful quote creation or updates.

Business Value

Efficiency: Streamlines the quote management process, reducing the time and effort required to handle quotes.
Accuracy: Ensures data integrity and accuracy, minimizing errors and discrepancies in quotes.
Automation: Automates the notification process, keeping operators informed in real-time.

Use Cases

Sales Teams: Quickly generate accurate quotes for potential clients, improving response times and customer satisfaction.
Operations Management: Ensure that all quotes are properly formatted and complete before proceeding with further actions.
Financial Planning: Use the generated quotes to forecast revenue and manage financial expectations.

Why Use These Endpoints?

Utilizing the endpoints under the Quotes tag helps to streamline the quote management process by ensuring data integrity and accuracy. They are essential tools for managing quotes efficiently and effectively.

Operations

Generate Quote

Request

This endpoint allows you to create a new quote and notifies the operator.

Key Features

Creation: Generates a new quote with the provided details.
Notification: Notifies the operator upon successful quote creation.

Why Use This Endpoint?

Using this endpoint helps to streamline the quote creation process, it is an essential tool for managing quotes efficiently and effectively.

Account Selection Logic

When submitting a quote, the system will attempt to create or pick the account provided in the following order:

Account ID: If customer.account.accountid is provided and valid, the account is retrieved using the ID.
External Reference: If no account is found, the system will search for an account using the customer.account.externalReference field.
Account Name: If no account is found, the system will search for an account using the customer.account.name field.
Account Number: If both customer.account.name and customer.account.accountNumber fields are provided, the system will attempt to find a match.
User Full Name: If no account is found by the above methods, the system will search for an account using the user's full name (concatenation offirstName and lastName).

Pricing Engine Note

When the aircraft uses the pricing engine, a price will only be returned if the request satisfies the pricing rules defined by the operator. If no applicable pricing rule is matched, the returned price will be 0.

To ensure accurate pricing, it is recommended to contact the operator directly for details on the specific conditions required for price calculation.

Security

API_AUTHENTICATION

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)

sourcingBookingIdinteger(int64)

sourcingBookingReferencestring

workflowstring

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

curl -i -X POST \
  https://test.fl3xx.com/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,
    "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

Status

Possible values:

R: New Request.
a: New Avinode Request.
W: New Web Request.
Q: Quote (= Request that has been answered).
A: Accepted Quote.
O: Owner’s Approval pending (if applicable).
S: Signed.
B: Booking.
F: Flights pending (everything else is done).
C: Canceled Quote/ Booking.
D: Dropped (when the flights of an unanswered Request are in the past, the Request is Dropped automatically).

Enum"R""a""W""Q""A""O""S""B""F""C"

Example: "B"

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": {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  },
  "externalReference": "",
  "internalId": 0,
  "legs": [
    { … }
  ],
  "links": {
    "empty": true
  },
  "origin": "DISPATCH",
  "postFlightClosed": true,
  "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": "",
  "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": {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  },
  "sourcingBookingId": 0,
  "sourcingBookingReference": "",
  "status": "B",
  "tripNumber": 0,
  "workflow": "CHARTER",
  "workflowCustomName": "704"
}

Get Non-Booked Quotes

Request

Fetches a list of quotes that have not been booked.

Security

API_AUTHENTICATION

Query

customerAccountIdinteger(int64)

Customer account filter. Returns quotes ordered by the customer account

customerIdinteger(int64)

Customer filter. Returns quotes ordered by the customer

lastRequeststring(date-time)

The date when the last request was loaded. If not defined then 24 hours before now will be used

pageinteger(int32)

Page number. In case request returns more than 1 page

sizeinteger(int32)

Size of the page. Must be limited to 50 items.

Example: size=10

curl -i -X GET \
  'https://test.fl3xx.com/api/external/quote/notbooked?customerAccountId=0&customerId=0&lastRequest=2019-08-24T14%3A15%3A22Z&page=0&size=10' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

contentArray of objects(BookingDto)

emptyboolean

firstboolean

lastboolean

numberinteger(int32)

numberOfElementsinteger(int32)

pageableobject(Pageable)

sizeinteger(int32)

sortobject(Sort)

totalElementsinteger(int64)

totalPagesinteger(int32)

Response

application/json

{
  "content": [
    { … }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": { … },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Create a Booked Quote

Request

This endpoint allows you to create a new booked quote and notifies the operator.

Key Features

Creation: Generates a new quote with the provided details.
Notification: Notifies the operator upon successful quote creation.

Why Use This Endpoint?

Using this endpoint helps to streamline the quote creation process, it is an essential tool for managing quotes efficiently and effectively.

Account Selection Logic

When submitting a quote, the system will attempt to create or pick the account provided in the following order:

Account ID: If customer.account.accountid is provided and valid, the account is retrieved using the ID.
External Reference: If no account is found, the system will search for an account using the customer.account.externalReference field.
Account Name: If no account is found, the system will search for an account using the customer.account.name field.
Account Number: If both customer.account.name and customer.account.accountNumber fields are provided, the system will attempt to find a match.
User Full Name: If no account is found by the above methods, the system will search for an account using the user's full name (concatenation offirstName and lastName).

Pricing Engine Note

When the aircraft uses the pricing engine, a price will only be returned if the request satisfies the pricing rules defined by the operator. If no applicable pricing rule is matched, the returned price will be 0.

To ensure accurate pricing, it is recommended to contact the operator directly for details on the specific conditions required for price calculation.

Security

API_AUTHENTICATION

Bodyapplication/json

Quote

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)

sourcingBookingIdinteger(int64)

sourcingBookingReferencestring

workflowstring

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

curl -i -X POST \
  https://test.fl3xx.com/api/external/quote/book \
  -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,
    "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

Status

Possible values:

R: New Request.
a: New Avinode Request.
W: New Web Request.
Q: Quote (= Request that has been answered).
A: Accepted Quote.
O: Owner’s Approval pending (if applicable).
S: Signed.
B: Booking.
F: Flights pending (everything else is done).
C: Canceled Quote/ Booking.
D: Dropped (when the flights of an unanswered Request are in the past, the Request is Dropped automatically).

Enum"R""a""W""Q""A""O""S""B""F""C"

Example: "B"

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": {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  },
  "externalReference": "",
  "internalId": 0,
  "legs": [
    { … }
  ],
  "links": {
    "empty": true
  },
  "origin": "DISPATCH",
  "postFlightClosed": true,
  "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": "",
  "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": {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  },
  "sourcingBookingId": 0,
  "sourcingBookingReference": "",
  "status": "B",
  "tripNumber": 0,
  "workflow": "CHARTER",
  "workflowCustomName": "704"
}

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations

FL3XX API (1.5.0)

Platform Overview

Flight Information

Airport Management

Aircraft Operations

Quotes & Bookings

Accounting

Document Management

Accounting

Accounts

Airports

Aircraft

Booking Itinerary (Legs)

Crew

Empty Legs

Flights

Flight Animals

Flight Cargo

Flight Crew

Flight Fixed Base Operator (FBO)

Flight Fuels

Flight Ground Services

Flight Luggage

Flight Migration

Flight Notifications

Flight Passengers

Flight PAX Details

Flight Planning Notes

Flight Post Flight

Flight Pre Flight

Flight Sanction List

Flight Travel Authorization

Flight Tickets

Quotes

Generate Quote

RequestExpand all

Responses

Get Non-Booked Quotes

Request

Responses

Create a Booked Quote

RequestExpand all

Responses

Roster

Users

Request

Request