All pages
Powered by GitBook
1 of 4

Integrations

Avalara

Avalara is a 3rd party tax compliance software that can be used to dynamically assign tax codes based on Order and Yard Locations.

First Time Setup

Yard Location

  • Go to Resources > Locations

  • Highlight a Region and Location

  • Click the Edit button on the Yard

HaulHub

For assistance in building the Haul Hub Integration, contact us at 865-219-2980 or support@tacinsight.com

Note: You will need access to the API Module in order to build this integration!

Enabling the Haul Hub Integration

  • Navigate to Admin Settings (Gear Icon) > API Info

  • Click on the "Show" button to access the Webhooks Dashboard.

  • Click the "+ Add Endpoint" button to build the webhook.

  • In the Message Filtering options, select ticket.created, ticket.updated, and ticket.voided.

  • Build the Endpoint URL following this layout:

https://integrations.fast-weigh.dev/api/HaulHubDOT?fw_api_key=<insert_fast-weigh_api_key_here>&hh_api_key=<insert_haulhub_api_key_here>&fw_graphql_server=<insert_graphql_server_prefix_here>

  • You can find your API Key and GraphQL server (the first part of the GraphQL Endpoint URL) on the API Info Page.

  • It should look something like this when you are finished:

https://integrations.fast-weigh.dev/api/HaulHubDOT?fw_api_key=11111-11111-1111-11111&hh_api_key=2222222-22222-22222-22222&fw_graphql_server=fwt

  • Hit the Create button to create the new webhook.

  • Check the "Certified" checkbox on any order that you want tickets to flow to HaulHub.

Some DOTs require a Agency Code. This value will be provided by Haul Hub if applicable.

https://integrations.fast-weigh.dev/api/HaulHubDOT?fw_api_key=<insert_fast-weigh_api_key_here>&hh_api_key=<insert_haulhub_api_key_here>&fw_graphql_server=<insert_graphql_server_prefix_here>&dot_code=<insert_agency_code_here>

It should looks something like this when you are finished:

https://integrations.fast-weigh.dev/api/HaulHubDOT?fw_api_key=11111-11111-1111-11111&hh_api_key=2222222-22222-22222-22222&fw_graphql_server=fwt&dot_code=0123436C3A3FABCD

Haulhub Javascript Payload

slip_number: ticket.TicketNumber,
dot_code: DOT_CODE ?? '',
dispatched_at: formattedDateTime,
last_updated: formattedDateTime,
timestamp: formattedDateTime,
gross_amount: ticket.GrossWeight,
tare_amount: ticket.TareWeight,
net_amount: ticket.NetWeight,
quantity_uom_code: 'ton',
gross2_amount: ticket.GrossWeight! * 2000,
tare2_amount: ticket.TareWeight! * 2000,
net2_amount: ticket.NetWeight * 2000,
uom2: 'lbs',
client_id: ticket.Order.Customer.CustomerID,
client_name: ticket.Order.Customer.CustomerName,
comments: ticket.Note,
contract_number: ticket.Order.PONumber,
customer_name: ticket.Order.Customer.CustomerName,
deputy: ticket.Operator,
dispatch_number: ticket.TicketNumber,
job: ticket.Order.Description,
job_number: ticket.Job ? ticket.Job : ticket.Order.DefaultJob,
line_item_description: ticket.OrderProduct?.Product.ProductDescription,
line_item_quantity: ticket.NetWeight,
loads_today: totalTickets,
material_number: ticket.OrderProduct?.Product.ProductID,
phase_code: ticket.Phase,
plant_id: ticket.OrderProduct?.Yard.YardName,
plant_name: ticket.OrderProduct?.Yard.YardDescription,
product_code: ticket.OrderProduct?.Product.ProductID,
purchase_order_number: ticket.Order.PONumber,
quantity_shipped_today: totalNetWeight,
supplier: ticket.OrderProduct?.Yard.Location.Region.RemitName,
supplier_code: ticket.OrderProduct?.Yard.WarehouseCode ?? ticket.OrderProduct?.Yard.Location.Region.RegionName,
tonnage: ticket.NetWeight,
void: ticket.Void,
weighmaster: ticket.Operator,
fleet_id: ticket.Truck.Hauler.HaulerID,
fleet_name: ticket.Truck.Hauler.HaulerName,
truck_id: ticket.Truck.TruckID,
license_1: ticket.Truck.LicenseNum,
audit_log: [],

Fast-Weigh Ticket Integrator

The Fast-Weigh Ticket Integrator uses 32-bit ODBC connections to query compatible databases and post tickets to the Fast-Weigh API. It syncs tickets every 3 minutes.

