Fuel transaction details

You can run ATE transactions using the CreateTransaction endpoint or the CreateOrAdjustTransaction endpoint. For each request, the following are required in the header:
Authorization using basic HTTP authentication
x-company-id (provided during provisioning)
Content-Type: application/json
The following models are also required in each transaction. These are shown and described in the code example below.
In addition to the required models listed above, you can also optionally specify models for exchange rates, transaction line measures, and special jurisdictions for origin, destination, and sale locations.
The example below shows a simple fuel transaction with transaction and transaction line elements.
{
  "AdjustmentReason": "Other", //--Required: Potential Values: NotAdjusted, SourcingIssue, ReconciledWithGeneralLedger, ExemptCertApplied, PriceAdjusted, ProductReturned, ProductExchanged, BadDebt, Other, Offline
  "AdjustmentDescription": "Price drop after shipping", //--Optional
  "newTransaction": {
    "TransactionLines": [
      {
        "InvoiceLine": 10, //--Required.  This delinates the tax response line items.
        "MovementStartDate": "", //--Optional:  Can be used for specialty tax configurations if populated with a value.
        "MovementEndDate": "", //--Optional:  Can be used for specialty tax configurations if populated with a value.
        "ProductCode": "167", //--Required:  Jurisdiction = '\''TD'\'' in Products table. All relevant FTA codes for hydrocarbon products.
        "UnitPrice": 1.00, //--Conditional Required:  If LineAmount NOT passed, required for sales tax calculations.
        "NetUnits": 10000, //--Required:  Net Unit volume at 60 degrees Fahrenheit
        "GrossUnits": 10123, //--Required:  Gross Unit volume at time of delivery
        "BilledUnits": 10000, //--Required:  Unit volume used for billing. Either NET or GROSS here.
        "LineAmount": 10000, //--Conditional Required:  If UnitPrice NOT passed, required for sales tax calculations.
        "BillOfLadingNumber": "CertTest_1", //--Optional, but relevant for searching for the transaction in the ATE GUI.
        "BillOfLadingDate": "", //--Optional, but relevant for searching for the transaction in the ATE GUI.
        "OriginCountryCode": "USA", //--Required.
        "OriginJurisdiction": "TX", //--Required.
        "OriginCounty": "HARRIS", //--Required.
        "OriginCity": "HOUSTON", //--Required.
        "OriginPostalCode": "77002", //--Required.
        "OriginAddress1": "", //--Recommended: provides more accurate sales tax determination if passed.
        "OriginType": "", //--Optional: can be used to key taxation rules based on the location type (Warehouse, Terminal, Bulk, etc.)
        "Origin": "Loc1234", //--Required: The ability to pass a CustomID for a defined location in Excise in lieu of location attributes.
        "DestinationCountryCode": "USA", //--Required.
        "DestinationJurisdiction": "TX", //--Required.
        "DestinationCounty": "HARRIS", //--Required.
        "DestinationCity": "HOUSTON", //--Required.
        "DestinationPostalCode": "77003", //--Required.
        "DestinationAddress1": "", //--Recommended: provides more accurate sales tax determination if passed.
        "DestinationType": "", //--Optional: can be used to key taxation rules based on the location type (Warehouse, Terminal, Bulk, etc.)
        "Destination": "Loc4321", //--Required: The ability to pass a CustomID for a defined location in Excise in lieu of location attributes.
        "SaleCountryCode": "USA", //--Required.   Important for Below the Rack transactions
        "SaleJurisdiction": "IL", //--Required.
        "SaleCounty": "COOK", //--Required.
        "SaleCity": "CHICAGO", //--Required.
        "SalePostalCode": "60610", //--Required.
        "SaleAddress1": "", //--Recommended: provides more accurate sales tax determination if passed.
        "SaleType": "", //--Optional: can be used to key taxation rules based on the location type (Warehouse, Terminal, Bulk, etc. used in constructing Advance Rules)
        "SaleLocation": "Loc4444", //--Required: The ability to pass a CustomID for a defined location in Excise in lieu of location attributes.
        "UserData": "CertTest_1", //--Optional: will return in the UserReturnedValue field in the Response.
        "Currency": "USD", //--Required: The currency of the locations.  If multi-currency is in scope, please reference the Currency Exchange JSON sample for explanations.
        "UnitOfMeasure": "BLL", //--Required: Unit of Measure for volumes passed in volume fields.
        "CustomString1": "Flag1", //--Future customizability field. Pass in API even if not sourced.
        "CustomString2": "Flag2", //--Future customizability field. Pass in API even if not sourced.
        "CustomString3": "Flag3", //--Future customizability field. Pass in API even if not sourced.
        "CustomNumeric1": 1, //--Future customizability field. Pass in API even if not sourced.
        "CustomNumeric2": 2, //--Future customizability field. Pass in API even if not sourced.
        "CustomNumeric3": 3, //--Future customizability field. Pass in API even if not sourced.
        "TaxIncluded": false, //--Optional:  Will pass TaxIncluded parameter to Avatax for reverse tax calculations when included in LineAmount
        "Discounted": false, //--True/False, line item'\''d discounted? Not required.
        "EntityUseCode": "" //--Required for full ATE/Avatax Integrations: EntityUseCode value to be passed to Avatax at the line level to key Sales/Use Tax Exemptions:
        //----Valid values: A-Federal Government, B-State Government, C-Tribal Government, D-Foreign Diplomat, E-Charitable/Exempt, F-Religious Organization
        //----(cont) G: Resale, H-Agriculture, I-Industrial Prod/Manufacturers, J-Direct Pay, K-Direct Mail, M-Educational Org, N-Local Government, P-Commerical Aquaculture
        //----(cont) Q-Commerical Fishery, R-Non-Resident (Custom EntityUseCode can also be leveraged)
      }
    ],
    "EffectiveDate": "08-23-24", //--Required:  Typically the Bill of Lading Date. The date of the tax rate to be applied to the transaction.
    "InvoiceDate": "08-23-24", //--Required:  Used for ease of search of transactions sent from source system.
    "InvoiceNumber": "", //--Required:  Used for ease of search of transactions sent from source system.
    "FuelUseCode": "", //--Optional:  Can be used for specialty tax configurations if populated with a value.
    "TitleTransferCode": "DEST", //--Required:  Where Title of ownership transfered.  Valid values: DEST and ORIG
    "TransactionType": "ABOVE", //--Required:  Where the product is in the supply chain. Valid values: ABOVE, BELOW, RACK
    "TransportationModeCode": "PL", //--Optional:  Mode of transportation. Can be used for specialty tax configurations.
    "Seller": "SUPPLIER2", //--Required:  The CustomId of the Seller.
    "Buyer": "SUPPLIER1", //--Required:  The CustomId of the Buyer.
    "UserData": "ATE_POSTMAN", //--Optional:  will return in the UserReturnedValue field in the Response.
    "UserTranId": "USER_TRAN_ID", //--Required:  The corresponding Avatax TransactionCode of which is used to Commit a transaction in both environments. GUID highly recommended.  Every new transaction must have a new UserTranId.
    "SourceSystem": "POSTMAN", //--Future customizability field. Pass in API even if not sourced.
    "CustomString1": "Certification", //--Future customizability field. Pass in API even if not sourced.
    "CustomString2": "Test", //--Future customizability field. Pass in API even if not sourced.
    "CustomString3": "No_1_167", //--Future customizability field. Pass in API even if not sourced.
    "CustomNumeric1": 0, //--Future customizability field. Pass in API even if not sourced.
    "CustomNumeric2": 0, //--Future customizability field. Pass in API even if not sourced.
    "CustomNumeric3": 0, //--Optional:  Can be used for specialty tax configurations if populated with a value.
    "AvataxTransactionType": "SalesInvoice", //--Recommended (SalesInvoice or PurchaseInvoice):  Defaults to SalesInvoice if not passed. Used to pass "type" into Avatax to indicate if Sales or Use Tax should be calculated.
    "Discount": "0.00", //--Discount.  Not required. Utilized for passing discounts into the tax engine.
    "EntityUseCode": "" //--Required for full ATE/Avatax Integrations: EntityUseCode value to be passed to Avatax at the line level to key Sales/Use Tax Exemptions:
    //----Valid values: A-Federal Government, B-State Government, C-Tribal Government, D-Foreign Diplomat, E-Charitable/Exempt, F-Religious Organization
    //----(cont) G: Resale, H-Agriculture, I-Industrial Prod/Manufacturers, J-Direct Pay, K-Direct Mail, M-Educational Org, N-Local Government, P-Commerical Aquaculture
    //----(cont) Q-Commerical Fishery, R-Non-Resident (Custom EntityUseCode can also be leveraged)
  }
}