ESC Reports API (Part 1)

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:

Accounts Receivable Aging Report
Annual Waste Report
Approval Status Order Report
Commission Report
Comparative Revenue Billto
Container Summary
Cost Analysis

…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 ¶

Accounts Receivable Aging Report ¶

Accounts Receivable Aging Report
GET`/api/reporting/accounts_receivable_aging`

Overview:

Retrieve data from the database to load into the Accounts Receivable Aging report.

Response Description:

Name	Data Type	Description
success	boolean	indicates if the request was successful or not
content	object	contains the actual response data
data	array	array of data items
dataContent	array	array of individual data items
id	numeric	unique identifier for the data item
billto_name	string	name of the customer/item
list_invoices	array	array of invoices for the item
invoice_no	numeric	invoice number
order_no	numeric	order number
balance_current	string	current balance amount
balance_30days	numeric	balance amount for 30 days
balance_60days	numeric	balance amount for 60 days
balance_90days	numeric	balance amount for 90 days
balance_before90days	numeric	balance amount before 90 days
balance_total	numeric	total balance amount
footer_data	object	totals for the individual item
total_cur	numeric	total current balance
total_30	numeric	total balance for 30 days
total_60	numeric	total balance for 60 days
total_90	numeric	total balance for 90 days
total_before90	numeric	total balance before 90 days
total_total	numeric	grand total for the item
sum_footer_data	object	grand totals across all items
sum_total_cur	numeric	total current balance
sum_total_30	numeric	total balance for 30 days
sum_total_60	numeric	total balance for 60 days
sum_total_90	numeric	total balance for 90 days
sum_total_before90	numeric	total balance before 90 days
sum_total_total	numeric	grand total

Example URI

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

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 (optional) Example: billto=
The filter for bill to

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": "true",
  "content": {
    "data": [
      {
        "dataContent": [
          {
            "id": 1,
            "billto_name": "Alamo 1",
            "list_invoices": [
              {
                "invoice_no": 185672,
                "order_no": "521349",
                "balance_current": 0,
                "balance_30days": 0,
                "balance_60days": 0,
                "balance_90days": 0,
                "balance_before90days": 1770,
                "balance_total": 1770
              }
            ],
            "footer_data": {
              "total_cur": 0,
              "total_30": 0,
              "total_60": 0,
              "total_90": 0,
              "total_before90": 1770,
              "total_total": 1770
            }
          }
        ],
        "sum_footer_data": {
          "sum_total_cur": 48118.96,
          "sum_total_30": 1301485.33,
          "sum_total_60": 1648271.3900000004,
          "sum_total_90": 1653657.64,
          "sum_total_before90": 71702724.70999995,
          "sum_total_total": 76354258.03000012
        }
      }
    ]
  }
}

Annual Waste Report ¶

Annual Waste Report
GET`/api/reporting/annual_waste_report`

Overview:

Retrieve data from the database to load into the Annual Waste Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique identifier for the customer
customerName	string	Name of the customer
customerAddress	string	Customer’s address
customerEPAId	string	Customer’s EPA identification number
customerStateId	string	Customer’s state identification number
customerContact	string	Customer contact person
data	object	Object containing customer data
json_contents	array	Empty array placeholder
total_info	array	Array containing total/summary info
summary_session	array	Session summary

Example URI

GET https://test-api.wastelinq.com/api/reporting/annual_waste_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
selectedFields: string (required) Example: customerName
The selected field for the response
filter: string (required) Example: startdate=2023-01-01,enddate=2023-02-28,customers=41024
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,
      "customerName": "1 Priority Environmental Services",
      "customerAddress": "4028 Daley Ave ,Fort Worth TX 76180",
      "customerEPAId": "TXCESQG",
      "customerStateId": "CESQG",
      "customerContact": "Joe Garcia",
      "data": {
        "json_contents": [],
        "total_info": [
          0,
          0,
          0,
          "1 Priority Environmental Services",
          1007454,
          "TXCESQG",
          "CESQG",
          0,
          "4028 Daley Ave ,Fort Worth TX 76180",
          "Joe Garcia"
        ],
        "summary_session": []
      }
    }
  ]
}

Approval Status Order Report ¶

Approval Status Order Report
GET`/api/reporting/approval_status_order_report`

Overview:

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

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for the order
Generator_Name	string	Name of the waste generator
Sub_Order	numeric	Sub-order number
Order_Status	string	Status of the order (pending, completed, etc.)
WPC	string	Waste Profile Code
Vendor_Code	string	Vendor code
Manifested_TSDF	string	Transporter/treatment facility on manifest
Manifest_No	string	Manifest number
Line_No	string	Line number
Profile_No	numeric	Waste profile number
Primary_Approval	string	Primary approver
Approval_2	string	Additional approvers
Approval_3	string	Additional approvers
Approval_4	string	Additional approvers
Approval_6	string	Additional approvers
Approval_7	string	Additional approvers
Approval_8	string	Additional approvers
Approval_9	string	Additional approvers
Approval_10	string	Additional approvers
Primary_Approval_Status	numeric	Status of primary approval
Approval_2_Status	numeric	Status of additional approvals
Approval_3_Status	numeric	Status of additional approvals
Approval_4_Status	numeric	Status of additional approvals
Approval_5_Status	numeric	Status of additional approvals
Approval_6_Status	numeric	Status of additional approvals
Approval_7_Status	numeric	Status of additional approvals
Approval_8_Status	numeric	Status of additional approvals
Approval_9_Status	numeric	Status of additional approvals
Approval_10_Status	numeric	Status of additional approvals
totalElements	numeric	Status of additional approvals

Example URI

GET https://test-api.wastelinq.com/api/reporting/approval_status_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
selectedFields: string (required) Example: Generator_Name,Sub_Order,Order_Status,WPC,Vendor_Code,Manifested_TSDF,Manifest_No,Line_No,Profile_No,Primary_Approval,Approval_2,Approval_3,Approval_4,Approval_5,Approval_6,Approval_7,Approval_8,Approval_9,Approval_10,Primary_Approval_Status,Approval_2_Status,Approval_3_Status,Approval_4_Status,Approval_5_Status,Approval_6_Status,Approval_7_Status,Approval_8_Status,Approval_9_Status,Approval_10_Status
The selected fields for the response
filter: string (required) Example: order_number=,status=0,generators=0
The filter query

Request

HideShow

Headers

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

Response 200

HideShow

Headers

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

Body

