Accounts
/
Update an account

FL3XX API (1.1.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

Get Accounts

Request

Get list of accounts.

Query
limitinteger(int32)

Maximum number of items returned

Default 100
offsetinteger(int32)

Offset

Default 0
curl -i -X GET \
  'https://test.fl3xx.com/api/external/user/account?limit=100&offset=0' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

The Account data

Bodyapplication/jsonArray [
accountNumberstring

Account number

Example: 1111
accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
internalIdinteger(int64)read-only

Internal ID

Example: 632123
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
]
Response
application/json
[
  {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  }
]

Creates an account

Request

Creates a new account

Bodyapplication/json

account

accountNumberstring

Account number

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
curl -i -X POST \
  https://test.fl3xx.com/api/external/user/account \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "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
    }
  }'

Responses

Newly created Account data

Bodyapplication/json
accountNumberstring

Account number

Example: 1111
accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
internalIdinteger(int64)read-only

Internal ID

Example: 632123
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
Response
application/json
{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Get an Account

Request

Fetches details of an account using it's externalReference

Path
externalReferencestringrequired

Property externalReference for the account

curl -i -X GET \
  'https://test.fl3xx.com/api/external/user/account/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

The Account data

Bodyapplication/json
accountNumberstring

Account number

Example: 1111
accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
internalIdinteger(int64)read-only

Internal ID

Example: 632123
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
Response
application/json
{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Update an account

Request

Updates an existing account using its externalReference

Path
externalReferencestringrequired

externalReference

Bodyapplication/json

account

accountNumberstring

Account number

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
curl -i -X PUT \
  'https://test.fl3xx.com/api/external/user/account/{externalReference}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "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
    }
  }'

Responses

The updated Account data

Bodyapplication/json
accountNumberstring

Account number

Example: 1111
accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111
emailstring

Email address

Example: "email@fl3xx.com"
externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"
internalIdinteger(int64)read-only

Internal ID

Example: 632123
mobilestring

Mobile phone

Example: 111111111
namestring

Account name

Example: "Account"
notesstring

Notes

Example: "Notes"
phonestring

Phone number

Example: 111111111
vatNumberstring

VAT Number

Example: "A11111111111"
addressobject(AddressDto)
linksobject(Links)
Response
application/json
{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Delete an account

Request

Deletes (makes inactive) an existing account using its reference

Path
externalReferencestringrequired

externalReference

curl -i -X DELETE \
  'https://test.fl3xx.com/api/external/user/account/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

The updated Account data

Body

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

Operations related to passenger for flights.

Operations

Flight PAX Details

Operations related to PAX details.

Operations

Flight Planning Notes

Operations related to planning notes for flights.

Operations

Flight Post Flight

Operations related to post-flight activities.

Operations

Flight Pre Flight

Operations related to pre-flight operations.

Operations

Flight Sanction List

Operations related to flight sanctions and approvals.

Operations

Flight Travel Authorization

Operations related to travel authorization.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

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