# FL3XX API

Platform Overview

The FL3XX API provides seamless access to a comprehensive suite of aviation services, enabling partners to integrate and manage flight information, airport details, and operational functionalities. Built with performance and reliability in mind, our API serves as the foundation for your aviation technology infrastructure.

Flight Information

Access detailed flight data, including schedules, crew assignments, passenger details, and real-time updates.

Airport Management

Retrieve information about airports, including ground services, fuel availability, and operational notes.

Fleet Operations

Manage aircraft assets, maintenance schedules, and operational fleet utilization.

Quotes & Bookings

Create, update, and manage quotes and bookings with flexible pricing and multi-sector support.

Financial Operations

Handle invoicing, payments, financial reporting, and integrated accounting workflows.

Document Management

Handle document processing, categorization, and seamless workflow integration.

Version: 1.8.0 License: MIT ## Servers Test Server ``` https://test.fl3xx.com ``` ## Security ### API_AUTHENTICATION Type: apiKey In: header Name: X-Auth-Token ## Download OpenAPI description [FL3XX API](https://developer.fl3xx.com/_bundle/reference/@v1/index.yaml) ## Accounting This group of endpoints is 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. ### Get an Accounting Document - [GET /api/external/accounting/attachments/{uuid}](https://developer.fl3xx.com/reference/accounting/getaccountingdocumentbyuuid.md): Get an accounting document using its UUID. ### Get Bookings - [GET /api/external/quote/bookings](https://developer.fl3xx.com/reference/accounting/getbookings.md): Searches for bookings using the provided filters. ### Get a Booking - [GET /api/external/accounting/booking/{reference}](https://developer.fl3xx.com/reference/accounting/getaccountentriesbybookingid.md): Fetches details of a booking using its ID. ### Get Invoices - [GET /api/external/accounting/booking/{reference}/invoices](https://developer.fl3xx.com/reference/accounting/getbookinginvoicesbybookingid.md): Fetches all invoices associated with a specific booking. ### Get Split Pricing - [GET /api/external/accounting/booking/{reference}/split](https://developer.fl3xx.com/reference/accounting/getbookingsplitinfobybookingid.md): Fetches split pricing information (cost, owner share, profitability) for a specific booking. ### Add GL Code to Account Entry - [PUT /api/external/accounting/{accountEntryId}](https://developer.fl3xx.com/reference/accounting/putaccountcodetoaccountentry.md): Adds a General Ledger (GL) code to an existing account entry identified by its ID. ### Get Invoice Payments - [GET /api/external/accounting/invoice-payments](https://developer.fl3xx.com/reference/accounting/getinvoicepayments.md): Fetches payments associated with a booking and/or invoice. ### Creates an Invoice Payment - [POST /api/external/accounting/invoice-payments](https://developer.fl3xx.com/reference/accounting/postinvoicepayment.md): Creates a new payment associated with a booking and/or invoice. ### Get an Invoice Payment - [GET /api/external/accounting/invoice-payments/{paymentId}](https://developer.fl3xx.com/reference/accounting/getinvoicepaymentbyid.md): Retrieves a booking and/or invoice payment by its ID. ### Update an Invoice Payment - [PUT /api/external/accounting/invoice-payments/{paymentId}](https://developer.fl3xx.com/reference/accounting/putinvoicepaymentbyid.md): Updates a booking and/or invoice payment information. ### Delete an Invoice Payment - [DELETE /api/external/accounting/invoice-payments/{paymentId}](https://developer.fl3xx.com/reference/accounting/deleteinvoicepaymentbyid.md): Deletes a booking and/or invoice payment. ### Add Invoice Payment Document - [POST /api/external/accounting/invoice-payments/{paymentId}/documents](https://developer.fl3xx.com/reference/accounting/postinvoicepaymentdocument.md): Associates a (PDF, JPG, PNG or JPEG) file to a booking and/or invoice payment. ### Get Invoice Payment Document - [GET /api/external/accounting/invoice-payments/{paymentId}/documents/{uuid}](https://developer.fl3xx.com/reference/accounting/getinvoicepaymentdocumentbyuuid.md): Fetches a document associated with a booking and/or invoice payment by its UUID. ### Delete Invoice Payment Document - [DELETE /api/external/accounting/invoice-payments/{paymentId}/documents/{uuid}](https://developer.fl3xx.com/reference/accounting/deleteinvoicepaymentdocumentbyuuid.md): Deletes a document associated with a booking and/or invoice payment by its UUID. ### Get Crew expenses - [GET /api/external/crew-expenses](https://developer.fl3xx.com/reference/accounting/getcrewexpenses.md): This endpoint allows users to retrieve a list of expenses associated with crew members. It provides detailed information about each expense, including the type, amount, date, and associated crew member. Important Filtering Rules: - Only expenses where the crew member has been set in the 'Reimbursable To' field will be returned. - LANDING and PARKING expense types are intentionally excluded and will never appear in results. - Most expense types require proper linking to related records (flights, users, duties, aircraft, etc.) to be included. Expenses with missing or broken links will be excluded. - Expense types that are always returned (no linking required): NAVIGATION_FEE, VIP_LOUNGE, PER_DIEMS. For a complete guide on which expense types are returned and why some expenses may be missing, see the Crew Expenses Guide. Example Use Case: A finance manager wants to review all expenses submitted by crew members for a specific month. By using this endpoint, they can fetch a comprehensive list of expenses, filter them by date, and analyze the data to ensure all expenses are accounted for and within the budget. ### Download Crew Expense Document - [GET /api/external/crew-expenses/{crewExpenseId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/accounting/getcrewexpensedocument.md): This endpoint allows users to download a document associated with a specific crew expense. It requires the crewExpenseId and documentUuid as path parameters to identify the specific document to be downloaded. Example Use Case: A finance manager needs to review the receipts submitted by a crew member for a specific expense. By using this endpoint, they can download the receipt document associated with the crew expense for further review and verification. ### Get Accounting Projects - [GET /api/external/accounting-projects](https://developer.fl3xx.com/reference/accounting/accountingprojectsget.md): This endpoint retrieves a paginated list of accounting projects. It allows users to manage and access project details efficiently, supporting financial tracking and project organization. 🔒 Required permission: ACCOUNTING_PROJECT_API:read Example Use Case: A finance manager can use this endpoint to retrieve a list of accounting projects for review, ensuring all projects are tracked and managed effectively. ### Create an Accounting Project - [POST /api/external/accounting-projects](https://developer.fl3xx.com/reference/accounting/accountingprojectspost.md): This endpoint allows users to create a new accounting project. It supports financial tracking and project organization by enabling the addition of project details. 🔒 Required permission: ACCOUNTING_PROJECT_API:create Example Use Case: A finance manager can use this endpoint to create a new accounting project, ensuring all financial activities are properly tracked and managed. ### Update an Accounting Project - [PUT /api/external/accounting-projects/{projectId}](https://developer.fl3xx.com/reference/accounting/accountingprojectsput.md): This endpoint allows users to update an existing accounting project. It supports financial tracking and project organization by enabling modifications to project details. 🔒 Required permission: ACCOUNTING_PROJECT_API:write Example Use Case: A finance manager can use this endpoint to update details of an accounting project, ensuring all financial activities are properly tracked and managed. ## Accounts Operations related to accounts. ### Get Accounts - [GET /api/external/user/account](https://developer.fl3xx.com/reference/accounts/getaccounts.md): Fetches a list of accounts. ### Creates an account - [POST /api/external/user/account](https://developer.fl3xx.com/reference/accounts/postaccount.md): Creates a new account ### Get an Account - [GET /api/external/user/account/{externalReference}](https://developer.fl3xx.com/reference/accounts/getaccountbyreference.md): Fetches details of an account using its externalReference ### Update an account - [PUT /api/external/user/account/{externalReference}](https://developer.fl3xx.com/reference/accounts/putaccount.md): Updates an existing account using its externalReference ### Delete an account - [DELETE /api/external/user/account/{externalReference}](https://developer.fl3xx.com/reference/accounts/deleteaccount.md): Deletes (makes inactive) an existing account using its reference ## Airports Access and manage airport information. ### Get an Airport - [GET /api/external/airports/{airportCode}](https://developer.fl3xx.com/reference/airports/getairportbycode.md): Fetches details of an airport using its ICAO, IATA, or FAA code. ### Get Ground Handling/FBO Services - [GET /api/external/airports/{airportCode}/agents](https://developer.fl3xx.com/reference/airports/getairportagents.md): Fetches a list of Ground Handling/FBO services associated with an airport using its ICAO, IATA, or FAA code. ### Get Airport Costs - [GET /api/external/airports/{airportCode}/costs](https://developer.fl3xx.com/reference/airports/getairportcost.md): Fetches costs associated with an airport using its ICAO, IATA, or FAA code. ### Get Airport Crew - [GET /api/external/airports/{airportCode}/crew](https://developer.fl3xx.com/reference/airports/getairportcrew.md): Fetches a list of crew members associated with an airport using its ICAO, IATA, or FAA code. ### Get Airport Documents - [GET /api/external/airports/{airportCode}/docs](https://developer.fl3xx.com/reference/airports/getairportdocuments.md): Fetches a list of documents associated with an airport using its ICAO, IATA, or FAA code. ### Get Airport Document - [GET /api/external/airports/{airportCode}/docs/{documentEadId}](https://developer.fl3xx.com/reference/airports/getairportdocsbyairportcodeanddocid.md): Fetches a base64-encoded file of an airport document using its EAD ID. ### Get Airport Fuels - [GET /api/external/airports/{airportCode}/fuels](https://developer.fl3xx.com/reference/airports/getairportfuelsbyairportcode.md): Fetches a list of fuels available at an airport using its ICAO, IATA, or FAA code. ### Get Shared Fuels - [GET /api/external/airports/{airportCode}/fuels/shared/{operatorId}](https://developer.fl3xx.com/reference/airports/getairportsharedfuels.md): Fetches a list of shared fuels available at an airport using the operator ID and the airport's ICAO, IATA, or FAA code. ### Get Airport Location - [GET /api/external/airports/{airportCode}/location](https://developer.fl3xx.com/reference/airports/getairportlocationbyairportcode.md): Fetches the location details of an airport using its ICAO, IATA, or FAA code. ### Get an Airport Operational Note - [GET /api/external/airports/{airportCode}/operationalNote/{id}](https://developer.fl3xx.com/reference/airports/getairportoperationalnotebyairportcodeandoperationalnoteid.md): Fetches the operational note of an airport using its ICAO, IATA, or FAA code. ### Get Operational Notes - [GET /api/external/airports/{airportCode}/operationalNotes](https://developer.fl3xx.com/reference/airports/getairportoperationalnotesbetweenusingget.md): Fetches a list of operational notes associated with an airport using its ICAO, IATA, or FAA code. ### Get Airport Providers - [GET /api/external/airports/{airportCode}/providers/{name}](https://developer.fl3xx.com/reference/airports/getairportprovidersusingget.md): Fetches a list of providers associated with an airport using its ICAO, IATA, or FAA code and the provider's name. ### Get Airport Services - [GET /api/external/airports/{airportCode}/services](https://developer.fl3xx.com/reference/airports/getairportservicesbyairportcode.md): Fetches a list of services available at an airport using its ICAO, IATA, or FAA code. ### Search Airport Services - [GET /api/external/airports/{airportCode}/services/{name}](https://developer.fl3xx.com/reference/airports/getairportservicesbyairportcodeandservicename.md): Fetches a list of services available at an airport using its ICAO, IATA, or FAA code and the service's name. ## Aircraft This group of endpoints is 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. ### Get Fleet - [GET /api/external/aircraft](https://developer.fl3xx.com/reference/aircraft/getaircraft.md): Fetches the list of aircraft in the fleet. ### Get Aircraft Picture - [GET /api/external/aircraft/picture/{uuid}](https://developer.fl3xx.com/reference/aircraft/getaircraftpicture.md): Fetches an aircraft picture using the document's uuid. ### Get Aircraft Thumbnail Picture - [GET /api/external/aircraft/picture/{uuid}/thumbnail](https://developer.fl3xx.com/reference/aircraft/loadthumbnailusingget.md): Fetches a thumbnail (100x100 px) of an aircraft picture using the document's UUID. ### Get an Aircraft - [GET /api/external/aircraft/{tailNumber}](https://developer.fl3xx.com/reference/aircraft/getaircraftbyid.md): Fetches details of an aircraft using its tail number. ### Get Aircraft Hold Items - [GET /api/external/aircraft/{tailNumber}/holditems](https://developer.fl3xx.com/reference/aircraft/getaircraftholditems.md): Fetches hold items associated with an aircraft using its tail number. ### Get Aircraft Pricing - [GET /api/external/aircraft/{tailNumber}/pricing](https://developer.fl3xx.com/reference/aircraft/getaircraftpricingdetails.md): Fetches pricing details of an aircraft using its tail number. ### Get Aircraft Schedule - [GET /api/external/aircraft/{tailNumber}/schedule](https://developer.fl3xx.com/reference/aircraft/getaircraftschedule.md): Fetches the schedule of an aircraft using its tail number. Limited to 60 days in the past and 60 days in the future. If an invalid date is provided, the default (-60 or +60) days will be returned. Aircraft tasks in FL3XX represent events that occur at a single location. This includes activities like maintenance, AOG (Aircraft On Ground) situations, and crew unavailability. Example: If you're scheduling maintenance for an aircraft at Rome's Fiumicino Airport, you would enter the following: * Departure Airport: Fiumicino (FCO) * Departure Time: The date and time the maintenance starts. * Arrival Airport: Fiumicino (FCO) * Arrival Time: The date and time the maintenance is expected to end. ### Get Aircraft Maintenance Schedule by Aircraft ID - [GET /api/external/aircraft/{aircraftId}/maintenanceSchedules](https://developer.fl3xx.com/reference/aircraft/getaircraftmaintenanceschedules.md): Fetches the maintenance schedule of an aircraft using its ID. ### Update Aircraft Maintenance Schedule - [PUT /api/external/aircraft/{aircraftId}/maintenanceSchedules](https://developer.fl3xx.com/reference/aircraft/putaircraftmaintenanceschedules.md): Updates the maintenance schedule of an aircraft. ### Delete Aircraft Maintenance Schedule - [DELETE /api/external/aircraft/{aircraftId}/maintenanceSchedules/{maintenanceScheduleId}](https://developer.fl3xx.com/reference/aircraft/deleteaircraftmaintenanceschedules.md): Deletes an aircraft maintenance schedule by aircraft ID and maintenance schedule ID. ## Booking Itinerary (Legs) Operations related to flight itinerary legs. ### Get Booking Itinerary - [GET /api/external/leg/{reference}](https://developer.fl3xx.com/reference/booking-itinerary-(legs)/getbookinglegsbybookingreference.md): Fetches the itinerary (legs) of a booking using its quoteId. ### Submit Booking Itinerary - [POST /api/external/leg/{reference}](https://developer.fl3xx.com/reference/booking-itinerary-(legs)/postbookinglegsbybookingreference.md): Submits the itinerary (legs) of a booking using its quoteId. ### Update Booking Itinerary - [PUT /api/external/leg/{reference}/{flightId}](https://developer.fl3xx.com/reference/booking-itinerary-(legs)/putbookinglegsbybookingreferenceandflightid.md): Updates the itinerary (legs) of a booking using its quoteId and flight ID. ### Delete Booking Itinerary - [DELETE /api/external/leg/{reference}/{flightId}](https://developer.fl3xx.com/reference/booking-itinerary-(legs)/deletebookinglegsbybookingreferenceandflightid.md): Deletes the itinerary (legs) of a booking using its quote ID and flight ID. ## Crew Operations related to crew details. ### Get Crew - [GET /api/external/staff/crew](https://developer.fl3xx.com/reference/crew/getstaffcrew.md): Fetches information about the crew. ### Get a Crew Member - [GET /api/external/staff/crew/{reference}](https://developer.fl3xx.com/reference/crew/getcrewbyreference.md): Fetches crew information using a specific reference. ### Search a crew member - [GET /api/external/user/crew](https://developer.fl3xx.com/reference/crew/getcrewmembers.md): Fetches information about a crew member. Must provide either the externalReference or the pilotId ## Crew Qualifications Manage crew qualifications and certifications. These endpoints enable partners to assign, update, and manage crew member qualifications including licenses, certifications, and associated documents. **Business Value** - Maintain accurate crew qualification records for compliance and safety. - Streamline qualification assignment and management processes. - Support document management for qualification certificates and licenses. - Ensure crew members meet operational requirements and regulations.
**Use Cases** - Assign new qualifications to crew members with license details and expiration dates. - Update existing qualification information including license numbers and issuing authorities. - Upload and manage qualification documents such as certificates and licenses. - Retrieve qualification information for crew members and compliance reporting. - Delete obsolete qualifications and associated documents.
For more information on managing crew qualifications, see the [Crew Qualification Management Guide](/guides/guides/crew-qualification). **Note:** > All crew qualification operations are bound to the operator context associated with the authentication token. Partners can only manage qualifications for crew members within their organization. ### Get crew qualifications - [GET /api/external/crew-qualifications](https://developer.fl3xx.com/reference/crew-qualifications/getcrewqualifications.md): Retrieve crew qualifications with pagination and filtering capabilities. Features: - Filter by crew ID (required) - Paginated results Example Use Case: An operations manager needs to retrieve all qualifications for a specific crew member to verify compliance status and upcoming expiration dates. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Assign a qualification to a crew member - [POST /api/external/crew-qualifications](https://developer.fl3xx.com/reference/crew-qualifications/assignqualificationtocrew.md): Assign a new qualification to a crew member with license details, expiration dates, and other relevant information. Features: - Validates required fields including crew ID and qualification ID - Supports license numbers, issuing authorities, and country information - Handles pilot-in-command designations and base month calculations Example Use Case: An operations manager needs to assign a new type rating qualification to a pilot after completing training. This endpoint allows them to create the qualification record with all necessary details. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Get a crew qualification by ID - [GET /api/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/crew-qualifications/getcrewqualificationbyid.md): Retrieve detailed information about a specific crew qualification including associated documents. Features: - Returns complete qualification details including document references - Includes creation and update timestamps Example Use Case: An operations manager needs to review the complete details of a specific qualification, including any uploaded documents, to verify compliance or prepare for audits. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Update a crew qualification by ID - [PATCH /api/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/crew-qualifications/updatecrewqualificationbyid.md): Updates an existing crew qualification with new information. Features: - Updates qualification details including license numbers and dates - Supports partial updates of qualification information Example Use Case: An operations manager needs to update a qualification after a license renewal or when additional information becomes available. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Delete a crew qualification by ID - [DELETE /api/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/crew-qualifications/deletecrewqualificationbyid.md): Deletes a crew qualification and removes it from the system. Features: - Permanently removes the qualification record - Returns confirmation of deletion Example Use Case: An operations manager needs to remove an obsolete qualification that is no longer valid or relevant for a crew member. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Get document associated with a crew qualification - [GET /api/external/crew-qualifications/{crewQualificationId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/crew-qualifications/getcrewqualificationdocument.md): Download a document associated with a crew qualification. Features: - Downloads the actual document file - Validates document ownership and access permissions Example Use Case: An operations manager needs to download a qualification certificate or license document for verification or compliance purposes. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Upload document associated with a crew qualification - [POST /api/external/crew-qualifications/{crewQualificationId}/documents](https://developer.fl3xx.com/reference/crew-qualifications/uploadcrewqualificationdocument.md): Upload a document file to be associated with a crew qualification. Features: - Supports various document formats - Associates the document with the specific qualification - Returns document metadata including UUID for future access Example Use Case: An operations manager needs to upload a scanned copy of a pilot's license or certificate to maintain digital records for compliance and verification. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Delete document associated with a crew qualification - [DELETE /api/external/crew-qualifications/{crewQualificationId}/documents/{uuid}](https://developer.fl3xx.com/reference/crew-qualifications/deletecrewqualificationdocument.md): Deletes a document associated with a crew qualification. Features: - Permanently removes the document file - Returns confirmation of deletion Example Use Case: An operations manager needs to remove an outdated or incorrect document that was previously uploaded for a qualification. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Get qualification types - [GET /api/external/qualification-types](https://developer.fl3xx.com/reference/crew-qualifications/getqualificationtypes.md): Retrieve available qualification types and their details for use in crew qualification assignments. Features: - Returns paginated list of available qualifications - Includes qualification metadata and configuration Example Use Case: An operations manager needs to see all available qualification types in the system to properly assign qualifications to crew members. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ### Get qualification type by ID - [GET /api/external/qualification-types/{id}](https://developer.fl3xx.com/reference/crew-qualifications/getqualificationtypebyid.md): Retrieve detailed information about a specific qualification type. Features: - Returns complete qualification configuration and metadata - Includes validity periods, grace periods, and relation information Example Use Case: An operations manager needs to understand the specific requirements and configuration of a qualification type before assigning it to a crew member. For more information on managing crew qualifications, see the Crew Qualification Management Guide. ## Empty Legs Operations related to empty leg flights. ### Get Empty Legs - [GET /api/external/quote/legs/empty](https://developer.fl3xx.com/reference/empty-legs/getemptylegs.md): Fetches a list of empty legs made available by the operator. ## Flights Operations related to flights. ### Get Flights - [GET /api/external/flight/flights](https://developer.fl3xx.com/reference/flights/getflights.md): Fetches a list of flights between two specified dates. ### Get a Flight - [GET /api/external/flight/{flightId}](https://developer.fl3xx.com/reference/flights/getflightbyid.md): Fetches detailed information about a specific flight using its ID. ## Flight Animals Operations related to flight animals. ### Get Flight Animals - [GET /api/external/flight/{id}/pax_details/animal](https://developer.fl3xx.com/reference/flight-animals/getflightanimalsbyflightid.md): Fetches animal information for a specific flight using its ID. ### Update Flight Animals - [PUT /api/external/flight/{id}/pax_details/animal](https://developer.fl3xx.com/reference/flight-animals/putflightanimalsbyflightid.md): Updates a list of animal information for a specific flight using its flight ID. ### Delete Flight Animals - [DELETE /api/external/flight/{id}/pax_details/animal](https://developer.fl3xx.com/reference/flight-animals/deleteflightanimalsbyflightid.md): Deletes animal information for a specific flight using its flight ID. ## Flight Cargo Operations related to flight cargo. ### Get Flight Cargo - [GET /api/external/flight/{id}/pax_details/cargo](https://developer.fl3xx.com/reference/flight-cargo/getflightcargobyflightid.md): Fetches a list of cargo information for a specific flight using its flight ID. ### Update Flight Cargo - [PUT /api/external/flight/{id}/pax_details/cargo](https://developer.fl3xx.com/reference/flight-cargo/putflightcargobyflightid.md): Updates cargo information for a specific flight using its flight ID. ### Delete Flight Cargo - [DELETE /api/external/flight/{id}/pax_details/cargo](https://developer.fl3xx.com/reference/flight-cargo/deleteflightcargobyflightid.md): Deletes cargo information for a specific flight using its flight ID. ## Flight Crew Operations related to crew for individual flights. ### Get Flight Crew - [GET /api/external/flight/{flightId}/crew](https://developer.fl3xx.com/reference/flight-crew/getflightcrew.md): Fetches a list of crew members assigned to a specific flight using its flight ID. ### Assign Crew to Flight - [POST /api/external/flight/{flightId}/crew](https://developer.fl3xx.com/reference/flight-crew/createflightcrew.md): Assigns a list of crew members to a specific flight using its flight ID. Required Fields: - pilotId: The unique identifier of the pilot/crew member (or use externalReference or logName as alternatives) - role: The crew role (see enum values in schema) Optional Fields: All other fields are optional. Additional crew information (firstName, lastName, email, etc.) is only used when updateCrewUsers=true (default) to create or update user records. Note: The crewPosition field is optional and not used during assignment. The system determines positions based on the role field and aircraft configuration. ## Flight Fixed Base Operator (FBO) Operations related to FBO. ### Update Flight FBO - [PUT /api/external/flight/{flight}/services/FBO/{target}](https://developer.fl3xx.com/reference/flight-fixed-base-operator-(fbo)/putflightservicefnobyflightidandservicetarget.md): Updates the Fixed Base Operator (FBO) service for a specific flight using its flight ID and service target. ### Delete Flight FBO - [DELETE /api/external/flight/{flight}/services/FBO/{target}](https://developer.fl3xx.com/reference/flight-fixed-base-operator-(fbo)/deleteflightservicefnobyflightidandservicetarget.md): Deletes the Fixed Base Operator (FBO) service for a specific flight using its flight ID and service target. ## Flight Fuels Operations related to fuel for flights. ### Get Flight Fuels - [GET /api/external/flight/{flightId}/fuels](https://developer.fl3xx.com/reference/flight-fuels/getflightfuels.md): Fetches fuel information for a flight using its flight ID. ### Create Flight Fuels - [POST /api/external/flight/{flightId}/fuels](https://developer.fl3xx.com/reference/flight-fuels/postflightfuelsbyflightid.md): Creates fuel information for a specific flight using its flight ID. ### Upload Fuel Document - [POST /api/external/flight/{flightId}/fuels/{fuelId}/documents](https://developer.fl3xx.com/reference/flight-fuels/postflightfueldocument.md): Upload fuel document for a flight. ### Upload fuel release document - [POST /api/external/flight/{flightId}/fuels/{fuelId}/documents/release](https://developer.fl3xx.com/reference/flight-fuels/postflightfuelreleasedocument.md): Upload fuel release document for a flight. ### Get fuel document file - [GET /api/external/flight/{flightId}/fuels/{fuelId}/documents/{documentId}](https://developer.fl3xx.com/reference/flight-fuels/getflightfueldocument.md): Download fuel document or fuel release document for a flight. ### Delete fuel document - [DELETE /api/external/flight/{flightId}/fuels/{fuelId}/documents/{documentId}](https://developer.fl3xx.com/reference/flight-fuels/deleteflightfueldocument.md): Delete fuel document or fuel release document for a flight. ## Flight Ground Services Operations related to ground services. ### Get Flight Ground Services - [GET /api/external/flight/{id}/services](https://developer.fl3xx.com/reference/flight-ground-services/putflightservicebyflightid.md): Fetches service information for a specific flight using its flight ID. Includes Ground Handling, Transportation, Hotac, and Catering services. ### Submit Flight Ground Service - [POST /api/external/flight/{id}/services](https://developer.fl3xx.com/reference/flight-ground-services/postflightservicebyflightid.md): Submits service information for a specific flight using its flight ID. Includes Ground Handling, Transportation, Hotac, and Catering services. ## Flight Luggage Operations related to luggage for flights. ### Update Flight Luggage - [PUT /api/external/flight/{id}/pax_details/luggage](https://developer.fl3xx.com/reference/flight-luggage/putflightluggagebyflightid.md): Updates luggage information for a specific flight using its flight ID. ### Delete Flight Luggage - [DELETE /api/external/flight/{id}/pax_details/luggage](https://developer.fl3xx.com/reference/flight-luggage/deleteflightluggagebyflightid.md): Deletes luggage information for a specific flight using its flight ID. ## Flight Migration Operations related to migrations. ### Get Flight Migration Information - [GET /api/external/flight/{flightId}/migration](https://developer.fl3xx.com/reference/flight-migration/getflightmigrationbyflightid.md): Fetches migration information for a specific flight using its flight ID. ### Update Flight Migration Information - [PUT /api/external/flight/{flightId}/migration](https://developer.fl3xx.com/reference/flight-migration/putflightmigrationbyflightid.md): Updates migration information for a specific flight using its flight ID. ## Flight Notifications Operations related to notifications for flights. ### Get Flight Operational Notification - [GET /api/external/flight/{flightId}/notification](https://developer.fl3xx.com/reference/flight-notifications/getflightnotificationsbyflightid.md): Fetches operational notification for a specific flight using its flight ID. ### Update Flight Operational Notification - [PUT /api/external/flight/{flightId}/notification](https://developer.fl3xx.com/reference/flight-notifications/updateflightnotificationusingput.md): Updates operational notifications for a specific flight using its flight ID. ### Delete Flight Operational Notification - [DELETE /api/external/flight/{flightId}/notification](https://developer.fl3xx.com/reference/flight-notifications/deleteflightnotificationbyflightid.md): Deletes operational notifications for a specific flight using its flight ID. ## 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. ### Add Passenger to Flight - [POST /api/external/flight/{flightId}/passenger](https://developer.fl3xx.com/reference/flight-passengers/postflightpassengerbyflightid.md): Adds a passenger to a specific flight using its flight ID. This operation creates a new flight ticket for the passenger and associates it with the flight. The request body must include the passenger's FL3XX User ID or externalReference. See User endpoints ### Get a Flight Passenger - [GET /api/external/flight/{flightId}/passenger/{ticketId}](https://developer.fl3xx.com/reference/flight-passengers/getflightpassengerbyflightidandticketid.md): Retrieves the details of a passenger associated with a specific flight ticket. ### Update a Flight Passenger - [PUT /api/external/flight/{flightId}/passenger/{ticketId}](https://developer.fl3xx.com/reference/flight-passengers/putflightpassengerbyflightidandticketid.md): Updates the details of a passenger associated with a specific flight ticket. ### Remove a Flight Passenger - [DELETE /api/external/flight/{flightId}/passenger/{ticketId}](https://developer.fl3xx.com/reference/flight-passengers/deleteflightpassengerbyflightidandticketid.md): Removes the passenger details of a specific flight ticket using the flight ID and ticket ID. ### Get Flight Passengers - [GET /api/external/flight/{flightId}/passengers](https://developer.fl3xx.com/reference/flight-passengers/getflightpassengersbyflightid.md): Fetches a list of passengers assigned to a specific flight using its flight ID. ## Flight PAX Details Operations related to PAX details. ### Get Flight PAX Information - [GET /api/external/flight/{id}/pax_details](https://developer.fl3xx.com/reference/flight-pax-details/getflightpaxdetailsbyflightid.md): Fetches animal and cargo information for a specific flight using its flight ID. ### Submit Flight PAX Information - [POST /api/external/flight/{id}/pax_details](https://developer.fl3xx.com/reference/flight-pax-details/postflightpaxdetailsbyflightid.md): Submits animal and cargo information for a specific flight using its flight ID. ## Flight Planning Notes Operations related to planning notes for flights. ### Get Flight Planning Notes - [GET /api/external/flight/{flightId}/planningnote](https://developer.fl3xx.com/reference/flight-planning-notes/getflightplanningnotesbyflightid.md): Fetches planning note for a specific flight using its flight ID. ### Update Flight Planning Notes - [PUT /api/external/flight/{flightId}/planningnote](https://developer.fl3xx.com/reference/flight-planning-notes/updateflightplanningnotesbyflightid.md): Updates planning notes for a specific flight using its flight ID. ### Remove Flight Planning Notes - [DELETE /api/external/flight/{flightId}/planningnote](https://developer.fl3xx.com/reference/flight-planning-notes/deleteflightplanningnotesbyflightid.md): Removes planning notes for a specific flight using its flight ID. ## Flight Post Flight Operations related to post-flight activities. ### Get Post-Flight Information - [GET /api/external/flight/{flight}/postflight](https://developer.fl3xx.com/reference/flight-post-flight/getflightpostflightinformationbyflightid.md): Fetches post-flight information for a specific flight using its flight ID. ### Submit Post-Flight Information - [POST /api/external/flight/{flight}/postflight](https://developer.fl3xx.com/reference/flight-post-flight/postflightpostflightinformationbyflightid.md): Submits post-flight information for a specific flight using its flight ID. ## Flight Pre Flight Operations related to pre-flight operations. ### Get Pre-Flight Information - [GET /api/external/flight/{flight}/preflight](https://developer.fl3xx.com/reference/flight-pre-flight/getflightpreflightinformationbyflightid.md): Fetches pre-flight information for a specific flight using its flight ID. ## Flight Sanction List Operations related to flight sanctions and approvals. ### Get Flight Sanction List - [GET /api/external/flight/{flightId}/sanction-list](https://developer.fl3xx.com/reference/flight-sanction-list/getflightsanctionlistbyflightid.md): Fetches the sanction list for a specific flight using its flight ID. ### Update Flight Sanction List - [PUT /api/external/flight/{flightId}/sanction-list](https://developer.fl3xx.com/reference/flight-sanction-list/putflightsanctionlistbyflightid.md): Updates the sanction list for a specific flight using its flight ID. ## 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. ### Get Passenger Travel Authorization Status - [GET /api/external/flight/{flightId}/visa](https://developer.fl3xx.com/reference/flight-travel-authorization/getflightvisabyflightid.md): This endpoint allows users to retrieve the travel authorization status associated with passengers on a specific flight. Example Use Case: A flight operations manager wants to review all visa information for passengers on a specific flight. Note: The deprecated fields should not be used. Please use the values in travelAuthorizationArrival and travelAuthorizationDeparture instead. ### Update Passengers' Visa Information - [PUT /api/external/flight/{flightId}/visa](https://developer.fl3xx.com/reference/flight-travel-authorization/putflightvisabyflightid.md): This endpoint allows users to update the travel authorization status associated with passengers on a specific flight. Note: The deprecated fields should not be used. Please use the values in travelAuthorizationArrival and travelAuthorizationDeparture instead. ## Flight Tickets Operations related to flight tickets. ### Get Flight Tickets - [GET /api/external/flight/{flightId}/tickets](https://developer.fl3xx.com/reference/flight-tickets/getflightticketsbyflightid.md): Fetches all tickets for a specific flight, where each ticket represents a passenger assigned to the flight. ### Update Flight Tickets - [PUT /api/external/flight/{flightId}/tickets](https://developer.fl3xx.com/reference/flight-tickets/updateticketsforflightusingput.md): Updates all tickets for a specific flight. This operation replaces all previously set values. To append new tickets or edit existing ones, first retrieve the current list, update the elements, and then send the whole updated list. ## Quotes This group of endpoints is 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. ### Generate Provisional Quote - [POST /api/external/quote/lookup](https://developer.fl3xx.com/reference/quotes/postquotelookup.md): This endpoint allows you to simulate the creation of a quote without actually creating a real one. It provides a way to check aircraft availability and validate the pricing information before proceeding with an actual quote creation. Key Features - Validation: Ensures that all required fields are correctly filled and formatted. - Simulation: Provides a simulated response that mimics the actual quote creation process. - Price and Availability: Fetches price and aircraft availability without notifying the operator. Why Use This Endpoint? Using this endpoint helps to prevent errors and streamline the quote creation process by allowing you to test and validate data before committing to a real quote. It is an essential tool for ensuring data integrity and accuracy in your operations. ### Get a Quote - [GET /api/external/quote/{reference}](https://developer.fl3xx.com/reference/quotes/getquotebyreference.md): Fetches the details of a quote using its reference (bookingId/quoteId or externalReference). ### Update a Quote - [PUT /api/external/quote/{reference}](https://developer.fl3xx.com/reference/quotes/putquotebyreference.md): Updates the details of an existing quote using its reference. ### Delete a Quote - [DELETE /api/external/quote/{reference}](https://developer.fl3xx.com/reference/quotes/deletequotebyreference.md): Deletes an existing quote using its reference. ### Generate Quote - [POST /api/external/quote](https://developer.fl3xx.com/reference/quotes/postquote.md): 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: 1. Account ID: If customer.account.accountid is provided and valid, the account is retrieved using the ID. 2. External Reference: If no account is found, the system will search for an account using the customer.account.externalReference field. 3. Account Name: If no account is found, the system will search for an account using the customer.account.name field. 4. Account Number: If both customer.account.name and customer.account.accountNumber fields are provided, the system will attempt to find a match. 5. 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. ### Get Non-Booked Quotes - [GET /api/external/quote/notbooked](https://developer.fl3xx.com/reference/quotes/getquotesnotbooked.md): Fetches a list of quotes that have not been booked. ### Create a Booked Quote - [POST /api/external/quote/book](https://developer.fl3xx.com/reference/quotes/postquotebook.md): 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: 1. Account ID: If customer.account.accountid is provided and valid, the account is retrieved using the ID. 2. External Reference: If no account is found, the system will search for an account using the customer.account.externalReference field. 3. Account Name: If no account is found, the system will search for an account using the customer.account.name field. 4. Account Number: If both customer.account.name and customer.account.accountNumber fields are provided, the system will attempt to find a match. 5. 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. ### Update a Booked Quote - [PUT /api/external/quote/book/{reference}](https://developer.fl3xx.com/reference/quotes/putquotebookbybookingreference.md): Updates a booked quote using its booking reference. If you modify the departure time, you need to make sure to update the arrival time too since FL3XX only calculates it at the first time. ### Cancel a Booked Quote - [DELETE /api/external/quote/book/{reference}](https://developer.fl3xx.com/reference/quotes/deletequotebookbybookingreference.md): Cancels a booked quote using its booking reference. ### Update Booking Payment Status - [PUT /api/external/quote/bookings/payment/{reference}](https://developer.fl3xx.com/reference/quotes/putbookingpaymentstatusbybookingreference.md): Updates the payment status of a booking using its reference. ### Get Quote Versions - [GET /api/external/quote/customer/{customerId}/versions](https://developer.fl3xx.com/reference/quotes/getquoteversionsbycustomerid.md): Fetches all versions of quotes associated with a specific customer ID. ### Get Quote Price - [GET /api/external/quote/price/{reference}](https://developer.fl3xx.com/reference/quotes/getquotepricebyquotereference.md): Fetches the price details of a quote using its reference. ### Get Booked Snapshot - [GET /api/external/quote/{reference}/bookedSnapshot](https://developer.fl3xx.com/reference/quotes/getquotebookedsnapshotbyreference.md): Fetches the snapshot of a booked quote using its reference. ### Get Quote History - [GET /api/external/quote/{reference}/history](https://developer.fl3xx.com/reference/quotes/getquotehistorybyreference.md): Fetches the history of a quote using its reference. ### Approve Quote by Owner - [POST /api/external/quote/{reference}/owner/approve](https://developer.fl3xx.com/reference/quotes/postquoteapproval.md): Approves a quote by the owner using its reference. ### Get Quote Versions by Account ID - [GET /api/external/quote/{rootBookingId}/account/{accountId}/versions](https://developer.fl3xx.com/reference/quotes/getquoteversionsbyrootbookingandaccountid.md): Fetches all versions of quotes associated with a specific account ID. ### Get Quote Versions by Customer ID - [GET /api/external/quote/{rootBookingId}/customer/{customerId}/versions](https://developer.fl3xx.com/reference/quotes/getquoteversionsbyrootbookingandcustomerusingget.md): Fetches all versions of quotes associated with a specific customer ID. ### Get All Quote Versions - [GET /api/external/quote/{rootBookingId}/versions](https://developer.fl3xx.com/reference/quotes/getquoteversionsbyrootbookingusingget.md): Fetches all versions of quotes associated with a specific root booking ID. ### Generate Quote (deprecated) - [POST /api/external/webQuote/create](https://developer.fl3xx.com/reference/quotes/postwebquote.md): Create a new quote (Deprecated) ## Roster Operations related to Rosters. ### Get Staff Roster - [GET /api/external/staff/roster](https://developer.fl3xx.com/reference/roster/getstaffrosters.md): Fetches the staff roster details. ### Create a new staff member - [POST /api/external/staff](https://developer.fl3xx.com/reference/roster/poststaff.md): Creates a new staff member in the system ### Update a staff member - [PATCH /api/external/staff/{reference}](https://developer.fl3xx.com/reference/roster/patchstaff.md): Partially updates an existing staff member identified by reference ### Upload document associated with an idCard - [POST /api/external/staff/{reference}/id-cards/{userCardId}/documents](https://developer.fl3xx.com/reference/roster/postidcarddocument.md): Uploads a document file associated with an idCard for a staff member ## Users Operations related to Users. ### Get Users - [GET /api/external/user](https://developer.fl3xx.com/reference/users/getusers.md): Fetches list of users. ### Creates a new user - [POST /api/external/user](https://developer.fl3xx.com/reference/users/postuser.md): Creates a new user ### Get Flight Passengers - [GET /api/external/user/flight/{externalReference}](https://developer.fl3xx.com/reference/users/getpassengersbyflightreference.md): Fetches data for a flight passenger using its externalReference ### Get a User - [GET /api/external/user/{externalReference}](https://developer.fl3xx.com/reference/users/getuserbyexternalreference.md): Fetches data about a user ### Updates a User - [PUT /api/external/user/{externalReference}](https://developer.fl3xx.com/reference/users/putuserbyexternalreference.md): Updates a user ### Deletes a User - [DELETE /api/external/user/{externalReference}](https://developer.fl3xx.com/reference/users/deleteuserbyreference.md): Deletes a user identified by its external reference ### Get User Documents - [GET /api/external/user/{userExternalReference}/documents](https://developer.fl3xx.com/reference/users/getuserdocumentsbyuserexternalreference.md): Get information about the documents of a user identified by the userExternalReference ### Create a User Document - [POST /api/external/user/{userExternalReference}/documents](https://developer.fl3xx.com/reference/users/postuserdocument.md): Creates a new user document ### Update a User's Document - [PUT /api/external/user/{userExternalReference}/documents/{externalReference}](https://developer.fl3xx.com/reference/users/putuserdocument.md): Updates a user's document using the userExternalReference and the document's externalReference ### Delete a User's Document - [DELETE /api/external/user/{userExternalReference}/documents/{externalReference}](https://developer.fl3xx.com/reference/users/deleteuserdocument.md): Deletes an existing document based on the user's externalReference and the document's externalReference