{
  "success": true,
  "content": [
    {
      "id": 321509,
      "Generator_Name": "Cemex-Western Railroad",
      "Sub_Order": 10759,
      "Order_Status": "Service Completed",
      "WPC": "6100",
      "Vendor_Code": "None",
      "Manifested_TSDF": "Gruene Transportation, LLC",
      "Manifest_No": "0",
      "Line_No": "1",
      "Profile_No": 4191,
      "Primary_Approval": "Gruene Transportation, LLC",
      "Approval_2": "",
      "Approval_3": "",
      "Approval_4": "",
      "Approval_5": "",
      "Approval_6": "",
      "Approval_7": "",
      "Approval_8": "",
      "Approval_9": "",
      "Approval_10": "",
      "Primary_Approval_Status": 2,
      "Approval_2_Status": 0,
      "Approval_3_Status": 0,
      "Approval_4_Status": 0,
      "Approval_5_Status": 0,
      "Approval_6_Status": 0,
      "Approval_7_Status": 0,
      "Approval_8_Status": 0,
      "Approval_9_Status": 0,
      "Approval_10_Status": 0
    }
  ],
  "totalElements": 4973
}

Commission Report ¶

Commission Report ESC
GET`/api/reporting/commission_report`

Overview:

Retrieve data from the database to load into the Commission Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for the order
Generator_Name	string	Name of the waste generator
Generator_No	numeric	Generator number ID
Legacy_Billing_ID	numeric	Legacy billing ID (if any)
Customer_Bill_To	string	Customer to bill
acc_asign_0	string	Assigned account reps
acc_asign_1	string	Assigned account reps
acc_asign_2	string	Assigned account reps
acc_asign_3	string	Assigned account reps
acc_asign_4	string	Assigned account reps
gen_cus_fields_0	string	Generator custom fields
gen_cus_fields_1	string	Generator custom fields
Order_No	numeric	Order number
Order_Type	string	Type of order
Invoice_No	numeric	Invoice number
Invoice_Date	string	Invoice date
Profile_Number	string	Waste profile number
Profile_Creation_Date	string	Profile created date
Profile_Name	string	Profile name
Invoiced_Volume	string	Billed volume
Billing_Basis_Unit	string	Unit of measurement
Invoiced_Price	string	Price per unit
Invoiced_Line_Total	string	Total for line item
Cost_Quantity	string	Cost quantity
Est_Cost	string	Estimated cost
Est_Total_Cost	string	Estimated total cost
Actual_Cost	string	Actual cost
Cost_Basis	string	Cost basis
Profit	string	Profit amount
totalElements	numeric	Total records

Example URI

GET https://test-api.wastelinq.com/api/reporting/commission_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: billto_id=,accAssign=,accAssignValue=,createdstart=2024-01-01,createdend=2024-01-31,customer_id=
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,
      "Generator_Name": "The San Antonio Refinery - Brooks City Base Office",
      "Generator_No": 1006296,
      "Legacy_Billing_ID": null,
      "Customer_Bill_To": "The San Antonio Refinery",
      "acc_asign_0": "",
      "acc_asign_1": "Suzanne Mack",
      "acc_asign_2": "",
      "acc_asign_3": "Brian Johnson",
      "acc_asign_4": "Ryan Schroeder",
      "gen_cus_fields_0": "30523",
      "gen_cus_fields_1": "",
      "Order_No": 469664,
      "Order_Type": "TFS",
      "Invoice_No": 199925,
      "Invoice_Date": "01-16-2024",
      "Profile_Number": "110",
      "Profile_Creation_Date": "",
      "Profile_Name": "PROF. SVCS - Analytical Services",
      "Invoiced_Volume": "1.00",
      "Billing_Basis_Unit": "Each",
      "Invoiced_Price": "$525.00",
      "Invoiced_Line_Total": "$525.00",
      "Cost_Quantity": "1.0",
      "Est_Cost": "$0.00",
      "Est_Total_Cost": "$0.00",
      "Actual_Cost": "$315.00",
      "Cost_Basis": "Each",
      "Profit": "$210.00"
    }
  ],
  "totalElements": 1304
}

Comparative Revenue Billto ¶

Comparative Revenue Billto
GET`/api/reporting/comparative_revenue_billto`

Overview:

Retrieve data from the database to load into the Comparative Revenue Billto report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
acc_assign1_id	numeric	ID of assigned account rep
acc_assign1_name	string	Name of assigned account rep
bill_id	numeric	ID of associated bill
bill_name	string	Name on bill
cus_id	numeric	Customer ID
cus_name	string	Customer name
from_revenue	string	Revenue in previous period
to_revenue	string	Revenue in current period
change	string	Revenue change amount
fromstart	string	Start of previous period
fromend	string	End of previous period
tostart	string	Start of current period
toend	string	End of current period
total_from_revenue	string	Total revenue in previous period
total_to_revenue	string	Total revenue in current period
total_change	string	Total revenue change amount
totalElements	numeric	Total records

Example URI

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

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: billto_id=,accAssign=,accAssignValue=,createdstart=2024-01-01,createdend=2024-01-31,customer_id=
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,
      "acc_assign1_id": 385,
      "acc_assign1_name": "Brian Johnson",
      "bill_id": 15771,
      "bill_name": "Entegris Company",
      "cus_id": 39842,
      "cus_name": "Entegris, Inc.",
      "from_revenue": "$172,578.30",
      "to_revenue": "$172,578.30",
      "change": "$.00"
    }
  ],
  "fromstart": "2023-10-01",
  "fromend": "2023-10-26",
  "tostart": "2023-10-01",
  "toend": "2023-10-26",
  "total_from_revenue": "$1,458,342.85",
  "total_to_revenue": "$1,458,342.85",
  "total_change": "$.00",
  "totalElements": 1847
}

Containter Summary ¶

Containter Summary
GET`/api/reporting/containter_summary`

Overview:

Retrieve data from the database to load into the Containter Summary report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
container_type	numeric	Type of container (e.g. BA, etc.)
container_size	string	Size of the container (gallons/liters)
count	numeric	Number of containers of this type/size
totalElements	string	Total number of container items in the response

Example URI

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

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
selectedFields: string (required) Example: container_type,container_size,count
The selected fields for the response
filter: string (required) Example: startdate=2023-11-25,enddate=2023-12-25
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,
      "container_type": "BA",
      "container_size": "202",
      "count": 11
    }
  ],
  "totalElements": 26
}

Cost Analysis ¶

Cost Analysis
GET`/api/reporting/cost_analysis`

Overview:

