This API is designed for exporting an invoice out of FBO One. When an invoice is generated by FBO One, our API will automatically make a call to your system to notify there’s a new invoice. In return your system can call into FBO One’s API and retrieve the invoice data in a JSON format.

The most common use case for this API is to have the invoice generated by FBO One and sent to your accounting system. The JSON schema contains all the details as they are printed on the invoice PDF. In return, you can PATCH with an update for the invoice internal remarks in FBO One to indicate that it was processed successfully. The remark can contain a reference number and the PATCH can also change the invoice workflow state for example: 'Exported'.

Please note that sometimes on the final customer invoices, multiple price component services are grouped together as a single invoice line. The API will respect those settings, showing the invoice line as one line.

Invoice JSON structure

• Invoice header:
  • Information about the invoice total amount, number, date, type
  • Information about the customer
  • Information about the seller (the finance department of the FBO location)
• Invoice details
  • Invoice lines - invoiced services (including pricing)
    • Information about the flight details
    • Information about the aircraft

• Invoice pre-payments - a list of payments that were made for this invoice

• Invoice PDF - the PDF version of this invoice as base64string

• Attachments - a list of supporting documents for this invoice as base64string

• The amounts are specified in the invoice charged currency but also in the currency of the FBO for tax purposes

Authorization

In order to use the Invoice API, the API user requires access to the following:

• API FBO Location access role
• API Administration access role
• Public API Invoice authorization

Once the API user has access to the above, a token can be generated in FBO One.

Attached examples

• Webhook message posted by FBO One to your subscriber application
• GET Http GET call to FBO One API to get the invoice details
• PATCH Http PATCH back to FBO One