The API will create/update/void any of the tickets posted.

  1. Download the exe from the latest release

  2. Create config.json file in the same directory as the .exe and set the api_key and dsn vars

  3. Create tickets.sql file in the same directory as the .exe

  4. Set FastWeighTicketIntegrator.exe to run at startup. (Run shell:startup via Windows Run. Copy a shortcut to the .exe into the startup directory.)

  5. Done!

Your directory should look like:

- config.json
- FastWeighTicketIntegrator.exe
- tickets.sql

Once the exe runs you'll also have some logs / debug files:

- api_payload.json
- api_response.json

config.json

You can write your own ODBC connection string in the "dsn" option, or use a 32-bit system DSN by name (preferred).

{
	"api_endpoint_url": "https://fwticketapi.azurewebsites.net/ticket",
	"api_key": "your-api-key-goes-here",
	"api_auth_method": "bearer",
	"dsn": "dsn=..."
}

If you're using the endpoint url https://api.fast-weigh.com/v3/tickets or https://api.fast-weigh.com/v2/tickets, set the api_auth_method to "api-key".

If you're using the endpoint url https://fwticketapi.azurewebsites.net/ticket, set the api_auth_method to "bearer".

tickets.sql

The tickets.sql file should conform to the FW API ticket payload body.

It is a simple text file with only the sql statement in it.

Field names should be renamed to match the keys in the ticket payload.

Sub-fields like the Region fields, Customer fields, etc... should be formated with underscores. Doing so will allow the program to parse the fields and nest them to match the format expected by the API endpoint.

A shortened example from the Libra dataset:

SELECT
  TicketNum AS TicketNumber,
  Transactions_DateTimeTransaction AS TicketDateTime,
  Customers_Customer_ID AS Customer_CustomerID
FROM Transactions
WHERE Transactions_DateTimeTransaction >= Date()-3

The above results in the following payload object:

{
	"TicketNumber": 1234,
	"TicketDateTime": "2022-04-01 12:00:00",
	"Customer": {
		"CustomerID": "ABC"
	}
}

Note: In some cases, the nesting will go 2 or 3 levels deep. Truck_Hauler_HaulerID for example.

Here's a starter script for a Libra Access DB:

SELECT
  TicketNum AS TicketNumber
  ,FORMAT( DATEADD('h', 5, Transactions_DateTimeTransaction) , 'YYYY-MM-DDThh:mm:ss') AS TicketDateTime
  ,FORMAT( DATEADD('h', 5, Transactions_DateTimeTransaction) , 'YYYY-MM-DDThh:mm:ss') AS PrintDateTime
  ,-5 AS UTCOffset
  ,Weighmaster AS Operator
  ,Transactions_TonsGrossWeight AS GrossWeight
  ,Transactions_TonsTareWeight AS TareWeight
  ,Transactions_TonsNetWeight AS NetWeight
  ,Trucks_Truck_ID AS Truck_TruckID
  ,Mid([Trucks_Description],1,10) AS Truck_Hauler_HaulerID
  ,Trucks_Description AS Truck_Hauler_HaulerName
  ,'External' AS Truck_Hauler_HaulerType
  ,'EXEMPT' AS TaxCode_Code
  ,'DURACAP' AS Region_RegionName
  ,'ASBURY' AS Location_LocationName
  ,'ASBRY' AS Yard_YardName
  ,Customers_Customer_ID AS Customer_CustomerID
  ,Customers_Customer_Name AS Customer_CustomerName
  ,Jobs_Job_ID AS Order_ExternalOrderID
  ,Jobs_Job_Name AS Order_Description
  ,Jobs_PO_Number AS Order_PONumber
  ,'true' AS Order_UsePOD
  ,'U' AS OrderProduct_FreightType
  ,'U' AS OrderProduct_SurchargeType
  ,'EXEMPT' AS OrderProduct_TaxCode_Code
  ,Products_Product_ID AS OrderProduct_Product_ProductID
  ,Products_Product_Name AS OrderProduct_Product_ProductDescription
  ,'Ton' AS OrderProduct_Product_UnitOfMeasure
  ,VoidTkt AS Void
FROM Transactions
WHERE Transactions_DateTimeTransaction >= Date()-3

Development notes

  • 32-bit Python. Many of these old databases are only compatible with 32-bit applications/drivers.

  • pyodbc requires Microsoft C++ Build Tools. The easiest way to get this is via the Visual Studio Installer.

  • Create virtual env: py -m venv venv (make sure you activate the env as well)

  • Install requirements: pip install -r requirements.txt

  • Dev command: py main.py

  • Build command: py build.py