Retrieve data from the database to load into the Cost Analysis report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
GeneratorName	string	Name of the waste generator
ESCAccountAssignment1	string	Primary account representative
Facility	string	Facility that accepted the waste
ProfileNumber	numeric	Waste profile number
ProfileName	string	Description of waste profile
ProfileStatus	string	Status of the waste profile
DisposalFacility	string	Facility receiving the waste
CommonName	string	Common name/description of waste
ApprovalStatus	string	Approval status
WasteProductCode	string	Waste code
VendorCode	string	Vendor code
ContainerType	string	Container type
ContainerSize	string	Container size
CostBasis	string	Basis for actual cost (e.g. per ton)
ActualCost	string	Actual cost to dispose of waste
MinCost	string	Minimum cost
PriceBasis	string	Basis for billing price
BillingPrice	string	Price customer was billed
BillingMinPrice	string	Minimum billing price
Active	string	Profile active status
Enterprise	string	Is it an enterprise account
totalElements	numeric	Total number of records

Example URI

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

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: billto=0,customerId=0,profileId=0,profileStatus=0,disposalFacility=0,approvalStatus=0,active=0,parentDisposalFacility=0
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,
      "GeneratorName": "3318 South Lamar, LP",
      "ESCAccountAssignment1": "Chad Liles",
      "Facility": "GEC - NBT",
      "ProfileNumber": 148432,
      "ProfileName": "Class 1 Soil",
      "ProfileStatus": "Approved",
      "DisposalFacility": "Waste Management - Covel Gardens Landfill",
      "CommonName": null,
      "ApprovalStatus": "Approved",
      "WasteProductCode": "7600",
      "VendorCode": "None",
      "ContainerType": "CM",
      "ContainerSize": "4000",
      "CostBasis": "Per Ton",
      "ActualCost": "$51.00",
      "MinCost": "$300.00",
      "PriceBasis": "Per Ton",
      "BillingPrice": "$159.00",
      "BillingMinPrice": "$.00",
      "Active": "Yes",
      "Enterprise": "Yes"
    }
  ],
  "totalElements": 22298
}

Customer Legacy ID Summary Report ¶

Customer Legacy ID Summary Report
GET`/api/reporting/customer_legacy_summary`

Overview:

Retrieve data from the database to load into the Customer Legacy ID Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for the generator record
LegacyID	string	Legacy system ID
GeneratorNumber	string	Generator identification number
GeneratorName	string	Name of the waste generator
Address1	string	Primary address line
Address2	string	Secondary address line (empty)
City	string	City
State	string	State
Zip	string	Zip/postal code
ContactPhone	string	Main contact name
ContactEmail	string	Contact phone number
BillToID	string	ID of associated bill-to record
BillToName	string	Name on bill-to record
AccountAssignment	string	Assigned account representative
totalElements	numeric	Total number of records returned

Example URI

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

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",
  "totalElements": 1847,
  "content": [
    {
      "id": 1,
      "LegacyID": "1007454",
      "GeneratorNumber": "1007454",
      "GeneratorName": "1 Priority Environmental Services",
      "Address1": "4028 Daley Ave",
      "Address2": "",
      "City": "Fort Worth",
      "State": "TX",
      "Zip": "76180",
      "ContactName": "Joe Garcia",
      "ContactPhone": "817-595-0790",
      "ContactEmail": "htran@wastelinq.com",
      "BillToID": "1008515",
      "BillToName": "1 Priority Environmental Services",
      "AccountAssignment": "Chad Liles"
    }
  ]
}

Disposal Log Report ¶

Disposal Log
GET`/api/reporting/disposal_log`

Overview:

Retrieve data from the database to load into the Disposal Log Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
tsdf	string	Name of treatment, storage, disposal facility
tsdf_city	string	City where TSDF is located
o_type	string	Type of order (e.g. Bulk, Rack, Drum)
hazardous	string	Indicates if waste is hazardous or non-hazardous
order_year	numeric	Year the order was placed
order_month	numeric	Month the order was placed
count	numeric	Number of items/containers in the order
weight	numeric	Total weight of order in pounds or kilograms
total_revenue	numeric	Total revenue amount for the order
totalElements	numeric	Total number of records returned

Example URI

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

URI Parameters

HideShow

page: number (required) Example: 0
The page number for pagination
pageSize: number (required) Example: 100
The number of items per page
selectedFields: string (required) Example: tsdf,tsdf_city,o_type,hazardous,order_year,order_month,count,weight,total_revenue
The selected fields for the response
filter: string (required) Example: disposal_id=0,start_date=2023-11-25,end_date=2023-12-25
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,
      "tsdf": "5A Environmental Services, LLC",
      "tsdf_city": "Hallettsville",
      "o_type": "Bulk",
      "hazardous": "No",
      "order_year": 2023,
      "order_month": 12,
      "count": 1,
      "weight": 41700,
      "total_revenue": 2450
    }
  ],
  "totalElements": 100
}

ESC/Network Order Invoice Status Report ¶

ESC/Network Order Invoice Status
GET`/api/reporting/esc_network_order_invoice_status`

Overview:

Retrieve data from the database to load into the ESC/Network Order Invoice Status Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
esc_order	string	Order number in ESC
network_order	string	Order number in the Network system
invoice_status	string	Current status of the invoice for this order
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/esc_network_order_invoice_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: 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,
      "esc_order": "212343",
      "network_order": "212457",
      "invoice_status": "Open"
    }
  ],
  "totalElements": 100
}

Expiring Profile Report ¶

Expiring Profile Report
GET`/api/reporting/esc_network_order_invoice_status`

Overview:

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

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
customerNumber	numeric	Customer account number
customerName	string	Customer name
profileNumber	numeric	Waste profile number
profileName	string	Description of waste profile
disposalFacility	string	Facility that can accept this waste profile
networkEnterprise	string	Type of network account (Enterprise)
dateExpires	string	Expiration date of approval
approvalNumber	string	Approval certification number
approvalStatus	string	Status of approval (Expired)
recertChangeStatus	string	Recertification/change status (N/A)
primary	boolean	Indicates if primary profile for customer
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/esc_network_order_invoice_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: startDate=,endDate=,brokerId=,status=
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": 66822,
      "customerNumber": 1007208,
      "customerName": "Watco Companies",
      "profileNumber": 4259,
      "profileName": "Choline Chloride / Urea",
      "disposalFacility": "US Ecology Texas, Inc.",
      "networkEnterprise": "Enterprise",
      "dateExpires": "2015-06-03",
      "approvalNumber": "81665",
      "approvalStatus": "Expired",
      "recertChangeStatus": "N/A",
      "primary": true
    }
  ],
  "totalElements": 9403
}

