Guides
Open FL3XX APP - Sandbox

🎣 Get List of Bookings Relevant for Accounting

Here's the detailed explanation of the key feature in the FL3XX API providing you with the new and modified quotes(bookings), which are relevant for your financial or accounting application.

Suggest Edits

Intro

One of the first questions is:

  • How to get quotes/bookings from FL3XX to my external application?
  • Will I get all the sales content? What if I don't want to transfer uncofirmed quotes/bookings, which the customers left unattended? I don't need them in my external application.
  • Can I select what I want to collect and transfer?

FL3XX offers a simple and efficient GET method to provide your application with a list of quotes/bookings relevant for you based on predefined criteria.

GET /bookings

This is the endpoint to instruct the FL3XX API to answer such query.

GET /api/external/quote/bookings

Two parameters are vital for using this method: (1) filter) and (2) date/time of the last previous API call.

Filter

Here's shown the filter added to this method:

GET /api/external/quote/bookings?filter=READY_TO_INVOICE

Focusing on accounting, this method enables you to filter out quotes/bookings according to these criteria:

  1. PAID
    Quote/booking is set as Paid (see the screenshot below)
  2. NOT_PAID
    Quote/booking is set as Unpaid (see the screenhost below)
  3. NOT_TRANSFERRED
    Not in use. Ignore.
  4. πŸ‘‰πŸ» READY_TO_INVOICE
    Quote/booking is set as "ready to invoice". This is the filter recommended by us.
    You can read detailed explanation of the "ready to invoice" in the Settings for Accounting article.

lastRequest

This is a compulsory parameter. You always have to let the FL3XX system know the "cut" date and time.

GET /api/external/quote/bookings?filter=READY_TO_INVOICE&lastRequest=2024-09-15T10%3A00&page=0&size=10

The cut date/time determines which new and modified quotes/bookings will be reverted in the payload. It can be interpreted as the date/time of your last previous API call.

FL3XX API will then revert only the quotes/bookings, which have been created or modified AFTER this date/time.

What does the quote/booking "modification" mean in this respect?

  • Any modification in the given quote/booking, executed in the sales module (not operational changes executed in the Dispatch).
  • Examples can be: Departure airport offered to Customer, Scheduled departure time, Number of seats ordered by customer, items in the calculation matrix, an invoice issued

Example

This API call can be interpreted as follows:

GET /api/external/quote/bookings?filter=READY_TO_INVOICE&lastRequest=2024-09-15T10%3A00&page=0&size=10

FL3XX, return a list of quotes/bookings

  1. Flagged as "Ready to Invoice"
    1. Depending on my settings
      1. Either only the bookings for which it's manually set
      2. Or all the confirmed bookings
  2. Which have been created or modified after Sep 15, 2024, 10:00 AM
    1. Which is when my app sent you the same query last time.

TBA - payload and explain further details

Updated 2 months ago