Aircraft

FL3XX API (1.3.0)

Welcome to the FL3XX API

The FL3XX API provides seamless access to a comprehensive suite of aviation services, enabling partners to integrate and manage flight information, airport details, and a wide array of operational functionalities.

Key Features

  • Flight Information: Access detailed flight data, including schedules, crew assignments, and passenger details.
  • Airport Management: Retrieve information about airports, including ground services, fuel availability, and operational notes.
  • Aircraft Operations: Manage aircraft details, maintenance schedules, and pricing information.
  • Quotes and Bookings: Create, update, and manage quotes and bookings with ease, including multi-leg itineraries and pricing details.
  • Accounting: Handle accounting operations such as invoice management, payment processing, and general ledger entries.
  • Document Management: Download and upload documents related to flights, invoices, and other operational aspects.

Why Choose FL3XX API?

Our API is designed to provide robust and reliable integration capabilities, ensuring that your operations run smoothly and efficiently. With our extensive documentation and dedicated support, you can quickly integrate and start leveraging the full potential of the FL3XX platform.

Get Started

To begin your integration journey, visit our Getting Started guide and follow the step-by-step instructions. For any support or questions, feel free to reach out to our integration team at integrations@fl3xx.com.

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.fl3xx.com
FL3XX Integration Support integrations@fl3xx.com
License MIT
Languages
Servers
Test Server
https://test.fl3xx.com/

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

Get Fleet

Request

Fetches aircraft/fleet.

Query
datestring

Earliest aircraft modification in format 'YYYY-MM-DDThh:mm‘

Example: date=2024-09-28T22:00
curl -i -X GET \
  'https://test.fl3xx.com/api/external/aircraft?date=2024-09-28T22%3A00' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
ambulanceboolean

Indicates whether the aircraft is an ambulance or not

Example: true
aocobject(AocDto)
cabinHeightnumber(float)

Cabin height

Example: 1.8
cabinLengthnumber(float)

Cabin length

Example: 10
cabinWidthnumber(float)

Cabin width

Example: 2
cargoboolean

Indicates whether the aircraft is a cargo aircraft or not

categorystring

Category

Enum"PISTON""TURBO_PROP""VERY_LIGHT_JET""LIGHT_JET""SUPER_LIGHT_JET""MIDSIZE_JET""SUPER_MIDSIZE_JET""HEAVY_JET""ULTRA_LONG_RANGE_JET""VIP_JET"
Example: "PISTON"
equipmentobject(AircraftEquipmentDto)
externalHeightnumber(float)

External height

Example: 3
externalLengthnumber(float)

External length

Example: 20
flightNumberTokenstring

Flight number token

homebasestring

Homebase

Example: "LMML"
idinteger(int64)

FL3XX Aircraft ID

keyAccountManagerobject(UserDto)
layoutobject(AircraftLayoutDto)
linksobject(Links)
maxFuelnumber(float)

Max fuel

Example: 1000
maxPayloadnumber(float)

Maximum payload. Unit is kg (kilograms).

Example: 1000
maxRangenumber(float)

Maximum range at 0 payload. Unit is m/s (meters per second)

Example: 1000
minRunwaynumber(float)

Minimum runway

Example: 1000
modelstring

Model

Example: "Clipper"
normalCruiseSpeednumber(float)

Normal cruise speed in m/s (meters per second). Formula to find kt value based on the data returned -> Knots (kt) = Meters per second (m/s) * 1.944

Example: 0.8
numberOfSeatsinteger(int32)

Number of seats

Example: 3
subcharterboolean

Indicates whether the aircraft is subcharter or not

Example: true
tailNumberstring

Tail number

Example: "SX-HIC"
typestring

Type

Example: "R44"
typeNamestring

Type name

Example: "Robi 44"
typeOfUsestring

Type of use

Enum"CHARTER""PRIVATE"
Example: "PRIVATE"
typeRatingstring

Type rating

wingSpannumber(float)

Wing span

Example: 0
]
Response
application/json
[
  {
    "ambulance": true,
    "aoc": { … },
    "cabinHeight": 1.8,
    "cabinLength": 10,
    "cabinWidth": 2,
    "cargo": true,
    "category": "PISTON",
    "equipment": { … },
    "externalHeight": 3,
    "externalLength": 20,
    "flightNumberToken": "string",
    "homebase": "LMML",
    "id": 0,
    "keyAccountManager": { … },
    "layout": { … },
    "links": { … },
    "maxFuel": 1000,
    "maxPayload": 1000,
    "maxRange": 1000,
    "minRunway": 1000,
    "model": "Clipper",
    "normalCruiseSpeed": 0.8,
    "numberOfSeats": 3,
    "subcharter": true,
    "tailNumber": "SX-HIC",
    "type": "R44",
    "typeName": "Robi 44",
    "typeOfUse": "PRIVATE",
    "typeRating": "string",
    "wingSpan": 0
  }
]

Get Aircraft Picture

Request

Fetches an aircraft picture using the document's uuid.

Path
uuidstring(uuid)required

picture uuid

curl -i -X GET \
  'https://test.fl3xx.com/api/external/aircraft/picture/{uuid}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body

Get Aircraft Thumbnail Picture

Request

Fetches a thumbnail (100x100 px) of an aircraft picture using the document's UUID.

Path
uuidstring(uuid)required

picture uuid

curl -i -X GET \
  'https://test.fl3xx.com/api/external/aircraft/picture/{uuid}/thumbnail' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body

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

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations