ESC Reports APIs (Part 2)

Overview ¶

This document provides a comprehensive guide to the APIs encompassed within the ESC Reports API suite.

The ESC Reports API is segmented into various sections, each dedicated to a specific functionality. The APIs currently available include:

…and several others.

Each API is associated with a unique endpoint and delivers distinct types of reports and data. The response from each API call comprises specific fields and data types.

For detailed documentation of each API, navigate to the respective link provided in the APIs section.

For more granular information on the request and response structures, please refer to the individual API sections.

Bearer Token

A bearer token is a type of access token that is used for authorization in APIs. It is a cryptic string that is generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources.

The “Bearer” keyword is a signal to the server that the token is a type of bearer token. Here’s an example of how to use it:

Authorization: Bearer <Your-Bearer-Token>

Replace with your actual bearer token.

For example:

Authorization: Bearer 5262d64b892e8d4341000001

Error Messages

400 Bad Request: This error is returned when the server could not understand the request due to invalid syntax. Check your request body and parameters.
401 Unauthorized: This error is returned when the request lacks valid authentication credentials for the target resource. Make sure your API key is correct.
403 Forbidden: This error is returned when the server understood the request, but it refuses to authorize it. This status is often returned if you’re missing permissions to access the resource.
404 Not Found: This error is returned when the server can’t find the requested resource. Check your endpoint and parameters.
500 Internal Server Error: This error is returned when the server encounters an unexpected condition that prevented it from fulfilling the request.

APIs ¶

Open Order Report ¶

Open Order Report
GET`/api/reporting/open_order_report`

Overview:

Retrieve data from the database to load into the Open Order Report.

Response Description:

Name	Data Type	Description
success	string	Indicates if request was successful (“true”/“false”)
content	array	Array of order records returned
id	number	Unique ID for the order record
orderNumber	number	Order number
billTo	string	Customer/party to bill
totalAmount	number	Total order amount
amountInvoiced	number	Amount already invoiced
amountSalesTax	number	Amount of sales tax
invoicingProtocol	string	Special invoicing instructions
invoiceStatus	string	Status of invoicing
orderName	string	Name of the order
facility	string	Facility related to order
totalElements	number	Total records counted

Example URI

GET https://test-api.wastelinq.com/api/reporting/open_order_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: customer=0,billTo=,facility=,startDate=,endDate=
The filter query
selectedFields: string (required) Example: suborderOrderNumber,billTo,generator,totalAmount,amountInvoiced,amountSalesTax
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": "true",
  "content": [
    {
      "id": 1,
      "orderNumber": 10000,
      "billTo": "Bill To ABC",
      "totalAmount": 268.52,
      "amountInvoiced": 0,
      "amountSalesTax": 0,
      "invoicingProtocol": "jane.doe@test.com\r\n\r\nFor project 10000 ONLY, bill to needs to be Western Railroad.",
      "invoiceStatus": null,
      "orderName": null,
      "facility": "Facility"
    }
  ],
  "totalElements": 2456
}

Order Revenue With Cost Detail Report ¶

Order Revenue With Cost Detail Report
GET`/api/reporting/order_revenue_with_cost_detail_report`

Overview:

Retrieve data from the database to load into the Order Revenue With Cost Detail Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of order records
id	number	Unique ID for the order
Sales_Rep	string	Sales representative
Generator_Number	number	Customer ID
Generator_Name	string	Customer name
Facility	string	Facility involved
Order_No	number	Order number
Order_Logistics_Status	string	Order status
Order_Type	string	Type of order
Scheduled_Date	date	Scheduled date
Total_Order_Wo_Sales_Tax	string	Total before tax
Sales_Tax	string	Sales tax amount
Total_Revenue	string	Total revenue
Material_Revenue	string	Revenue from materials
Products_Services_Revenue	string	Revenue from products/services
Material_Cost	string	Cost of materials
Products_Services_Cost	string	Cost of products/services
Total_Cost	string	Total cost
Gross_Margin	string	Total gross margin
Percent_Gross_Margin	string	Percentage gross margin
totalElements	number	Total records count

Example URI

GET https://test-api.wastelinq.com/api/reporting/order_revenue_with_cost_detail_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startdate=,enddate=,order_status=,facility=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "Sales_Rep": "Jane Doe",
      "Generator_Number": 100000,
      "Generator_Name": "Company ABC",
      "Facility": "Facility",
      "Order_No": 1,
      "Order_Logistics_Status": "Invoiced",
      "Order_Type": "Waste",
      "Scheduled_Date": "03-07-2019",
      "Total_Order_Wo_Sales_Tax": "$2,751.50",
      "Sales_Tax": "$0.00",
      "Total_Revenue": "$2,751.50",
      "Material_Revenue": "$764.00",
      "Products_Services_Revenue": "$1,987.50",
      "Material_Cost": "$573.00",
      "Products_Services_Cost": "$0.00",
      "Total_Cost": "$573.00",
      "Gross_Margin": "$2,178.50",
      "Percent_Gross_Margin": "79.17%"
    }
  ],
  "totalElements": 28432
}

Order Summary By Status Report ¶

Order Summary By Status
GET`/api/reporting/order_by_status`

Overview:

Retrieve data from the database to load into the Order Summary By Status Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array containing order records
id	number	Unique ID for the order
suborderOrderNumber	string	Order number
orderType	string	Type of order e.g. Waste
orderStatus	string	Current status of the order
salesRep	string	Sales representative assigned
scheduledDate	date	Date order was scheduled
orderTotal	string	Total value of the order
invoiceDate	date	Date the invoice was issued
invoiceNumber	string	Invoice number
invoiceTotal	string	Total on the invoice
billTo	string	Party/company to bill
customerNumber	string	Unique customer ID
totalElements	number	Total records in response

Example URI

GET https://test-api.wastelinq.com/api/reporting/order_by_status

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: customerId=,status=,billto=,startDate=,endDate=
The filter query
sort: string (required) Example: suborderOrderNumber asc
The sorting order

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "suborderOrderNumber": "1",
      "orderType": "Waste",
      "orderStatus": "Service Completed",
      "salesRep": "Jane Doe",
      "scheduledDate": "06-20-2018",
      "orderTotal": "$268.52",
      "invoiceDate": "",
      "invoiceNumber": "",
      "invoiceTotal": "",
      "billTo": "Bill To ABC",
      "customerNumber": "100000 / Company ABC / 10000"
    }
  ],
  "totalElements": 28432
}

Order Transportation Time Detail Report ¶

Order Transportation Time Detail
GET`/api/reporting/order_tran_time_delay`

Overview:

Retrieve data from the database to load into the Order Transportation Time Detail Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array containing pickup records
id	number	Unique ID for the pickup record
legacy_id	string	Legacy system ID (if applicable)
customer_no	string	Customer account number
customer_name	string	Customer name
sales_rep	string	Sales representative
tran1	string	Name of primary transporter
tran2	string	Name of secondary transporter (if any)
pup_date	date	Date of pickup
pup_time	string	Time of pickup
order_number	string	Associated order number
ptl_to_ptl_1	string	First pickup to next pickup interval
ptl_to_ptl_2	string	Second pickup to next interval (if route)
pup_stop_time	string	Time pickup was completed
del_time	string	Delivery time (if going direct)
totalElements	number	Total records returned

Example URI

GET https://test-api.wastelinq.com/api/reporting/order_tran_time_delay

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startDate=2023-08-01,endDate=2023-10-17,logistic=Generator Pickup,esc=31
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "legacy_id": "1",
      "customer_no": "100000",
      "customer_name": "Company ABC",
      "sales_rep": "Jane Doe",
      "tran1": "Jane Doe",
      "tran2": "Jane Doe",
      "pup_date": "09-12-2023",
      "pup_time": "12:00 AM",
      "order_number": "517275-01",
      "ptl_to_ptl_1": "10",
      "ptl_to_ptl_2": "",
      "pup_stop_time": "",
      "del_time": ""
    }
  ],
  "totalElements": 2498
}

Order Waste Product Code Summary Total Report ¶

Order Waste Product Code Summary Total
GET`/api/reporting/order_waste_product_code_summary_total`

Overview:

Retrieve data from the database to load into the Order Waste Product Code Summary Total Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of records
id	number	Unique record ID
process_code	string	Code for type of process/service
waste_type	string	Description of waste type
order_year	number	Year of order
order_month	number	Month of order
count	number	Number of orders
total_revenue	number	Total revenue from orders
orders	array	Array of individual order numbers
totalElements	number	Total records returned

Example URI

GET https://test-api.wastelinq.com/api/reporting/order_waste_product_code_summary_total

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startdate=2023-11-25,enddate=2023-12-25
The filter query
selectedFields: string (required) Example: process_code,waste_type,order_year,order_month,count,total_revenue
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 0,
      "process_code": "2012",
      "waste_type": "High Haz liquids\n",
      "order_year": 2023,
      "order_month": 11,
      "count": 1,
      "total_revenue": 8593,
      "orders": [
        "10000"
      ]
    }
  ],
  "totalElements": 109
}

Outbound Shipment Cont Type Size Summary Detail Report ¶

Outbound Shipment Cont Type Size Summary Detail
GET`/api/reporting/outbound_shipment_cont_type_size_summary_detail`

Overview:

Retrieve data from the database to load into the Outbound Shipment Cont Type Size Summary Detail Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of shipment records
id	number	Unique record ID
legacy_id	string	Legacy system ID
customer_no	string	Customer account number
customer_name	string	Customer name
tran1	string	Transporter name
pup_date	date	Pickup date
shipment_no	string	Shipment number
shipment_date	date	Shipment date
sub_order_number	string	Associated sub-order number
pos	number	Position in manifest
manifest_no	string	Manifest number
manifest_line	number	Line in manifest
tsdf_name	string	Receiving facility name
profile_no	string	Waste profile number
cont_count	number	Container count
cont_type	string	Container type
cont_size	number	Container size
d55equivalent	number	Weight equivalent
totalElements	number	Total records

Example URI

GET https://test-api.wastelinq.com/api/reporting/outbound_shipment_cont_type_size_summary_detail

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startdate=2023-12-01,enddate=2023-12-25,broker_id=
The filter query
selectedFields: string (required) Example: esc,legacy_id,customer_no,customer_name,tran1,pup_date,shipment_no,shipment_date,sub_order_number,pos,manifest_no,manifest_line,tsdf_name,profile_no,cont_count,cont_type,cont_size,d55equivalent
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "legacy_id": "1",
      "customer_no": "10000",
      "customer_name": "Company ABC",
      "tran1": "Third Party Trans Entry",
      "pup_date": "12-07-2023",
      "shipment_no": "1",
      "shipment_date": "12-07-2023",
      "sub_order_number": "10000-01",
      "pos": "1",
      "manifest_no": "10000",
      "manifest_line": "1",
      "tsdf_name": "tsdf abc",
      "profile_no": "1",
      "cont_count": "3",
      "cont_type": "TP",
      "cont_size": "275",
      "d55equivalent": 15
    }
  ],
  "totalElements": 462
}

Outbound Shipment Report ¶

Outbound Shipment Report
GET`/api/reporting/outbound_shipment_report`

Overview:

Retrieve data from the database to load into the Outbound Shipment Report.

Sample TOKEN:

Authorization: 5262d64b892e8d4341000001

Response Description:

Name	Data Type	Description
success	string	Indicates request success status
content	array	Array of shipment records
id	number	Unique record identifier
OutboundShipmentNumber	number	Shipment reference number
DisposalLoadNumber	number	Related disposal load number
ShipmentDate	string	Date shipment was made
TruckNumber	string	Transport vehicle ID
DisposalSite	string	Receiving facility name
Trailer	string	Trailer unit used (if relevant)
OrderNumber	string	Reference to source order
CustomerNumber	string	Generator/customer name
ManifestNumber	string	Associated waste manifest #
ManifestDisposalNumber	string	Link to disposal manifest
ProfileName	string	Waste profile classification
ApprovalNumber	string	Generator’s waste permit #
WasteProductCode	string	Disposal category code
ContainerType	string	Type of container used
ContainerSize	string	Container capacity
ContainerCount	number	Containers in shipment
Weight	number	Total shipment weight
totalElements	number	Total records in response

Example URI

GET https://test-api.wastelinq.com/api/reporting/outbound_shipment_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: obshipid=0,startdate=,enddate=,chkShipped=,obshipname=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": "true",
  "content": [
    {
      "id": 1,
      "OutboundShipmentNumber": 1,
      "DisposalLoadNumber": 1,
      "ShipmentDate": "05-27-2020",
      "TruckNumber": "1",
      "DisposalSite": "Disposal Site 1",
      "Trailer": "Trailer 1",
      "OrderNumber": "1",
      "CustomerNumber": "Company ABC",
      "ManifestNumber": "10000",
      "ManifestDisposalNumber": 10000,
      "ProfileName": "Profile ABC",
      "ApprovalNumber": "10000",
      "WasteProductCode": "7603",
      "ContainerType": "CM",
      "ContainerSize": "4000",
      "ContainerCount": 1,
      "Weight": 0
    }
  ],
  "totalElements": 38091
}

Payment Balance Invoice Report ¶

Payment Balance Invoice
GET`/api/reporting/payment_balance_invoice`

Overview:

Retrieve data from the database to load into the Payment Balance Invoice Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of transaction records
id	number	Unique transaction ID
orders	string	Associated orders (if any)
date	date	Date of transaction
description	string	Description of transaction type
invoice_no	string	Invoice number (if invoice)
project	string	Related project (if any)
charge	string	Charge amount
discount_applied	string	Discount applied (if any)
payment	string	Payment received (if any)
balance	string	Remaining balance

Example URI

GET https://test-api.wastelinq.com/api/reporting/payment_balance_invoice

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: billtoId=16297,startDate=2023-11-25,endDate=2023-12-25
The filter query
selectedFields: string (required) Example: orders,date,description,invoice_no,project,charge,discount_applied,payment,balance
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "orders": "1",
      "date": "2023-11-25",
      "description": "Balance Forward",
      "invoice_no": "1",
      "project": "project abc",
      "charge": "charge",
      "discount_applied": "10%",
      "payment": "Cash",
      "balance": "$16,687.86"
    }
  ]
}

Profile Activity Report ¶

Profile Activity Report
GET`/api/reporting/profile_active_order`

Overview:

Retrieve data from the database to load into the Profile Activity Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of records
id	number	Unique record ID
orderNumber	string	Associated order number
customerName	string	Name of customer
profileNumber	number	Waste profile/DOT number
profileName	string	Description of waste profile
tsdf	string	Receiving treatment/disposal facility
orderDate	date	Date of order/pickup
manifest	string	Manifest number
lineNumber	string	Line on the manifest
processCode	string	Type of service/process code
contType	string	Container type (box, drum etc)
contSize	string	Container size/capacity
contCnt	number	Number of containers
isNetworkExcempt	string	Exemption class (if any)
totalElements	number	Total records in response

Example URI

GET https://test-api.wastelinq.com/api/reporting/profile_active_order

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: customer_id=,profile_id=,esc=,is_exam=Enterprise,startDate=,endDate=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "orderNumber": "10000",
      "customerName": "Company ABC",
      "profileNumber": 1,
      "profileName": "4FT FLUOR. LAMPS",
      "tsdf": "tsdf abc",
      "orderDate": "06-20-2018",
      "manifest": "D1000",
      "lineNumber": "1",
      "processCode": "1000",
      "contType": "CF",
      "contSize": "1",
      "contCnt": 75,
      "isNetworkExcempt": "Enterprise"
    }
  ],
  "totalElements": 26401
}

Sale Activity Report ¶

Sale Activity Report
GET`/api/reporting/sale_activity_report`

Overview:

Retrieve data from the database to load into the Sale Activity Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of records
id	number	Unique record ID
sale_rep	string	Name of sales representative
new_gen_add	number	New generators/accounts added
pricing_requests_submitted	number	Pricing requests submitted
new_profile_created	number	New waste profiles created
forecast_revenue	number	Forecasted future revenue
completed_order_revenue	number	Revenue from completed orders
discount_invoice_revenue	number	Revenue from discounted invoices
total_row	array	Array with total metrics

Example URI

GET https://test-api.wastelinq.com/api/reporting/sale_activity_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: salerep=-1,startdate=2023-01-01,enddate=2023-12-31
The filter query
selectedFields: string (required) Example: sale_rep,new_gen_add,pricing_requests_submitted,new_profile_created,forecast_revenue,completed_order_revenue,discount_invoice_revenue
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "sale_rep": "Unassigned",
      "new_gen_add": 5,
      "pricing_requests_submitted": 0,
      "new_profile_created": 1,
      "forecast_revenue": 0,
      "completed_order_revenue": 0,
      "discount_invoice_revenue": 0
    }
  ],
  "total_row": [
    "Total",
    282,
    109,
    2133,
    19159965.06,
    751973.12,
    18398559.21
  ]
}

Sales Summary Report by Rep ¶

Sales Summary Report by Rep
GET`/api/reporting/sales_summary_report_by_rep`

Overview:

Retrieve data from the database to load into the Sales Summary Report by Rep.

Response Description:

Name	Data Type	Description
success	boolean	Indicates request success
content	array	Array of order records
id	number	Unique record ID
sale_rep_id	string	Sales rep ID
sales_rep	string	Sales rep name
bill_to	string	Billing name
list_orders	array	Array of order details
order_number	string	Order number
zone	string	Service zone
gen_num	number	Generator ID
gen_name	string	Generator name
city	string	Generator city
category	string	Order category
scheduled_date	date	Scheduled date
total_order	string	Total order amount
order_status	string	Status of order
invoice_date	date	Invoice date
invoice_status	string	Invoice status
bill_to	string	Billing name
facility	string	Facility servicing order
sales_rep	string	Sales rep name
sales_rep_id	number	Sales rep ID

Example URI

GET https://test-api.wastelinq.com/api/reporting/sales_summary_report_by_rep

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startdate=2023-12-01,enddate=2023-12-25
The filter query
selectedFields: string (required) Example: sales_rep
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "sale_rep_id": "1",
      "sales_rep": "Jane Doe",
      "bill_to": "Bill To ABC",
      "list_orders": [
        {
          "order_number": "1",
          "zone": 1A,
          "gen_num": 1,
          "gen_name": "Company ABC",
          "city": "New York",
          "category": "GEN",
          "scheduled_date": "12-21-2023",
          "total_order": "$1,439.00",
          "order_status": "Service Completed",
          "invoice_date": "12-21-2023",
          "invoice_status": null,
          "bill_to": "bill to abc",
          "facility": "Facility 1",
          "sales_rep": "Jane Doe",
          "sales_rep_id": 396
        }
      ]
    }
  ]
}

Service Profile Summary Report ¶

Service Profile Summary Report
GET`/api/reporting/service_profile_summary_report`

Overview:

Retrieve data from the database to load into the Service Profile Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array of generator records
id	number	Unique generator ID
Legacy_ID	string	Legacy system ID
Generator_Name	string	Name of generator
Address1	string	Address line 1
Address2	string	Address line 2
City	string	City
State	string	State
Zip	string	Zip code
Account_Assignment	string	Account manager
Fuel_Surcharge_Rate	string	Fuel surcharge percentage
Fuel_Surcharge_Exempt	boolean	Fuel surcharge exemption flag
Base_Container_Size	string	Base container size
Base_Container_Rate	string	Base container rate
55_Equivalent_Rate	string	55-gallon drum equivalent rate
Washout_Cost	string	Washout cost
Product_Number	string	Associated product/material number
Description	string	Product description
Price_per_Unit	string	Price per unit of measure
totalElements	number	Total records returned

Example URI

GET https://test-api.wastelinq.com/api/reporting/service_profile_summary_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "Legacy_ID": "1",
      "Generator_Name": "Company ABC",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Account_Assignment": "Jane Doe",
      "Fuel_Surcharge_Rate": "0.29",
      "Fuel_Surcharge_Exempt": "False",
      "Base_Container_Size": "10",
      "Base_Container_Rate": "10",
      "55_Equivalent_Rate": "10",
      "Washout_Cost": "100",
      "Product_Number": "1",
      "Description": "test",
      "Price_per_Unit": "1"
    }
  ],
  "totalElements": 4453
}

Shipment Container Detail Report ¶

Shipment Container Detail Report
GET`/api/reporting/shipment_container_detail_report`

Overview:

Retrieve data from the database to load into the Shipment Container Detail Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if request was successful
content	array	Array containing manifest records
id	number	Unique ID for the record
json_contents	array	Nested array of manifest details
StateWasteCode	string	State generated waste code
TSDF	string	Receiving treatment/disposal facility
handing_code	string	Handling code
facility_State_ID	string	Facility state ID
facility_EPA_ID	string	Facility EPA ID
Manifest_Cnt	number	Manifest container count
materials	array	Nested materials/shipments array
order_id	string	Associated order ID
manifest	string	Associated manifest number
linenumber	number	Line item on manifest
cont_type	string	Container type (drum, tote, etc)
cont_size	number	Container size in gallons
cont_count	number	Number of containers
pu_date	date	Pickup/collection date
approval_number	string	Waste approval permit #
exp_date	date	Approval expiration date
profile_name	string	Waste profile classification
process_code	string	Treatment/disposal process
weight	number	Shipment weight in lbs or kg
tran_state_id	string	Transporter’s state ID
total_cost	number	Total cost of shipment
cost	number	Per container/unit cost
actual_weight	number	Measured weight if differs
container_no	string	Container serial numbers
total_cost	number	Total cost of the shipment in the record
avg_cost	number	Average cost per item in the shipment
total_weight	number	Total weight of the shipment in pounds
total_info	object	Aggregated totals for the customer
total_weight	number	Total weight of all shipments for customer
total_cost	number	Total cost of all shipments for customer
avg_cost	number	Avg cost per unit of all shipments for customer
customer_name	string	Name of the associated customer
customer_no	number	Customer ID/account number
customer_epa	string	Customer’s EPA registration number
customer_state	string	Customer’s state registration
sumclass_weight	object	Summary of shipment weights by category
sumclass_weight_1 etc	number	Weight for each category
sumclass_cost	object	Summary of costs by category
sumclass_cost_1 etc	number	Cost for each category
totalElements	number	Total records in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/shipment_container_detail_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: startdate=2023-01-01,enddate=2023-12-01,customer_id=39894,chkCost=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "json_contents": [
        {
          "StateWasteCode": "10000",
          "TSDF": "TSDF ABC",
          "handing_code": "H132",
          "facility_State_ID": "1000/20000",
          "facility_EPA_ID": "10000",
          "Manifest_Cnt": 1,
          "EPA_Code": "1",
          "HandingCode": "1",
          "marterials": [
            {
              "order_id": "10000-01",
              "manifest": "10000",
              "linenumber": "1",
              "cont_type": "TP",
              "cont_size": "275",
              "cont_count": 22,
              "pu_date": "03-02-2023",
              "approval_number": " 10000",
              "exp_date": "07-08-2023",
              "profile_name": "RCRA Empty Containers",
              "process_code": "7506",
              "weight": 4416.5,
              "tran_state_id": "91034",
              "total_cost": 2750,
              "cost": 125,
              "acctual_weight": 22,
              "container_no": "N/A"
            }
          ],
          "total_cost": 2750,
          "avg_cost": 125,
          "total_weight": 4416.5
        }
      ],
      "total_info": {
        "total_weight": 125473.5,
        "total_cost": 30539,
        "avg_cost": 83.79310344827586,
        "customer_name": "Company ABC",
        "customer_no": 1006360,
        "customer_epa": "10000",
        "customer_state": "96117"
      },
      "sumclass_weight": {
        "sumclass_weight_1": 32033.6,
        "sumclass_weight_2": 0,
        "sumclass_weight_3": 0,
        "sumclass_weight_4": 0,
        "sumclass_weight_5": 93439.89999999998
      },
      "sumclass_cost": {
        "sumclass_cost_1": 12910,
        "sumclass_cost_2": 0,
        "sumclass_cost_3": 0,
        "sumclass_cost_4": 0,
        "sumclass_cost_5": 17629
      }
    }
  ],
  "totalElements": 1
}

Vendor Cost Report ¶

Vendor Cost
GET`/api/reporting/vendor_cost`

Overview:

Retrieve data from the database to load into the Vendor Cost Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates request success status
content	array	Array of record objects
id	number	Unique record identifier
path	string	Hierarchical path of related records
vendorName	string	Name of vendor/service provider
vendorNumber	string	Vendor account/reference number
costCategory	string	Type of cost (disposal, transport etc)
description	string	Item/service description
quantity	string	Quantity of item/service provided
unitPrice	string	Price per unit
commitCost	string	Estimated/committed cost
actualCost	string	Actual invoiced cost
orderNumber	string	Associated purchase order number
subtotal	string	Running line item subtotal
totalElements	number	Total records in full response

Example URI

GET https://test-api.wastelinq.com/api/reporting/vendor_cost

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: vendorInvoice=,vendorId=,startDate=2023-08-01,endDate=2023-10-20
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "path": "1/1/1",
      "vendorName": Demo LLC",
      "vendorNumber": "1",
      "costCategory": "Disposal",
      "description": "Used Oil Filters",
      "quantity": "2.00",
      "unitPrice": "$35.00",
      "commitCost": "$70.00",
      "actualCost": "$31.40",
      "orderNumber": "10000",
      "subtotal": ""
    }
  ],
  "totalElements": 6333
}

Waste Product Code Pricing Summary Report ¶

Waste Product Code Pricing Summary
GET`/api/reporting/process_code_pricing_summary_report`

Overview:

Retrieve data from the database to load into the Waste Product Code Pricing Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates request success status
content	array	Array of waste profile records
Waste_Product_Code	string	Internal code for waste product
waste_type	string	Description of the waste type
disposal_method	string	Method of handling the waste
final_tsdf	string	Name of final facility
vendor_process_code	string	Vendor’s internal code
cont_type	string	Typical container type used
cont_size	string	Standard container size
cost_basic	string	Basis for how cost is determined
cost	string	Associated cost (likely per container)
min_cost	string	Minimum cost
price_basic	string	Basis for how price is set
list_price	string	Standard published price
min_price	string	Minimum price
case_by_case	string	Pricing flexibility flag
Enterprise	string	Customer type eligibility
id	number	Unique record identifier
totalElements	number	Total records in response

Example URI

GET https://test-api.wastelinq.com/api/reporting/process_code_pricing_summary_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: process_code=,tsdf=,wastetypes=,disposalmethod=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "Waste_Product_Code": "123456",
      "waste_type": "Waste Type",
      "disposal_method": "Alternate Fuels",
      "final_tsdf": "TSDF ABC",
      "vendor_process_code": "None",
      "cont_type": "BA",
      "cont_size": "202 (G)",
      "cost_basic": "Per Container",
      "cost": "$22.00",
      "min_cost": "$22.00",
      "price_basic": "Per Container",
      "list_price": "$22.00",
      "min_price": "$22.00",
      "case_by_case": "No",
      "Enterprise": "Yes",
      "id": 1
    }
  ],
  "totalElements": 11229
}

Waste Product Code Summary Report ¶

Waste Product Code Summary
GET`/api/reporting/process_code_summary_report`

Overview:

Retrieve data from the database to load into the Waste Product Code Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates request success status
content	array	Array of waste profile records
id	number	Unique record identifier
Waste_Product_Code	string	Internal code for waste product
Disposal_Method	string	Specified disposal method
Waste_Type	string	Description of waste type
totalElements	number	Total records in response

Example URI

GET https://test-api.wastelinq.com/api/reporting/process_code_summary_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: process_code=,disposalmethod=,wastetypes=
The filter query

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 0,
      "Waste_Product_Code": "1000",
      "Disposal_Method": "Incineration",
      "Waste_Type": "PCB Liquids >10,000 BTU/lb"
    }
  ],
  "totalElements": 478
}

Waste Receipt Summary Report ¶

Waste Receipt Summary Report
GET`/api/reporting/waste_receipt_summary_report`

Overview:

Retrieve data from the database to load into the Waste Receipt Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful
content	array	Array of shipment records
id	number	Unique record identifier
esc_order	number	Reference to source order number
is_enterprise	string	Indicates enterprise/network account customer
manifest	string	Associated waste manifest number
line_number	string	Line item number on the manifest
generator	string	Company who generated the waste
site_state	string	State where waste was generated
state_id	string	Generator’s state ID number
line_status	string	Status of the line item/shipment
inventory_start_date	string	Date item entered storage
profile	string	Waste profile/classification
cont_type	string	Type of container used
cont_size	string	Container size
cont_count	number	Number of containers in the shipment
shipping_weight	string	Reported weight of shipment
actual_weight	string	As-measured weight (if differs)
days_in_inventory	number	Days in storage before shipping
class	string	Waste category
state_waste_code	string	State-specific waste code
disposal_facility	string	Receiving disposal facility
handlingcode	string	Facility internal handling code
approval_no	number	Generator’s waste authorization
network_order	string	Related network order number
totalElements	number	Total records in full response

Example URI

GET https://test-api.wastelinq.com/api/reporting/waste_receipt_summary_report

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
filter: string (required) Example: facility=,warehouse=,startdate=,enddate=,searchBox=,inventory_type=0,tsdfs=,lStatus=,ent=0,includeshipped=
The filter query
selectedFields: string (required) Example: esc_order,is_enterprise,manifest,line_number,generator,site_state,state_id,line_status,inventory_start_date,profile,cont_type,cont_size,cont_count,shipping_weight,actual_weight,days_in_inventory,class,state_waste_code,disposal_facility,handlingcode,approval_no,network_order
The selected fields for the response

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "esc_order": 10000,
      "is_enterprise": "Enterprise",
      "manifest": "10000",
      "line_number": "2",
      "generator": "Company A",
      "site_state": "NY",
      "state_id": "12401",
      "line_status": "Fully Shipped to Disposal",
      "inventory_start_date": "",
      "profile": "RCRA EMPTY METAL DRUMS",
      "cont_type": "DM",
      "cont_size": "55",
      "cont_count": 34,
      "shipping_weight": "1089.0",
      "actual_weight": "",
      "days_in_inventory": 32,
      "class": "USED OIL",
      "state_waste_code": "",
      "disposal_facility": "Company A",
      "handlingcode": "H010",
      "approval_no": null,
      "network_order": "1"
    }
  ],
  "totalElements": 5829
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

APIs ¶

Open Order Report ¶

Open Order ReportGET/api/reporting/open_order_report

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Order Revenue With Cost Detail Report ¶

Order Revenue With Cost Detail ReportGET/api/reporting/order_revenue_with_cost_detail_report

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Order Summary By Status Report ¶

Order Summary By StatusGET/api/reporting/order_by_status

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Order Transportation Time Detail Report ¶

Order Transportation Time DetailGET/api/reporting/order_tran_time_delay

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Order Waste Product Code Summary Total Report ¶

Order Waste Product Code Summary TotalGET/api/reporting/order_waste_product_code_summary_total

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Outbound Shipment Cont Type Size Summary Detail Report ¶

Outbound Shipment Cont Type Size Summary DetailGET/api/reporting/outbound_shipment_cont_type_size_summary_detail

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Outbound Shipment Report ¶

Outbound Shipment ReportGET/api/reporting/outbound_shipment_report

Overview: ¶

Sample TOKEN: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Payment Balance Invoice Report ¶

Payment Balance InvoiceGET/api/reporting/payment_balance_invoice

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Profile Activity Report ¶

Profile Activity ReportGET/api/reporting/profile_active_order

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Sale Activity Report ¶

Other APIs docs

Bearer Token

Error Messages

Open Order Report
GET`/api/reporting/open_order_report`

Overview:

Response Description:

Order Revenue With Cost Detail Report
GET`/api/reporting/order_revenue_with_cost_detail_report`

Overview:

Response Description:

Order Summary By Status
GET`/api/reporting/order_by_status`

Overview:

Response Description:

Order Transportation Time Detail
GET`/api/reporting/order_tran_time_delay`

Overview:

Response Description:

Order Waste Product Code Summary Total
GET`/api/reporting/order_waste_product_code_summary_total`

Overview:

Response Description:

Outbound Shipment Cont Type Size Summary Detail
GET`/api/reporting/outbound_shipment_cont_type_size_summary_detail`

Overview:

Response Description:

Outbound Shipment Report
GET`/api/reporting/outbound_shipment_report`

Overview:

Sample TOKEN:

Response Description:

Payment Balance Invoice
GET`/api/reporting/payment_balance_invoice`

Overview:

Response Description:

Profile Activity Report
GET`/api/reporting/profile_active_order`

Overview:

Response Description:

Sale Activity Report
GET`/api/reporting/sale_activity_report`

Overview:

Response Description:

Sales Summary Report by Rep
GET`/api/reporting/sales_summary_report_by_rep`

Overview:

Response Description:

Service Profile Summary Report
GET`/api/reporting/service_profile_summary_report`

Overview:

Response Description:

Shipment Container Detail Report
GET`/api/reporting/shipment_container_detail_report`

Overview:

Response Description:

Vendor Cost
GET`/api/reporting/vendor_cost`

Overview:

Response Description:

Waste Product Code Pricing Summary
GET`/api/reporting/process_code_pricing_summary_report`

Overview:

Response Description:

Waste Product Code Summary
GET`/api/reporting/process_code_summary_report`

Overview:

Response Description:

Waste Receipt Summary Report
GET`/api/reporting/waste_receipt_summary_report`

Overview:

Response Description: