API Reference for Hauling Software System Adminstration
To access our Invoicing API, contact us so that we can provide you with the necessary credentials and API URL endpoints.
All API calls are POST request to the endpoint URL, with JSON data returned.
Using the System Admin API to retrieve data
Action: get_all
Vaules Passed: api_key, action, admin_table
admin_table accepted values: (company | disposal | leases | drivers | invoice_status | special_projects | additional_line_items | pusher | trailer_type | trailer | truck_type | truck | yards)
Return: Notice, Result (array)
Below are a few examples with return data.
Company Table
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=company
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "5440",
"name": "Ada Energy"
},
{
"id": "5441",
"name": "Alpha Operating, LLC"
},
{
"id": "5442",
"name": "Bulldog Production"
},
{
"id": "5443",
"name": "PetroFind"
},
{
"id": "5444",
"name": "Red Mountain"
}
]
}Leases Table
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=leases
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "48206",
"name": "Mackey 1-11H",
"company": "Ada Energy",
"disposal": "Mowdy SWD",
"company_id": "5440",
"disposal_id": "960"
},
{
"id": "48208",
"name": "Smith 2-18H",
"company": "Ada Energy",
"disposal": "Mowdy SWD",
"company_id": "5440",
"disposal_id": "960"
},
{
"id": "48210",
"name": "Cougar 1-32H",
"company": "Alpha Operating, LLC",
"disposal": "Double 5 SWD",
"company_id": "5441",
"disposal_id": "959"
},
{
"id": "48212",
"name": "Jack Stone #9",
"company": "Bulldog Production",
"disposal": "Pearcy SWD",
"company_id": "5442",
"disposal_id": "961"
}
]
}Truck
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=truck
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "1315",
"truck_type": "Transport",
"truck_number": "8978",
"vin": "12345",
"year": "2019",
"make": "Kenworth",
"model": "T800",
"tag": "8978",
"color": "Black",
"licenseplatenumber": "12345"
},
{
"id": "1316",
"truck_type": "Transport",
"truck_number": "5642",
"vin": "54321",
"year": "2019",
"make": "Mack",
"model": "CHU613",
"tag": "5642",
"color": "Black",
"licenseplatenumber": "54321"
},
{
"id": "1317",
"truck_type": "Pump Truck",
"truck_number": "9845-PT",
"vin": "45678",
"year": "2019",
"make": "Kenworth",
"model": "T300",
"tag": "45678",
"color": "White",
"licenseplatenumber": "45678"
},
{
"id": "1318",
"truck_type": "Bobtail",
"truck_number": "6545-BT",
"vin": "65432",
"year": "2019",
"make": "Mack",
"model": "CL713",
"tag": "65432",
"color": "White",
"licenseplatenumber": "65432"
}
]
}Trailer
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=trailer
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "397",
"trailer_type": "120 BBL",
"trailer_number": "1",
"vin": "",
"year": "2019",
"make": "",
"model": ""
},
{
"id": "398",
"trailer_type": "120 BBL",
"trailer_number": "2",
"vin": "",
"year": "2019",
"make": "",
"model": ""
}
]
}