Sale API Request Object

The description of the Sale API request object

You form a Sale API request in standard JSON format. The following tables list the properties of a Sale API request:

Top-Level Properties

Property	Description	Data Type	Length	Required	Allowed Values
`eEntryType`	How you entered the payment method.	Enum		YES	`ManualCardPresent` `Swipe`
`cardType`	The type of card that you processed. Currently, only `Aircard`.	Enum	7	YES	`Aircard`
`paymentMethodNumber`	The AIR Card® number.	Varchar	50	YES
`cvv`	The AIR Card® Card Verification Value, which you can use for manual card processing.	Varchar	3	NO
`cardExpirationDate`	The card expiration date in the format of `MM/yyyy`.	Char	7	YES
`softwareVendor`	The name of the software vendor transmitting the transaction.	Varchar	100	NO
`invoice`	The `invoice` subobject.	Object		YES

`invoice` Subobject

Property	Description	Data Type	Length	Required	Allowed Values
`invoiceNbr`	The invoice number, which must be unique within the context of the FBO.	Varchar	50	YES
`originalInvoiceNbr`	The number of the original invoice that you are rebilling in this transaction.	Varchar	50	NO
`currency`	The transaction currency.	Varchar	4	YES	A valid currency code.
`eFlightType`	The flight type associated with the transaction.	Enum	50	NO	`Private/Military` `Private/Experimental` `Private/Cargo` `Private/Government` `Private/Hazardous` `Material` `Private/Non` `Revenue` `Private/Ambulance` `Commercial` `Charter/Air` `Ambulance` `Charter/Air` `Taxi` `Charter/Cargo` `Charter/Hazardous` `Material` `Charter/Military` `Charter` `Charter/FAR 129` `Foreign Air Carrier`
`invoiceDate`	The invoice date in the format of `yyyy-MM-dd`.	Char	10	YES
`invoiceTotal`	The invoice total amount. The sum of all line items on the invoice, not including taxes and fees, should match this number, and you must round it to two decimal places.	Decimal	10,2	YES
`notes`	Any transaction notes.	Varchar	1000	NO
`captainName`	The name of the captain.	Varchar	150	NO
`fromIcao`	The ICAO code of the flight’s origin airport.	Varchar	4	NO
`destIcao`	The ICAO code of the flight’s destination airport.	Varchar	4	NO
`isDomestic`	Whether or not the flight is domestic or international. Domestic is considered a flight that has an origin and a next destination within the same country.	Boolean		NO
`tailNbr`	The aircraft’s tail number.	Varchar	50	YES
`details`	The `details` subobject array.	Array		YES

`details` Subobject (Array)

📘
Important Notes

You must send taxes and fees associated with a specific product or service in a taxAndFeesBreakdown subobject array.

If you charge a "vendor fee" for non-fuel items, however, you must include this fee in a details subobject and not in a taxAndFeesBreakdown subobject. Also, the gateway validates that the percentage of this fee in relation to the total value of non-fuel items matches the percentage that you specified in your configuration.

If you've applied a government discount to a transaction, you must reflect this discount in the difference between the postedPrice and the unitPrice properties.

A details subobject can only include one item of type Fuel but can have several non-fuel items.

The lineTotal and unitPrice properties can be zero, but the qty property must be greater than zero.

If itemCode has a product type of Fuel Related, there must be another item in the details subobject that has a product type of Fuel.

Property	Description	Data Type	Length	Required	Allowed Values
`lineId`	A line identifier that a merchant’s POS system generates, which must be unique within the context of a single transaction.	Integer	1000	YES
`itemCode`	A valid product code.	Varchar	100	YES
`VendorProductName`	The name of the product or service provided by the vendor in the POS system.	Varchar	100	YES
`flightNbr`	The flight number.	Varchar	50	NO
`unitOfMeasure`	The unit of measure for the item sold.	Enum	50	YES	`USG` `HL` `IMPGAL` `KL` `Liter` `M3` `Tons` `Each`
`eProcessingType`	The processing type, either `Contract` or `Retail`. If you input an `eProcessingType` of `Contract`, the gateway will check if you are under contract for that fuel and related contract products with the airport at the date and time that you have provided in the `deliveryDate` or in the `invoiceDate` if `deliveryDate` has not been specified. If you are not under contract at an airport for that fuel or related contract product, you cannot send transactions to the gateway if another merchant is under contract at the same airport (though system overrides may apply). If you are a third-party merchant with an `eProcessingType` of `Retail`, you must send the gateway the price of fuel prior to transaction initiation, and the gateway will validate this price in ongoing transactions.	Enum		YES	`Contract` `Retail`
`deliveryTicketNumber`	The delivery ticket number for fuel products, which must be unique within the context of the FBO.	Varchar	50	Required if the item is a fuel type.
`deliveryDate`	The date and time the service was delivered, in the format `yyyy-MM-dd HH:mm:ss`. The time is optional, but if provided, you must do so in UTC time.	Char	19	Required if the item is a fuel type.
`qty`	The product or service quantity, which can include up to two decimal places.	Decimal	8,2	YES
`unitPrice`	The unit price of the line item, which can include up to six decimal places.	Decimal	10,6	YES
`lineTotal`	The line total amount, up to two decimal places. If the product has taxes, you should specify them separately in the `taxAndFeesBreakdown` subobject array.	Decimal	10,2	YES
`postedPrice`	The posted price of the line item.	Decimal	19,8	NO
`description`	Any additional descriptive note for the line item.	Varchar	1000	NO
`taxAndFeesBreakdown`	The `taxAndFeesBreakdown` subobject array.	Array		NO

`taxAndFeesBreakdown` Subobject (Array)

📘
Important Notes

You cannot include the taxes and fees that have been specified in a taxAndFeesBreakdown subobject in the invoiceTotal property.

You can only include taxes and fees that the gateway has approved in a taxAndFeesBreakdown subobject.

The lineTotal and unitPrice properties can be zero, but the qty property must be greater than zero.

Property	Description	Data Type	Length	Required	Allowed Values
`itemCode`	A valid product code.	Varchar	100	YES
`VendorProductName`	The name of the product or service provided by the vendor in the POS system.	Varchar	100	YES
`eRateType`	Whether the tax or fee is percentage based or fixed per unit.	Enum		YES	`Percent` `PerUnit`
`percent`	The tax or fee percent. Required only if `eRateType` is `Percent`.	Decimal	5,2	NO
`eType`	Whether the tax or fee is a sales or cost tax.	Enum		YES	`SalesTax` `CostTax`
`qty`	Should specify the quantity for which the tax or fee applies, which will usually be the same as the quantity of the product the tax applies to.	Decimal	10,6	YES
`unitPrice`	The actual tax or fee value, which you should always send in decimal format. So if `eRateType` is `Percent` and the tax rate is 6.5%, you should send it as `0.065`.	Decimal	10,6	YES
`lineTotal`	The tax or fee line total rounded to 2 decimal places. Should equal `unitPrice * qty`.	Decimal	10,2	YES
`description`	Any additional descriptive note for the line item.	Varchar	1000	NO

You can find examples of this request object here.

Updated over 1 year ago

Did this page help you?