Back to top

Setup Tools APIs (Part 2)

Overview

Welcome to the Setup Tools API section of the Wastelinq API suite. This collection of APIs is designed to manage and interact with setup tools within the Wastelinq system, providing a robust framework for handling setup tools data efficiently.

Each API endpoint in this section corresponds to a unique functionality related to setup tools. The response from each API call includes specific fields and data types, providing detailed information about the setup tools.

For comprehensive documentation of each API, follow the respective link provided in the APIs section.

For more detailed information on the structure of requests and responses, 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.

Products & Services

productsandservices

productsandservices
GET/api/lookup/productsandservices

Overview:

The productsandservices endpoint, accessible at /api/lookup/productsandservices, is a GET request that is used to retrieve the details of products and services.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the products and services.
id number The unique identifier for the product or service.
product_Number number The product number.
product_Item string The product item.
esc_id string The ESC identifier.
vendor_type string The vendor type.
general_Description string The general description of the product or service.
type_id number The type identifier.
type_Name string The type name.
price string The price of the product or service.
uM_id number The unit of measure identifier.
uM_Name string The unit of measure name.
gL_Revenue string The general ledger revenue.
gL_Cost string The general ledger cost.
services array An array of services.
dOT_Description string The description of the Department of Transportation.
volume string The volume of the product or service.
weight string The weight of the product or service.
status string The status of the product or service.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.
extra_content array An array of extra content.
is_3_decimals boolean Indicates whether the price has 3 decimals.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productsandservices
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 4150,
      "product_Number": 95,
      "product_Item": "814",
      "esc_id": null,
      "vendor_type": "",
      "general_Description": "TRANSPORTATION - 10gl Cont",
      "type_id": 399,
      "type_Name": "Transportation",
      "price": "0",
      "uM_id": 322,
      "uM_Name": "Each",
      "gL_Revenue": "408140",
      "gL_Cost": "508140",
      "services": [
        "Non-Inventory Control Item"
      ],
      "dOT_Description": null,
      "volume": null,
      "weight": null,
      "status": "Active",
      "showDelete": false
    }
  ],
  "totalElements": 111,
  "extra_content": [
    {
      "is_3_decimals": false
    }
  ]
}

productsandservices_save

productsandservices_save
POST/api/lookup/productsandservices_save/

Overview:

The productsandservices_save endpoint, accessible at /api/lookup/productsandservices_save/, is a POST request that is used to create or update a product or service.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service.
message string A message indicating the result of the operation.
status string The status of the product or service.
weight string The weight of the product or service.
volume string The volume of the product or service.
dOT_Description string The description of the Department of Transportation.
services array An array of services.
gL_Cost string The general ledger cost.
gL_Revenue string The general ledger revenue.
uM_id number The unit of measure identifier.
price string The price of the product or service.
type_id number The type identifier.
general_Description string The general description of the product or service.
vendor_type string The vendor type.
esc_id string The ESC identifier.
product_Item string The product item.
vendorCostList array An array of vendor costs.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productsandservices_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "status": "Active",
  "weight": "1",
  "volume": "1",
  "dOT_Description": "test",
  "services": [
    "Sales Tax"
  ],
  "gL_Cost": "test",
  "gL_Revenue": "test",
  "uM_id": "321",
  "price": "1",
  "type_id": "398",
  "general_Description": "test",
  "vendor_type": "Enterprise",
  "esc_id": "test",
  "product_Item": "test",
  "id": "0",
  "vendorCostList": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 15425,
  "message": "Product_Service created successfully"
}

productsandservices_del

productsandservices_del
POST/api/lookup/productsandservices_del/

Overview:

The productsandservices_del endpoint, accessible at /api/lookup/productsandservices_del/, is a POST request that is used to delete a product or service.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productsandservices_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "15425"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "15425",
  "message": "Products and Services deleted successfully"
}

Billing - Services

productservicetype

productservicetype
GET/api/lookup/productservicetype/

Overview:

The productservicetype endpoint, accessible at /api/lookup/productservicetype/, is a GET request that is used to retrieve the details of product or service types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the product or service type.
id number The unique identifier for the product or service type.
name string The name of the product or service type.
cost_Category_ID number The cost category identifier.
cost_Category_Name string The cost category name.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productservicetype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 618,
      "name": "Taxes,Fees,Surcharges",
      "cost_Category_ID": 229,
      "cost_Category_Name": "Taxes & Fees",
      "showDelete": false
    }
  ],
  "totalElements": 10
}

productservicetype_save

productservicetype_save
POST/api/lookup/productservicetype_save/

Overview:

The productservicetype_save endpoint, accessible at /api/lookup/productservicetype_save/, is a POST request that is used to create or update a product or service type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service type.
message string A message indicating the result of the operation.
cost_Category_ID number The cost category identifier.
name string The name of the product or service type.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productservicetype_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "cost_Category_ID": "220",
  "name": "test",
  "id": "0"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 1128,
  "message": "Product & Service Type created successfully"
}

productservicetype_del

productservicetype_del
POST/api/lookup/productservicetype_del/

Overview:

The productservicetype_del endpoint, accessible at /api/lookup/productservicetype_del/, is a POST request that is used to delete a product or service type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service type.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productservicetype_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1128"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1128",
  "message": "Product & Service Type deleted successfully"
}

productserviceunitsmeasure

productserviceunitsmeasure
GET/api/lookup/productserviceunitsmeasure/

Overview:

The productserviceunitsmeasure endpoint, accessible at /api/lookup/productserviceunitsmeasure/, is a GET request that is used to retrieve the details of product or service units of measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the product or service units of measure.
id number The unique identifier for the product or service units of measure.
name string The name of the product or service units of measure.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productserviceunitsmeasure/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 329,
      "name": "Per Invoice",
      "showDelete": false
    }
  ],
  "totalElements": 8
}

productserviceunitsmeasure_save

productserviceunitsmeasure_save
POST/api/lookup/productserviceunitsmeasure_save/

Overview:

The productserviceunitsmeasure_save endpoint, accessible at /api/lookup/productserviceunitsmeasure_save/, is a POST request that is used to create or update a product or service units of measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service units of measure.
message string A message indicating the result of the operation.
name string The name of the product or service units of measure.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productserviceunitsmeasure_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 1088,
  "message": "Product & Service Units of Measure created successfully"
}

productserviceunitsmeasure_del

productserviceunitsmeasure_del
POST/api/lookup/productserviceunitsmeasure_del/

Overview:

The productserviceunitsmeasure_del endpoint, accessible at /api/lookup/productserviceunitsmeasure_del/, is a POST request that is used to delete a product or service units of measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service units of measure.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productserviceunitsmeasure_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1088"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1088",
  "message": "Product & Service Units of Measure deleted successfully"
}

customerpaymentterms

customerpaymentterms
GET/api/lookup/customerpaymentterms/

Overview:

The customerpaymentterms endpoint, accessible at /api/lookup/customerpaymentterms/, is a GET request that is used to retrieve the details of customer payment terms.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the customer payment terms.
id number The unique identifier for the customer payment terms.
order number The order of the customer payment terms.
name string The name of the customer payment terms.
dueDate number The due date of the customer payment terms.
isDefault boolean Indicates whether the customer payment terms are the default.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerpaymentterms/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 469,
      "order": 16,
      "name": "Per Contract",
      "dueDate": 30,
      "isDefault": false,
      "showDelete": false
    }
  ],
  "totalElements": 16
}

customerpaymentterms_save

customerpaymentterms_save
POST/api/lookup/customerpaymentterms_save/

Overview:

The customerpaymentterms_save endpoint, accessible at /api/lookup/customerpaymentterms_save/, is a POST request that is used to create or update a customer payment terms.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the customer payment terms.
message string A message indicating the result of the operation.
order number The order of the customer payment terms.
name string The name of the customer payment terms.
dueDate number The due date of the customer payment terms.
isDefault boolean Indicates whether the customer payment terms are the default.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerpaymentterms_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "order": 17,
  "name": "1",
  "isDefault": false,
  "dueDate": 30
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 1350,
  "message": "Customer Payment Terms created successfully"
}

customerpaymentterms_del

customerpaymentterms_del
POST/api/lookup/customerpaymentterms_del/

Overview:

The customerpaymentterms_del endpoint, accessible at /api/lookup/customerpaymentterms_del/, is a POST request that is used to delete a customer payment terms.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the product or service units of measure.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/customerpaymentterms_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1350"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1350",
  "message": "Customer Payment Terms deleted successfully"
}

ordertype

ordertype
GET/api/lookup/ordertype/

Overview:

The ordertype endpoint, accessible at /api/lookup/ordertype/, is a GET request that is used to retrieve the details of order types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the order type.
id number The unique identifier for the order type.
name string The name of the order type.
status string The status of the order type.
displayOnCal boolean Indicates whether the order type should be displayed on the calendar.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordertype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 418,
      "name": "Sustainability",
      "status": "Active",
      "displayOnCal": true,
      "showDelete": false
    }
  ],
  "totalElements": 12
}

ordertype_save

ordertype_save
POST/api/lookup/ordertype_save/

Overview:

The ordertype_save endpoint, accessible at /api/lookup/ordertype_save/, is a POST request that is used to create or update an order type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the order type.
message string A message indicating the result of the operation.
name string The name of the order type.
status string The status of the order type.
displayOnCal boolean Indicates whether the order type should be displayed on the calendar.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordertype_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test",
  "status": "Active",
  "displayOnCal": "Yes"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 716,
  "message": "Order Type created successfully"
}

ordertype_del

ordertype_del
POST/api/lookup/ordertype_del/

Overview:

The ordertype_del endpoint, accessible at /api/lookup/ordertype_del/, is a POST request that is used to delete an order type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the order type.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/ordertype_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "716"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "716",
  "message": "Order Type deleted successfully"
}

accountsreceivablestatus

accountsreceivablestatus
GET/api/lookup/accountsreceivablestatus/

Overview:

The accountsreceivablestatus endpoint, accessible at /api/lookup/accountsreceivablestatus/, is a GET request that is used to retrieve the details of accounts receivable status.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the accounts receivable status.
id number The unique identifier for the accounts receivable status.
name string The name of the accounts receivable status.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/accountsreceivablestatus/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 411,
      "name": "Emailed"
    }
  ],
  "totalElements": 8
}

orderdelayreason

orderdelayreason
GET/api/lookup/orderdelayreason/

Overview:

The orderdelayreason endpoint, accessible at /api/lookup/orderdelayreason/, is a GET request that is used to retrieve the details of order delay reasons.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the order delay reason.
id number The unique identifier for the order delay reason.
name string The name of the order delay reason.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/orderdelayreason/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 20,
      "name": "Logistics",
      "showDelete": false
    }
  ],
  "totalElements": 5
}

orderdelayreason_save

orderdelayreason_save
POST/api/lookup/orderdelayreason_save/

Overview:

The orderdelayreason_save endpoint, accessible at /api/lookup/orderdelayreason_save/, is a POST request that is used to create or update an order delay reason.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the order delay reason.
message string A message indicating the result of the operation.
name string The name of the order delay reason.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/orderdelayreason_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 55,
  "message": "Order Delay Reason created successfully"
}

orderdelayreason_del

orderdelayreason_del
POST/lookup/orderdelayreason_del/

Overview:

The orderdelayreason_del endpoint, accessible at /api/lookup/orderdelayreason_del/, is a POST request that is used to delete an order delay reason.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the order delay reason.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./lookup/orderdelayreason_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "55"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "55",
  "message": "Order Delay Reason deleted successfully"
}

costcategory

costcategory
GET/api/lookup/costcategory/

Overview:

The costcategory endpoint, accessible at /api/lookup/costcategory/, is a GET request that is used to retrieve the details of cost categories.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the cost category.
id number The unique identifier for the cost category.
name string The name of the cost category.
showEdit boolean Indicates whether the edit button should be displayed.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/costcategory/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 220,
      "name": "Disposal",
      "showEdit": false,
      "showDelete": false
    }
  ],
  "totalElements": 4
}

costcategory_save

costcategory_save
POST/api/lookup/costcategory_save/

Overview:

The costcategory_save endpoint, accessible at /api/lookup/costcategory_save/, is a POST request that is used to create or update a cost category.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the cost category.
message string A message indicating the result of the operation.
name string The name of the cost category.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/costcategory_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 710,
  "message": "Cost Category created successfully"
}

costcategory_del

costcategory_del
POST/api/lookup/costcategory_del/

Overview:

The costcategory_del endpoint, accessible at /api/lookup/costcategory_del/, is a POST request that is used to delete a cost category.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the cost category.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/costcategory_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "710"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "710",
  "message": "Cost Category deleted successfully"
}

Billing - Transportation

transportationbillingrates

transportationbillingrates
GET/api/lookup/transportationbillingrates/

Overview:

The transportationbillingrates endpoint, accessible at /api/lookup/transportationbillingrates/, is a GET request that is used to retrieve the details of transportation billing rates.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the transportation billing rates.
id number The unique identifier for the transportation billing rates.
transportationType string The transportation type.
prodServCode string The product or service code.
prodServ_Code_ID number The product or service code identifier.
prodServ_Code_Product_Item string The product or service code product item.
bulkOnly boolean Indicates whether the transportation is bulk only.
packageOnly boolean Indicates whether the transportation is package only.
inactive boolean Indicates whether the transportation is inactive.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationbillingrates/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 790,
      "tranTypeDesc": "Bulk-Subcontracted",
      "prodServCode": "",
      "prodServ_Code_ID": 4169,
      "prodServ_Code_Product_Item": "890",
      "bulkOnly": true,
      "packageOnly": false,
      "inactive": false,
      "showDelete": false
    }
  ],
  "totalElements": 9
}

transportationbillingrates_save

transportationbillingrates_save
POST/api/lookup/transportationbillingrates_save/

Overview:

The transportationbillingrates_save endpoint, accessible at /api/lookup/transportationbillingrates_save/, is a POST request that is used to create or update a transportation billing rate.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the transportation billing rates.
message string A message indicating the result of the operation.
inactive boolean Indicates whether the transportation is inactive.
packageOnly boolean Indicates whether the transportation is package only.
bulkOnly boolean Indicates whether the transportation is bulk only.
prodServ_Code_ID number The product or service code identifier.
prodServCode string The product or service code.
tranTypeDesc string The transportation type description.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationbillingrates_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "inactive": true,
  "packageOnly": true,
  "bulkOnly": true,
  "prodServ_Code_ID": "4179",
  "prodServCode": "210",
  "tranTypeDesc": "test",
  "id": "0"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 2511,
  "message": "Transportation Billing Rate created successfully"
}

transportationbillingrates_del

transportationbillingrates_del
POST/api/lookup/transportationbillingrates_del/

Overview:

The transportationbillingrates_del endpoint, accessible at /api/lookup/transportationbillingrates_del/, is a POST request that is used to delete a transportation billing rate.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the transportation billing rates.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationbillingrates_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "2511"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "2511",
  "message": "Transportation Billing Rate deleted successfully"
}

transportationcontainersizeconversion

transportationcontainersizeconversion
GET/api/lookup/transportationcontainersizeconversion/

Overview:

The transportationcontainersizeconversion endpoint, accessible at /api/lookup/transportationcontainersizeconversion/, is a GET request that is used to retrieve the details of transportation container size conversion.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the transportation container size conversion.
id number The unique identifier for the transportation container size conversion
trans_Prod_Code string The transportation product code.
container_Size string The container size.
prodServ_Code_ID number The product or service code identifier.
prodServ_Code_Product_Item string The product or service code product item.
prodServ_Code_General_Description string The product or service code general description.
base_Conversion number The base conversion.
type string The type of conversion.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationcontainersizeconversion/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 557,
      "trans_Prod_Code": "823 ",
      "container_Size": "550",
      "prodServ_Code_ID": 4159,
      "prodServ_Code_Product_Item": "823",
      "prodServ_Code_General_Description": "TRANSPORTATION - 550gl Container",
      "base_Conversion": 10,
      "type": "By Container",
      "showDelete": true
    }
  ],
  "totalElements": 13
}

transportationcontainersizeconversion_save

transportationcontainersizeconversion_save
POST/api/lookup/transportationcontainersizeconversion_save/

Overview:

The transportationcontainersizeconversion_save endpoint, accessible at /api/lookup/transportationcontainersizeconversion_save/, is a POST request that is used to create or update a transportation container size conversion.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the transportation container size conversion.
message string A message indicating the result of the operation
type string The type of conversion.
base_Conversion number The base conversion.
prodServ_Code_Product_Item string The product or service code product item.
prodServ_Code_ID number The product or service code identifier.
container_Size string The container

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationcontainersizeconversion_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "type": "1",
  "base_Conversion": 0,
  "prodServ_Code_Product_Item": "110",
  "prodServ_Code_ID": "4086",
  "container_Size": "1",
  "id": "0"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 1399,
  "message": "Transportation - Container Size Conversion created successfully"
}

transportationcontainersizeconversion_del

transportationcontainersizeconversion_del
POST/api/lookup/transportationcontainersizeconversion_del/

Overview:

The transportationcontainersizeconversion_del endpoint, accessible at /api/lookup/transportationcontainersizeconversion_del/, is a POST request that is used to delete a transportation container size conversion.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the transportation container size conversion.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/transportationcontainersizeconversion_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "1399"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "1399",
  "message": "Transportation - Container Size Conversion deleted successfully"
}

washouttype

washouttype
GET/api/lookup/washouttype/

Overview:

The washouttype endpoint, accessible at /api/lookup/washouttype/, is a GET request that is used to retrieve the details of washout types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the washout type.
id number The unique identifier for the washout type.
washOutTypeDesc string The washout type description.
prodServCode string The product or service code.
inactive boolean Indicates whether the washout type is inactive.
prodServ_Code_ID number The product or service code identifier.
prodServ_Code_Product_Item string The product or service code product item.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/washouttype/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 75,
      "washOutTypeDesc": "Dump Truck Washout",
      "prodServCode": null,
      "inactive": false,
      "prodServ_Code_ID": 4090,
      "prodServ_Code_Product_Item": "730",
      "showDelete": true
    }
  ],
  "totalElements": 4
}

washouttype_save

washouttype_save
POST/api/lookup/washouttype_save/

Overview:

The washouttype_save endpoint, accessible at /api/lookup/washouttype_save/, is a POST request that is used to create or update a washout type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the washout type.
message string A message indicating the result of the operation.
inactive boolean Indicates whether the washout type is inactive.
prodServ_Code_ID number The product or service code identifier.
prodServCode string The product or service code.
washOutTypeDesc string The washout type description.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/washouttype_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "inactive": true,
  "prodServ_Code_ID": "4086",
  "prodServCode": "110",
  "washOutTypeDesc": "test",
  "id": "0"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 162,
  "message": "Washout Type created successfully"
}

washouttype_del

washouttype_del
POST/api/lookup/washouttype_del/

Overview:

The washouttype_del endpoint, accessible at /api/lookup/washouttype_del/, is a POST request that is used to delete a washout type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the washout type.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/washouttype_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "162"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "162",
  "message": "Washout Type deleted successfully"
}

containersizelist

containersizelist
GET/api/lookup/containersizelist/

Overview:

The containersizelist endpoint, accessible at /api/lookup/containersizelist/, is a GET request that is used to retrieve the details of container sizes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the container sizes.
containerSize string The container size.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/containersizelist/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "containerSize": "0.25"
    },
    {
      "containerSize": "0.5"
    },
    {
      "containerSize": "0.75"
    }
  ],
  "totalElements": 66
}

Billing - Service Profile

productitemlist

productitemlist
GET/api/lookup/productitemlist/

Overview:

The productitemlist endpoint, accessible at /api/lookup/productitemlist/, is a GET request that is used to retrieve the details of product items.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the product items.
id number The unique identifier for the product item.
product_Item string The product item.
general_Description string The general description of the product item.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/productitemlist/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 4086,
      "product_Item": "110",
      "general_Description": "PROF. SVCS - Analytical Services"
    },
    {
      "id": 4085,
      "product_Item": "120",
      "general_Description": "PROF. SVCS - DOCUMENTS (fee, prep) / PERMITS /CONSULTING"
    }
  ],
  "totalElements": 116
}

brokerconfiginfo2

brokerconfiginfo2
GET/api/lookup/brokerconfiginfo2/

Overview:

The brokerconfiginfo2 endpoint, accessible at /api/lookup/brokerconfiginfo2/, is a GET request that is used to retrieve the broker configuration information.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the broker configuration information.
id number The unique identifier for the broker configuration information.
eis_Service_Item string The EIS service item.
waste_Fee_Service_Item number The waste fee service item.
fuel_Surchg_Service_Item number The fuel surcharge service item.
fuel_Surchg_Tx_Service_Item number The fuel surcharge tax service item.
min_Stop_Service_Item number The minimum stop service item.
max_Stop_Service_Item number The maximum stop service item.
per_Pallet_Trans_Service_Item number The per pallet transportation service item.
empty_Drum_Trans_Service_Item number The empty drum transportation service item.
empty_Tote_Trans_Service_Item number The empty tote transportation service item.
flat_Rate_Service_ID number The flat rate service identifier.
document_Fee_Service_Item number The document fee service item.
wash_Out_Service_Item number The washout service item.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/brokerconfiginfo2/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 13,
      "eis_Service_Item": "",
      "waste_Fee_Service_Item": 4087,
      "fuel_Surchg_Service_Item": 4167,
      "fuel_Surchg_Tx_Service_Item": 4167,
      "min_Stop_Service_Item": 4166,
      "max_Stop_Service_Item": 7952,
      "per_Pallet_Trans_Service_Item": 4156,
      "empty_Drum_Trans_Service_Item": 4160,
      "empty_Tote_Trans_Service_Item": 4161,
      "flat_Rate_Service_ID": 4165,
      "document_Fee_Service_Item": 4170,
      "wash_Out_Service_Item": 4090
    }
  ],
  "totalElements": 1
}

brokerconfiginfo2_save

brokerconfiginfo2_save
POST/api/lookup/brokerconfiginfo2_save/

Overview:

The brokerconfiginfo2_save endpoint, accessible at /api/lookup/brokerconfiginfo2_save/, is a POST request that is used to create or update the broker configuration information.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the broker configuration information.
message string A message indicating the result of the operation.
wash_Out_Service_Item string The washout service item.
document_Fee_Service_Item string The document fee service item.
flat_Rate_Service_ID string The flat rate service identifier
empty_Tote_Trans_Service_Item string The empty tote transportation service item.
empty_Drum_Trans_Service_Item string The empty drum transportation service item.
per_Pallet_Trans_Service_Item string The per pallet transportation service item.
max_Stop_Service_Item string The maximum stop service item.
min_Stop_Service_Item string The minimum stop service item.
fuel_Surchg_Tx_Service_Item string The fuel surcharge tax service item.
fuel_Surchg_Service_Item string The fuel surcharge service item.
waste_Fee_Service_Item string The waste fee service item.
eis_Service_Item string The EIS service item.
brokerId number The broker identifier.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/brokerconfiginfo2_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "wash_Out_Service_Item": "4090",
  "document_Fee_Service_Item": "4170",
  "flat_Rate_Service_ID": "4165",
  "empty_Tote_Trans_Service_Item": "4161",
  "empty_Drum_Trans_Service_Item": "4160",
  "per_Pallet_Trans_Service_Item": "4156",
  "max_Stop_Service_Item": "7952",
  "min_Stop_Service_Item": "4166",
  "fuel_Surchg_Tx_Service_Item": "4167",
  "fuel_Surchg_Service_Item": "4167",
  "waste_Fee_Service_Item": "4087",
  "eis_Service_Item": "",
  "id": "13",
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "UPDATE",
  "id": "13",
  "message": "BrokerConfigInfo2 updated successfully"
}

Billing - Fee

defaultfee

defaultfee
GET/api/lookup/defaultfee/

Overview:

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/defaultfee/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "sales_tax_default_rate": "8.25"
    },
    {
      "id": 16,
      "feeNo": 16,
      "name": "EIS ",
      "type": "Rate",
      "value": "14",
      "apply": "Waste Material",
      "status": "Active",
      "showDelete": false,
      "isDeleted": false
    }
  ],
  "totalElements": 4
}

changetaxrate

changetaxrate
POST/api/lookup/changetaxrate/

Overview:

The changetaxrate endpoint, accessible at /api/lookup/changetaxrate/, is a POST request that is used to change the tax rate.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
message string A message indicating the result of the operation.
value number The value of the tax rate.
brokerId number The broker identifier.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/changetaxrate/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "value": 7.25,
  "brokerId": 31
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Default Tax Rate save successfully"
}

defaultfee_save

defaultfee_save
POST/api/lookup/defaultfee_save/

Overview:

The defaultfee_save endpoint, accessible at /api/lookup/defaultfee_save/, is a POST request that is used to create or update a default fee.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the default fee.
message string A message indicating the result of the operation.
sales_tax_default_rate number The sales tax default rate.
status string The status of the default fee.
apply string The application of the default fee.
value number The value of the default fee.
type string The type of the default fee.
name string The name of the default fee.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/defaultfee_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "sales_tax_default_rate": 7.25,
  "status": "Active",
  "apply": "All",
  "value": 0,
  "type": "Flat Fee",
  "name": "kien_test",
  "id": "0"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 75,
  "message": "Default Fee created successfully"
}

defaultfee_del

defaultfee_del
POST/api/lookup/defaultfee_del/

Overview:

The defaultfee_del endpoint, accessible at /api/lookup/defaultfee_del/, is a POST request that is used to delete a default fee.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the default fee.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/defaultfee_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "75"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "75",
  "message": "Default Fee deleted successfully"
}

Billing - Tax Schedule

taxschedule

taxschedule
GET/api/lookup/taxschedule/

Overview:

The taxschedule endpoint, accessible at /api/lookup/taxschedule/, is a GET request that is used to retrieve the details of tax schedules.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the tax schedules.
id number The unique identifier for the tax schedule.
name string The name of the tax schedule.
rate number The rate of the tax schedule.
showDelete boolean Indicates whether the delete button should be displayed.
isDeleted boolean Indicates whether the tax schedule is deleted.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/taxschedule/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 64,
      "name": "test_test",
      "rate": 1,
      "showDelete": true,
      "isDeleted": false
    }
  ],
  "totalElements": 1
}

taxschedule_save

taxschedule_save
POST/api/lookup/taxschedule_save/

Overview:

The taxschedule_save endpoint, accessible at /api/lookup/taxschedule_save/, is a POST request that is used to create or update a tax schedule.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the tax schedule.
message string A message indicating the result of the operation.
name string The name of the tax schedule.
rate number The rate of the tax schedule.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/taxschedule_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test",
  "rate": 1
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 63,
  "message": "Tax Schedule created successfully"
}

taxschedule_del

taxschedule_del
POST/api/lookup/taxschedule_del/

Overview:

The taxschedule_del endpoint, accessible at /api/lookup/taxschedule_del/, is a POST request that is used to delete a tax schedule.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the tax schedule.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/taxschedule_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "63"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "63",
  "message": "Tax Schedule deleted successfully"
}

Waste Product Code

disposalmethod

disposalmethod
GET/api/lookup/disposalmethod/

Overview:

The disposalmethod endpoint, accessible at /api/lookup/disposalmethod/, is a GET request that is used to retrieve the details of disposal methods.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the disposal methods.
id number The unique identifier for the disposal method.
name string The name of the disposal method.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalmethod/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1033,
      "name": "Alternate Fuels",
      "showDelete": false
    },
    {
      "id": 1034,
      "name": "Battery",
      "showDelete": true
    },
    {
      "id": 1035,
      "name": "Cylinder",
      "showDelete": true
    }
  ],
  "totalElements": 26
}

disposalmethod_save

disposalmethod_save
POST/api/lookup/disposalmethod_save/

Overview:

The disposalmethod_save endpoint, accessible at /api/lookup/disposalmethod_save/, is a POST request that is used to create or update a disposal method.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the disposal method.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalmethod_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 3648,
  "message": "Disposal Method created successfully"
}

disposalmethod_del

disposalmethod_del
POST/api/lookup/disposalmethod_del/

Overview:

The disposalmethod_del endpoint, accessible at /api/lookup/disposalmethod_del/, is a POST request that is used to delete a disposal method.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the disposal method.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalmethod_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "3648"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "3648",
  "message": "Disposal Method deleted successfully"
}

wastetypes

wastetypes
GET/api/lookup/wastetypes/

Overview:

The wastetypes endpoint, accessible at /api/lookup/wastetypes/, is a GET request that is used to retrieve the details of waste types.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the waste types.
id number The unique identifier for the waste type.
name string The name of the waste type.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/wastetypes/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 7485,
      "name": "RCRA neutral waste water",
      "showDelete": false
    },
    {
      "id": 7484,
      "name": "Oxidizer solids",
      "showDelete": false
    },
    {
      "id": 7483,
      "name": "Oxidizer liquids",
      "showDelete": false
    }
  ],
  "totalElements": 412
}

wastetypes_save

wastetypes_save
POST/api/lookup/wastetypes_save/

Overview:

The wastetypes_save endpoint, accessible at /api/lookup/wastetypes_save/, is a POST request that is used to create or update a waste type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the waste type.
message string A message indicating the result of the operation.
name string The name of the waste type.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/wastetypes_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 34965,
  "message": "WasteTypes created successfully"
}

wastetypes_del

wastetypes_del
POST/api/lookup/wastetypes_del/

Overview:

The wastetypes_del endpoint, accessible at /api/lookup/wastetypes_del/, is a POST request that is used to delete a waste type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the waste type.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/wastetypes_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "34965"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "34965",
  "message": "WasteTypes deleted successfully"
}

wasteproductcodes

wasteproductcodes
GET/api/lookup/wasteproductcodes?{filter_direct}

Overview:

The wasteproductcodes endpoint, accessible at /api/lookup/wasteproductcodes, is a GET request that is used to retrieve the details of waste product codes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the waste product codes.
id number The unique identifier for the waste product code.
code string The code of the waste product.
isEnterprise string Indicates whether the waste product is an enterprise.
esc_id string The ESC identifier.
waste_Types_id number The waste types identifier.
waste_Types_Name string The waste types name.
empty_container boolean Indicates whether the container is empty.
waste_Category_New string The new waste category.
waste_Category string The waste category.
eSC_Category_Description_Examples string The ESC category description examples.
disposal_Method_id number The disposal method identifier.
disposal_Method_Name string The disposal method name.
special_Gravity string The special gravity.
revenue_General_Ledger string The revenue general ledger.
cost_General_Ledger string The cost general ledger.
grade_id string The grade identifier.
grade_Value string The grade value.
status string The status of the waste product.
showDelete boolean Indicates whether the delete button should be displayed.
special_certification_document boolean Indicates whether the special certification document is required.
ESCCategoryDescriptionExamples object The ESC category description examples.
id number The unique identifier for the ESC category description examples.
content string The content of the ESC category description examples.
Cost_General_Ledger string The cost general ledger.
Revenue_General_Ledger string The revenue general ledger.
esc_id string The ESC identifier.
broker number The broker identifier.
process_code number The process code.
grade string The grade.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/wasteproductcodes?filter_direct
URI Parameters
HideShow
filter_direct
string (optional) 

The filter direct.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 3948,
      "code": "9000",
      "isEnterprise": "No",
      "esc_id": null,
      "waste_Types_id": 5870,
      "waste_Types_Name": "Transportation only",
      "empty_container": false,
      "waste_Category_New": "Trans only",
      "waste_Category": "Utilize for transportation only profiles",
      "eSC_Category_Description_Examples": null,
      "disposal_Method_id": 911,
      "disposal_Method_Name": "Transportation",
      "special_Gravity": "0",
      "revenue_General_Ledger": "0",
      "cost_General_Ledger": "0",
      "grade_id": "",
      "grade_Value": "",
      "status": "Active",
      "showDelete": false,
      "special_certification_document": false,
      "ESCCategoryDescriptionExamples": {
        "id": 2454,
        "content": null,
        "Cost_General_Ledger": "502240",
        "Revenue_General_Ledger": "402240",
        "esc_id": "224",
        "broker": 31,
        "process_code": 3948,
        "grade": null
      }
    }
  ],
  "totalElements": 481
}

Material Management Processes

process_codes

process_codes
GET/api/processcode/process_codes/

Overview:

The process_codes endpoint, accessible at /api/processcode/process_codes/, is a GET request that is used to retrieve the details of process codes.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the process codes.
items array An array of objects containing the details of the process codes.
id number The unique identifier for the process code.
tsdf_process_id string The TSDF process identifier.
tsdf_process_definition string The TSDF process definition.
disposal_method string The disposal method.
profiles_number_str_for_displaying string The profiles number string for displaying.
processcodes_code_str_for_displaying string The process codes code string for displaying.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/process_codes/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "items": [
      {
        "id": 210,
        "tsdf_process_id": "4FT",
        "tsdf_process_definition": "4FT Fluorescent Bulbs",
        "disposal_method": "Recycle",
        "profiles_number_str_for_displaying": "64426",
        "processcodes_code_str_for_displaying": "6021",
        "showDelete": true
      },
      {
        "id": 186,
        "tsdf_process_id": "UWP Aerosols",
        "tsdf_process_definition": "UWPRM Reroute",
        "disposal_method": "Varies",
        "profiles_number_str_for_displaying": "5310, 132761, 191226",
        "processcodes_code_str_for_displaying": "3509, 6044",
        "showDelete": false
      }
    ],
    "totalElements": 9
  }
}

add_process_codes_definition_init

add_process_codes_definition_init
GET/api/processcode/add_process_codes_definition_init/

Overview:

The add_process_codes_definition_init endpoint, accessible at /api/processcode/add_process_codes_definition_init/, is a GET request that is used to retrieve the details of the process codes definition.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the process codes definition.
tsdf_list array An array of objects containing the TSDF list.
id number The unique identifier for the TSDF.
Name string The name of the TSDF.
disposal_method_list array An array of objects containing the disposal method list.
id number The unique identifier for the disposal method.
Name string The name of the disposal method.
processcodes_required array An array of objects containing the process codes required.
id number The unique identifier for the process codes required.
display_val string The display value of the process codes required.
handling_codes array An array of objects containing the handling codes.
id string The identifier for the handling codes.
Name string The name of the handling codes.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/add_process_codes_definition_init/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "tsdf_list": [
      {
        "id": 9982,
        "Name": "Company A"
      },
      {
        "id": 12194,
        "Name": "Company B"
      }
    ],
    "disposal_method_list": [
      {
        "id": 1033,
        "Name": "Alternate Fuels"
      },
      {
        "id": 1034,
        "Name": "Battery"
      }
    ],
    "processcodes_required": [
      {
        "id": 4092,
        "display_val": "1000 - PCB Liquids >10,000 BTU/lb"
      },
      {
        "id": 4093,
        "display_val": "1001 - PCB Liquids 3,000 - 10,000 BTU/lb"
      },
      {
        "id": 3948,
        "display_val": "9000 - Transportation only"
      }
    ],
    "handling_codes": [
      {
        "id": "All",
        "Name": "All"
      },
      {
        "id": "H010- METALS RECOVERY",
        "Name": "H010- METALS RECOVERY"
      },
      {
        "id": "H011- MERCURY RECOVERY (INCLUDES MERCURY RETORTING, BULB/LAMP CRUSHING AND MERCURY VAPOR RECOVERY, THERMOSTAT RECOVERY, MERCURY FROM MEDICAL EQUIPMENT RECOVERY, MERCURY CAR SWITCH RECOVERY, ETC.)",
        "Name": "H011- MERCURY RECOVERY (INCLUDES MERCURY RETORTING, BULB/LAMP CRUSHING AND MERCURY VAPOR RECOVERY, THERMOSTAT RECOVERY, MERCURY FROM MEDICAL EQUIPMENT RECOVERY, MERCURY CAR SWITCH RECOVERY, ETC.)"
      }
    ]
  }
}

edit_process_codes_definition_init

edit_process_codes_definition_init
GET/api/processcode/edit_process_codes_definition_init/?id=332

Overview:

The edit_process_codes_definition_init endpoint, accessible at /api/processcode/edit_process_codes_definition_init/?id=332, is a GET request that is used to retrieve the details of the process codes definition.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the process codes definition.
details object An object containing the details of the process codes definition.
id number The unique identifier for the process code.
tsdf number The TSDF.
tsdf_process_id string The TSDF process identifier.
tsdf_process_definition string The TSDF process definition.
disposal_method number The disposal method.
handling_code string The handling code.
epa_codes string The EPA codes.
final_method boolean Indicates whether the final method is required.
secondary_profile_required boolean Indicates whether the secondary profile is required.
weight_uom string The weight unit of measure.
volumetric_uom string The volumetric unit of measure.
mmp_type string The MMP type.
processcodes_required array An array of objects containing the process codes required.
id number The unique identifier for the process codes required.
tsdf_list array An array of objects containing the TSDF list.
id number The unique identifier for the TSDF.
Name string The name of the TSDF.
disposal_method_list array An array of objects containing the disposal method list.
id number The unique identifier for the disposal method.
Name string The name of the disposal method.
processcodes_required array An array of objects containing the process codes required.
id number The unique identifier for the process codes required.
display_val string The display value of the process codes required.
handling_codes array An array of objects containing the handling codes.
id string The identifier for the handling codes.
Name string The name of the handling codes.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/edit_process_codes_definition_init/?id=332
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "details": {
      "id": 332,
      "tsdf": 9982,
      "tsdf_process_id": "test_kien",
      "tsdf_process_definition": "test_kien",
      "disposal_method": 1033,
      "handling_code": "H010- METALS RECOVERY",
      "epa_codes": "123",
      "final_method": false,
      "secondary_profile_required": false,
      "weight_uom": "Pound",
      "volumetric_uom": "Gallon",
      "mmp_type": "",
      "processcodes_required": [
        "4092"
      ]
    },
    "tsdf_list": [
      {
        "id": 9982,
        "Name": "Company A"
      },
      {
        "id": 12194,
        "Name": "Company B"
      }
    ],
    "disposal_method_list": [
      {
        "id": 1033,
        "Name": "Alternate Fuels"
      },
      {
        "id": 1034,
        "Name": "Battery"
      }
    ],
    "processcodes_required": [
      {
        "id": 4092,
        "display_val": "1000 - PCB Liquids >10,000 BTU/lb"
      },
      {
        "id": 4093,
        "display_val": "1001 - PCB Liquids 3,000 - 10,000 BTU/lb"
      },
      {
        "id": 3948,
        "display_val": "9000 - Transportation only"
      }
    ],
    "handling_codes": [
      {
        "id": "All",
        "Name": "All"
      },
      {
        "id": "H010- METALS RECOVERY",
        "Name": "H010- METALS RECOVERY"
      },
      {
        "id": "H011- MERCURY RECOVERY (INCLUDES MERCURY RETORTING, BULB/LAMP CRUSHING AND MERCURY VAPOR RECOVERY, THERMOSTAT RECOVERY, MERCURY FROM MEDICAL EQUIPMENT RECOVERY, MERCURY CAR SWITCH RECOVERY, ETC.)",
        "Name": "H011- MERCURY RECOVERY (INCLUDES MERCURY RETORTING, BULB/LAMP CRUSHING AND MERCURY VAPOR RECOVERY, THERMOSTAT RECOVERY, MERCURY FROM MEDICAL EQUIPMENT RECOVERY, MERCURY CAR SWITCH RECOVERY, ETC.)"
      }
    ]
  }
}

get_profile_list_for_mmp

get_profile_list_for_mmp
GET/api/processcode/get_profile_list_for_mmp/

Overview:

The get_profile_list_for_mmp endpoint, accessible at /api/processcode/get_profile_list_for_mmp/, is a GET request that is used to retrieve the details of the profile list for the material management process.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the profile list.
items array An array of objects containing the details of the profile list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/get_profile_list_for_mmp/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "items": []
  }
}

add_process_codes_definition_save

add_process_codes_definition_save
POST/api/processcode/add_process_codes_definition_save/

Overview:

The add_process_codes_definition_save endpoint, accessible at /api/processcode/add_process_codes_definition_save/, is a POST request that is used to create the process codes definition.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the process codes definition.
volumetric_uom string The volumetric unit of measure.
weight_uom string The weight unit of measure.
disposal_method string The disposal method.
processcodes_required array An array of objects containing the process codes required.
epa_codes string The EPA codes.
handling_code string The handling code.
tsdf_process_definition string The TSDF process definition.
tsdf_process_id string The TSDF process identifier.
tsdf string The TSDF.
CostList array An array of objects containing the cost list.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/add_process_codes_definition_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "volumetric_uom": "Gallon",
  "weight_uom": "Pound",
  "disposal_method": "1036",
  "processcodes_required": [
    "4092"
  ],
  "epa_codes": "test1",
  "handling_code": "H011- MERCURY RECOVERY (INCLUDES MERCURY RETORTING, BULB/LAMP CRUSHING AND MERCURY VAPOR RECOVERY, THERMOSTAT RECOVERY, MERCURY FROM MEDICAL EQUIPMENT RECOVERY, MERCURY CAR SWITCH RECOVERY, ETC.)",
  "tsdf_process_definition": "test1",
  "tsdf_process_id": "test1",
  "tsdf": "12193",
  "CostList": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {}
}

edit_process_codes_definition_save

edit_process_codes_definition_save
POST/api/processcode/edit_process_codes_definition_save/

Overview:

The edit_process_codes_definition_save endpoint, accessible at /api/processcode/edit_process_codes_definition_save/, is a POST request that is used to update the process codes definition.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the process codes definition.
volumetric_uom string The volumetric unit of measure.
weight_uom string The weight unit of measure.
disposal_method string The disposal method.
processcodes_required array An array of objects containing the process codes required.
epa_codes string The EPA codes.
handling_code string The handling code.
tsdf_process_definition string The TSDF process definition.
tsdf_process_id string The TSDF process identifier.
tsdf string The TSDF.
id number The unique identifier for the process code.
final_method boolean Indicates whether the final method is required.
secondary_profile_required boolean Indicates whether the secondary profile is required.
mmp_type string The MMP type.
CostList array An array of objects containing the cost list.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/processcode/edit_process_codes_definition_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "volumetric_uom": "Gallon",
  "weight_uom": "Pound",
  "disposal_method": "1033",
  "processcodes_required": [
    "4092"
  ],
  "epa_codes": "123",
  "handling_code": "H010- METALS RECOVERY",
  "tsdf_process_definition": "test_kien",
  "tsdf_process_id": "test_kien",
  "tsdf": "9982",
  "id": 332,
  "final_method": false,
  "secondary_profile_required": false,
  "mmp_type": "",
  "CostList": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {}
}

Grade

grade

grade
GET/api/lookup/grade/

Overview:

The grade endpoint, accessible at /api/lookup/grade/, is a GET request that is used to retrieve the details of grades.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the grades.
id number The unique identifier for the grade.
value string The value of the grade.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/grade/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 45,
      "value": "LF",
      "showDelete": true
    },
    {
      "id": 37,
      "value": "UWP 508",
      "showDelete": true
    }
  ],
  "totalElements": 8
}

grade_save

grade_save
POST/api/lookup/grade_save/

Overview:

The grade_save endpoint, accessible at /api/lookup/grade_save/, is a POST request that is used to create or update a grade.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the grade.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/grade_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "value": "1"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 67,
  "message": "Grade created successfully"
}

grade_del

grade_del
POST/api/lookup/grade_del/

Overview:

The grade_del endpoint, accessible at /api/lookup/grade_del/, is a POST request that is used to delete a grade.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the grade.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/grade_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "67"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "67",
  "message": "Grade deleted successfully"
}

Vendors

vendors

vendors
GET/api/lookup/vendors/

Overview:

The vendors endpoint, accessible at /api/lookup/vendors/, is a GET request that is used to retrieve the details of vendors.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the vendors.
id number The unique identifier for the vendor.
vendor_Number number The vendor number.
name string The name of the vendor.
address1 string The address1 of the vendor.
address2 string The address2 of the vendor.
city string The city of the vendor.
state string The state of the vendor.
zip string The zip of the vendor.
phone_num string The phone number of the vendor.
phone_Ext string The phone extension of the vendor.
phone string The phone of the vendor.
email string The email of the vendor.
website string The website of the vendor.
legacy_Vendor_No string The legacy vendor number.
note string The note of the vendor.
approval_Documents string The approval documents of the vendor.
editable boolean Indicates whether the vendor is editable.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/vendors/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 2866,
      "vendor_Number": 16,
      "name": "Company A",
      "address1": "132, My Street, Kingston, New York 12401.",
      "address2": 132, My Street, Kingston, New York 12401.,
      "city": "Kingston",
      "state": "NY",
      "zip": "12401",
      "phone_num": "222-222-2222",
      "phone_Ext": null,
      "phone": "222-222-2222",
      "email": "janedoe@test.com",
      "website": null,
      "legacy_Vendor_No": "13",
      "note": "",
      "approval_Documents": null,
      "editable": true,
      "showDelete": false
    },
    {
      "id": 3117,
      "vendor_Number": 1043,
      "name": "TBD",
      "address1": "TBD",
      "address2": null,
      "city": "TBD",
      "state": "TX",
      "zip": "77777",
      "phone_num": "",
      "phone_Ext": null,
      "phone": null,
      "email": null,
      "website": "",
      "legacy_Vendor_No": null,
      "note": "",
      "approval_Documents": null,
      "editable": true,
      "showDelete": false
    }
  ],
  "totalElements": 442
}

vendors_save

vendors_save
POST/api/lookup/vendors_save/

Overview:

The vendors_save endpoint, accessible at /api/lookup/vendors_save/, is a POST request that is used to create or update a vendor.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the vendor.
message string A message indicating the result of the operation.
name string The name of the vendor.
address1 string The address1 of the vendor.
address2 string The address2 of the vendor.
city string The city of the vendor.
state string The state of the vendor.
zip string The zip of the vendor.
phone string The phone of the vendor.
phone_Ext string The phone extension of the vendor.
email string The email of the vendor.
website string The website of the vendor.
legacy_Vendor_No string The legacy vendor number.
note string The note of the vendor.
contactList array An array of objects containing the contact list.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/vendors_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test",
  "address1": "test",
  "address2": "test",
  "city": "test",
  "state": "CT",
  "zip": "10001",
  "phone": "123-123-1234",
  "phone_Ext": "",
  "email": "janedoe@wastelinq.vn",
  "website": "www.google.com",
  "legacy_Vendor_No": "1",
  "note": "1",
  "contactList": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 7155,
  "message": "Vendor created successfully"
}

vendors_del

vendors_del
POST/api/lookup/vendors_del/

Overview:

The vendors_del endpoint, accessible at /api/lookup/vendors_del/, is a POST request that is used to delete a vendor.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the vendor.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/vendors_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "7155"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "7155",
  "message": "Vendor deleted successfully"
}

get_vendors_list

get_vendors_list
GET/api/lookup/get_vendors_list/

Overview:

The get_vendors_list endpoint, accessible at /api/lookup/get_vendors_list/, is a GET request that is used to retrieve the details of vendors list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the vendors.
id number The unique identifier for the vendor.
name string The name of the vendor.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/get_vendors_list/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 3188,
      "name": "Company A"
    },
    {
      "id": 3118,
      "name": "Company B"
    },
    {
      "id": 2851,
      "name": "Company C"
    }
  ],
  "totalElements": 442
}

disposalfacilities

disposalfacilities
GET/api/lookup/disposalfacilities{?filter_direct,searchValue}

Overview:

The disposalfacilities endpoint, accessible at /api/lookup/disposalfacilities{?filter_direct,searchValue}, is a GET request that is used to retrieve the details of disposal facilities.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the disposal facilities.
id number The unique identifier for the disposal facility.
facility_ID number The facility identifier.
name string The name of the disposal facility.
parentDisposalFacility_Name string The parent disposal facility name.
ePA_ID string The EPA identifier.
phone_num string The phone number.
status string The status of the disposal facility.
approval_Status string The approval status.
date_Last_Audited string The date last audited.
excludeFromEnterprise boolean Indicates whether the disposal facility is excluded from the enterprise.
item_broker_id number The item broker identifier.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilities?filter_direct=&searchValue=
URI Parameters
HideShow
filter_direct
string (optional) 

The filter direct.

searchValue
string (optional) 

The search value.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 21315,
      "facility_ID": 15652,
      "name": "Company A",
      "parentDisposalFacility_Name": "Company A",
      "ePA_ID": "222222",
      "phone_num": "222-222-2222",
      "status": "Active",
      "approval_Status": "Yes",
      "date_Last_Audited": "",
      "excludeFromEnterprise": false,
      "item_broker_id": 26,
      "showDelete": false
    }
  ],
  "totalElements": 457
}

disposalfacilities_edit

disposalfacilities_edit
GET/api/lookup/disposalfacilities_edit/{id}

Overview:

The disposalfacilities_edit endpoint, accessible at /api/lookup/disposalfacilities_edit/{id}, is a GET request that is used to retrieve the details of a disposal facility.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the disposal facility.
id number The unique identifier for the disposal facility.
disposalFacility_Broker_id number The disposal facility broker identifier.
facility_ID number The facility identifier.
name string The name of the disposal facility.
approver string The approver.
commonName string The common name.
parentDisposalFacility_id number
parentDisposalFacility_Name string The parent disposal facility name.
customFacilityName string The custom facility name.
internal boolean Indicates whether the disposal facility is internal.
vendor_id string The vendor identifier.
excludeFromNetwork boolean Indicates whether the disposal facility is excluded from the network.
excludeFromEnterprise boolean Indicates whether the disposal facility is excluded from the enterprise.
customer_id string The customer identifier.
export_from_us boolean Indicates whether the disposal facility is exported from the US.
port_of_entryexit string The port of entry/exit.
outsideUSA boolean Indicates whether the disposal facility is outside the USA.
foreignerAddress string The foreigner address.
address1 string The address1 of the disposal facility.
address2 string The address2 of the disposal facility.
city string The city of the disposal facility.
state string The state of the disposal facility.
zip string The zip of the disposal facility.
eis_percent string The EIS percent.
state_ID string The state identifier.
ePA_ID string The EPA identifier.
phone string The phone of the disposal facility.
phone_Ext string The phone extension of the disposal facility.
fax string The fax of the disposal facility.
email string The email of the disposal facility.
status string The status of the disposal facility.
approval_Status string The approval status.
date_Last_Audited string The date last audited.
audited_By_id string The audited by identifier.
audited_By1_id string The audited by1 identifier.
approval_Documents string The approval documents.
AITemplate string The AI template.
has_ai_items boolean Indicates whether the disposal facility has AI items.
broker_id number The broker identifier.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilities_edit/id
URI Parameters
HideShow
id
number (required) 

The unique identifier for the disposal facility.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 21315,
      "disposalFacility_Broker_id": 1068,
      "facility_ID": 15652,
      "name": "Company A",
      "approver": "",
      "commonName": "Company B",
      "parentDisposalFacility_id": 16,
      "parentDisposalFacility_Name": "Company B",
      "customFacilityName": "",
      "internal": false,
      "vendor_id": "",
      "excludeFromNetwork": true,
      "excludeFromEnterprise": false,
      "customer_id": "",
      "export_from_us": false,
      "port_of_entryexit": "",
      "outsideUSA": false,
      "foreignerAddress": "",
      "address1": "132, My Street, Kingston, New York 12401.",
      "address2": "132, My Street, Kingston, New York 12401.",
      "city": "Kingston",
      "state": "NY",
      "zip": "12401",
      "eis_percent": "17",
      "state_ID": "",
      "ePA_ID": "22222",
      "phone": "222-222-2222",
      "phone_Ext": "",
      "fax": "",
      "email": "",
      "status": "Active",
      "approval_Status": "Yes",
      "date_Last_Audited": "",
      "audited_By_id": "",
      "audited_By1_id": "",
      "approval_Documents": "[]",
      "AITemplate": null,
      "has_ai_items": false,
      "broker_id": 31
    }
  ],
  "totalElements": 1
}

disposalfacilities_save

disposalfacilities_save
POST/api/lookup/disposalfacilities_save/

Overview:

The disposalfacilities_save endpoint, accessible at /api/lookup/disposalfacilities_save/, is a POST request that is used to create or update a disposal facility.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the disposal facility.
message string A message indicating the result of the operation.
approval_Documents string The approval documents of the disposal facility.
audited_By1_id string The audited by1 identifier.
audited_By_id string The audited by identifier.
audited_By_tmp_id string The audited by tmp identifier.
date_Last_Audited string The date last audited.
AITemplate string The AI template.
approval_Status string The approval status.
status string The status of the disposal facility.
scheduling_Protocol string The scheduling protocol.
email string The email of the disposal facility.
fax string The fax of the disposal facility.
phone_Ext string The phone extension of the disposal facility.
phone string The phone of the disposal facility.
ePA_ID string The EPA identifier.
state_ID string The state identifier.
eis_percent string The EIS percent.
outsideUSA boolean Indicates whether the disposal facility is outside the USA.
zip string The zip of the disposal facility.
state string The state of the disposal facility.
city string The city of the disposal facility.
address2 string The address2 of the disposal facility.
address1 string The address1 of the disposal facility.
foreignerAddress string The foreigner address of the disposal facility.
excludeFromEnterprise boolean Indicates whether the disposal facility is excluded from the enterprise.
excludeFromNetwork boolean Indicates whether the disposal facility is excluded from the network.
port_of_entryexit string The port of entry/exit.
export_from_us boolean Indicates whether the disposal facility is exported from the US.
outage boolean Indicates whether the disposal facility is outaged.
vendor_id string The vendor identifier.
internal boolean Indicates whether the disposal facility is internal.
customer_id string The customer identifier.
parentDisposalFacility_id string
customFacilityName string The custom facility name.
commonName string The common name.
approver string The approver.
name string The name of the disposal facility.
facility_ID string The facility identifier.
contactList array An array of objects containing the contact list.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilities_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "approval_Documents": "",
  "audited_By1_id": "",
  "audited_By_id": "",
  "audited_By_tmp_id": "",
  "date_Last_Audited": "",
  "AITemplate": "0",
  "approval_Status": "No",
  "status": "Active",
  "scheduling_Protocol": "",
  "email": "testmail@gmail.com",
  "fax": "1234567890",
  "phone_Ext": "",
  "phone": "123-456-7890",
  "ePA_ID": "test",
  "state_ID": "test",
  "eis_percent": "",
  "outsideUSA": false,
  "zip": "10001",
  "state": "AL",
  "city": "test",
  "address2": "test",
  "address1": "test",
  "foreignerAddress": "",
  "excludeFromEnterprise": false,
  "excludeFromNetwork": false,
  "port_of_entryexit": "",
  "export_from_us": false,
  "outage": false,
  "vendor_id": "3188",
  "internal": false,
  "customer_id": "",
  "parentDisposalFacility_id": "121",
  "customFacilityName": "",
  "commonName": "test",
  "approver": "1875",
  "name": "testtest",
  "facility_ID": "",
  "id": "0",
  "contactList": []
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 24955,
  "message": "Disposal Facility created successfully"
}

disposalfacilities_del

disposalfacilities_del
POST/api/lookup/disposalfacilities_del/

Overview:

The disposalfacilities_del endpoint, accessible at /api/lookup/disposalfacilities_del/, is a POST request that is used to delete a disposal facility.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the disposal facility.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/disposalfacilities_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "24955"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "24955",
  "message": "Disposal Facility deleted successfully"
}

parentdisposalfacilities

parentdisposalfacilities
GET/api/lookup/parentdisposalfacilities/

Overview:

The parentdisposalfacilities endpoint, accessible at /api/lookup/parentdisposalfacilities/, is a GET request that is used to retrieve the details of parent disposal facilities.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the parent disposal facilities.
id number The unique identifier for the parent disposal facility.
name string The name of the parent disposal facility.
profileCoordinator number The profile coordinator.
profileCoordinatorName string The profile coordinator name.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/parentdisposalfacilities/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "name": "Company A",
      "profileCoordinator": 1017,
      "profileCoordinatorName": "Jane Doe",
      "showDelete": false
    },
    {
      "id": 105,
      "name": "Company B",
      "profileCoordinator": 1017,
      "profileCoordinatorName": "Jane Doe",
      "showDelete": false
    }
  ],
  "totalElements": 98
}

parentdisposalfacilities_save

parentdisposalfacilities_save
POST/api/lookup/parentdisposalfacilities_save/

Overview:

The parentdisposalfacilities_save endpoint, accessible at /api/lookup/parentdisposalfacilities_save/, is a POST request that is used to create or update a parent disposal facility.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the parent disposal facility.
message string A message indicating the result of the operation.
name string The name of the parent disposal facility.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/parentdisposalfacilities_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 123,
  "message": "Parent Disposal Facilities created successfully"
}

parentdisposalfacilities_del

parentdisposalfacilities_del
POST/api/lookup/parentdisposalfacilities_del/

Overview:

The parentdisposalfacilities_del endpoint, accessible at /api/lookup/parentdisposalfacilities_del/, is a POST request that is used to delete a parent disposal facility.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the parent disposal facility.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/parentdisposalfacilities_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "123"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "123",
  "message": "Parent Disposal Facilities deleted successfully"
}

Portal

portal_list_generatorportal

portal_list_generatorportal
GET/api/portalweb/portal_list_generatorportal?{page,pageSize,selectedFields,filter,sort}

Overview:

The portal_list_generatorportal endpoint, accessible at /api/portalweb/portal_list_generatorportal?{page,pageSize,selectedFields,filter,sort}, is a GET request that is used to retrieve the details of generator portal list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the generator portal list.
id number The unique identifier for the generator portal.
Name string The name of the generator portal.
Customer_Number number The customer number.
SiteAddress string The site address.
EPAIDs string The EPA identifiers.
status array An array of objects containing the status.
id number The unique identifier for the status.
name string The name of the status.
selected boolean Indicates whether the status is selected.
NumOfUsers string The number of users.
NumberofActiveUsers string The number of active users.
AdministratorUsername string The administrator username.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/portal_list_generatorportal?page&pageSize&selectedFields&filter&sort
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

sort
string (optional) 

The sort.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 54710,
      "Name": "Company A",
      "Customer_Number": 1009754,
      "SiteAddress": "132, My Street, Kingston, New York 12401.",
      "EPAIDs": "22222",
      "status": [
        {
          "id": 1,
          "name": "Active",
          "selected": false
        },
        {
          "id": 2,
          "name": "InActive",
          "selected": true
        }
      ],
      "NumOfUsers": "",
      "NumberofActiveUsers": "0",
      "AdministratorUsername": ""
    },
    {
      "id": 39997,
      "Name": "Company B",
      "Customer_Number": 1006463,
      "SiteAddress": "132, My Street, Kingston, New York 12401.",
      "EPAIDs": "22222",
      "NumOfUsers": 1,
      "NumberofActiveUsers": 2,
      "AdministratorUsername": "janedoe@gmail.com",
      "status": [
        {
          "id": 1,
          "name": "Active",
          "selected": true
        },
        {
          "id": 2,
          "name": "InActive",
          "selected": false
        }
      ]
    }
  ],
  "totalElements": 1589
}

get_portal_licenses_count

get_portal_licenses_count
GET/api/portalweb/get_portal_licenses_count

Overview:

The get_portal_licenses_count endpoint, accessible at /api/portalweb/get_portal_licenses_count, is a GET request that is used to retrieve the details of portal licenses count.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
activeUsersCount number The number of active users.
numOfPortalUsed number The number of portal used.
numberOfPortalUsers number The number of portal users.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/get_portal_licenses_count
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "activeUsersCount": 88,
  "numOfPortalUsed": 85,
  "numberOfPortalUsers": 500
}

portal_list_generatorportal_saverow

portal_list_generatorportal_saverow
POST/api/portalweb/portal_list_generatorportal_saverow

Overview:

The portal_list_generatorportal_saverow endpoint, accessible at /api/portalweb/portal_list_generatorportal_saverow, is a POST request that is used to update a generator portal.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the generator portal.
status string The status of the generator portal.
NumOfUsers string The number of users.
AdministratorUsername string The administrator username.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/portal_list_generatorportal_saverow
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 54710,
  "status": "InActive",
  "NumOfUsers": "",
  "AdministratorUsername": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

portal_list_corporatesignon

portal_list_corporatesignon
GET/api/portalweb/portal_list_corporatesignon

Overview:

The portal_list_corporatesignon endpoint, accessible at /api/portalweb/portal_list_corporatesignon{?page,pageSize,selectedFields,filter,sort}, is a GET request that is used to retrieve the details of corporate sign on list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the corporate sign on list.
id number The unique identifier for the corporate sign on.
NumOfUsers string The number of users.
NumberofActiveUsers string The number of active users.
AdminUsername string The administrator username.
Generators array An array of objects containing the generators.
id number The unique identifier for the generator.
Name string The name of the generator.
Customer_Number number The customer number.
SiteAddress string The site address.
EPAIDs string The EPA identifiers.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/portal_list_corporatesignon
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 8,
      "NumOfUsers": 1,
      "NumberofActiveUsers": 88,
      "AdminUsername": "company_admin",
      "Generators": [
        {
          "id": 39834,
          "Name": "Company A",
          "Customer_Number": 1006300,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        },
        {
          "id": 39832,
          "Name": "Company B",
          "Customer_Number": 1006298,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        },
        {
          "id": 39836,
          "Name": "Company C",
          "Customer_Number": 1006302,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        },
        {
          "id": 39835,
          "Name": "Company D",
          "Customer_Number": 1006301,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        },
        {
          "id": 39831,
          "Name": "Company E",
          "Customer_Number": 1006297,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        },
        {
          "id": 39833,
          "Name": "Company F",
          "Customer_Number": 1006299,
          "SiteAddress": "132, My Street, Kingston, New York 12401.",
          "EPAIDs": "22222"
        }
      ]
    }
  ],
  "totalElements": 3
}

portal_corporatesignon_details

portal_corporatesignon_details
GET/api/portalweb/portal_corporatesignon_details{?id}

Overview:

The portal_corporatesignon_details endpoint, accessible at /api/portalweb/portal_corporatesignon_details{?id}, is a GET request that is used to retrieve the details of a corporate sign on.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the corporate sign on.
id number The unique identifier for the corporate sign on.
CorporateSignOnForm object An object containing the details of the corporate sign on form.
id number The unique identifier for the corporate sign on.
AdminUsername string The administrator username.
NumOfUsers number The number of users.
Generators array An array of objects containing the generators.
id number The unique identifier for the generator.
Name string The name of the generator.
GeneratorList array An array of objects containing the generator list.
id number The unique identifier for the generator.
Name string The name of the generator.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/portal_corporatesignon_details?id=
URI Parameters
HideShow
id
number (required) 

The unique identifier for the corporate sign on.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "CorporateSignOnForm": {
      "id": 8,
      "AdminUsername": "company_admin",
      "NumOfUsers": 1,
      "Generators": [
        {
          "id": 39834,
          "Name": "Company ABC"
        }
      ]
    },
    "GeneratorList": [
      {
        "id": 41464,
        "Name": "Company ABC"
      },
      {
        "id": 40832,
        "Name": "Company EFD"
      }
    ]
  },
  "totalElements": 0
}

portal_list_corporatesignon_saverow

portal_list_corporatesignon_saverow
POST/api/portalweb/portal_list_corporatesignon_saverow

Overview:

The portal_list_corporatesignon_saverow endpoint, accessible at /api/portalweb/portal_list_corporatesignon_saverow, is a POST request that is used to update a corporate sign on.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the corporate sign on.
NumOfUsers number The number of users.
AdminUsername string The administrator username.
Generators array An array of objects containing the generators.
id number The unique identifier for the generator.
Name string The name of the generator.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/portalweb/portal_list_corporatesignon_saverow
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 8,
  "NumOfUsers": 1,
  "AdminUsername": "janedoe_admin",
  "Generators": [
    {
      "id": 39834,
      "Name": "Company ABC"
    },
    {
      "id": 39832,
      "Name": "Company QWE"
    },
    {
      "id": 39836,
      "Name": "Company ASD"
    },
    {
      "id": 39835,
      "Name": "Company ZXC"
    },
    {
      "id": 39831,
      "Name": "Company BNM"
    },
    {
      "id": 39833,
      "Name": "Company IOP"
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

Profile Information

casdictionary

casdictionary
GET/api/lookup/casdictionary

Overview:

The casdictionary endpoint, accessible at /api/lookup/casdictionary, is a GET request that is used to retrieve the details of the CAS dictionary.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the CAS dictionary.
id number The unique identifier for the CAS dictionary.
chemicalCompoundName string The chemical compound name.
cASNumber string The CAS number.
section string The section.
cerclaRq string The CERCLA RQ.
section302 string The section 302.
section304 string The section 304.
sectionCaa112 string The section CAA 112.
sectionRcraCode string The section RCRA code.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/casdictionary
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 85969,
      "chemicalCompoundName": "Chlordane (Technical Mixture and Metabolites)",
      "cASNumber": "N.A.",
      "section": null,
      "cerclaRq": "1",
      "section302": null,
      "section304": null,
      "sectionCaa112": null,
      "sectionRcraCode": "U036",
      "showDelete": true
    }
  ],
  "totalElements": 4021
}

casdictionary_save

casdictionary_save
POST/api/lookup/casdictionary_save/

Overview:

The casdictionary_save endpoint, accessible at /api/lookup/casdictionary_save/, is a POST request that is used to create or update a CAS dictionary.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the CAS dictionary.
message string A message indicating the result of the operation.
chemicalCompoundName string The chemical compound name.
cASNumber string The CAS number.
section string The section.
cerclaRq string The CERCLA RQ.
section302 string The section 302.
section304 string The section 304.
sectionCaa112 string The section CAA 112.
sectionRcraCode string The section RCRA code.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/casdictionary_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "chemicalCompoundName": "1",
  "cASNumber": "1",
  "section": "1",
  "cerclaRq": "1",
  "section302": "1",
  "section304": "1",
  "sectionCaa112": "1",
  "sectionRcraCode": "1"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 89990,
  "message": "CAS Dictionary created successfully"
}

casdictionary_del

casdictionary_del
POST/api/lookup/casdictionary_del/

Overview:

The casdictionary_del endpoint, accessible at /api/lookup/casdictionary_del/, is a POST request that is used to delete a CAS dictionary.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the CAS dictionary.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/casdictionary_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "89990"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "89990",
  "message": "CAS Dictionary deleted successfully"
}

dottable

dottable
GET/api/lookup/dottable

Overview:

The dottable endpoint, accessible at /api/lookup/dottable, is a GET request that is used to retrieve the details of the DOT table.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the DOT table.
id number The unique identifier for the DOT table.
uNNAID string The UNNA ID.
dOTShippingName string The DOT shipping name.
classValue string The class value.
subClass string The sub class.
pG string The PG.
eRG string The ERG.
genericNOS string The generic NOS.
shipping_packing number The shipping packing.
showDelete boolean Indicates whether the delete button should be displayed.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/dottable
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 14188,
      "uNNAID": "22222",
      "dOTShippingName": "Consumer ABC",
      "classValue": "9",
      "subClass": "",
      "pG": "",
      "eRG": "ERG 171",
      "genericNOS": "No",
      "shipping_packing": 294248,
      "showDelete": false
    }
  ],
  "totalElements": 2650
}

dottable_save

dottable_save
POST/api/lookup/dottable_save/

Overview:

The dottable_save endpoint, accessible at /api/lookup/dottable_save/, is a POST request that is used to create or update a DOT table.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the DOT table.
message string A message indicating the result of the operation.
uNNAID string The UNNA ID.
dOTShippingName string The DOT shipping name.
classValue string The class value.
subClass string The sub class.
pG string The PG.
eRG string The ERG.
genericNOS string The generic NOS.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/dottable_save/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "uNNAID": "test",
  "dOTShippingName": "test",
  "classValue": "test",
  "subClass": "test",
  "pG": "PG I",
  "eRG": "test",
  "genericNOS": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "CREATE",
  "id": 16069,
  "message": "DOT Table created successfully"
}

dottable_del

dottable_del
POST/api/lookup/dottable_del/

Overview:

The dottable_del endpoint, accessible at /api/lookup/dottable_del/, is a POST request that is used to delete a DOT table.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
process string The type of operation performed.
id number The unique identifier for the DOT table.
message string A message indicating the result of the operation.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/lookup/dottable_del/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "16069"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "process": "DELETE",
  "id": "16069",
  "message": "DOT Table deleted successfully"
}

Logs

factor_logs

factor_logs
GET/facility/network/factor_logs/

Overview:

The factor_logs endpoint, accessible at /facility/network/factor_logs/, is a GET request that is used to retrieve the details of factor logs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the factor logs.
id number The unique identifier for the factor log.
Facility_Name string The name of the facility.
Type string The type of the factor.
Size string The size of the factor.
Old_Value string The old value of the factor.
New_Value string The new value of the factor.
Username string The username.
DateTime string The date and time.
formatted_date string The formatted date.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/factor_logs/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "Facility_Name": "Company ABC",
      "Type": "ABC",
      "Size": "1",
      "Old_Value": "0.000",
      "New_Value": "0.35",
      "Username": "network_doe",
      "DateTime": "2022-07-07T14:54:27.591Z",
      "formatted_date": "2022-07-07 02:07:27 PM"
    }
  ]
}

restriction_logs

restriction_logs
GET/facility/network/restriction_logs/

Overview:

The restriction_logs endpoint, accessible at /facility/network/restriction_logs/, is a GET request that is used to retrieve the details of restriction logs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the restriction logs.
id number The unique identifier for the restriction log.
Parent_Facility_Name string The name of the parent facility.
Facility_Name string The name of the facility.
ESC_Name string The ESC name.
Old_Process_Code string The old process code.
New_Process_Code string The new process code.
Old_Cost_Basis string The old cost basis.
New_Cost_Basis string The new cost basis.
Old_Type string The old type.
New_Type string The new type.
Old_Size string The old size.
New_Size string The new size.
Old_Unit string The old unit.
New_Unit string The new unit.
Username string The username.
DateTime string The date and time.
formatted_date string The formatted date.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/restriction_logs/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "Parent_Facility_Name": "All",
      "Facility_Name": "System",
      "ESC_Name": "All",
      "Old_Process_Code": "Created",
      "New_Process_Code": "1090",
      "Old_Cost_Basis": "Created",
      "New_Cost_Basis": "All",
      "Old_Type": "Created",
      "New_Type": "All",
      "Old_Size": "Created",
      "New_Size": "All",
      "Old_Unit": "Created",
      "New_Unit": "G",
      "Username": "network_janedoe",
      "DateTime": "2022-07-07T15:04:43.253Z",
      "formatted_date": "2022-07-07 03:07:43 PM"
    }
  ]
}

extrapolation_logs

extrapolation_logs
GET/facility/network/extrapolation_logs/

Overview:

The extrapolation_logs endpoint, accessible at /facility/network/extrapolation_logs/, is a GET request that is used to retrieve the details of extrapolation logs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the extrapolation logs.
id number The unique identifier for the extrapolation log.
task_id string The task identifier.
task_name string The task name.
task_args string The task arguments.
task_kwargs string The task keyword arguments.
status string The status of the task.
worker string The worker.
content_type string The content type.
content_encoding string The content encoding.
result string The result.
date_created string The date created.
date_done string The date done.
traceback string The traceback.
meta string The meta.
formatted_date_created string The formatted date created.
formatted_date_done string The formatted date done.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/extrapolation_logs/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 29147,
      "task_id": "9f80fd2b-630e-43a3-b99f-0bc829447df5",
      "task_name": "Standard Cost Update",
      "task_args": "\"()\"",
      "task_kwargs": "\"{}\"",
      "status": "SUCCESS",
      "worker": "janedoe.internal",
      "content_type": "application/json",
      "content_encoding": "utf-8",
      "result": "null",
      "date_created": "2024-07-31T07:03:29.737Z",
      "date_done": "2024-07-31T07:03:29.774Z",
      "traceback": null,
      "meta": "{\"children\": []}",
      "formatted_date_created": "2024-07-31 07:07:29 AM",
      "formatted_date_done": "2024-07-31 07:07:29 AM"
    }
  ]
}

cost_error_logs

cost_error_logs
GET/facility/network/cost_error_logs/

Overview:

The cost_error_logs endpoint, accessible at /facility/network/cost_error_logs/, is a GET request that is used to retrieve the details of cost error logs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the cost error logs.
id number The unique identifier for the cost error log.
WPC string The WPC.
Final_TSDF string The final TSDF.
Vendor_Code string The vendor code.
Container_Type string The container type.
Container_Size string The container size.
Cost_Basis string The cost basis.
Cost string The cost.
Min_Cost string The minimum cost.
Price_Basis string The price basis.
List_Price string The list price.
Min_Price string The minimum price.
Sales_Tax string The sales tax.
Case_By_Case string The case by case.
Message string The message.
DateTime string The date and time.
formatted_date string The formatted date.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/cost_error_logs/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "WPC": "2012",
      "Final_TSDF": "Company ABC",
      "Vendor_Code": "",
      "Container_Type": "",
      "Container_Size": "",
      "Cost_Basis": "",
      "Cost": "",
      "Min_Cost": "",
      "Price_Basis": "",
      "List_Price": "",
      "Min_Price": "",
      "Sales_Tax": "",
      "Case_By_Case": "",
      "Message": "CREATE: No EIS",
      "DateTime": "2022-07-22T06:04:54.571Z",
      "formatted_date": "2022-07-22 06:07:54 AM"
    }
  ]
}

price_error_logs

price_error_logs
GET/facility/network/price_error_logs/

Overview:

The price_error_logs endpoint, accessible at /facility/network/price_error_logs/, is a GET request that is used to retrieve the details of price error logs.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the price error logs.
id number The unique identifier for the price error log.
WPC string The WPC.
ESC string The ESC.
Final_TSDF string The final TSDF.
Vendor_Code string The vendor code.
Container_Type string The container type.
Container_Size string The container size.
Cost_Basis string The cost basis.
Book_Cost string The book cost.
Min_Cost string The minimum cost.
Price_Basis string The price basis.
List_Price string The list price.
Min_Price string The minimum price.
Book_Price string The book price.
Book_Min string The book minimum.
Case_By_Case string The case by case.
Lock string The lock.
Message string The message.
DateTime string The date and time.
formatted_date string The formatted date.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/price_error_logs/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "WPC": "690",
      "ESC": "Company ABC",
      "Final_TSDF": "Company DES",
      "Vendor_Code": "None",
      "Container_Type": "DM",
      "Container_Size": "55 G",
      "Cost_Basis": "Per Container",
      "Book_Cost": "$50.00",
      "Min_Cost": "0",
      "Price_Basis": "Per Container",
      "List_Price": "$100.00",
      "Min_Price": "0",
      "Book_Price": "0",
      "Book_Min": "0",
      "Case_By_Case": "False",
      "Lock": "False",
      "Message": "UPDATE: Could not save Book Price / Book Min",
      "DateTime": "2022-07-16T00:50:53.376Z",
      "formatted_date": "2022-07-16 12:07:53 AM"
    }
  ]
}

Extrapolation Restrictions

getParentDisposalFacilityList

getParentDisposalFacilityList
GET/facility/network/getParentDisposalFacilityList/

Overview:

The getParentDisposalFacilityList endpoint, accessible at /facility/network/getParentDisposalFacilityList/, is a GET request that is used to retrieve the details of the parent disposal facility list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the parent disposal facility list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/getParentDisposalFacilityList/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    "All",
    "Company ABCA",
    "Company ABCB",
    "Company ABCC",
    "Company ABCD",
    "Company ABCE",
    "Company ABCF",
    "Company ABCG",
    "Company ABCH"
  ]
}

getESCList

getESCList
GET/facility/network/getESCList/

Overview:

The getESCList endpoint, accessible at /facility/network/getESCList/, is a GET request that is used to retrieve the details of the ESC list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the ESC list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/getESCList/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    "All",
    "Company ABCA",
    "Company ABCB",
    "Company ABCC",
    "Company ABCD"
  ]
}

getCostBasisList

getCostBasisList
GET/facility/network/getCostBasisList/

Overview:

The getCostBasisList endpoint, accessible at /facility/network/getCostBasisList/, is a GET request that is used to retrieve the details of the cost basis list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the cost basis list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/getCostBasisList/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    "All",
    "Each",
    "Per Bulb",
    "Per Container",
    "Per GAL",
    "Per Gram",
    "Per Hour",
    "Per Kg",
    "Per LBS",
    "Per Load",
    "Per Ton",
    "Per UM",
    "Per YD"
  ]
}

getWPCList

getWPCList
GET/facility/network/getWPCList/

Overview:

The getWPCList endpoint, accessible at /facility/network/getWPCList/, is a GET request that is used to retrieve the details of the WPC list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the WPC list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/getWPCList/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    "All",
    "1000",
    "1001",
    "1002",
    "1003",
    "1004",
    "1005",
    "1010",
    "1011",
    "1012",
    "1013",
    "1014",
    "1020"
  ]
}

getContainerTypeList

getContainerTypeList
GET/facility/network/getContainerTypeList/

Overview:

The getContainerTypeList endpoint, accessible at /facility/network/getContainerTypeList/, is a GET request that is used to retrieve the details of the container type list.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the container type list.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/getContainerTypeList/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    "All",
    "BA",
    "CF",
    "CM",
    "CW",
    "CY",
    "DF",
    "DM",
    "DT",
    "DW",
    "HG",
    "TC",
    "TP",
    "TT"
  ]
}

extrapolation_restrictions

extrapolation_restrictions
GET/facility/network/extrapolation_restrictions/

Overview:

The extrapolation_restrictions endpoint, accessible at /facility/network/extrapolation_restrictions/, is a GET request that is used to retrieve the details of extrapolation restrictions.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the extrapolation restrictions.
id number The unique identifier for the extrapolation restriction.
Parent_Disposal_Facility string The parent disposal facility.
Disposal_Facility string The disposal facility.
ESC string The ESC.
Process_Code string The process code.
Cost_Basis string The cost basis.
Container_Type string The container type.
Container_Size string The container size.
Container_Unit string The container unit.
showDelete boolean Indicates whether the delete button should be displayed.
wpcs array An array of objects containing the WPCs.
id number The unique identifier for the WPC.
Code string The code.
Waste_Type string The waste type.
Waste_Types_id number The waste types identifier.
Waste_Category string The waste category.
Waste_Category_New string The new waste category.
ESC_Category_Description_Examples string The ESC category description examples.
Disposal_Method_id number The disposal method identifier.
Special_Gravity string The special gravity.
Cost_General_Ledger string The cost general ledger.
Revenue_General_Ledger string The revenue general ledger.
Grade_id string The grade identifier.
Status string The status.
Sales_Tax boolean Indicates whether the sales tax is applicable.
empty_container boolean Indicates whether the container is empty.
Group_id string The group identifier.
Created_date string The created date.
Modified_date string The modified date.
User_id string The user identifier.
Broker_id number The broker identifier.
special_certification_document boolean Indicates whether the special certification document is required.
esc_id string The ESC identifier.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/extrapolation_restrictions/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1,
      "Parent_Disposal_Facility": "All",
      "Disposal_Facility": "All",
      "ESC": "All",
      "Process_Code": "1090",
      "Cost_Basis": "All",
      "Container_Type": "All",
      "Container_Size": "All",
      "Container_Unit": "G",
      "showDelete": true
    }
  ],
  "wpcs": [
    {
      "id": 4237,
      "Code": "5049",
      "Waste_Type": null,
      "Waste_Types_id": 6448,
      "Waste_Category": "Class 8 cylinders, small (4 Diameter x 24 Length), for disposal",
      "Waste_Category_New": "Cylinders",
      "ESC_Category_Description_Examples": null,
      "Disposal_Method_id": 912,
      "Special_Gravity": "",
      "Cost_General_Ledger": null,
      "Revenue_General_Ledger": null,
      "Grade_id": null,
      "Status": "Active",
      "Sales_Tax": false,
      "empty_container": false,
      "Group_id": null,
      "Created_date": null,
      "Modified_date": null,
      "User_id": null,
      "Broker_id": 26,
      "special_certification_document": false,
      "esc_id": null
    }
  ]
}

recalculate_system_extrapolation

recalculate_system_extrapolation
GET/facility/network/recalculate/system_extrapolation/

Overview:

The recalculate_system_extrapolation endpoint, accessible at /facility/network/recalculate/system_extrapolation/, is a GET request that is used to recalculate the system extrapolation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
extrapolation_cpc array An array of objects containing the extrapolation CPC.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.
extrapolation_lbs array An array of objects containing the extrapolation LBS.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.
message string A message indicating the result of the operation.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/recalculate/system_extrapolation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "extrapolation_cpc": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.450",
      "System_Factor": "0.993",
      "Avg": "77.166",
      "Min": "0.000",
      "Max": "414.000",
      "Std_Dev": "60.656",
      "Sample_Count": 303,
      "size_float": 1
    }
  ],
  "extrapolation_lbs": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.450",
      "System_Factor": "0.732",
      "Avg": "97.501",
      "Min": "0.000",
      "Max": "219.520",
      "Std_Dev": "58.819",
      "Sample_Count": 52,
      "size_float": 1
    }
  ],
  "message": "Containers recalculated."
}

clear_system_extrapolation

clear_system_extrapolation
GET/facility/network/clear/system_extrapolation/

Overview:

The clear_system_extrapolation endpoint, accessible at /facility/network/clear/system_extrapolation/, is a GET request that is used to clear the system extrapolation.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
extrapolation_cpc array An array of objects containing the extrapolation CPC.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.
extrapolation_lbs array An array of objects containing the extrapolation LBS.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.
message string A message indicating the result of the operation.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/clear/system_extrapolation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "extrapolation_cpc": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.450",
      "System_Factor": "0.993",
      "Avg": "0.000",
      "Min": "0.000",
      "Max": "0.000",
      "Std_Dev": "0.000",
      "Sample_Count": 0,
      "size_float": 1
    }
  ],
  "extrapolation_lbs": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.450",
      "System_Factor": "0.732",
      "Avg": "0.000",
      "Min": "0.000",
      "Max": "0.000",
      "Std_Dev": "0.000",
      "Sample_Count": 0,
      "size_float": 1
    }
  ],
  "message": "Containers cleared."
}

system_cpc_submit

system_cpc_submit
POST/facility/network/system_cpc_submit/1

Overview:

The system_cpc_submit endpoint, accessible at /facility/network/system_cpc_submit/1, is a POST request that is used to submit the system CPC.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
message string A message indicating the result of the operation.
size_id string The size identifier.
cpc_applied_value string The CPC applied value.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/system_cpc_submit/1
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "size_id": "1",
  "cpc_applied_value": "0.451"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Applied value successfully saved."
}

system_restriction_add_or_edit

system_restriction_add_or_edit
POST/facility/network/edit/extrapolation/system_restriction_add_or_edit/

Overview:

The system_restriction_add_or_edit endpoint, accessible at /facility/network/edit/extrapolation/system_restriction_add_or_edit/, is a POST request that is used to add or edit a system restriction.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
message string A message indicating the result of the operation.
Container_Unit string The container unit.
Container_Size string The container size.
Container_Type string The container type.
Cost_Basis string The cost basis.
Process_Code string The process code.
ESC string The ESC.
Disposal_Facility string The disposal facility.
Parent_Disposal_Facility string The parent disposal facility.
id string The identifier.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/edit/extrapolation/system_restriction_add_or_edit/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Container_Unit": "G",
  "Container_Size": "1",
  "Container_Type": "BA",
  "Cost_Basis": "Each",
  "Process_Code": "1000",
  "ESC": "Company ABC",
  "Disposal_Facility": "Company ABC",
  "Parent_Disposal_Facility": "Company ABC",
  "id": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Restrictions successfully saved."
}

system_restriction_delete

system_restriction_delete
POST/facility/network/edit/extrapolation/system_restriction_delete/

Overview:

The system_restriction_delete endpoint, accessible at /facility/network/edit/extrapolation/system_restriction_delete/, is a POST request that is used to delete a system restriction.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
message string A message indicating the result of the operation.
ids array An array of objects containing the identifiers.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/edit/extrapolation/system_restriction_delete/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "ids": [
    "209"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Restriction(s) successfully deleted."
}

running_system_extrapolation

running_system_extrapolation
GET/facility/network/running/system_extrapolation/

Overview:

The running_system_extrapolation endpoint, accessible at /facility/network/running/system_extrapolation/, is a GET request that is used to check whether the system extrapolation is running.

Request Body and Response Description:

Name Data Type Description
task_running boolean Indicates whether the task is running.
task_id string The task identifier.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/running/system_extrapolation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "task_running": true,
  "task_id": "5d6740fc-def7-40e2-a4c1-7d1c5d8ee3bf"
}

system_extrapolation

system_extrapolation
GET/facility/network/system_extrapolation/

Overview:

The system_extrapolation endpoint, accessible at /facility/network/system_extrapolation/, is a GET request that is used to retrieve the details of the system extrapolation.

Request Body and Response Description:

Name Data Type Description
wpcs array An array of objects containing the WPCs.
id number The unique identifier for the WPC.
Code string The code.
Waste_Type string The waste type.
Waste_Types_id number The waste types identifier.
Waste_Category string The waste category.
Waste_Category_New string The new waste category.
ESC_Category_Description_Examples string The ESC category description examples.
Disposal_Method_id number The disposal method identifier.
Special_Gravity string The special gravity.
Cost_General_Ledger string The cost general ledger.
Revenue_General_Ledger string The revenue general ledger.
Grade_id string The grade identifier.
Status string The status.
Sales_Tax boolean Indicates whether the sales tax is applicable.
empty_container boolean Indicates whether the container is empty.
Group_id string The group identifier.
Created_date string The created date.
Modified_date string The modified date.
User_id string The user identifier.
Broker_id number The broker identifier.
special_certification_document boolean Indicates whether the special certification document is required.
esc_id string The ESC identifier.
extrapolation_cpc array An array of objects containing the extrapolation CPC.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.
extrapolation_lbs array An array of objects containing the extrapolation LBS.
Size string The size.
Type string The type.
Applied_Value string The applied value.
System_Factor string The system factor.
Avg string The average.
Min string The minimum.
Max string The maximum.
Std_Dev string The standard deviation.
Sample_Count number The sample count.
size_float number The size float.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./facility/network/system_extrapolation/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "wpcs": [
    {
      "id": 4237,
      "Code": "5049",
      "Waste_Type": null,
      "Waste_Types_id": 6448,
      "Waste_Category": "Class 8 cylinders, small (4 Diameter x 24 Length), for disposal",
      "Waste_Category_New": "Cylinders",
      "ESC_Category_Description_Examples": null,
      "Disposal_Method_id": 912,
      "Special_Gravity": "",
      "Cost_General_Ledger": null,
      "Revenue_General_Ledger": null,
      "Grade_id": null,
      "Status": "Active",
      "Sales_Tax": false,
      "empty_container": false,
      "Group_id": null,
      "Created_date": null,
      "Modified_date": null,
      "User_id": null,
      "Broker_id": 26,
      "special_certification_document": false,
      "esc_id": null
    }
  ],
  "extrapolation_cpc": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.451",
      "System_Factor": "0.993",
      "Avg": "0.000",
      "Min": "0.000",
      "Max": "0.000",
      "Std_Dev": "0.000",
      "Sample_Count": 0,
      "size_float": 1
    }
  ],
  "extrapolation_lbs": [
    {
      "Size": "1",
      "Type": "DF/DM",
      "Applied_Value": "0.450",
      "System_Factor": "0.732",
      "Avg": "0.000",
      "Min": "0.000",
      "Max": "0.000",
      "Std_Dev": "0.000",
      "Sample_Count": 0,
      "size_float": 1
    }
  ]
}

Supplies

supplie_product_type

supplie_product_type
GET/api/tools/supplie_product_type{?page,pageSize,selectedFields,filter}

Overview:

The supplie_product_type endpoint, accessible at /api/tools/supplie_product_type{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the details of the product types.

Request Body and Response Description:

Name Data Type Description
content array An array of objects containing the product types.
items array An array of objects containing the product types.
id number The unique identifier for the product type.
Name string The name of the product type.
showDelete boolean Indicates whether the delete button should be displayed.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_type?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {},
  "items": [
    {
      "id": 5,
      "Name": "Analytical",
      "showDelete": true
    },
    {
      "id": 18,
      "Name": "Box",
      "showDelete": false
    }
  ]
}

supplie_product_sub_type

supplie_product_sub_type
GET/api/tools/supplie_product_sub_type{?page,pageSize,selectedFields,filter}

Overview:

The supplie_product_sub_type endpoint, accessible at /api/tools/supplie_product_sub_type{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the details of the product sub types.

Request Body and Response Description:

Name Data Type Description
content array An array of objects containing the product sub types.
items array An array of objects containing the product sub types.
id number The unique identifier for the product sub type.
Name string The name of the product sub type.
showDelete boolean Indicates whether the delete button should be displayed.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_sub_type?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {},
  "items": [
    {
      "id": 8,
      "Name": "Absorbent and Vermiculite",
      "showDelete": false
    },
    {
      "id": 9,
      "Name": "Accessories",
      "showDelete": false
    }
  ]
}

supplie_product_unit_measure

supplie_product_unit_measure
GET/api/tools/supplie_product_unit_measure{?page,pageSize,selectedFields,filter}

Overview:

The supplie_product_unit_measure endpoint, accessible at /api/tools/supplie_product_unit_measure{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the details of the product unit measures.

Request Body and Response Description:

Name Data Type Description
content array An array of objects containing the product unit measures.
items array An array of objects containing the product unit measures.
id number The unique identifier for the product unit measure.
Name string The name of the product unit measure.
showDelete boolean Indicates whether the delete button should be displayed.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unit_measure?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {},
  "items": [
    {
      "id": 6,
      "Name": "Box",
      "showDelete": false
    },
    {
      "id": 2,
      "Name": "Case",
      "showDelete": false
    }
  ]
}

supplie_product_unrating

supplie_product_unrating
GET/api/tools/supplie_product_unrating{?page,pageSize,selectedFields,filter}

Overview:

The supplie_product_unrating endpoint, accessible at /api/tools/supplie_product_unrating{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the details of the product unratings.

Request Body and Response Description:

Name Data Type Description
content array An array of objects containing the product unratings.
items array An array of objects containing the product unratings.
id number The unique identifier for the product unrating.
Name string The name of the product unrating.
showDelete boolean Indicates whether the delete button should be displayed.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unrating?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {},
  "items": [
    {
      "id": 80,
      "Name": "1A1",
      "showDelete": true
    },
    {
      "id": 1,
      "Name": "1A1",
      "showDelete": true
    }
  ]
}

supplie_product_type_details

supplie_product_type_details
GET/api/tools/supplie_product_type_details{?id}

Overview:

The supplie_product_type_details endpoint, accessible at /api/tools/supplie_product_type_details{?id}, is a GET request that is used to retrieve the details of the product type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the product type details.
ProductTypeForm object An object containing the product type details.
id number The unique identifier for the product type.
Name string The name of the product type.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_type_details?id=
URI Parameters
HideShow
id
number (required) 

The product type identifier.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "ProductTypeForm": {
      "id": 5,
      "Name": "Analytical"
    }
  }
}

supplie_product_sub_type_details

supplie_product_sub_type_details
GET/api/tools/supplie_product_sub_type_details{?id}

Overview:

The supplie_product_sub_type_details endpoint, accessible at /api/tools/supplie_product_sub_type_details{?id}, is a GET request that is used to retrieve the details of the product sub type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the product sub type details.
ProductSubTypeForm object An object containing the product sub type details.
id number The unique identifier for the product sub type.
Name string The name of the product sub type.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_sub_type_details?id=
URI Parameters
HideShow
id
number (required) 

The product sub type identifier.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "ProductSubTypeForm": {
      "id": 8,
      "Name": "Absorbent and Vermiculite"
    }
  }
}

supplie_product_unit_measure_details

supplie_product_unit_measure_details
GET/api/tools/supplie_product_unit_measure_details{?id}

Overview:

The supplie_product_unit_measure_details endpoint, accessible at /api/tools/supplie_product_unit_measure_details{?id}, is a GET request that is used to retrieve the details of the product unit measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the product unit measure details.
ProductUnitMeasureForm object An object containing the product unit measure details.
id number The unique identifier for the product unit measure.
Name string The name of the product unit measure.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unit_measure_details?id=
URI Parameters
HideShow
id
number (required) 

The product unit measure identifier.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "ProductUnitMeasureForm": {
      "id": 6,
      "Name": "Box"
    }
  }
}

supplie_product_unrating_details

supplie_product_unrating_details
GET/api/tools/supplie_product_unrating_details

Overview:

The supplie_product_unrating_details endpoint, accessible at /api/tools/supplie_product_unrating_details{?id}, is a GET request that is used to retrieve the details of the product unrating.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the product unrating details.
ProductUNRatingForm object An object containing the product unrating details.
id number The unique identifier for the product unrating.
Name string The name of the product unrating.
ProductSubType number The product sub type.
ProductSubTypeList array An array of objects containing the product sub types.
id number The unique identifier for the product sub type.
Name string The name of the product sub type.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unrating_details
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "ProductUNRatingForm": {
      "id": 80,
      "Name": "1A1",
      "ProductSubType": 8,
      "ProductSubTypeList": [
        {
          "id": 8,
          "Name": "Absorbent and Vermiculite"
        },
        {
          "id": 9,
          "Name": "Accessories"
        },
        {
          "id": 44,
          "Name": "Premium Liners"
        }
      ]
    }
  }
}

supplie_product_type_add

supplie_product_type_add
POST/api/tools/supplie_product_type_add/

Overview:

The supplie_product_type_add endpoint, accessible at /api/tools/supplie_product_type_add/, is a POST request that is used to add a product type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product type.
Name string The name of the product type.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_type_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "Name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_type_add

supplie_product_type_add
DELETE/api/tools/supplie_product_type_add/

Overview:

The supplie_product_type_add endpoint, accessible at /api/tools/supplie_product_type_add/, is a DELETE request that is used to delete a product type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product type.

Example URI

DELETE [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_type_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "20"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_sub_type_add

supplie_product_sub_type_add
POST/api/tools/supplie_product_sub_type_add/

Overview:

The supplie_product_sub_type_add endpoint, accessible at /api/tools/supplie_product_sub_type_add/, is a POST request that is used to add a product sub type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product sub type.
Name string The name of the product sub type.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_sub_type_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "Name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_sub_type_add

supplie_product_sub_type_add
DELETE/api/tools/supplie_product_sub_type_add/

Overview:

The supplie_product_sub_type_add endpoint, accessible at /api/tools/supplie_product_sub_type_add/, is a DELETE request that is used to delete a product sub type.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product sub type.

Example URI

DELETE [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_sub_type_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "49"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_unit_measure_add

supplie_product_unit_measure_add
POST/api/tools/supplie_product_unit_measure_add/

Overview:

The supplie_product_unit_measure_add endpoint, accessible at /api/tools/supplie_product_unit_measure_add/, is a POST request that is used to add a product unit measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product unit measure.
Name string The name of the product unit measure.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unit_measure_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "0",
  "Name": "test"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_unit_measure_add

supplie_product_unit_measure_add
DELETE/api/tools/supplie_product_unit_measure_add/

Overview:

The supplie_product_unit_measure_add endpoint, accessible at /api/tools/supplie_product_unit_measure_add/, is a DELETE request that is used to delete a product unit measure.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product unit measure.

Example URI

DELETE [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unit_measure_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "9"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_unrating_add

supplie_product_unrating_add
POST/api/tools/supplie_product_unrating_add/

Overview:

The supplie_product_unrating_add endpoint, accessible at /api/tools/supplie_product_unrating_add/, is a POST request that is used to add a product unrating.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product unrating.
Name string The name of the product unrating.
ProductSubType number The product sub type.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unrating_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 0,
  "Name": "test",
  "ProductSubType": 9
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

supplie_product_unrating_add

supplie_product_unrating_add
DELETE/api/tools/supplie_product_unrating_add/

Overview:

The supplie_product_unrating_add endpoint, accessible at /api/tools/supplie_product_unrating_add/, is a DELETE request that is used to delete a product unrating.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the product unrating.

Example URI

DELETE [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_product_unrating_add/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": "84"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

Catalog

supplie_filter_catalog

supplie_filter_catalog
GET/api/tools/supplie_filter_catalog

Overview:

The supplie_filter_catalog endpoint, accessible at /api/tools/supplie_filter_catalog, is a GET request that is used to retrieve the catalog filters.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the catalog filters.
ProductVendorType array An array of objects containing the product vendor types.
id number The unique identifier for the product vendor type.
Name string The name of the product vendor type.
ProductTypeType array An array of objects containing the product types.
id number The unique identifier for the product type.
Name string The name of the product type.
ProductSubTypeType array An array of objects containing the product sub types.
id number The unique identifier for the product sub type.
Name string The name of the product sub type.
EscType array An array of objects containing the ESC types.
id number The unique identifier for the ESC type.
Broker_Name string The broker name.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_filter_catalog
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "success": true,
    "content": {
        "ProductVendorType": [
            {
                "id": 7003,
                "Name": "AAA Co"
            }
                    ],
        "ProductTypeType": [
            {
                "id": 5,
                "Name": "Analytical"
            }
                    ],
        "ProductSubTypeType": [
            {
                "id": 8,
                "Name": "Absorbent and Vermiculite"
            },
                    ],
        "EscType": [
            {
                "id": 115,
                "Broker_Name": "Company ABC"
            }
                    ]
    },
    "totalElements": 0
}

supplie_catalog

supplie_catalog
GET/api/tools/supplie_catalog{?page,pageSize,selectedFields,filter,sort}

Overview:

The supplie_catalog endpoint, accessible at /api/tools/supplie_catalog{?page,pageSize,selectedFields,filter,sort}, is a GET request that is used to retrieve the catalog.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the catalog.
id number The unique identifier for the catalog.
Catalog_id number The catalog identifier.
Top25 boolean Indicates whether the catalog is in the top 25.
ProductItem string The product item.
GeneralDescription string The general description.
ProductDetail string The product detail.
Type string The type.
SubType string The sub type.
UOM string The unit of measure.
Vendor string The vendor.
VendorCode string The vendor code.
Primary string Indicates whether the catalog is primary.
SalesTax string Indicates whether the sales tax is applicable.
Cost number The cost.
ListPrice number The list price.
ImageUpload string The image upload.
InOutStock string Indicates whether the catalog is in stock.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_catalog?page=&pageSize=&selectedFields=&filter=&sort=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

sort
string (optional) 

The sort.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 312,
      "Catalog_id": 99,
      "Top25": true,
      "ProductItem": "23000",
      "GeneralDescription": "05 Gallon, Poly Pail, Open Top, No Cover (White)",
      "ProductDetail": "Capacity:\t5 gal\nColor: White\nMaterial: High-Density Polyethylene\nStyle: Open Head\nShape: Round\nUN Rating: 1H2\nCountry of Origin: USA\nCovers: Due to the large variety available, this package does not come with a cover.",
      "Type": "Containers",
      "SubType": "Pails",
      "UOM": "Each",
      "Vendor": "Pipeline Packaging",
      "VendorCode": "33333",
      "Primary": "No",
      "SalesTax": "Yes",
      "Cost": 12,
      "ListPrice": 33,
      "ImageUpload": "Open_Top_Poly_Pail_5.jpeg",
      "InOutStock": "In-Stock"
    }
  ],
  "totalElements": 305
}

supplie_catalog_details

supplie_catalog_details
GET/api/tools/supplie_catalog_details{?id}

Overview:

The supplie_catalog_details endpoint, accessible at /api/tools/supplie_catalog_details{?id}, is a GET request that is used to retrieve the details of the catalog.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the catalog details.
CatalogForm object An object containing the catalog details.
id number The unique identifier for the catalog.
Top25 boolean Indicates whether the catalog is in the top 25.
Inactive boolean Indicates whether the catalog is inactive.
ProductDetail string The product detail.
SalesTax boolean Indicates whether the sales tax is applicable.
CostCode string The cost code.
GeneralDescription string The general description.
RevenueCode string The revenue code.
ProductItem string The product item.
ImageUpload string The image upload.
CatalogType number The catalog type.
CatalogUnitOfMeasure number The catalog unit of measure.
CatalogUNRating array An array of objects containing the catalog UN ratings.
id number The unique identifier for the catalog UN rating.
Name string The name of the catalog UN rating.
CatalogSubType number The catalog sub type.
ApprovedForESCs array An array of objects containing the approved ESCs.
CatalogTypeList array An array of objects containing the catalog types.
id number The unique identifier for the catalog type.
Name string The name of the catalog type.
CatalogSubTypeList array An array of objects containing the catalog sub types.
id number The unique identifier for the catalog sub type.
Name string The name of the catalog sub type.
CatalogUnitOfMeasureList array An array of objects containing the catalog unit of measures.
id number The unique identifier for the catalog unit of measure.
Name string The name of the catalog unit of measure.
CatalogUNRatingList array An array of objects containing the catalog UN ratings.
id number The unique identifier for the catalog UN rating.
Name string The name of the catalog UN rating.
CatalogESCList array An array of objects containing the catalog ESCs.
id number The unique identifier for the catalog ESC.
Broker_Name string The broker name.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_catalog_details?id=
URI Parameters
HideShow
id
number (required) 

The catalog identifier.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "CatalogForm": {
      "id": 99,
      "Top25": true,
      "Inactive": true,
      "ProductDetail": "Capacity:\t5 gal\nColor: White\nMaterial: High-Density Polyethylene\nStyle: Open Head\nShape: Round\nUN Rating: 1H2\nCountry of Origin: USA\nCovers: Due to the large variety available, this package does not come with a cover.",
      "SalesTax": true,
      "CostCode": "aaaa",
      "GeneralDescription": "05 Gallon, Poly Pail, Open Top, No Cover (White)",
      "RevenueCode": "aaaa",
      "ProductItem": "23000",
      "ImageUpload": "Open_Top_Poly_Pail_5.jpeg",
      "CatalogType": 2,
      "CatalogUnitOfMeasure": 1,
      "CatalogUNRating": [
        {
          "id": 118,
          "Name": "1H2/Y1.5/30"
        }
      ],
      "CatalogSubType": 2,
      "ApprovedForESCs": []
    },
    "CatalogTypeList": [
      {
        "id": 5,
        "Name": "Analytical"
      }
    ],
    "CatalogSubTypeList": [
      {
        "id": 8,
        "Name": "Absorbent and Vermiculite"
      }
    ],
    "CatalogUnitOfMeasureList": [
      {
        "id": 6,
        "Name": "Box"
      }
    ],
    "CatalogUNRatingList": [
      {
        "id": 80,
        "Name": "1A1/X1.2/250"
      }
    ],
    "CatalogESCList": [
      {
        "id": 115,
        "Broker_Name": "3L Energy Solutions"
      }
    ]
  },
  "totalElements": 0
}

products_anc_catalog_edit_vendor

products_anc_catalog_edit_vendor
GET/api/tools/products_anc_catalog_edit_vendor{?id}

Overview:

The products_anc_catalog_edit_vendor endpoint, accessible at /api/tools/products_anc_catalog_edit_vendor{?id}, is a GET request that is used to retrieve the details of the catalog vendor.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the catalog vendor details.
cataVendorList array An array of objects containing the catalog vendors.
id number The unique identifier for the catalog vendor.
Catalog_id number The catalog identifier.
Vendor_id number The vendor identifier.
CostPerVendor number The cost per vendor.
ListPrice number The list price.
Primary boolean Indicates whether the catalog is primary.
OutOfStock boolean Indicates whether the catalog is out of stock.
VendorCode string The vendor code.
isNew boolean Indicates whether the catalog is new.
vendors array An array of objects containing the vendors.
id number The unique identifier for the vendor.
Vendor_Number number The vendor number.
Name string The name of the vendor.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/products_anc_catalog_edit_vendor?id=
URI Parameters
HideShow
id
number (required) 

The catalog identifier.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "cataVendorList": [
      {
        "id": 183,
        "Catalog_id": 99,
        "Vendor_id": 6949,
        "CostPerVendor": 5.12,
        "ListPrice": 6.83,
        "Primary": true,
        "OutOfStock": true,
        "VendorCode": "57100",
        "isNew": false
      }
    ],
    "vendors": [
      {
        "id": 7003,
        "Vendor_Number": 3953,
        "Name": "Company ABC"
      }
    ]
  },
  "totalElements": 0
}

supplie_catalog_add

supplie_catalog_add
POST/api/tools/supplie_catalog_add

Overview:

The supplie_catalog_add endpoint, accessible at /api/tools/supplie_catalog_add, is a POST request that is used to add a catalog.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the catalog identifier.
catalog_id number The catalog identifier.
Top25 boolean Indicates whether the catalog is in the top 25.
CatalogUNRating array An array of objects containing the catalog UN ratings.
id number The unique identifier for the catalog UN rating.
Name string The name of the catalog UN rating.
Inactive boolean Indicates whether the catalog is inactive.
CatalogSubType number The catalog sub type.
CatalogUnitOfMeasure number The catalog unit of measure.
CatalogType number The catalog type.
ProductDetail string The product detail.
SalesTax boolean Indicates whether the sales tax is applicable.
CostCode string The cost code.
GeneralDescription string The general description.
RevenueCode string The revenue code.
ProductItem string The product item.
ApprovedForESCs array An array of objects containing the approved ESCs.
CataVendorList array An array of objects containing the catalog vendors.
id number The unique identifier for the catalog vendor.
Catalog_id number The catalog identifier.
Vendor_id number The vendor identifier.
CostPerVendor number The cost per vendor.
ListPrice number The list price.
Primary boolean Indicates whether the catalog is primary.
OutOfStock boolean Indicates whether the catalog is out of stock.
VendorCode string The vendor code.
isNew boolean Indicates whether the catalog is new.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_catalog_add
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 99,
  "Top25": true,
  "CatalogUNRating": [
    {
      "id": 118,
      "Name": "1H2"
    }
  ],
  "Inactive": true,
  "CatalogSubType": 2,
  "CatalogUnitOfMeasure": 1,
  "CatalogType": 2,
  "ProductDetail": "Capacity:\t5 gal\nColor: White\nMaterial: High-Density Polyethylene\nStyle: Open Head\nShape: Round\nUN Rating: 1H2\nCountry of Origin: USA\nCovers: Due to the large variety available, this package does not come with a cover.",
  "SalesTax": true,
  "CostCode": "aaaa",
  "GeneralDescription": "05 Gallon, Poly Pail, Open Top, No Cover (White)",
  "RevenueCode": "aaaa",
  "ProductItem": "23000",
  "ApprovedForESCs": [],
  "CataVendorList": [
    {
      "id": 183,
      "Catalog_id": 99,
      "Vendor_id": 6949,
      "CostPerVendor": 5.12,
      "ListPrice": 6.83,
      "Primary": true,
      "OutOfStock": true,
      "VendorCode": "57100",
      "isNew": false
    },
    {
      "id": 311,
      "Catalog_id": 99,
      "Vendor_id": 6944,
      "CostPerVendor": 12,
      "ListPrice": 16,
      "Primary": false,
      "OutOfStock": false,
      "VendorCode": "",
      "isNew": false
    },
    {
      "id": 312,
      "Catalog_id": 99,
      "Vendor_id": 6949,
      "CostPerVendor": 12,
      "ListPrice": 33,
      "Primary": false,
      "OutOfStock": false,
      "VendorCode": "33333",
      "isNew": false
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "catalog_id": 99
  }
}

Book Catalog

supplie_book_catalog

supplie_book_catalog
GET/api/tools/supplie_book_catalog{?page,pageSize,selectedFields,filter,sort}

Overview:

The supplie_book_catalog endpoint, accessible at /api/tools/supplie_book_catalog{?page,pageSize,selectedFields,filter,sort}, is a GET request that is used to retrieve the catalog.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the catalog.
id number The unique identifier for the catalog.
ESC string The ESC.
ProductItem string The product item.
GeneralDescription string The general description.
ProductDetail string The product detail.
Type string The type.
SubType string The sub type.
RevenueCode string The revenue code.
CostCode string The cost code.
UOM string The unit of measure.
Vendor string The vendor.
VendorCode string The vendor code.
SalesTax string Indicates whether the sales tax is applicable.
Cost number The cost.
ListPrice number The list price.
Discount number The discount.
BookPrice number The book price.
LockBookPrice boolean Indicates whether the book price is locked.
totalElements number The total number of elements.

Example URI

GET [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_book_catalog?page=&pageSize=&selectedFields=&filter=&sort=
URI Parameters
HideShow
page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

sort
string (optional) 

The sort.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 8,
      "ESC": "Company A",
      "ProductItem": "23000",
      "GeneralDescription": "05 Gallon, Poly Pail, Open Top, No Cover (White)",
      "ProductDetail": "Capacity:\t5 gal\nColor: White\nMaterial: High-Density Polyethylene\nStyle: Open Head\nShape: Round\nUN Rating: 1H2\nCountry of Origin: USA\nCovers: Due to the large variety available, this package does not come with a cover.",
      "Type": "Containers",
      "SubType": "Pails",
      "RevenueCode": "aaaa",
      "CostCode": "aaaa",
      "UOM": "Each",
      "Vendor": "Pipeline Packaging",
      "VendorCode": "57100",
      "SalesTax": "Yes",
      "Cost": 5.12,
      "ListPrice": 6.83,
      "Discount": 5,
      "BookPrice": 6.83,
      "LockBookPrice": false
    }
  ],
  "totalElements": 25613
}

supplie_apply_lock_discount_inline

supplie_apply_lock_discount_inline
POST/api/tools/supplie_apply_lock_discount_inline

Overview:

The supplie_apply_lock_discount_inline endpoint, accessible at /api/tools/supplie_apply_lock_discount_inline, is a POST request that is used to apply the lock discount inline.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
id number The unique identifier for the catalog.
lockline boolean Indicates whether the lock discount is applied.

Example URI

POST [Setup Tools APIs](https://test-api.wastelinq.com)./api/tools/supplie_apply_lock_discount_inline
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 29483,
  "lockline": true
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true"
}

Generated by aglio on 01 Aug 2024