API Documentation
Description
Retrieves the burn rate information for a specific aircraft model based on its ID.
Parameters
- id (query) - The unique identifier of the aircraft model.
Responses
Success - Returns the burn rate details of the specified aircraft model.
{"burnRate": "value"}Method Not Allowed
{"error": "Method Not Allowed"}Description
Retrieves detailed information about the company.
Responses
Example Response
{
"id": "uuid-123",
"name": "Acme Corporation",
"description": "A company that specializes in everything.",
"location": "123 Acme Way, Anytown, AN",
"country_code": "AN",
"margin": 10.5,
"discount": 2.5,
"is_active": true,
"is_deleted": false,
"time_created": "2023-01-01T00:00:00Z"
}Description
Retrieves emissions data, utilizing caching for optimized response times.
Responses
Example success response (JSON structure depends on database schema):
{
"emissionsData": [
{
"id": "uuid-456",
"category": "Transport",
"amount": 1500,
"unit": "kgCO2e",
"date": "2023-01-02"
}
]
}Description
Retrieves detailed information about a specific emission record by its unique ID.
Parameters
- emission_id (path) - The unique identifier of the emission record.
Responses
Example success response:
{
"id": "uuid-456",
"companyId": "uuid-789",
"aircraftId": "uuid-123",
"fuelType": "Jet A",
"flightDuration": 2.5,
"carbonEmitted": 1500,
"isCalculated": true,
"timeEmitted": "2023-02-15T00:00:00Z",
"timeCreated": "2023-02-16T00:00:00Z",
"timeUpdated": "2023-02-17T00:00:00Z"
}Description
Retrieves information about all available aircraft models, with optional filtering by name, burn rate, and active status.
Parameters
- name (query) - Filter models by name.
- isActive (query) - Filter models by their active status (true/false).
- burnRate (query) - Filter models by burn rate.
Responses
Example success response:
[{"id": "uuid-1", "name": "Boeing 747", "burnRate": 5, "isActive": true}, ...]Description
Retrieves detailed information about an aircraft model by its unique ID.
Parameters
- model_id (path) - The unique identifier of the aircraft model.
Responses
Example success response:
{
"id": "model-uuid",
"name": "Boeing 787",
"burnRate": 5.2,
"isActive": true
}Description
Retrieves a list of provisions, optionally filtering by reconciliation status, company ID, or whether the provision is marked as deleted.
Parameters
- isReconciled (query) - Filter provisions by their reconciliation status (true/false).
- companyId (query) - Filter provisions associated with a specific company ID.
- isDeleted (query) - Filter provisions by whether they are marked as deleted (true/false).
Responses
Example success response:
[{
"id": "uuid-1",
"companyId": "uuid-123",
"description": "Tree Planting Initiative",
"carbonAmount": 100,
"price": 2000,
"isReconciled": false,
"isDeleted": false,
"timeCreated": "2023-01-01T00:00:00Z",
"timeUpdated": "2023-01-02T00:00:00Z"
}]Description
Fetches detailed information for a specific provision by its unique ID.
Parameters
- provision_id (path) - The unique identifier of the provision.
Responses
Example success response:
{
"id": "provision-uuid",
"companyId": "company-uuid",
"description": "Renewable Energy Project",
"carbonAmount": 1000,
"price": 25000,
"isReconciled": false
}Description
Retrieves detailed information about a specific source by its ID.
Parameters
- source_id (path) - Unique identifier for the source to retrieve.
Responses
Example success response:
{
"id": "source-uuid",
"name": "Wind Farm Project",
"description": "A project dedicated to generating renewable energy",
"price": 50,
"puroId": "PURO123",
"country": "DE",
"region": "Bavaria",
"city": "Munich",
"category": "Energy",
"website": "https://windfarmporject.com",
"logo": "https://windfarmporject.com/logo.png",
"certification": "VCS",
"certificationDate": "2021-06-01T00:00:00Z",
"isActive": true
}Description
Fetches comprehensive details about a specific invoice, including associated provisions, total carbon offset, price details, and status.
Parameters
- invoice_id (path) - Unique identifier of the invoice to retrieve.
Responses
Example success response:
{
"id": "uuid-234",
"companyId": "uuid-123",
"carbonTotal": 5000,
"creditTotal": 200,
"priceTotal": 15000,
"stripeLink": "https://stripe.com/invoice/uuid-234",
"isComplete": true,
"isActive": true,
"isDeleted": false,
"timeCompleted": "2023-03-17T12:00:00Z",
"timeCreated": "2023-01-01T00:00:00Z",
"timeUpdated": "2023-03-01T00:00:00Z"
}Description
This API endpoint will allow for the generation and retrieval of various reports related to emissions, provisions, and other environmental metrics.
Responses
Expected Methods
GET, POST (More details coming soon)Expected Parameters
Details about required and optional parameters will be added in the future.Example Usage
Examples of how to interact with this endpoint will be shared once it is fully implemented.Expected Responses
Information on successful and error responses will be provided upon the endpoint's completion.Description
FL3XX Sync API provides seamless integration between FL3XX and third-party systems, allowing you to synchronize data effortlessly. Stay tuned for updates!
Parameters
- from (query) - Start date parameter in YYYY-MM-DD format
- to (query) - End date parameter in YYYY-MM-DD format
- include (query) - (Optional) Additional data to include
- timeZone (query) - (Optional) Time zone for date parameters
Responses
Response
{
"accountId": number,
"accountName": string,
"accountReference": string,
"accountTrigram": string,
"aircraftAOC": {
"id": number,
"name": string
},
"aircraftCategory": string,
"airportFrom": string,
"airportTo": string,
"blockOffEstLocal": string,
"blockOffEstUTC": string,
"blockOnEstLocal": string,
"blockOnEstUTC": string,
"bookingIdentifier": string,
"bookingReference": string,
"customerFirstname": string,
"customerId": string,
"customerLastname": string,
"customerTrigram": string,
"dateFrom": string,
"dateTo": string,
"eta": string,
"etd": string,
"flightId": number,
"flightNumber": string,
"flightNumberCompany": string,
"flightStatus": string,
"flightType": string,
"fuelArrival": number,
"fuelMassUnit": string,
"fuelOffBlock": number,
"fuelRemainigActual": number,
"operator": {
"id": number,
"name": string
},
"paxNumber": number,
"paxReferences": [
{
"comment": string,
"documentExternalReference": string,
"externalReference": string,
"internalId": number,
"isMain": boolean,
"links": {
"empty": boolean
},
"paxExternalReference": string,
"paxType": string
}
],
"postFlightClosed": boolean,
"realAirportFrom": string,
"realAirportTo": string,
"realDateIN": string,
"realDateOFF": string,
"realDateON": string,
"realDateOUT": string,
"registrationNumber": string,
"requestedAircraftType": string,
"rescheduledDateFrom": string,
"rescheduledDateTo": string,
"status": string,
"tripNumber": number,
"upliftMass": number,
"userReference": string,
"workflow": string,
"workflowCustomName": string
}Description
Estimates the carbon emissions for a specific aircraft model over a given flight duration.
Parameters
- aircraftModel (query) - The name of the aircraft model.
- flightDuration (query) - The duration of the flight in hours.
Responses
Example success response:
{
"aircraftModel": "Gulfstream G550",
"flightDuration": "5",
"carbonEmitted": 2500
}Example error response (missing parameters):
{
"error": "aircraftModel and flightDuration are required."
}Example error response (invalid model):
{
"error": "Invalid burn rate obtained from OpenAI"
}