isFleetSupported - setting this value to true enables sale transactions using a fleet card.| Name | Max | Required | Description |
|---|---|---|---|
| SummaryCommodityCode | 4 | Required | International description code of overall goods or services. |
| DiscountAmount | 12 | Required | Discount amount applied to the line item total. This field should be 0.00 if the unit cost reflects a discount price or if no line item discount applies, Recommend 0.00(DDDDDDDDD.CC) |
| DestinationZIPCode | Required | Postal/Zip Code of the address to where the purchased goods are being shipped. Recommend using merchant zip code for card-present. | |
| ShipFromZIPCode | Required | Postal/Zip Code of the address to where the purchased goods are being shipped. Recommend using merchant zip code for card-present. | |
| DestinationCountryCode | Required | Country code where goods are being shipped. U.S. is 840. Canada is 124. | |
| OrderDate | Required | Purchase order date.(YYYYMMDD) | |
| LineItemCount | Required | Number of line items included in transaction. Fleet supports 1 to 7 line items. |
| Name | Max | Required | Description |
|---|---|---|---|
| ItemCommodityCode | 12 | Required | International description code of the individual good or service being supplied. Recommend using numeric NACS code. |
| ItemDescription | 35 | Required | Item description. |
| ProductCode | 3 | Required | Numeric NACS code. |
| Quantity | 8 | Required | Quantity of the item.(NNNNN.DDD) |
| UnitOfMeasure | 1 | Required | Code for units of measurement. C = Case or Carton G = Gallons K = Kilograms L = Liters O = Other P = Pounds Q = Quarts U = Units Z = Ounces |
| UnitCost | 8 | Required | Unit cost of the item.(DDDDD.CC) |
| LineItemVATAmount | 12 | Required | Amount of any sales or value added taxes associated with the item. Recommend 0.00(DDDDDDDD.CC) |
| LineItemVATRate | 4 | Required | Tax rate used to calculate LineItemVATAmount. Submitted as a percentage. Two-digit implied decimal. Recommend 0. For example, if 10.42%, submit 1042 |
| LineItemDiscountAmount | 12 | Required | Discount amount applied to the line item. This field should be 0.00 if the unit cost reflects a discount price or if no line item discount applies.(DDDDDDDDD.CC) |
| LineItemTotalAmount | 12 | Required | Total full amount associated with the line item (UnitCost * Quantity) - LineItemDiscountAmount for that item.(DDDDDDDDD.CC) |
| AlternateTaxIdentifier | 15 | Optional | Tax identification number of the merchant reporting the alternate tax amount. Not applicable for US merchants. (tag must be present, but can be empty) |
| VATType | 4 | Optional | Type of value added taxes being used. Not applicable for US merchants. (tag must be present, but can be empty) |
| DiscountCode | 2 | Required | Indicates whether discount was applied to the purchase price of the item. Recommend 0. 0 = Not supported 1 = Amount is discounted 2 = Amount is not discounted |
| NetGrossCode | 2 | Required | Indicates whether extended item amount included the tax. Recommend 0. 0 = Not supported 1 = Item Amount includes tax amount 2 = Item Amount does not include tax amount |
| ExtendedItemAmount | 12 | Required | Amount of the item (unit price multiplied by quantity only). DDDDDDDDD.CC |
| DebitCreditCode | 2 | Required | Indicates whether ExtendedItemAmount is a Credit (taking away from the total amount of the sale) or Debit (adding to the total amount of the sale). Recommend 0. 0 = Not supported 1 = Extended Item Amount is Credit 2 = Extended Item Amount is Debit |
| ItemDiscountRate | 5 | Required | Discount rate for the line item. Submitted as a percentage. Two-digit implied decimal. Recommend 0. For example, if 10.42%, submit 1042 |
Here is sample request body for Fleet Sale:
POST /api/v1/sale
{
"laneId": "9999",
"transactionAmount": "11.00",
"commercialCardCustomerCode": "test",
"fleet": {
"summaryCommodityCode":9999,
"discountAmount":0.0,
"destinationZipCode":12345,
"shipfromZipCode":12345,
"destinationCountryCode":840,
"orderDate":20221231,
"lineItemCount":1,
"lineItemDetail": {
"lineItem": [ {
"itemCommodityCode":"9999",
"itemDescription":"Non-Fuel Item",
"productCode":"103",
"quantity":"1",
"unitOfMeasure":"C",
"unitCost":"11",
"lineItemVatAmount":"1",
"lineItemVatRate":"0.00",
"lineItemDiscountAmount":"0.00",
"lineItemTotalAmount":"11.00",
"alternateTaxIdentifier":" ",
"vatType":" ",
"discountCode":"0",
"netGrossCode":"0",
"extendedItemAmount":"0",
"debitCreditCode":"0",
"itemDiscountRate":"0"
} ]
}
}
}