Generator Profile Summary Report ¶

Generator Profile Summary
GET`/api/reporting/customer_profile_summary`

Overview:

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

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
profileNumber	numeric	Waste profile number
brokerName	string	Name of broker handling the profile
generatorName	string	Name of waste generator
facility	string	Facility that received the manifests
profileName	string	Description of the waste profile
tsdf	string	Name of treatment, storage, disposal facility
commonName	string	Common name of the TSDF location
tsdfApproval	string	Approval granted by TSDF (if any)
tsdfDateexpire	string	Expiration date of TSDF approval
status	string	Current status of the profile (Expired)
isNetworkExempt	string	Indicates if exempt from network
totalElements	numeric	Total number of records returned in the response

Example URI

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

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=,esc=,status=,startDate=,endDate=,disposalFacility=,facility=
The filter query
sort: string (required) Example: brokerName desc
The sorting order

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 1,
      "profileNumber": 4079,
      "brokerName": "Gruene Environmental Companies",
      "generatorName": "Alamo Group",
      "facility": "GEC - NBT",
      "profileName": "NON-PCB BALLASTS",
      "tsdf": "LRT Lighting Resources Texas, LLC",
      "commonName": "LRT-Fort Worth, TX",
      "tsdfApproval": "None",
      "tsdfDateexpire": "2021-06-04",
      "status": "Expired",
      "isNetworkExempt": "Yes"
    }
  ],
  "totalElements": 13996
}

Generator Profile Summary with Pricing and Cost Report ¶

Generator Profile Summary with Pricing and Cost
GET`/api/reporting/generator_profile_summary_price_cost`

Overview:

Retrieve data from the database to load into the Generator Profile Summary with Pricing and Cost Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID
customer_no	numeric	Customer account number
customer_name	string	Customer name
facility_name	string	Receiving facility
account_assign	string	Assigned account representative
profile_no	numeric	Waste profile number
profile_name	string	Profile description
profile_status	string	Status of the profile (Expired)
waste_descr	string	Description of waste
full_wastecode	string	Full hazardous waste code
hard_waste	string	Waste type flags
universal_waste	string	Waste type flags
state_waste	string	Waste type flags
shipping_usdot_comment	string	Shipping classification
tsdf_name	string	TSDF handling profile
tsdf_isprimary	string	Indicates primary TSDF
tsdf_commonname	string	Common name of the TSDF location
tsdf_approvalnumber	string	Approval granted
tsdf_approvalstatus	string	Status of TSDF approval
tsdf_dateexpires	string	Approval expiration date
container_type	string	Container details
container_size	string	Container details
process_code	string	Waste handling code
vendor_code	string	Vendor/carrier
cost_basic_name	string	Basis for actual cost (Per YD)
cost	string	Actual cost amount
min_cost	string	Minimum cost
price_basis_name	string	Pricing information.
list_price	string	Pricing information.
min_price	string	Pricing Details
act_basis_name	string	Actual/Applied pricing information.
act_price	string	Actual/Applied pricing information.
act_min_price	string	Actual/Applied pricing information.
active	string	Status Details
is_network_enterprise	string	Status Details
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/generator_profile_summary_price_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: billto=,customerId=,status=,active=,wpc=,disposalFacility=,approvalStatus=,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,
      "customer_no": 1006288,
      "customer_name": "Austin Energy - Sand Hill Energy Center",
      "facility_name": "GEC - NBT",
      "account_assign": "Ryan Metz",
      "profile_no": 4115,
      "profile_name": "CLASS 2 FILTERS",
      "profile_status": "Expired",
      "waste_descr": "CLASS 2 FILTERS",
      "full_wastecode": "00623102",
      "hard_waste": "No",
      "universal_waste": "No",
      "state_waste": "",
      "shipping_usdot_comment": "NON-REGULATED MATERIAL PER 40 & 49 CFR (CLASS 2 FILTERS)",
      "tsdf_name": "Texas Disposal Systems Landfill, Inc.",
      "tsdf_isprimary": "Yes",
      "tsdf_commonname": "TDS LF - Creekmoore",
      "tsdf_approvalnumber": "TDSL032817",
      "tsdf_approvalstatus": "Expired",
      "tsdf_dateexpires": "06-04-2023",
      "container_type": "CM",
      "container_size": "4000",
      "process_code": "7603",
      "vendor_code": "None",
      "cost_basic_name": "Per YD",
      "cost": "$5.00",
      "min_cost": "$.01",
      "price_basis_name": "Per YD",
      "list_price": "$.01",
      "min_price": "$.00",
      "act_basis_name": "Per YD",
      "act_price": "$25.00",
      "act_min_price": "$.01",
      "active": "Yes",
      "is_network_enterprise": "Yes"
    }
  ],
  "totalElements": 22778
}

Inventory Check Report ¶

Inventory Check Report
GET`/api/reporting/inventory_check_report`

Overview:

Retrieve data from the database to load into the Inventory Check Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/inventory_check_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
selectedFields: string (required) Example: sanned_date_start,sanned_date_finish,inv_cont_id,scanned_cont_id,gen_name,order_no,manifest_no,disposal_facility,profile_no,profile_name,cont_type_size,waste_product_code,enterprise_network,facility_name,warehouse,storage_location,inv_start_date,order_line_status,order_line_facility
The selected fields for the response
filter: string (required) Example: facility=0,war=0,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": [],
  "totalElements": 0
}

Inventory Report ¶

Inventory Report
GET`/api/reporting/inventory_report`

Overview:

Retrieve data from the database to load into the Inventory Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
facility	string	The name of the generating facility
facility_id	numeric	Unique ID of the generating facility
list_tsdf	array	Array of approved treatment, storage, disposal facilities (TSDFs) for this facility
tsdf	string	Name of the TSDF
tsdf_id	numeric	Unique ID of the TSDF
waste_item	array	Array of waste items/shipments for this TSDF
order_number	string	Order number
line_number	string	Line item number on the order
gen_name	string	Name of the waste generator
profile_name	string	Waste profile/description
line_status	string	Status of the line item (Reconciled)
manifest	string	Manifest number
cont_type_size	string	Container type and size (TT-5000)
cont_count	numeric	Number of containers
order_date	string	Date the order was placed
inv_day	numeric	Number of invoice days

Example URI

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

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "facility": "GEC - NBT",
      "facility_id": 70,
      "list_tsdf": [
        {
          "tsdf": "Gruene Transportation, LLC",
          "tsdf_id": 12193,
          "waste_item": [
            {
              "order_number": "537948",
              "line_number": "1",
              "gen_name": "Hill Country Customs Towing LLC",
              "profile_name": "USED OIL (no water)",
              "line_status": "Reconciled",
              "manifest": "2026639GEC",
              "cont_type_size": "TT-5000",
              "cont_count": 1,
              "order_date": "2023-11-29",
              "inv_day": 55
            }
          ]
        }
      ]
    }
  ]
}

Last Shipment By Profile Report ¶

Last Shipment By Profile
GET`/api/reporting/last_shipment_by_profile`

Overview:

Retrieve data from the database to load into the Last Shipment By Profile Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for this record
customer_no	numeric	Customer ID number
gen_name	string	Name of the waste generating company
profile_no	numeric	ID number for the waste profile
profile_name	string	Description of the waste profile
enterprise_network	string	Indicates if part of an enterprise/group network
dats_last_shipment	numeric	Date of last shipment, null if none
revenue_shipment	numeric	Revenue from shipments, null if none
total_shipment	numeric	Total number of shipments
average_cost	numeric	Average cost per shipment, null if no shipments
totalElements	numeric	Total number of records returned in the response

Example URI

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

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-10-01,enddate=2023-12-01,is_exam=
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,
      "customer_no": 1023544,
      "gen_name": "5F Mechanical Group Inc.",
      "profile_no": 163792,
      "profile_name": "HVAC Flush Water",
      "enterprise_network": "Network",
      "dats_last_shipment": null,
      "revenue_shipment": null,
      "total_shipment": 0,
      "average_cost": null
    }
  ],
  "totalElements": 4533
}

MMP Profile Report ¶

MMP Profile Report
GET`/api/reporting/mmp_profile_report`

Overview:

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

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for this record
Generator	string	Name of the generator
Profile_No	numeric	ID number for the waste profile
Profile_Name	string	Description of the waste profile
Profile_EPA_codes	string	EPA codes related to this profile (if any)
MMP	string	MMP name
MMP_EPA_codes	string	EPA codes related to the MMP (if any)
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/mmp_profile_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: mmp_id=,generator_id=
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": 8983,
      "Generator": "Caterpillar - Seguin WM",
      "Profile_No": 5139,
      "Profile_Name": "UWP",
      "Profile_EPA_codes": "",
      "MMP": "UWP 500",
      "MMP_EPA_codes": ""
    }
  ],
  "totalElements": 1453
}

MMP/WPC Report ¶

MMP/WPC Report
GET`/api/reporting/wpc_mmp_report`

Overview:

Retrieve data from the database to load into the MMP/WPC Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for this record
tsdf_process_id	string	ID for the waste processing/disposal process
tsdf_process_definition	string	Name/description of the waste process
mmp_type	string	Type of process (e.g. Reroute, etc)
handling_code	string	Specifies which materials the process can handle
epa_codes	string	Any applicable EPA codes for the process
processcodes_required	string	Code(s) required to track materials through the process
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/wpc_mmp_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": 210,
      "tsdf_process_id": "4FT",
      "tsdf_process_definition": "4FT Fluorescent Bulbs",
      "mmp_type": "Reroute",
      "handling_code": "All",
      "epa_codes": "",
      "processcodes_required": "4249"
    }
  ],
  "totalElements": 9
}

Margin Report - Actual vs Estimated ¶

Margin Report - Actual vs Estimated
GET`/api/reporting/margin_preview_summary_report`

Overview:

Retrieve data from the database to load into the Margin Report - Actual vs Estimated.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
id	numeric	Unique ID for this record
OrderNumber	string	Order number
OrderType	string	Type of order (e.g. Waste)
Enterprise_Network	string	Indicates if part of an enterprise/group network
AccountExecutive	string	Account Executive person
GeneratorName	string	Waste Generator name
InvoiceNumber	numeric	Invoice number
InvoiceDate	string	Invoice date
CreatedDate	string	Order creation date
ScheduledDate	string	Scheduled date
OrderStatus	string	Status of order (e.g. Invoiced)
FacilityName	string	Facility name
EstimatedRev	string	Estimated total revenue
EstimatedDisposalRev	string	Estimated disposal revenue
EstimatedTransRev	string	Estimated transport revenue
EstimatedOtherRev	string	Estimated other revenue
EstimatedFees_TaxesRev	string	Estimated fees & taxes revenue
Invoiced	string	Invoiced total amount
InvoicedDisposal	string	Invoiced disposal amount
InvoicedTrans	string	Invoiced transport amount
InvoicedOther	string	Invoiced other amount
InvoicedFees_Taxes	string	Invoiced fees & taxes amount
EstimatedCost	string	Estimated total cost
EstimatedDisposalCost	string	Estimated disposal cost
EstimatedTransCost	string	Estimated transport cost
EstimatedOtherCost	string	Estimated other cost
EstimatedFees_TaxesCost	string	Estimated fees & taxes cost
ActualCost	string	Actual total cost
ActualDisposalCost	string	Actual disposal cost
ActualTransCost	string	Actual transport cost
ActualProducts_ServicesCost	string	Actual products/services cost
ActualOtherCost	string	Actual other cost
ActualFees_TaxesCost	string	Actual fees & taxes cost
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/margin_preview_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: broker=31,startdate=11-12-2023,enddate=11-16-2023,customer_id=,billto=,customer_name=,order_status=,tendaydate=,pickupstart=,pickupend=
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": "12311",
      "OrderType": "Waste",
      "Enterprise_Network": "Enterprise",
      "AccountExecutive": "Tiffany Skidmore",
      "GeneratorName": "Afton Chemical",
      "InvoiceNumber": 28243,
      "InvoiceDate": "04-12-2019",
      "CreatedDate": "03-05-2019",
      "ScheduledDate": "03-07-2019",
      "OrderStatus": "Invoiced",
      "FacilityName": "GEC - HOU",
      "EstimatedRev": "$2,751.50",
      "EstimatedDisposalRev": "$764.00",
      "EstimatedTransRev": "$1,457.50",
      "EstimatedOtherRev": "$530.00",
      "EstimatedFees_TaxesRev": "$0.00",
      "Invoiced": "$2,751.50",
      "InvoicedDisposal": "$764.00",
      "InvoicedTrans": "$1,457.50",
      "InvoicedOther": "$530.00",
      "InvoicedFees_Taxes": "$0.00",
      "EstimatedCost": "$1,563.50",
      "EstimatedDisposalCost": "$0.00",
      "EstimatedTransCost": "$1,245.50",
      "EstimatedOtherCost": "$318.00",
      "EstimatedFees_TaxesCost": "",
      "ActualCost": "$573.00",
      "ActualDisposalCost": "$573.00",
      "ActualTransCost": "$0.00",
      "ActualProducts_ServicesCost": "$0.00",
      "ActualOtherCost": "$0.00",
      "ActualFees_TaxesCost": "$0.00"
    }
  ],
  "totalElements": 26986
}

Margin Report - Low Margin ¶

Margin Report - Low Margin
GET`/api/reporting/margin_report`

Overview:

Retrieve data from the database to load into the Margin Report - Low Margin.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
content	array	Array containing response data
BillTo_id	numeric	Unique ID for the bill to entity
BillTo_Name	string	Name of the bill to entity
id	numeric	Unique ID for this record
json_orders	array	Array containing order details
order_number	string	Order number
json_order_info	array	Array containing order info
order_type	string	Type of order (e.g. waste)
sales_rep	string	Sales representative
cus_name	string	Customer name
facility_name	string	Facility name
invoice_no	numeric	Invoice number
invoice_date	string	Invoice date
date_created	string	Order creation date
TS_Pick_Up_Date	string	Scheduled pick up date
Order_Logistics_Status	string	Order status (e.g. invoiced)
json_materials	array	Array containing material details
project_desc	string	Material description
billing_weight_volume_count	string	Billing quantity
billing_basis	string	Billing basis (e.g. per container)
line_total	numeric	Line total
cost_category	string	Cost category (e.g. disposal)
vendor	string	Vendor
tsdf_parent	string	ID of the parent waste processing/disposal facility
description	string	Description or additional details of the material/product/line item
actual_shipping_weight	numeric	Actual weight of the material/shipment
committed_cost	numeric	Estimated/committed cost amount
actual_cost	numeric	Actual cost incurred amount
profit_loss	numeric	Difference between actual and committed cost (profit or loss)
margin_percent	numeric	Percentage of profit/loss margin
json_products	array	Array containing products details
project_desc	string	Description of the product or line item
quantity_unit	string	Unit of measure for the quantity (e.g. each, pounds)
quantity	numeric	Quantity purchased or included
line_total	numeric	Total price for the line item
cost_category	string	Category the cost belongs to (e.g. Freight)
vendor	string	Supplier or provider of the product/service
description	string	Additional text details about the item
committed_cost	numeric	Estimated or agreed upon cost
actual_cost	numeric	Actual cost incurred
profit_loss	numeric	Profit or loss amount for the item
margin_percent	numeric	Percentage profit margin for the item
json_fees	array	This array contains individual fee records attached to the order.
id	numeric	Unique identifier for the fee
fees	string	Description of the fee
type	string	The type of fee (e.g. flat rate, percentage)
total_fee	numeric	The total amount of the fee
json_others	array	This array is used to capture any miscellaneous or additional charges not categorized elsewhere.
cost_category	string	Category the cost is associated with (e.g. transportation)
vendor	string	Party/provider associated with the cost
description	string	Detail/reason for the other cost
actual_cost	numeric	The real/invoiced cost
non_actual_cost	numeric	Estimated/quoted cost if different than actual
total_materials	numeric	Total value/cost of all materials
profit_materials	numeric	Total profit from materials
actual_cost_materials	numeric	Total actual cost of materials
marterial_margin_percent	numeric	Percentage profit margin on materials
total_products	numeric	Total value/cost of all products
profit_products	numeric	Total profit from products
actual_cost_products	numeric	Total actual cost of products
product_margin_percent	numeric	Percentage profit margin on products
total_fees	numeric	Total value/cost of all fees
total_cost_other	numeric	Total value/cost of all other charges
total_profit_other	numeric	Total profit/loss from other charges
total_profit_order	numeric	Total profit earned on the whole order
actual_cost_order	numeric	Total actual costs for the order
total_order_line	numeric	Total value/cost of the entire order
margin_percent	numeric	Percentage profit margin for the full order
total_profit	numeric	Total profit amount for the record/entity
total_line	numeric	Total value/cost for the record/entity
totalElements	numeric	Total number of records returned in the response

Example URI

GET https://test-api.wastelinq.com/api/reporting/margin_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: billto_id=0,margin_percent=,startdate=2024-01-01,enddate=2024-11-25
The filter query

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "BillTo_id": 24452,
      "BillTo_Name": "ACM Frame and Body",
      "id": 13,
      "json_orders": [
        {
          "order_number": "523014",
          "json_order_info": [
            {
              "order_number": "523014",
              "order_type": "Waste",
              "sales_rep": "Natasha Zunker",
              "cus_name": "ACM Frame and Body",
              "facility_name": "GEC - NBT",
              "invoice_no": 200041,
              "invoice_date": "01-16-2024",
              "date_created": "09-25-2023",
              "TS_Pick_Up_Date": "11-30-2023",
              "Order_Logistics_Status": "Invoiced"
            }
          ],
          "json_materials": [
            {
              "project_desc": "168762/RCRA Empty Metal Drums",
              "billing_weight_volume_count": "1.00",
              "billing_basis": "Per Container",
              "line_total": 100,
              "cost_category": "Disposal",
              "vendor": "WASTELINQ",
              "tsdf_parent": "",
              "description": "RCRA Empty Metal Drums",
              "actual_shipping_weight": 1,
              "committed_cost": 16,
              "actual_cost": 16,
              "profit_loss": 84,
              "margin_percent": 84
            }
          ],
          "json_products": [
            {
              "project_desc": "880/TRANSPORTATION - Fuel Surcharge",
              "quantity_unit": "0.36",
              "line_total": 183.6,
              "cost_category": "",
              "vendor": "",
              "description": "",
              "committed_cost": 0,
              "actual_cost": "",
              "profit_loss": 183.6,
              "margin_percent": 100
            }
          ],
          "json_fees": [
            {
              "id": 149933,
              "fees": "EIS Fee, 2022",
              "type": "Rate",
              "total_fee": 58.1
            }
          ],
          "json_others": [
            {
              "cost_category": "Transportation",
              "vendor": "Gruene Transportation",
              "description": "demurrage",
              "actual_cost": "52.5",
              "non_actual_cost": -52.5
            }
          ],
          "total_materials": 415,
          "profit_materials": 329,
          "actual_cost_materials": 86,
          "marterial_margin_percent": 79.28,
          "total_products": 1788.6,
          "profit_products": 1193.1,
          "actual_cost_products": 595.5,
          "product_margin_percent": 66.71,
          "total_fees": 58.1,
          "total_cost_other": 203.82,
          "total_profit_other": -203.82,
          "total_profit_order": 1376.3799999999999,
          "actual_cost_order": 885.3199999999999,
          "total_order_line": 2261.7,
          "margin_percent": 60.86
        }
      ],
      "total_profit": 1376.38,
      "total_line": 2261.7
    }
  ],
  "totalElements": 9
}

