Accounting
/
Get an Accounting Document

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
Languages
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

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments?invoiceId=0&quoteId=107592' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
]
Response
application/json
[
  {
    "id": 225636,
    "status": "NOT_PAID",
    "quoteId": 5563201,
    "invoiceIds": [ … ],
    "amount": 56.36,
    "currency": "EUR",
    "documents": [ … ],
    "remarks": "string",
    "date": "2023-12-24"
  }
]

Creates an Invoice Payment

Request

Creates a new payment associated with a booking and/or invoice.

Bodyapplication/jsonrequired
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
curl -i -X POST \
  https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "id": 225636,
    "status": "NOT_PAID",
    "quoteId": 5563201,
    "invoiceIds": [
      66542554
    ],
    "amount": 56.36,
    "currency": "EUR",
    "documents": [
      {
        "id": 66325,
        "uuid": "2342343423423423423ASS32",
        "originalName": "fil3.pdf",
        "fileSize": 652154,
        "creationDate": "2024-11-27T16:56:40Z"
      }
    ],
    "remarks": "string",
    "date": "2023-12-24"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
Response
application/json
{
  "id": 225636,
  "status": "NOT_PAID",
  "quoteId": 5563201,
  "invoiceIds": [
    66542554
  ],
  "amount": 56.36,
  "currency": "EUR",
  "documents": [
    { … }
  ],
  "remarks": "string",
  "date": "2023-12-24"
}

Get an Invoice Payment

Request

Gets a booking and/or invoice payment by its ID.

Path
paymentIdinteger(int64)required

Invoice payment ID

Example: 327
curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments/{paymentId}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
Response
application/json
{
  "id": 225636,
  "status": "NOT_PAID",
  "quoteId": 5563201,
  "invoiceIds": [
    66542554
  ],
  "amount": 56.36,
  "currency": "EUR",
  "documents": [
    { … }
  ],
  "remarks": "string",
  "date": "2023-12-24"
}

Update an Invoice Payment

Request

Updates a booking and/or invoice payment information.

Path
paymentIdinteger(int64)required

Invoice payment ID

Example: 327
Bodyapplication/jsonrequired
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
curl -i -X PUT \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments/{paymentId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "id": 225636,
    "status": "NOT_PAID",
    "quoteId": 5563201,
    "invoiceIds": [
      66542554
    ],
    "amount": 56.36,
    "currency": "EUR",
    "documents": [
      {
        "id": 66325,
        "uuid": "2342343423423423423ASS32",
        "originalName": "fil3.pdf",
        "fileSize": 652154,
        "creationDate": "2024-11-27T16:56:40Z"
      }
    ],
    "remarks": "string",
    "date": "2023-12-24"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)(Payment ID)

Payment ID

Example: 225636
statusstring(Payment status)

Indicates if the quote/invoice has been paid in full or not

Enum"PAID""NOT_PAID"
Example: "NOT_PAID"
quoteIdinteger(int64)(Quote ID)

Quote ID

Example: 5563201
invoiceIdsArray of integers(int64)(Invoice IDs)unique

The IDs of the invoices associated with the payment

Example: [66542554]
amountnumber(Payment amount)

Payment amount

Example: 56.36
currencystring(Payment currency)

Payment currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example: "EUR"
documentsArray of objects(Payment document)unique

Payment document (PDF, PNG, JPG, JPEG)

remarksstring
datestring
Example: "2023-12-24"
Response
application/json
{
  "id": 225636,
  "status": "NOT_PAID",
  "quoteId": 5563201,
  "invoiceIds": [
    66542554
  ],
  "amount": 56.36,
  "currency": "EUR",
  "documents": [
    { … }
  ],
  "remarks": "string",
  "date": "2023-12-24"
}

Delete an Invoice Payment

Request

Delete booking and/or invoice payment.

Path
paymentIdinteger(int64)required

Invoice payment ID

curl -i -X DELETE \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments/{paymentId}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
deletedboolean
Response
application/json
{
  "deleted": true
}

Add Invoice Payment Document

Request

Associates a (PDF, JPG, PNG or JPEG) file to a booking and/or invoice payment.

Path
paymentIdinteger(int64)required

Invoice payment ID

Bodyapplication/json
filestring(binary)required
curl -i -X POST \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments/{paymentId}/documents' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "file": "string"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)(ID)

Document ID

Example: 66325
uuidstring(UUID)

Document UUID

Example: "2342343423423423423ASS32"
originalNamestring(Original name)

Original name of the document

Example: "fil3.pdf"
fileSizeinteger(int64)(File size)

File size

Example: 652154
creationDatestring(Original name)

Date created

Example: "2024-11-27T16:56:40Z"
Response
application/json
{
  "id": 66325,
  "uuid": "2342343423423423423ASS32",
  "originalName": "fil3.pdf",
  "fileSize": 652154,
  "creationDate": "2024-11-27T16:56:40Z"
}

Get Invoice Payment Document

Request

Fetches a document associated with a booking and/or invoice payment by its UUID.

Path
paymentIdinteger(int64)required

Invoice payment ID

uuidstringrequired

Document UUID

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

Responses

OK

Bodyapplication/json
string(binary)
Response
application/json
"string"

Delete Invoice Payment Document

Request

Deletes a document associated with a booking and/or invoice payment by its UUID.

Path
paymentIdinteger(int64)required

Invoice payment ID

uuidstringrequired

Document UUID

curl -i -X DELETE \
  'https://developer.fl3xx.com/_mock/reference/api/external/accounting/invoice-payments/{paymentId}/documents/{uuid}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
deletedboolean
Response
application/json
{
  "deleted": true
}

Get Bookings

Request

Searches for bookings using the provided filters.

Query
customerAccountIdinteger(int64)

Customer account ID

customerIdinteger(int64)

Customer ID

filterstring

Status

Enum"PAID""NOT_PAID""NOT_TRANSFERRED""READY_TO_INVOICE"
Example: filter=PAID
lastRequeststring

Include only bookings that have been updated on and after the given date (YYYY-MM-DDTHH:MM)

Example: lastRequest=2019-09-01T10:00
pageinteger(int32)

Page number

Example: page=1
sizeinteger(int32)<= 50

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

Example: size=10
curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/quote/bookings?customerAccountId=0&customerId=0&filter=PAID&lastRequest=string&page=0&size=50' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
contentArray of objects(QuoteDto)
emptyboolean
firstboolean
lastboolean
numberinteger(int32)
numberOfElementsinteger(int32)
pageableobject(Pageable)
sizeinteger(int32)
sortobject(Sort)
totalElementsinteger(int64)
totalPagesinteger(int32)
Response
application/json
{
  "content": [
    { … }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": { … },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

Operations related to aircraft.

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

Operations related to flight quotes.

Operations

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations