FL3XX API (1.0.0)

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

Download OpenAPI description

index.json

index.yaml

Overview

URL https://www.fl3xx.com

FL3XX Integration Support integrations@fl3xx.com

License MIT

Servers

Mock server

https://developer.fl3xx.com/_mock/reference/

Sandbox server

https://test.fl3xx.com/

Accounting

Operations related to accounting.

Operations

Get an Accounting Document

Request

Get an accounting document using its UUID.

Path

uuidstring(uuid)required

Document's UUID

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/attachments/{uuid}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

PDF document

Bodyapplication/pdf

string(binary)

Get a Booking

Request

Fetches details of a booking using its ID.

Path

bookingIdstringrequired

Booking ID

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/booking/{bookingId}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

accountEntriesArray of objects(AccountEntryDto)

aircraftobject(AircraftDto)

aircraftAccountCodestring

bookingIdentifierstring

Custom booking identifier

Example: "PXXJG"

bookingStatusstring

Booking status

Enum"QUOTE""OPTION""BOOKING""CLOSED""CANCELED"

Example: "QUOTE"

customerobject(UserDto)

customerAccountCodestring

exchangeRatesArray of objects(BookingExchangeRateDto)

invoiceStatusstring

Enum"TRANSFERRED""READY_TO_INVOICE""TRANSFERRING"

Example: "TRANSFERRED"

paymentGuaranteestring

Payment guarantee

Enum"NOT_GUARANTEED""SAFE_CLIENT""CREDIT_CARD_AUTHORIZED""FINANCIAL_RELEASE_OK"

Example: "NOT_GUARANTEED"

paymentMethodstring

Payment method

Enum"TRANSFER""DIRECT_DEBIT""CREDIT_CARD""ON_ACCOUNT""OTHER""ELECTRONIC_PAYMENT""NOT_REQUIRED""JET_CARD"

Example: "TRANSFER"

paymentStatusstring

Payment status

Enum"NOT_PAID""PAID"

Example: "NOT_PAID"

Response

application/json

{
  "accountEntries": [
    { … }
  ],
  "aircraft": {
    "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
  },
  "aircraftAccountCode": "string",
  "bookingIdentifier": "PXXJG",
  "bookingStatus": "QUOTE",
  "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
  },
  "customerAccountCode": "string",
  "exchangeRates": [
    { … }
  ],
  "invoiceStatus": "TRANSFERRED",
  "paymentGuarantee": "NOT_GUARANTEED",
  "paymentMethod": "TRANSFER",
  "paymentStatus": "NOT_PAID"
}

Get Invoices

Request

Fetches all invoices associated with a specific bookingId.

Path

bookingIdstringrequired

Booking ID

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/booking/{bookingId}/invoices' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [

grossPricenumber

Gross price of the invoice

Example: 5000.69

invoiceDatestring

Date of the invoice (YYYY-MM-DDTHH:MM:SS.SSSZ)

Example: "2024-11-21T11:24:20.064Z"

invoiceNumberstring

Number of the invoice

Example: 123456

invoiceTypestring

Type of the invoice

Enum"INVOICE""PROFORMA_INVOICE""CREDIT_MEMO""CANCELLATION"

Example: "INVOICE"

netPricenumber

Net price of the invoice

Example: 4000.69

timestampstring

Example: "2024-11-21T11:24:28.249Z"

vatnumber

VAT of the invoice

Example: 1000

vatPercentagenumber

VAT percentage of the invoice

Example: 20

documentobject(BinaryReferenceMinDto)

userobject(UserDto)

]

Response

application/json

[
  {
    "grossPrice": 5000.69,
    "invoiceDate": "2024-11-21T11:24:20.064Z",
    "invoiceNumber": 123456,
    "invoiceType": "INVOICE",
    "netPrice": 4000.69,
    "timestamp": "2024-11-21T11:24:28.249Z",
    "vat": 1000,
    "vatPercentage": 20,
    "document": { … },
    "user": { … }
  }
]

Get Split Pricing

Request

Fetches split pricing information (cost, owner share, profitability) for a specific bookingId.

Path

bookingIdstringrequired

bookingId

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/booking/{bookingId}/split' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

bookingIdinteger(int64)

Booking ID

Example: 107853

bookingIdentifierstring

Custom booking Identifier

Example: "PIOJG"

splitArray of objects(ExternalSplitItemDto)

Response

application/json

{
  "bookingId": 107853,
  "bookingIdentifier": "PIOJG",
  "split": [
    { … }
  ]
}

Add GL Code to Account Entry

Request

Adds a General Ledger (GL) code to an existing account entry identified by its ID.

Path

accountEntryIdinteger(int64)required

accountEntryId

Query

accountCodestringrequired

accountCode

curl -i -X PUT \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/{accountEntryId}?accountCode=string' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

accountCodestring

amountnumber

Amount

Example: 5.23

billableboolean

categoryAccountCodestring

currencystring

Currency

Example: "EUR"

datestring

Epoch date value

Example: 1732188260064

descriptionstring

Notes

Example: "Account discount"

flightNumberstring

Flight number

Example: 34343

idinteger(int64)

Example: 33423

legIdinteger(int64)

Leg ID

Example: 2323

quantitynumber

ratenumber

statusstring

Status

Enum"TRANSFERRED""READY_TO_INVOICE""TRANSFERRING"

Example: "TRANSFERRED"

supplierIdinteger(int64)

supplierNamestring

taxableboolean

unitstring

attachmentsArray of objects(BinaryReferenceMinDto)

actualobject(AccountPriceEntryDto)

Response

application/json

{
  "accountCode": "string",
  "amount": 5.23,
  "billable": true,
  "categoryAccountCode": "string",
  "currency": "EUR",
  "date": 1732188260064,
  "description": "Account discount",
  "flightNumber": 34343,
  "id": 33423,
  "legId": 2323,
  "quantity": 0,
  "rate": 0,
  "status": "TRANSFERRED",
  "supplierId": 0,
  "supplierName": "string",
  "taxable": true,
  "unit": "string",
  "attachments": [
    { … }
  ],
  "actual": {
    "amount": 96.23,
    "baseCurrency": "USD",
    "currency": "EUR",
    "quantity": 1,
    "rate": 1.23,
    "unit": "string"
  }
}

Get Invoice Payments

Request

Fetches payments associated with a booking and/or invoice.

Query

quoteIdinteger(int64)required

Quote ID

Example: quoteId=107592

invoiceIdinteger(int64)

Invoice ID

FL3XX API (1.0.0)

Accounting

Get an Accounting Document

Request

Responses

Was this helpful?

Get a Booking

Request

Responses

Was this helpful?

Get Invoices

Request

Responses

Was this helpful?

Get Split Pricing

Request

Responses

Was this helpful?

Add GL Code to Account Entry

Request

Responses

Was this helpful?

Get Invoice Payments

Request