Margin Report - Material ¶

Margin Report - Material
GET`/api/reporting/material_revenue_cost_margin_report`

Overview:

Retrieve data from the database to load into the Margin Report - Material.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful (true/false)
totalElements	numeric	Total number of elements/records returned
id	numeric	Unique ID for the record
OrderNumber	string	Order number
OrderType	string	Type of order (e.g. Waste)
Enterprise_Network	string	Indicates if part of an enterprise/group network
AssignAccount	string	Person assigned to the order
GeneratorName	string	Company generating the waste
InvoiceNumber/Date	string	Invoice details if applicable
DateCreated	string	Date order was created
ScheduledDate	string	Scheduled pickup/service date
OrderLogisticsStatus	string	Status of the order lifecycle
Facility	string	Facility involved
ProjectNumber/Phase	string	Project details if relevant
ItemNumber	string	Item/line number within the order
ManifestNumber	string	Waste manifest number
LineNumber	numeric	Line item number
ProfileNumber/Name	numeric/string	Waste profile/characterization details
WPC	string	Waste code
DisposalSite	string	Location waste was disposed at
ContainerType/Size	string	Container used for transport
ContainerCount	numeric	Number of containers
ShippingWeight	numeric	Weight of container(s) & waste
BillingWeight	numeric	Weight charged/billable amount
ActualWeight	numeric	Actual measured weight
EstimatedVolume/Weight	string	Estimated volume & weight
BillingBasis	string	Units billed on (weight, volume, count etc.)
Price	string	Unit price charged
LineTotal	string	Total for the line item
CostBasis	string	Units the cost is based on
EstimatedUnitCost	string	Estimated cost per unit
CommittedCost	string	Cost agreed upon or bid
TSDFActualCost	string	Actual cost charged by disposal facility
VendorInvoice	string	Link to vendor invoice
EstimateMargin	numeric	Estimated profit percentage
ActualMargin	numeric	Actual profit percentage

Example URI

GET https://test-api.wastelinq.com/api/reporting/material_revenue_cost_margin_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
selectedFields: string (required) Example: ESCName,OrderNumber,OrderType,AccountExecutive,GeneratorName,InvoiceNumber,InvoiceDate,DateCreated,ScheduledDate,OrderLogisticsStatus,Facility,ItemNumber,ManifestNumber,LineNumber,ProfileNumber,ProfileName,WPC,DisposalSite,Parent,ContainerType,ContainerSize,ContainerCount,ShippingWeight,BillingWeight,ActualWeight,EstimatedVolume,EstimatedWeight,BillingBasis,Price,LineTotal,EstimatedUnitCost,CommittedCost,TSDFActualCost,VendorInvoice,EstimateMargin,ActualMargin,BookCostExtrapolated,BookPriceExtrapolated
The selected fields for the response
filter: string (required) Example: billto=,customer_id=,broker_id=,customer_name=,createdstart=,createdend=,pickupstart=,pickupend=,orderstart=,orderend=
The filter query

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": "true",
  "totalElements": 138256,
  "content": [
    {
      "id": 1,
      "OrderNumber": "10009",
      "OrderType": "Waste",
      "Enterprise_Network": "Enterprise",
      "AssignAccount": "Ryan Metz",
      "GeneratorName": "Austin Energy - Sand Hill Energy Center",
      "InvoiceNumber": "",
      "InvoiceDate": "",
      "DateCreated": "07-02-2018",
      "ScheduledDate": "07-02-2018",
      "OrderLogisticsStatus": "Service Completed",
      "Facility": "GEC - NBT",
      "ProjectNumber": "",
      "ProjectPhase": "",
      "ItemNumber": "1.1",
      "ManifestNumber": "d9768",
      "LineNumber": "1",
      "ProfileNumber": 4116,
      "ProfileName": "PLANT TRASH",
      "WPC": "7603",
      "DisposalSite": "Texas Disposal Systems Landfill, Inc.",
      "ContainerType": "CM",
      "ContainerSize": "4000",
      "ContainerCount": 1,
      "ShippingWeight": 25,
      "BillingWeight": 0.1,
      "ActualWeight": null,
      "EstimatedVolume": "25.0 (Y)",
      "EstimatedWeight": "0.0 (P)",
      "BillingBasis": "Per YD",
      "Price": "$37.00",
      "LineTotal": "$3.70",
      "CostBasis": "Per YD",
      "EstimatedUnitCost": "$7.50",
      "CommittedCost": "$.75",
      "TSDFActualCost": "$.00",
      "VendorInvoice": "",
      "EstimateMargin": 79.73,
      "ActualMargin": 100
    }
  ]
}

Margin Report - Product & Service ¶

Margin Report - Product & Service
GET`/api/reporting/products_services_revenue_cost_margin_report`

Overview:

Retrieve data from the database to load into the Margin Report - Product & Service.

Response Description:

Name	Data Type	Description
success	boolean	Indicates request success status
content	array	Array containing response data
id	numeric	Unique ID for the record
suborderOrderNumber	string	Order number
orderType	string	Type of order (waste, service etc)
networkEnterpriseField	string	Indicates if part of an enterprise/group network
assignAcc	string	Assigned account manager
customerName	string	Customer name
invoiceNo	numeric	Invoice number
invoiceDate	string	Invoice date
dateCreated	string	Date order was created
scheduledDate	string	Scheduled date for service
orderLogisticsStatus	string	Order status
invoiceArStatus	string	Invoice status
facilityName	string	Facility involved
projectName	string	Associated project name
phaseName	string	Project phase
lineNumber	string	Line item number
productItem	string	Product/item code
description	string	Item description
quantity	numeric	Item quantity
unitPrice	string	Unit price
lineTotal	string	Line total
proActualcost	string	Actual product cost
totalCost	string	Total line cost
lineItemMargin	numeric	Line item margin %
totalElements	numeric	Total records

Example URI

GET https://test-api.wastelinq.com/api/reporting/products_services_revenue_cost_margin_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: customerId=0,billto=0,customerName=,brokerId=0,startDate=2023-10-01,endDate=2023-10-23,orderStart=,orderEnd=,pickupStart=,pickupEnd=,description=
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": 1307683,
      "suborderOrderNumber": "524473",
      "orderType": "Waste",
      "networkEnterpriseField": "Enterprise",
      "assignAcc": "Julie Ruffino",
      "customerName": "Mitsubishi Chemical America, Inc.",
      "invoiceNo": 192942,
      "invoiceDate": "11-20-2023",
      "dateCreated": "10-02-2023",
      "scheduledDate": "10-06-2023",
      "orderLogisticsStatus": "Invoiced",
      "invoiceArStatus": "Invoice Issued",
      "facilityName": "GEC - HOU",
      "projectName": "Wastewater Tank Cleanout",
      "phaseName": "Phase 1",
      "lineNumber": "3",
      "productItem": "731",
      "description": "WASHOUTS-3rd Party",
      "quantity": 1,
      "unitPrice": "$350.00",
      "lineTotal": "$350.00",
      "proActualcost": "$250.00",
      "totalCost": "$227.71",
      "lineItemMargin": 34.94
    }
  ],
  "totalElements": 1112
}

Material Class Weight Summary Report ¶

Material Class Weight Summary
GET`/api/reporting/material_classwt_summary`

Overview:

Retrieve data from the database to load into the Material Class Weight Summary Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful or not
content	array	Array containing the response data
id	numeric	Unique identifier for the record
Order_No	string	Order number
Waste_Product_Code	string	Code to identify the waste product
Material	string	Description of the material/waste
Container_Type_Size	string	Container type and size used
Container_ID_No	string	Identification number of the container
Weight	numeric	Weight of the material (can be null)
totalElements	numeric	Total number of records returned

Example URI

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

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: order_number=,profile_id=,customer_id=
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,
      "Order_No": "10009",
      "Waste_Product_Code": "7603",
      "Material": "PLANT TRASH",
      "Container_Type_Size": "CM-4000",
      "Container_ID_No": "d9768-1-1",
      "Weight": null
    }
  ],
  "totalElements": 148609
}

Network Order Documentation Report ¶

Network Order Documentation Report
GET`/api/reporting/network_order_documentation_report`

Overview:

Retrieve data from the database to load into the Network Order Documentation Report.

Response Description:

Name	Data Type	Description
success	boolean	Indicates if the request was successful or not
content	array	Array containing the response data records
id	numeric	Unique identifier for the record
order_number	string	Order number this record belongs to
customer_name	string	Name of the customer
filetype_name	string	Type of file (e.g. manifest)
created_date	string	Date file was created
filename	string	Name of the file
totalElements	numeric	Total number of records returned

Example URI

GET https://test-api.wastelinq.com/api/reporting/network_order_documentation_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: filetype=,cus_id=,startdate=2023-01-01,enddate=2024-01-01
The filter query
selectedFields: string (required) Example: order_number,customer_name,filetype_name,created_date,filename
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,
      "order_number": "437574-03",
      "customer_name": "Caterpillar - Schertz WM",
      "filetype_name": "Final Manifest",
      "created_date": "2023-01-03",
      "filename": "2022049GEC - Final Manifest.pdf"
    }
  ],
  "totalElements": 1841
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

APIs ¶

Accounts Receivable Aging Report ¶

Accounts Receivable Aging ReportGET/api/reporting/accounts_receivable_aging

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Annual Waste Report ¶

Annual Waste ReportGET/api/reporting/annual_waste_report

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Approval Status Order Report ¶

Approval Status Order ReportGET/api/reporting/approval_status_order_report

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Commission Report ¶

Commission Report ESCGET/api/reporting/commission_report

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Comparative Revenue Billto ¶

Comparative Revenue BilltoGET/api/reporting/comparative_revenue_billto

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Containter Summary ¶

Containter SummaryGET/api/reporting/containter_summary

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Cost Analysis ¶

Cost AnalysisGET/api/reporting/cost_analysis

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Customer Legacy ID Summary Report ¶

Customer Legacy ID Summary ReportGET/api/reporting/customer_legacy_summary

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

Disposal Log Report ¶

Disposal LogGET/api/reporting/disposal_log

Overview: ¶

Response Description: ¶

Example URI

Headers

Headers

Body

ESC/Network Order Invoice Status Report ¶

ESC/Network Order Invoice StatusGET/api/reporting/esc_network_order_invoice_status

Other APIs docs

Bearer Token

Error Messages

Accounts Receivable Aging Report
GET`/api/reporting/accounts_receivable_aging`

Overview:

Response Description:

Annual Waste Report
GET`/api/reporting/annual_waste_report`

Overview:

Response Description:

Approval Status Order Report
GET`/api/reporting/approval_status_order_report`

Overview:

Response Description:

Commission Report ESC
GET`/api/reporting/commission_report`

Overview:

Response Description:

Comparative Revenue Billto
GET`/api/reporting/comparative_revenue_billto`

Overview:

Response Description:

Containter Summary
GET`/api/reporting/containter_summary`

Overview:

Response Description:

Cost Analysis
GET`/api/reporting/cost_analysis`

Overview:

Response Description:

Customer Legacy ID Summary Report
GET`/api/reporting/customer_legacy_summary`

Overview:

Response Description:

Disposal Log
GET`/api/reporting/disposal_log`

Overview:

Response Description:

ESC/Network Order Invoice Status
GET`/api/reporting/esc_network_order_invoice_status`

Overview:

Response Description:

Expiring Profile Report
GET`/api/reporting/esc_network_order_invoice_status`

Overview:

Response Description:

Generator Profile Summary
GET`/api/reporting/customer_profile_summary`

Overview:

Response Description:

Generator Profile Summary with Pricing and Cost
GET`/api/reporting/generator_profile_summary_price_cost`

Overview:

Response Description:

Inventory Check Report
GET`/api/reporting/inventory_check_report`

Overview:

Response Description:

Inventory Report
GET`/api/reporting/inventory_report`

Overview:

Response Description:

Last Shipment By Profile
GET`/api/reporting/last_shipment_by_profile`

Overview:

Response Description:

MMP Profile Report
GET`/api/reporting/mmp_profile_report`

Overview:

Response Description:

MMP/WPC Report
GET`/api/reporting/wpc_mmp_report`

Overview:

Response Description: