# FuelU2 Customer API

API for handling customer data, relationships, and order interactions within the FuelU2 network.

Version: 1.0.0
License: MIT

## Servers

Production server
```
https://api.fuelu2.com
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[FuelU2 Customer API](https://developers.fuelu2.com/_bundle/apis/customer.yaml)

## Authentication

### User Login

 - [POST /Users/login](https://developers.fuelu2.com/apis/customer/authentication/userlogin.md): Authenticates a user and returns a token that must be included in the Authorization header for subsequent requests.

### User Logout

 - [POST /Users/logout](https://developers.fuelu2.com/apis/customer/authentication/userlogout.md): Logs out the currently authenticated user by invalidating their session token.

## Orders

### Create/Edit An Order

 - [POST /Orders](https://developers.fuelu2.com/apis/customer/orders/createorder.md): Creates a new order with optional recurring settings and specified service quantities.

### Get A Paged Orders List

 - [GET /Orders/paged](https://developers.fuelu2.com/apis/customer/orders/getpagedorders.md): Retrieves a paginated list of orders with optional filters for date, status, customer, and more.

### Renew An Existing Order

 - [POST /Orders/renewOrder](https://developers.fuelu2.com/apis/customer/orders/reneworder.md): Renews an existing order by specifying its ID and creation timestamp.

### Cancel An Existing Order

 - [POST /Orders/cancel](https://developers.fuelu2.com/apis/customer/orders/cancelorder.md): Cancels an existing order by specifying its ID, creation timestamp, and reason.

## Drivers

### Create/Edit A Driver

 - [POST /Drivers](https://developers.fuelu2.com/apis/customer/drivers/createdriver.md): Creates a new driver record for a specific customer.

### Delete A Driver

 - [DELETE /Drivers](https://developers.fuelu2.com/apis/customer/drivers/paths/~1drivers/delete.md): Deletes an existing driver by specifying their unique ID and creation timestamp.

### Get A Paged Drivers List

 - [GET /Drivers/paged](https://developers.fuelu2.com/apis/customer/drivers/getpageddrivers.md): Retrieves a paginated list of drivers with optional filters for customer, subcontract, and search text.

## Vehicles

### Create/Edit A Vehicle

 - [POST /Vehicles](https://developers.fuelu2.com/apis/customer/vehicles/createvehicle.md): Creates a new vehicle record with registration details and capacity information.

### Delete A Vehicle

 - [DELETE /Vehicles](https://developers.fuelu2.com/apis/customer/vehicles/paths/~1vehicles/delete.md): Deletes an existing vehicle by specifying its unique ID and creation timestamp.

### Get A Paged Vehicles List

 - [GET /Vehicles/paged](https://developers.fuelu2.com/apis/customer/vehicles/getpagedvehicles.md): Retrieves a paginated list of vehicles with optional filters for customer, product, subcontract, and search text.

## Subcontracts

### Create/Edit a SubContract

 - [POST /SubContracts](https://developers.fuelu2.com/apis/customer/subcontracts/createsubcontract.md): Creates a new subcontract or updates an existing one.
The id field can be omitted or set to null when adding a new subcontract.

### Get a Paged Subcontracts List

 - [GET /SubContracts/paged](https://developers.fuelu2.com/apis/customer/subcontracts/getpagedsubcontracts.md): Retrieves a paginated list of subcontracts with optional filters for customer, driver, vehicle, and search text.

### Adjust Subcontract Markups

 - [POST /SubContractMarkups](https://developers.fuelu2.com/apis/customer/subcontracts/subcontractmarkups.md): Adjusts the markup for a specific product within a subcontract. The subContractId is required to identify which subcontract’s markup is being modified.

### Place Subcontract Order

 - [POST /SubContractOrders](https://developers.fuelu2.com/apis/customer/subcontracts/subcontractorders.md): Creates a new subcontract order.
The customerId and subContractId are automatically assigned on the backend.

### List SubContract Orders (Paged)

 - [GET /SubContractOrders/paged](https://developers.fuelu2.com/apis/customer/subcontracts/getpagedsubcontractorders.md): Retrieves a paginated list of subcontract orders.
The customerId and subContractId are set automatically on the backend.

### Get Proforma

 - [GET /Files/{id}](https://developers.fuelu2.com/apis/customer/subcontracts/getproforma.md): Retrieves a proforma document using the order's customerSubContractInvoiceId.