Generators Data APIs
Overview ¶
Welcome to the Generators API section of the Wastelinq API suite. This collection of APIs is specifically designed to manage and interact with generator data within the Wastelinq system.
The Generators API provides functionalities such as creating, updating, retrieving, and deleting generator data. It allows for efficient management of generators, enabling seamless integration with other systems or services.
Each API endpoint in this section corresponds to a unique functionality related to generators. The response from each API call includes specific fields and data types, providing detailed information about the generators.
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
For example:
Authorization: Bearer 5262d64b892e8d4341000001
Error Messages
-
400 Bad Request: This error is returned when the server could not understand the request due to invalid syntax. Check your request body and parameters. -
401 Unauthorized: This error is returned when the request lacks valid authentication credentials for the target resource. Make sure your API key is correct. -
403 Forbidden: This error is returned when the server understood the request, but it refuses to authorize it. This status is often returned if you’re missing permissions to access the resource. -
404 Not Found: This error is returned when the server can’t find the requested resource. Check your endpoint and parameters. -
500 Internal Server Error: This error is returned when the server encounters an unexpected condition that prevented it from fulfilling the request.
APIs ¶
Generators ¶
GeneratorsGET/api/generators/{?page,pageSize,selectedFields,filter,sort}
Overview:
The Generator Data API retrieves generator data from the WasteLinq system. It returns a list of generators with specific details and supports filtering and sorting parameters. An Authorization token is required for access. The API is primarily used for managing and retrieving generator data.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The unique identifier for the generator. |
| Name | string | The name of the generator. |
| Customer_Number | number | The customer number associated with the generator. |
| primarysiteaddress | string | The primary site address of the generator. |
| secondarysiteaddress | string | The secondary site address of the generator. |
| EPA_ID | string | The EPA ID of the generator. |
| billToName | string | The billing name and address of the generator. |
| status | string | The status of the generator. |
| being_accessed | boolean | A boolean indicating if the generator is currently being accessed. |
| Accessing_User | string | The user who is currently accessing the generator. |
| one_time_generator | boolean | A boolean indicating if the generator is a one-time generator. |
| totalElements | number | The total number of generators returned by the API. |
Example URI
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 4.
- selectedFields
object(optional)The fields to be included in the response.
- filter
string(optional)The filter conditions. Default is “all=,facilities=,disabledGenerator=false”.
- sort
string(optional)The sorting order. Default is “Name asc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"Name": "Company ABC",
"Customer_Number": 10000,
"primarysiteaddress": "132, My Street, Kingston, New York 12401.",
"secondarysiteaddress": "132, My Street, Kingston, New York 12401.",
"EPA_ID": "10000",
"billToName": "Company ABC",
"status": "",
"being_accessed": false,
"Accessing_User": "",
"one_time_generator": false
}
],
"totalElements": 1558
}Generator Detail ¶
Generator DetailGET/api/generators/{id}/{?extra}
Overview:
The Generator Detail API endpoint retrieves detailed information about a specific generator in the WasteLinq system. It requires an Authorization token and returns a comprehensive set of generator attributes. This endpoint is primarily used for fetching and managing individual generator data.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The unique identifier for the generator. |
| Generator_Facility_Name | string | The name of the generator facility. |
| Name | string | The name of the generator. |
| Customer_Number | number | The customer number associated with the generator. |
| Legacy_ID | string | The legacy ID of the generator. |
| State_ID | string | The state ID of the generator. |
| EPA_ID | string | The EPA ID of the generator. |
| NAICS | string | The North American Industry Classification System code for the generator. |
| SIC_Code | string | The Standard Industrial Classification code for the generator. |
| Industrial_Gen | string | The industrial generator status. |
| EmergencyNumber | string | The emergency contact number for the generator. |
| Note | string | Any additional notes for the generator. |
| IsTemplateProfile | boolean | Indicates if the generator profile is a template. |
| Being_Accessed | boolean | Indicates if the generator is currently being accessed. |
| Created_date | string | The date the generator was created. |
| Modified_date | string | The date the generator was last modified. |
| Status | string | The status of the generator. |
| if_different | boolean | If Different than Set Up Tools Default. |
| loa_on_file | number | Letter of Authenticity numbers. |
| verify_status | string | The verification status of the generator. |
| verified_date | string | The date the generator was verified. |
| Commercial | string | The commercial status of the generator. |
| Facility_Name | number | The facility name ID. |
| Category | number | The category ID. |
| Segment | number | The segment ID. |
| SizeCode | number | The size code ID. |
| Generator_Size | number | The generator size ID. |
| Accessing_User | number | The user currently accessing the generator. |
| Broker | number | The broker ID. |
| Billing_Contact | number | The billing contact for the generator. |
| account_assignments | object | The account assignments for the generator. |
| primary_contact | object | The primary contact for the generator. |
| generatorNotes | object | The notes for the generator. |
| generatorCustomerstatus | object | The customer status for the generator. |
| custom_fields | object | The custom fields for the generator. |
| is_loa_on_file | boolean | Indicates if the letter of authorization is on file. |
Example URI
- id
number(required)The unique identifier for the generator.
- extra
boolean(optional)An optional parameter to include extra data. Default is false.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"id": 10000,
"Generator_Facility_Name": "Facility ABC",
"Name": "Company ABC",
"Customer_Number": 10000,
"Legacy_ID": "10000",
"State_ID": "10000",
"EPA_ID": "10000",
"NAICS": "10000",
"SIC_Code": "10000",
"Industrial_Gen": "NON-Industrial",
"EmergencyNumber": "100-100-1000",
"Note": "#10000 - ON CALL SUPERVISOR",
"IsTemplateProfile": false,
"Being_Accessed": false,
"Created_date": "2020-06-24T16:40:59.335341-05:00",
"Modified_date": "2024-03-28T10:12:38.234192-05:00",
"Status": "Active",
"if_different": true,
"loa_on_file": null,
"verify_status": "NO",
"verified_date": "2024-03-28T10:12:38.234199-05:00",
"Commercial": "COMMERCIAL",
"Facility_Name": 70,
"Category": 191,
"Segment": 700,
"SizeCode": 178,
"Generator_Size": 124,
"Accessing_User": null,
"Broker": 31,
"Billing_Contact": null,
"account_assignments": {
"89": 389,
"90": 671,
"91": 943,
"93": 389,
"108": 389
},
"primary_contact": {
"id": 65759,
"Contact_Type": 158,
"MasterContact": {
"id": 84716,
"First_Name": "Jane",
"Last_Name": "Doe",
"Status": "Active",
"IsInactive": false,
"Contact_Number": 10000,
"emails": [
{
"Label": "Work",
"Email": "test@wastelinq.com"
}
],
"phones": [
{
"Label": "Work",
"Phone_Number": "100-100-2000",
"Phone_Ext": ""
}
]
}
},
"generatorNotes": {
"id": null,
"note": ""
},
"generatorCustomerstatus": {
"id": 8514,
"Inv_Rev_Req": false,
"Dollar_Increase_Note": false,
"Acct_On_Hold": false,
"Inside_Sales": false,
"Acct_Inactive": false,
"Sign_Auth": false,
"Delete_Acct": false,
"Acct_Closed": false,
"Bill_To_Acct_On_Hold": false,
"tentative_hold": false,
"one_time_generator": false,
"is_custom_label": false,
"custom_label_name": null,
"Customer": 41024
},
"custom_fields": {
"10": "1",
"26": "2"
},
"is_loa_on_file": false
}Generator Summary ¶
Generator SummaryGET/api/generators/{id}/summary
Overview:
The Generator Summary API endpoint retrieves a summary of a specific generator’s data from the WasteLinq system. This endpoint requires an Authorization token and returns a subset of the generator’s details, including customer number, name, verification status, EPA ID, state ID, facility name, physical address, billing information, contact information, and statuses. This API is primarily used for quickly accessing key information about a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| Customer_Number | number | The customer number associated with the generator. |
| Name | string | The name of the generator. |
| verify_status | string | The verification status of the generator. |
| EPA_ID | string | The EPA ID of the generator. |
| State_ID | string | The state ID of the generator. |
| Facility_Name | string | The name of the generator facility. |
| Physical_Address | object | The physical address of the generator, which includes fields for Address1, Address2, City, State, and Zip. |
| Bill_To | object | The billing information for the generator, which includes fields for id, Name, Address1, City, State, and Zip. |
| Contact | object | The contact information for the generator, which includes fields for Name and Phone. |
| Statuses | array | An array of statuses for the generator. |
Example URI
- id
number(required)The unique identifier for the generator.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"Customer_Number": 10000,
"Name": "Company ABC",
"verify_status": "NO",
"EPA_ID": "10000",
"State_ID": "10000",
"Facility_Name": "Facility ABC",
"Physical_Address": {
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401"
},
"Bill_To": {
"id": 10000,
"Name": "Bill To ABC",
"Address1": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401"
},
"Contact": {
"Name": "Jane Doe",
"Phone": "100-100-3000"
},
"Statuses": []
}Addresses ¶
AddressesGET/api/generators/{id}/addresses
Overview:
The Generator Addresses API endpoint retrieves the mailing and physical addresses of a specific generator from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the generator’s addresses, including the unique identifier for the address, the first and second lines of the address, the city, state, zip code, county, flags indicating whether the address is outside the United States or the same as the mailing address, the foreign address (if applicable), the person or department to which mail should be directed, and the customer number associated with the address. This API is primarily used for managing and accessing the address information of a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| mailing_address | object | The mailing address of the generator |
| physical_address | object | The physical address of the generator |
| id | number | The unique identifier for the address. |
| Address1 | string | The first line of the address. |
| Address2 | string | The second line of the address (if applicable). |
| City | string | The city where the address is located. |
| State | string | The state where the address is located. |
| Zip | string | The zip code of the address. |
| County | string | The county where the address is located. |
| OutsideUSA | boolean | A flag indicating whether the address is outside the United States. |
| ForeignerAddress | string | The foreign address (if applicable). |
| AttentionTo | string | The person or department to which mail should be directed. |
| Customer | number | The customer number associated with the address. |
| same_as_mailing_address | boolean | A flag indicating whether the physical address is the same as the mailing address. |
Example URI
- id
number(required)The unique identifier for the generator.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"mailing_address": {
"id": 10000,
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401",
"County": null,
"OutsideUSA": false,
"ForeignerAddress": null,
"AttentionTo": "",
"Customer": 10000
},
"physical_address": {
"Address1": "",
"Address2": "",
"City": "",
"State": "",
"Zip": "",
"County": "",
"OutsideUSA": false,
"ForeignerAddress": "",
"Customer": null,
"same_as_mailing_address": true
}
}Communication ¶
CommunicationGET/api/generators/{id}/communication
Overview:
The Generator Communication API endpoint retrieves the communication history of a specific generator from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the generator’s communication history, including the frequency of contact with the generator, the last time the generator was contacted, and an array of history logs related to the generator. This API is primarily used for managing and accessing the communication history of a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| Contact_Frequency | string | The frequency of contact with the generator. |
| Last_Time_Contacted | string | The last time the generator was contacted. |
| HistoryLogs | array | An array of history logs related to the generator. |
Example URI
- id
number(required)The unique identifier for the generator.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"Contact_Frequency": "",
"Last_Time_Contacted": "",
"HistoryLogs": []
}Projects ¶
ProjectsGET/api/generators/{id}/projects
Overview:
The Generator Projects API endpoint retrieves the project details associated with a specific generator from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the generator’s projects, including the unique identifier for the project, project number, customer name, project name, start and end dates, order assigned, purchase order number, total invoice amount, total cost, and expected revenue. This API is primarily used for managing and accessing the project information of a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| totalElements | number | The total number of elements in the content array. |
| content | array | An array containing the project details. |
| id | number | The unique identifier for the project. |
| Project_Number | number | The project number. |
| Customer__Name | string | The name of the customer. |
| Name | string | The name of the project. |
| StartDate | string | The start date of the project. |
| EndDate | string | The end date of the project. |
| order_assigned | string | The order assigned to the project. |
| PO_Number | string | The purchase order number of the project. |
| total_invoice | number | The total invoice amount for the project. |
| total_cost | number | The total cost of the project. |
| ExpectedRevenue | number | The expected revenue from the project. |
Example URI
- id
number(required)The unique identifier for the generator.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"totalElements": 1,
"content": [
{
"id": 666,
"Project_Number": 10125,
"Customer__Name": "Company ABC",
"Name": "Company ABC",
"StartDate": "2021-02-01",
"EndDate": "2021-02-04",
"order_assigned": "",
"PO_Number": ".",
"total_invoice": 0,
"total_cost": 0,
"ExpectedRevenue": null
}
]
}Project Detail ¶
Project DetailGET/api/generators/{id}/projects/{project_id}
Overview:
The Project Detail API endpoint retrieves the detailed information of a specific project associated with a specific generator from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the project, including the unique identifier for the project, project number, project name, start and end dates, purchase order number, purchase order amount, purchase order usage, expected revenue, customer number, customer name, total costs, actual revenue, and associated phases and phase orders. This API is primarily used for managing and accessing the detailed information of a specific project for a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The unique identifier for the project. |
| Project_Number | number | The project number. |
| Name | string | The name of the project. |
| StartDate | string | The start date of the project. |
| EndDate | string | The end date of the project. |
| PO_Number | string | The purchase order number of the project. |
| PO_Amount | number | The purchase order amount for the project. |
| PO_Usage | number | The purchase order usage for the project. |
| ExpectedRevenue | number | The expected revenue from the project. |
| Customer | number | The customer number associated with the project. |
| Customer__Name | string | The name of the customer. |
| total_costs | number | The total costs of the project. |
| Actual_Revenue | number | The actual revenue from the project. |
| Phases | array | An array of phases associated with the project. |
| Phase_Orders | array | An array of phase orders associated with the project. |
Example URI
- id
number(required)The unique identifier for the generator.
- project_id
number(required)The unique identifier for the project.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"id": 666,
"Project_Number": 10125,
"Name": ".",
"StartDate": "2021-02-01",
"EndDate": "2021-02-04",
"PO_Number": ".",
"PO_Amount": 0,
"PO_Usage": null,
"ExpectedRevenue": null,
"Customer": 10000,
"Customer__Name": "Company ABC",
"total_costs": 0,
"Actual_Revenue": null,
"Phases": [],
"Phase_Orders": []
}Project Order ¶
Project OrderGET/api/generators/{id}/projects/{project_id}/orders
Overview:
The Project Order API endpoint retrieves the order details associated with a specific project for a specific generator from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the orders, including the unique identifier for the order and the order number. This API is primarily used for managing and accessing the order information of a specific project for a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The unique identifier for the order. |
| Order_Number | number | The order number. |
Example URI
- id
number(required)The unique identifier for the generator.
- project_id
number(required)The unique identifier for the project.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
[
{
"id": 10000,
"Order_Number": 10000
},
{
"id": 10000,
"Order_Number": 10000
},
{
"id": 10000,
"Order_Number": 10000
},
{
"id": 10000,
"Order_Number": 10000
},
{
"id": 10000,
"Order_Number": 10000
}
]Contacts ¶
ContactsGET/api/generators/contacts/{customer_id}/
Overview:
The Contacts API endpoint retrieves the contact details associated with a specific customer from the WasteLinq system. This endpoint requires an Authorization token and returns the details of the contacts, including the unique identifier for the contact, status, MSID, contact type, first name, last name, phone number, email, title, activity status, order usage status, and associated contact types. This API is primarily used for managing and accessing the contact information of a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| id | number | The unique identifier for the contact. |
| status | string | The status of the contact. |
| msid | number | The MSID of the contact. |
| Contact_Type | number | The type of the contact. |
| First_Name | string | The first name of the contact. |
| Last_Name | string | The last name of the contact. |
| Phone | string | The phone number of the contact. |
| string | The email address of the contact. | |
| Title | string | The title of the contact. |
| IsInactive | string | The activity status of the contact. |
| is_used_in_order | boolean | Indicates whether the contact is used in order. |
| contactTypes | array | An array of contact types associated with the contact. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 20727,
"status": "0",
"msid": 35885,
"Contact_Type": 159,
"First_Name": "Jane",
"Last_Name": "Doe",
"Phone": "100-100-1000 None",
"Email": "test@wastelinq.com",
"Title": "None",
"IsInactive": "Active",
"is_used_in_order": true,
"contactTypes": [
{
"id": 158,
"name": "Customer Primary"
},
{
"id": 159,
"name": "Site Secondary"
},
{
"id": 160,
"name": "Accounts Payable"
},
{
"id": 161,
"name": "Site Primary"
},
{
"id": 162,
"name": "Profile Contact"
},
{
"id": 268,
"name": "Customer Secondary"
}
]
}
],
"totalElements": 1
}System Information ¶
System InformationGET/api/generators/systeminformation/{customer_id}/{?page,pageSize,selectedFields,filter,sort}
Overview:
The System Information API endpoint retrieves a list of change records for a specific customer from the WasteLinq system. Each record includes information about a change that was made, such as the field that was changed, the old and new values, and the user who made the change.This API is primarily used for tracking changes made to a specific customer’s information. It requires an Authorization token and supports pagination, field selection, filtering, and sorting through the page, pageSize, selectedFields, filter, and sort parameters respectively.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful |
| content | array | An array of change records |
| id | number | The unique identifier for the change record |
| createdDate | string | The date and time when the change was made |
| fieldName | string | The name of the field that was changed |
| oldValue | string | The old value of the field |
| newValue | string | The new value of the field |
| authUser | string | The user who made the change |
| totalElements | number | The total number of change records |
Example URI
- customer_id
number(required)The unique identifier for the customer.
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 10.
- selectedFields
object(optional)The fields to be included in the response. Default is “createdDate,authUser,fieldName,oldValue,newValue”.
- filter
string(optional)The filter conditions. Default is “all=”.
- sort
string(optional)The sorting order. Default is “createdDate desc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 293360,
"createdDate": "03-29-2024 03:45 AM",
"fieldName": "Primary Contact - Email",
"oldValue": "test@wastelinq.com",
"newValue": "test@gmail.com",
"authUser": "Jane Doe"
}
],
"totalElements": 1
}Notes ¶
NotesPOST/api/generators/notes/{customer_id}/
Overview:
The Notes API endpoint allows for the creation of a new note for a specific customer in the WasteLinq system. Each note includes information such as the note content, the associated customer, and the broker. This API is primarily used for adding additional information or context to a specific customer’s record. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | object | Contains the content of the response |
| id | number | The unique identifier for the content |
| Note | string | A note associated with the content |
| Customer | number | The unique identifier for the customer |
| Broker | number | The unique identifier for the broker |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"id": 10000,
"Note": "test"
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 10000,
"Note": "test",
"Customer": 10000,
"Broker": 10
}
}Status Save ¶
Status SavePOST/api/generators/status/{customer_id}/save/
Overview:
The Status Save API endpoint allows for the updating of a specific customer’s status in the WasteLinq system. Each status includes various flags such as invoice review required, account on hold, inside sales, and more. This API is primarily used for updating the status of a specific customer’s record. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | object | Contains the content of the response |
| id | number | The unique identifier for the generator |
| Inv_Rev_Req | boolean | Invoice review required flag |
| Dollar_Increase_Note | boolean | Dollar increase note flag |
| Acct_On_Hold | boolean | Account on hold flag |
| Inside_Sales | boolean | Inside sales flag |
| Acct_Inactive | boolean | Account inactive flag |
| Sign_Auth | boolean | Sign authority flag |
| Delete_Acct | boolean | Delete account flag |
| Acct_Closed | boolean | Account closed flag |
| Bill_To_Acct_On_Hold | boolean | Bill to account on hold flag |
| tentative_hold | boolean | Tentative hold flag |
| one_time_generator | boolean | One time generator flag |
| is_custom_label | boolean | Is custom label flag |
| custom_label_name | string | The name of the custom label |
| Customer | number | The unique identifier for the customer |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"custom_label_name": null,
"is_custom_label": false,
"one_time_generator": false,
"tentative_hold": false,
"Bill_To_Acct_On_Hold": false,
"Delete_Acct": false,
"Sign_Auth": false,
"Acct_Inactive": false,
"Inside_Sales": true,
"Dollar_Increase_Note": false,
"Inv_Rev_Req": false,
"Acct_On_Hold": false,
"Acct_Closed": false,
"id": "1000",
"Customer": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 1000,
"Inv_Rev_Req": false,
"Dollar_Increase_Note": false,
"Acct_On_Hold": false,
"Inside_Sales": true,
"Acct_Inactive": false,
"Sign_Auth": false,
"Delete_Acct": false,
"Acct_Closed": false,
"Bill_To_Acct_On_Hold": false,
"tentative_hold": false,
"one_time_generator": false,
"is_custom_label": false,
"custom_label_name": null,
"Customer": 10000
}
}Check Permission ¶
Check PermissionGET/api/generators/check_permission
Overview:
The Check Permission API endpoint retrieves the permissions for a specific user in the WasteLinq system. Each permission includes information such as write permission, emergency contact details, broker configuration, and read access to StreamLinq. This API is primarily used for checking the permissions of a specific user. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| write_permission | boolean | Indicates if the user has write permission |
| Emergency_Phone | string | The emergency contact phone number |
| Emergency_Contact | string | The emergency contact person or department |
| broker_configured | boolean | Indicates if a broker is configured |
| read_streamlinq | boolean | Indicates if the user has read access to StreamLinq |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"write_permission": true,
"Emergency_Phone": "100-100-1000",
"Emergency_Contact": "#10000 - ON CALL SUPERVISOR",
"broker_configured": true,
"read_streamlinq": true
}Billto ¶
BilltoGET/api/generators/billto/{customer_id}/
Overview:
The Billto API endpoint retrieves a list of billing records for a specific customer from the WasteLinq system. Each record includes information about the customer’s billing details such as account ID, name, address, contact details, status, and more. This API is primarily used for retrieving billing information for a specific customer. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the generator |
| Acct_ID | number | The account ID of the generator |
| Name | string | The name of the generator |
| Address1 | string | The first line of the address |
| Address2 | string | The second line of the address |
| City | string | The city of the generator |
| State | string | The state of the generator |
| Zip | string | The zip code of the generator |
| County | string | The county of the generator |
| Country | string | The country of the generator |
| Contact | string | The contact person for the generator |
| Phone | string | The phone number of the generator |
| Phone_Ext | string | The phone extension of the generator |
| Fax | string | The fax number of the generator |
| string | The email address of the generator | |
| Status | string | The status of the generator |
| Created_date | string | The date the generator was created |
| Modified_date | string | The date the generator was last modified |
| Current_Account_Balance | number | The current account balance of the generator |
| Credit_Line_Account | number | The credit line account of the generator |
| Dun_Bradstreet_No | number | The Dun & Bradstreet number of the generator |
| Electronic_Billing | boolean | Indicates if the generator uses electronic billing |
| Billing_Note | string | Any notes related to billing for the generator |
| IsDeleted | boolean | Indicates if the generator has been deleted |
| OutsideUSA | boolean | Indicates if the generator is outside the USA |
| ForeignerAddress | string | The foreign address of the generator |
| legacy_billing_id | number | The legacy billing ID of the generator |
| ESC_Factor | string | The ESC factor of the generator |
| Base_Gross_Margin | string | The base gross margin of the generator |
| esc_certified_profile | boolean | Indicates if the generator has an ESC certified profile |
| User | number | The user ID associated with the generator |
| Broker | number | The broker ID associated with the generator |
| PaymentTerm | number | The payment term ID associated with the generator |
| PaymentType | number | The payment type ID associated with the generator |
| totalElements | number | The total number of elements in the response |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"Acct_ID": 10000,
"Name": "Company ABC",
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401",
"County": null,
"Country": "United States",
"Contact": null,
"Phone": null,
"Phone_Ext": null,
"Fax": null,
"Email": "test@wastelinq.com",
"Status": "Active",
"Created_date": "2020-06-23T16:27:18.803279-05:00",
"Modified_date": "2022-05-08T18:54:15.280748-05:00",
"Current_Account_Balance": null,
"Credit_Line_Account": null,
"Dun_Bradstreet_No": null,
"Electronic_Billing": false,
"Billing_Note": null,
"IsDeleted": false,
"OutsideUSA": false,
"ForeignerAddress": null,
"legacy_billing_id": null,
"ESC_Factor": "1.00",
"Base_Gross_Margin": "20.00",
"esc_certified_profile": false,
"User": 196,
"Broker": 31,
"PaymentTerm": 454,
"PaymentType": null
}
],
"totalElements": 1
}Tax Schedule ¶
Tax ScheduleGET/api/generators/tax_schedule/{customer_id}/
Overview:
The Tax Schedule API endpoint retrieves a list of tax schedules for a specific customer from the WasteLinq system. Each record includes information about the customer’s tax details. This API is primarily used for retrieving tax schedule information for a specific customer. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| totalElements | number | The total number of elements in the response |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [],
"totalElements": 0
}Payment Term ¶
Payment TermGET/api/generators/payment_term/
Overview:
The Payment Term API endpoint retrieves a list of payment terms for a specific customer from the WasteLinq system. Each record includes information about the customer’s payment terms such as order, name, default status, and days to calculate due date. This API is primarily used for retrieving payment term information for a specific customer. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the tax schedule |
| Order | number | The order of the tax schedule |
| Name | string | The name of the tax schedule |
| IsDefault | string | Indicates if the tax schedule is the default |
| day_to_calculate_due_date | number | The number of days to calculate the due date |
| Broker | number | The unique identifier for the broker |
| totalElements | number | The total number of elements in the response |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 464,
"Order": 11,
"Name": "1.5% 10, Net 30",
"IsDefault": "No",
"day_to_calculate_due_date": 30,
"Broker": 31
}
],
"totalElements": 1
}Billing Info ¶
Billing InfoGET/api/generators/billing_info/{customer_id}/
Overview:
The Billing Info API endpoint retrieves the billing information for a specific customer from the WasteLinq system. The information includes details such as customer ID, network status, billing address, purchase order requirements, invoicing protocol, sales tax rate, tax ID, sales tax exemption status, tax schedule, contact details, electronic billing details, current account balance, credit line account, Dun & Bradstreet number, payment term, and files associated with the generator. This API is primarily used for retrieving billing information for a specific customer. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | object | Contains the content of the response |
| id | number | The unique identifier for the generator |
| is_network | boolean | Indicates if the generator is part of a network |
| Customer | number | The unique identifier for the customer |
| Biil_To | number | The unique identifier for the billing address |
| PO_Required | boolean | Indicates if a purchase order is required |
| PO_Expiration_Date | string | The expiration date of the purchase order |
| Blanket_PO_No | string | The blanket purchase order number |
| Invoicing_Protocol | string | The invoicing protocol |
| Sales_Tax_Rate | string | The sales tax rate |
| Tax_ID | string | The tax ID of the generator |
| Sales_Tax_Exempt | boolean | Indicates if the generator is exempt from sales tax |
| TaxSchedule | string | The tax schedule of the generator |
| Address1 | string | The first line of the address |
| Address2 | string | The second line of the address |
| Billing_Address | string | The billing address of the generator |
| City | string | The city of the generator |
| State | string | The state of the generator |
| Zip | string | The zip code of the generator |
| Contact | string | The contact person for the generator |
| Phone | string | The phone number of the generator |
| Phone_Ext | string | The phone extension of the generator |
| Phone_Full | string | The full phone number of the generator |
| Fax | string | The fax number of the generator |
| string | The email address of the generator | |
| Electronic_Billing | string | The electronic billing details of the generator |
| Current_Account_Balance | string | The current account balance of the generator |
| Credit_Line_Account | string | The credit line account of the generator |
| Dun_Bradstreet_No | string | The Dun & Bradstreet number of the generator |
| PaymentTerm | string | The payment term of the generator |
| OutsideUSA | string | Indicates if the generator is outside the USA |
| ForeignerAddress | string | The foreign address of the generator |
| files | array | The files associated with the generator |
| totalElements | number | The total number of elements in the response |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 10000,
"is_network": false,
"Customer": 10000,
"Biil_To": 10000,
"PO_Required": false,
"PO_Expiration_Date": null,
"Blanket_PO_No": null,
"Invoicing_Protocol": "make sure you have a reference number to reference",
"Sales_Tax_Rate": "8.25",
"Tax_ID": null,
"Sales_Tax_Exempt": false,
"TaxSchedule": null,
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": "132, My Street, Kingston, New York 12401.",
"Billing_Address": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401",
"Contact": "Jane Doe",
"Phone": "(100) 100-1000",
"Phone_Ext": "",
"Phone_Full": "(100) 100-1000",
"Fax": "",
"Email": "test@wastelinq.com",
"Electronic_Billing": "",
"Current_Account_Balance": "0",
"Credit_Line_Account": "",
"Dun_Bradstreet_No": "",
"PaymentTerm": "Net 30",
"OutsideUSA": "False",
"ForeignerAddress": "",
"files": []
},
"totalElements": 1
}Get Billto ¶
Get BilltoGET/api/generators/get_billto/{customer_id}/
Overview:
The Get Billto API endpoint retrieves the billing information for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. The API returns a success status and an object containing the customer’s billing information, including the billing address, contact person, phone number, email address, current account balance, payment terms, and more. This API is primarily used for retrieving and managing the billing information for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| data | object | Contains the customer’s billing information. |
| Address1 | string | The first line of the billing address. |
| Address2 | string | The second line of the billing address. |
| Billing_Address | string | The full billing address. |
| City | string | The city of the billing address. |
| State | string | The state of the billing address. |
| Zip | string | The zip code of the billing address. |
| Contact | string | The contact person for the customer. |
| Phone | string | The contact phone number for the customer. |
| Phone_Ext | string | The extension for the contact phone number. |
| Phone_Full | string | The full contact phone number including the extension. |
| Fax | string | The fax number for the customer. |
| string | The email address for the customer. | |
| Electronic_Billing | string | Indicates whether the customer uses electronic billing. |
| Current_Account_Balance | string | The current balance of the customer’s account. |
| Credit_Line_Account | string | The credit line account for the customer. |
| Dun_Bradstreet_No | string | The Dun & Bradstreet number for the customer. |
| PaymentTerm | string | The payment terms for the customer. |
| OutsideUSA | string | Indicates whether the customer is located outside the USA. |
| ForeignerAddress | string | The foreign address for the customer. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"data": {
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": "132, My Street, Kingston, New York 12401.",
"Billing_Address": "132, My Street, Kingston, New York 12401.",
"City": "New York",
"State": "NY",
"Zip": "12401",
"Contact": "Jane Doe",
"Phone": "100-100-1000",
"Phone_Ext": "",
"Phone_Full": "100-100-1000",
"Fax": "",
"Email": "test@wastelinq.com",
"Electronic_Billing": "",
"Current_Account_Balance": "5398.95",
"Credit_Line_Account": "",
"Dun_Bradstreet_No": "",
"PaymentTerm": "Net 30",
"OutsideUSA": "False",
"ForeignerAddress": ""
}
}Upload File Billto ¶
Upload File BilltoPOST/api/generators/uploadfile_billto/{customer_id}/
Overview:
The Upload File Billto API endpoint allows for the uploading of a file for a specific customer in the WasteLinq system. This API is primarily used for uploading a file to a specific customer’s record. It requires an Authorization token and a file in the form-data of the request body.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| customer_id | number | The unique identifier for the generator |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/html
Authorization: {TOKEN}Body
------WebKitFormBoundaryjDOsFgNLDk3qZxNz
Content-Disposition: form-data; name="file"; filename="test.html"
Content-Type: text/html
------WebKitFormBoundaryjDOsFgNLDk3qZxNz--
200Headers
Content-Type: application/jsonBody
{
"success": true,
"customer_id": 10000
}Delete File ¶
Delete FileGET/api/generators/deletefile/{id}/
Overview:
The Delete File API endpoint allows for the deletion of a specific file associated with a generator in the WasteLinq system. This endpoint requires an Authorization token and the unique identifier (id) of the target file as a parameter. Upon successful deletion, the API returns a success status and the id of the deleted file. This API is primarily used for managing and deleting files associated with generators in the system.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| id | number | The unique identifier for the target file |
Example URI
- id
number(required)The unique identifier for the target file.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"id": 10000
}Add Bill To With Json ¶
Add Bill To With JsonPOST/api/generators/add_bill_to_with_json/
Overview:
The Add Bill To With Json API endpoint allows for the creation of a new billing record for a generator in the WasteLinq system using a JSON payload. The payload includes details such as Dun & Bradstreet number, payment term, credit line account, current account balance, contact details, and address. This API is primarily used for creating a new billing record for a generator. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| itemId | number | The unique identifier for the new billto |
| Dun_Bradstreet_No | string | The Dun & Bradstreet number of the generator |
| PaymentTerm | string | The payment term of the generator |
| Credit_Line_Account | string | The credit line account of the generator |
| Current_Account_Balance | string | The current account balance of the generator |
| string | The email address of the generator | |
| Fax | string | The fax number of the generator |
| Phone_Ext | string | The phone extension of the generator |
| Phone | string | The phone number of the generator |
| lastname | string | The last name of the contact person for the generator |
| firstname | string | The first name of the contact person for the generator |
| Country | string | The country of the generator |
| County | string | The county of the generator |
| Zip | string | The zip code of the generator |
| State | string | The state of the generator |
| City | string | The city of the generator |
| Address2 | string | The second line of the address |
| Address1 | string | The first line of the address |
| Name | string | The name of the generator |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"Dun_Bradstreet_No": "test",
"PaymentTerm": "461",
"Credit_Line_Account": "1",
"Current_Account_Balance": "160",
"Email": "test@gmail.com",
"Fax": "123-412-3123",
"Phone_Ext": "",
"Phone": "123-412-3123",
"lastname": "test",
"firstname": "test",
"Country": "United States",
"County": "test",
"Zip": "95133",
"State": "AL",
"City": "test",
"Address2": "test",
"Address1": "test",
"Name": "test"
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"itemId": 27446
}Service Profile ¶
Service ProfileGET/api/generators/serviceprofile/{customer_id}/
Overview:
The Service Profile API endpoint retrieves the service profile information for a specific customer from the WasteLinq system. The information includes details such as service profile number, name, transportation region, storage label status, last update, transportation note, creation date, modification date, and the identifiers for the customer, creator, and modifier. This API is primarily used for retrieving service profile information for a specific customer. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | object | Contains the content of the response |
| id | number | The unique identifier for the service profile |
| ServiceProfile_Number | number | The number of the service profile |
| ServiceProfile_Name | string | The name of the service profile |
| Transportation_Region | string | The transportation region of the service profile |
| Storage_Label | boolean | Indicates if the storage label is true |
| Last_Update | string | The last update of the service profile |
| Transportation_Note | string | The transportation note of the service profile |
| Created_date | string | The creation date of the service profile |
| Modified_date | string | The modification date of the service profile |
| Customer | number | The unique identifier for the customer |
| Creator | number | The unique identifier for the creator of the service profile |
| Modifier | number | The unique identifier for the modifier of the service profile |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 10000,
"ServiceProfile_Number": 10000,
"ServiceProfile_Name": "Name ABC",
"Transportation_Region": "TX",
"Storage_Label": true,
"Last_Update": "jane.doe@test.com/03-30-2024",
"Transportation_Note": "",
"Created_date": "2024-03-30T02:04:17.458382-05:00",
"Modified_date": "2024-03-30T02:08:08.817539-05:00",
"Customer": 10000,
"Creator": 3825,
"Modifier": 3825
}
}Gen Trans Equip Req ¶
Gen Trans Equip ReqGET/api/generators/serviceprofile/gen_trans_equip_req/
Overview:
The Gen Trans Equip Req API endpoint retrieves the transportation equipment requirements for a specific generator from the WasteLinq system. The information includes details such as equipment type, description, and the identifier for the broker. This API is primarily used for retrieving transportation equipment requirements for a specific generator. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the equipment |
| Equipment | string | The type of equipment |
| Description | string | The description of the equipment |
| Broker | number | The unique identifier for the broker |
| totalElements | number | The total number of elements in the response |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 620,
"Equipment": "48' Trailer",
"Description": " ",
"Broker": 31
}
],
"totalElements": 1
}Tran Sp Equip Requirement ¶
Tran Sp Equip RequirementGET/api/generators/serviceprofile/tran_sp_equip_requirement/{customer_id}/
Overview:
The Tran Sp Equip Requirement API endpoint retrieves the transportation equipment requirements for a specific service profile from the WasteLinq system. The information includes details such as equipment type, description, and the identifier for the broker. This API is primarily used for retrieving transportation equipment requirements for a specific service profile. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the generator transportation equipment requirement |
| Gen_Trans_Equip_Req | object | Contains the details of the generator transportation equipment requirement |
| id | number | The unique identifier for the generator transportation equipment requirement |
| Equipment | string | The type of equipment required |
| Description | string | The description of the equipment |
| Broker | number | The unique identifier for the broker |
| Description | string | The description of the generator transportation equipment requirement |
| Customer | number | The unique identifier for the customer |
| totalElements | number | The total number of elements in the response |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 343,
"Gen_Trans_Equip_Req": {
"id": 620,
"Equipment": "48' Trailer",
"Description": " ",
"Broker": 31
},
"Description": "test",
"Customer": 80849
}
],
"totalElements": 1
}Transportation Detail ¶
Transportation DetailGET/api/generators/serviceprofile/transportation_detail/{customer_id}/
Overview:
The Transportation Detail API endpoint retrieves the transportation details for a specific service profile from the WasteLinq system. The information includes details such as average stop, average bulk stop, average delivery stop, hours of operation, last update, notes, site access restrictions, approved vendor requirement, third party transportation allowance, transportation restriction details, disposal site restriction details, creation date, modification date, and the identifier for the customer. This API is primarily used for retrieving transportation details for a specific service profile. It requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | object | Contains the content of the response |
| id | number | The unique identifier for the generator |
| Avg_PUP_Stop | string | The average stop for the generator |
| Avg_Bik_PUP_Stop | string | The average bulk stop for the generator |
| Avg_DEL_Stop | string | The average delivery stop for the generator |
| Hours_Of_Operation | string | The hours of operation for the generator |
| Last_Updated | string | The last update of the generator |
| Note | string | Any notes regarding the generator |
| Site_Access_Restrictions | string | Any site access restrictions for the generator |
| Approved_Vendor_Requirement | boolean | Indicates if the approved vendor requirement is true |
| No_3rd_Party_Transportation | boolean | Indicates if third party transportation is not allowed |
| Trans_Restriction_Detail | string | Details of any transportation restrictions |
| Disposal_Site_Restriction_Detail | string | Details of any disposal site restrictions |
| Created_date | string | The creation date of the service profile |
| Modified_date | string | The modification date of the service profile |
| Customer | number | The unique identifier for the customer |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 10000,
"Avg_PUP_Stop": "1",
"Avg_Bik_PUP_Stop": "0.5",
"Avg_DEL_Stop": "0.5",
"Hours_Of_Operation": "2",
"Last_Updated": "2024-04-01",
"Note": "test",
"Site_Access_Restrictions": "test",
"Approved_Vendor_Requirement": true,
"No_3rd_Party_Transportation": false,
"Trans_Restriction_Detail": "",
"Disposal_Site_Restriction_Detail": "",
"Created_date": "2024-04-01T03:05:52.643615-05:00",
"Modified_date": "2024-04-01T03:05:52.643631-05:00",
"Customer": 10000
}
}Get Transporter Datatable Ajax ¶
Get Transporter Datatable AjaxGET/api/generators/get_transporter_datatable_ajax/{?page,pageSize,selectedFields,filter,sort}
Overview:
The Get Transporter Datatable Ajax API endpoint retrieves a list of transporters associated with a specific generator in the WasteLinq system. This endpoint requires an Authorization token and returns a success status, an array containing the transporter details, including the unique identifier for the transporter, the name of the transporter, the type of the transporter (either “Network” or “Enterprise”), and the total number of elements in the content array. This API is primarily used for managing and accessing the list of transporters for a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the transporter details. |
| id | number | The unique identifier for the transporter. |
| Name | string | The name of the transporter. |
| network_or_enterprise | string | The type of the transporter, either “Network” or “Enterprise”. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 10.
- selectedFields
object(optional)The fields to be included in the response.
- filter
string(optional)The filter conditions. Default is “all=,broker_type=,type_infomation=CUSTOMER,infomation_id=10000.
- sort
string(optional)The sorting order. Default is “Name asc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"Name": "Company ABC",
"network_or_enterprise": "Network"
}
],
"totalElements": 1
}Get Disposal Site Restriction Datatable Ajax ¶
Get Disposal Site Restriction Datatable AjaxGET/api/generators/get_disposal_site_restriction_datatable_ajax/{?page,pageSize,selectedFields,filter,sort}
Overview:
The Get Disposal Site Restriction Datatable Ajax API endpoint retrieves a list of disposal site restrictions associated with a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts parameters for page number, page size, selected fields, filter conditions, and sorting order. The API returns a success status, an array containing the disposal site details, including the unique identifier for the disposal site, the name of the disposal site, the parent company of the disposal site, the type of the disposal site (either “Network” or “Enterprise”), and the total number of elements in the content array. This API is primarily used for managing and accessing the list of disposal site restrictions for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the disposal site details. |
| id | number | The unique identifier for the disposal site. |
| Name | string | The name of the disposal site. |
| parent_df | string | The parent company of the disposal site. |
| network_or_enterprise | string | The type of the disposal site, either “Network” or “Enterprise”. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 10.
- selectedFields
object(optional)The fields to be included in the response. Default is “id,Name,parent_df,network_or_enterprise”.
- filter
string(optional)The filter conditions. Default is “all=,broker_type=,type_infomation=CUSTOMER,infomation_id=10000.
- sort
string(optional)The sorting order. Default is “Name asc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"Name": "Company ABC",
"parent_df": "Company ABC",
"network_or_enterprise": "Network"
}
],
"totalElements": 1
}Get Disposal Technology Restriction Datatable Ajax ¶
Get Disposal Technology Restriction Datatable AjaxGET/api/generators/get_disposal_technology_restriction_datatable_ajax/{?page,pageSize,selectedFields,filter,sort}
Overview:
The Get Disposal Technology Restriction Datatable Ajax API endpoint retrieves a list of disposal technology restrictions associated with a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts parameters for page number, page size, selected fields, filter conditions, and sorting order. The API returns a success status, an array containing the disposal technology restriction details, including the unique identifier for the disposal technology restriction, the name of the disposal technology restriction, and the total number of elements in the content array. This API is primarily used for managing and accessing the list of disposal technology restrictions for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the disposal technology restriction details. |
| id | number | The unique identifier for the disposal technology restriction. |
| Name | string | The name of the disposal technology restriction. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 10.
- selectedFields
object(optional)The fields to be included in the response.
- filter
string(optional)The filter conditions. Default is “all=,type_infomation=CUSTOMER,infomation_id=10000.
- sort
string(optional)The sorting order. Default is “Name asc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 1034,
"Name": "Battery"
}
],
"totalElements": 1
}Get Transporter Restriction Datatable Ajax With Customer ID ¶
Get Transporter Restriction Datatable Ajax With Customer IDGET/api/generators/get_transporter_restriction_datatable_ajax/{customer_id}/
Overview:
The Get Transporter Restriction Datatable Ajax API retrieves transportation restriction details for a specific transporter from the WasteLinq system. Information includes the unique identifier for the restriction, transportation company number, restriction name, portal default status, state ID, EPA ID, phone number, address, restriction status, approval documents, creation and modification dates, sub field, preference status, WasteLinq status, company transportation provision, user, from esc, broker identifier, network status, and customer identifier. This API is used primarily for retrieving transportation restriction details for a specific transporter and requires an Authorization token.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the transportation restriction detail |
| TransRestrictionDetail | object | Contains the details of the transportation restriction |
| id | number | The unique identifier for the transportation restriction |
| Tran_Com_Number | number | The transportation company number |
| Name | string | The name of the transportation restriction |
| Portal_Default | boolean | Indicates if the portal default is true |
| Transportation_State_ID | string | The state ID of the transportation |
| Transportation_EPA_ID | string | The EPA ID of the transportation |
| Transportation_Phone | string | The phone number of the transportation |
| Address1 | string | The first line of the address |
| Address2 | string | The second line of the address |
| City | string | The city of the address |
| State | string | The state of the address |
| Zip | string | The zip code of the address |
| Status | string | The status of the transportation restriction |
| Approval_Documents | string | The approval documents of the transportation restriction |
| Created_date | string | The creation date of the transportation restriction |
| Modified_date | string | The modification date of the transportation restriction |
| Sub_Field | string | The sub field of the transportation restriction |
| Preferred | boolean | Indicates if the transportation restriction is preferred |
| IsWasteLinq | boolean | Indicates if the transportation restriction is WasteLinq |
| is_company_transportation | boolean | Indicates if the company provides transportation |
| User | string | The user of the transportation restriction |
| from_esc | string | The from esc of the transportation restriction |
| Broker | number | The unique identifier for the broker |
| is_network | boolean | Indicates if the generator is in the network |
| Customer | number | The unique identifier for the customer |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 8,
"TransRestrictionDetail": {
"id": 10000,
"Tran_Com_Number": 10000,
"Name": "Company ABC",
"Portal_Default": false,
"Transportation_State_ID": "0",
"Transportation_EPA_ID": "10000",
"Transportation_Phone": "0",
"Address1": null,
"Address2": null,
"City": null,
"State": null,
"Zip": null,
"Status": "Active",
"Approval_Documents": null,
"Created_date": "2019-12-12T09:07:01.581474-06:00",
"Modified_date": "2022-07-18T17:04:48.414114-05:00",
"Sub_Field": null,
"Preferred": true,
"IsWasteLinq": false,
"is_company_transportation": false,
"User": null,
"from_esc": null,
"Broker": 26
},
"is_network": false,
"Customer": 10000
}
]
}Get Disposal Site Restriction Datatable Ajax With Customer ID ¶
Get Disposal Site Restriction Datatable Ajax With Customer IDGET/api/generators/get_disposal_site_restriction_datatable_ajax/{customer_id}/
Overview:
The Get Disposal Site Restriction Datatable Ajax API endpoint retrieves the disposal site restriction details for a specific customer. The customer is identified by the customer_id parameter in the URL. The response includes a wide range of information about the disposal site restriction, such as its ID, name, address, status, approval status, audit details, and much more. The response also includes information about the customer and whether the generator is in the network. This endpoint requires an authorization token in the request header.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the disposal site restriction detail |
| DisposalSiteRestrictionDetail | object | Contains the details of the disposal site restriction |
| id | number | The unique identifier for the disposal site restriction |
| Facility_ID | number | The facility ID of the disposal site |
| Name | string | The name of the disposal site |
| Portal_Default | boolean | Indicates if the portal default is true |
| Address1 | string | The first line of the address |
| Address2 | string | The second line of the address |
| City | string | The city of the address |
| State | string | The state of the address |
| Zip | string | The zip code of the address |
| State_ID | string | The state ID of the disposal site |
| EPA_ID | string | The EPA ID of the disposal site |
| Phone | string | The phone number of the disposal site |
| Phone_Ext | string | The phone extension of the disposal site |
| Fax | string | The fax number of the disposal site |
| string | The email of the disposal site | |
| Status | string | The status of the disposal site restriction |
| Approval_Status | string | The approval status of the disposal site restriction |
| Date_Last_Audited | string | The last audit date of the disposal site restriction |
| Audited_By_id | number | The unique identifier for the auditor |
| Audited_By1_id | number | The unique identifier for the secondary auditor |
| Approval_Documents | string | The approval documents of the disposal site restriction |
| Created_date | string | The creation date of the disposal site restriction |
| Modified_date | string | The modification date of the disposal site restriction |
| Approver | string | The approver of the disposal site restriction |
| IsDeleted | boolean | Indicates if the disposal site restriction is deleted |
| Internal | boolean | Indicates if the disposal site restriction is internal |
| Outage | boolean | Indicates if the disposal site restriction is in outage |
| Scheduling_Protocol | string | The scheduling protocol of the disposal site restriction |
| CommonName | string | The common name of the disposal site restriction |
| CustomFacilityName | string | The custom facility name of the disposal site restriction |
| Parent | number | The unique identifier for the parent disposal site restriction |
| eis_percent | string | The eis percent of the disposal site restriction |
| TSDF_Factor | string | The TSDF factor of the disposal site restriction |
| isRequiredLOA | boolean | Indicates if the LOA is required for the disposal site restriction |
| export_from_us | boolean | Indicates if the disposal site restriction is exported from US |
| port_of_entryexit | string | The port of entry/exit for the disposal site restriction |
| OutsideUSA | boolean | Indicates if the disposal site restriction is outside USA |
| ForeignerAddress | string | The foreigner address of the disposal site restriction |
| General_Manager | string | The general manager of the disposal site restriction |
| User | string | The user of the disposal site restriction |
| Broker | number | The unique identifier for the broker |
| AITemplate | number | The unique identifier for the AI template |
| ParentDisposalFacility | number | The unique identifier for the parent disposal facility |
| Customer | number | The unique identifier for the customer |
| Extrapolation_CPC | number | The extrapolation CPC of the disposal site restriction |
| Extrapolation_LBS | number | The extrapolation LBS of the disposal site restriction |
| Vendor | number | The unique identifier for the vendor |
| ESC_Links | array | The ESC links of the disposal site restriction |
| is_network | boolean | Indicates if the generator is in the network |
| Customer | number | The unique identifier for the customer |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"DisposalSiteRestrictionDetail": {
"id": 10000,
"Facility_ID": 10000,
"Name": "Company ABC",
"Portal_Default": false,
"Address1": "132, My Street, Kingston, New York 12401.",
"Address2": 132, My Street, Kingston, New York 12401.,
"City": "New York",
"State": "NY",
"Zip": "12401",
"State_ID": "10000",
"EPA_ID": "10000",
"Phone": "100-100-1000",
"Phone_Ext": null,
"Fax": null,
"Email": "",
"Status": "Active",
"Approval_Status": "Yes",
"Date_Last_Audited": "2019-01-01",
"Audited_By_id": 442,
"Audited_By1_id": 0,
"Approval_Documents": "[]",
"Created_date": "2019-12-12T09:07:07.034407-06:00",
"Modified_date": "2024-01-29T11:51:51.528517-06:00",
"Approver": "149,148",
"IsDeleted": false,
"Internal": false,
"Outage": false,
"Scheduling_Protocol": null,
"CommonName": "Company ABC",
"CustomFacilityName": null,
"Parent": null,
"eis_percent": "0",
"TSDF_Factor": "1.50",
"isRequiredLOA": false,
"export_from_us": false,
"port_of_entryexit": null,
"OutsideUSA": false,
"ForeignerAddress": null,
"General_Manager": null,
"User": null,
"Broker": 26,
"AITemplate": 15,
"ParentDisposalFacility": 1,
"Customer": null,
"Extrapolation_CPC": 8480,
"Extrapolation_LBS": 8480,
"Vendor": null,
"ESC_Links": [
26961
]
},
"is_network": false,
"Customer": 41024
}
]
}Get Technology Restriction Detail Datatable Ajax With Customer ID ¶
Get Technology Restriction Detail Datatable Ajax With Customer IDGET/api/generators/get_technology_restriction_detail_datatable_ajax/{customer_id}/
Overview:
The Get Technology Restriction Detail Datatable Ajax API endpoint retrieves the technology restriction details for a specific customer. The customer is identified by the customer_id parameter in the URL. The response includes information about the technology restriction such as its ID, name, and associated broker. It also indicates whether the generator is in the network and provides the customer’s unique identifier. This endpoint requires an authorization token in the request header.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| content | array | Contains the content of the response |
| id | number | The unique identifier for the technology restriction detail |
| TechnologyRestrictionDetail | object | Contains the details of the technology restriction |
| id | number | The unique identifier for the technology restriction |
| Name | string | The name of the technology restriction |
| Broker | number | The unique identifier for the broker |
| is_network | boolean | Indicates if the generator is in the network |
| Customer | number | The unique identifier for the customer |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 103,
"TechnologyRestrictionDetail": {
"id": 1033,
"Name": "Alternate Fuels",
"Broker": 31
},
"is_network": false,
"Customer": 10000
}
]
}Save Transportation Restriction ¶
Save Transportation RestrictionPOST/api/generators/save_transportation_restriction/
Overview:
The Save Transportation Restriction API endpoint allows the user to save transportation restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of transportation restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status, a message describing the result of the request, and an array containing the saved transportation restriction details, including the unique identifiers for the transportation restriction detail and the customer, and the name of the transportation restriction detail. This API is primarily used for managing and saving transportation restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the TransRestrictionDetail IDs |
| type_infomation | string | The type of information, in this case “CUSTOMER” |
| infomation_id | number | The unique identifier for the information |
| success | boolean | Indicates if the request was successful |
| message | string | A message describing the result of the request |
| data | array | An array of objects containing the data |
| id | number | The unique identifier for the data object |
| TransRestrictionDetail_id | number | The unique identifier for the TransRestrictionDetail |
| TransRestrictionDetail__Name | string | The name of the TransRestrictionDetail |
| Customer_id | number | The unique identifier for the Customer |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
119413
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully",
"data": [
{
"id": 16,
"TransRestrictionDetail_id": 10000,
"TransRestrictionDetail__Name": "Company ABC",
"Customer_id": 10000
}
]
}Delete Transportation Restriction ¶
Delete Transportation RestrictionPOST/api/generators/delete_transportation_restriction/
Overview:
The Delete Transportation Restriction API endpoint allows the user to delete transportation restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of transportation restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status and a message describing the result of the request. This API is primarily used for managing and deleting transportation restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the unique identifier for the data object |
| type_infomation | string | The type of information, in this case “CUSTOMER” |
| infomation_id | number | The unique identifier for the information |
| success | boolean | Indicates if the request was successful |
| message | string | A message describing the result of the request |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
16
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully"
}Save Disposal Site Restriction ¶
Save Disposal Site RestrictionPOST/api/generators/save_disposal_site_restriction/
Overview:
The Save Disposal Site Restriction API endpoint allows the user to save disposal site restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of disposal site restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status, a message describing the result of the request, and an array containing the saved disposal site restriction details, including the unique identifiers for the disposal site restriction detail and the customer, and the name of the disposal site restriction detail. This API is primarily used for managing and saving disposal site restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the the disposal site restriction detail IDs. |
| type_infomation | string | The type of information, in this case, “CUSTOMER”. |
| infomation_id | number | The unique identifier for the information. |
| success | boolean | Indicates whether the request was successful. |
| message | string | A message describing the result of the request. |
| data | array | An array containing the disposal site restriction details. |
| id | number | The unique identifier for the disposal site restriction detail. |
| DisposalSiteRestrictionDetail_id | number | The unique identifier for the disposal site restriction detail. |
| DisposalSiteRestrictionDetail__Name | string | The name of the disposal site restriction detail. |
| Customer_id | number | The unique identifier for the customer. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
21315
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully",
"data": [
{
"id": 10000,
"DisposalSiteRestrictionDetail_id": 10000,
"DisposalSiteRestrictionDetail__Name": "Company ABC",
"Customer_id": 10000
}
]
}Delete Disposal Site Restriction ¶
Delete Disposal Site RestrictionPOST/api/generators/delete_disposal_site_restriction/
Overview:
The Delete Disposal Site Restriction API endpoint allows the user to delete disposal site restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of disposal site restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status and a message describing the result of the request. This API is primarily used for managing and deleting disposal site restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the unique identifier for the data object |
| type_infomation | string | The type of information, in this case “CUSTOMER” |
| infomation_id | number | The unique identifier for the information |
| success | boolean | Indicates if the request was successful |
| message | string | A message describing the result of the request |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
1160
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully"
}Save Disposal Technology Restriction ¶
Save Disposal Technology RestrictionPOST/api/generators/save_disposal_technology_restriction/
Overview:
The Save Disposal Technology Restriction API endpoint allows the user to save disposal technology restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of technology restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status, a message describing the result of the request, and an array containing the saved technology restriction details, including the unique identifiers for the technology restriction detail and the customer, and the name of the technology restriction detail. This API is primarily used for managing and saving technology restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the technology restriction detail IDs. |
| type_infomation | string | The type of information, in this case, “CUSTOMER”. |
| infomation_id | number | The unique identifier for the information. |
| success | boolean | Indicates whether the request was successful. |
| message | string | A message describing the result of the request. |
| data | array | An array containing the technology restriction details. |
| id | number | The unique identifier for the technology restriction detail. |
| TechnologyRestrictionDetail_id | number | The unique identifier for the technology restriction detail. |
| TechnologyRestrictionDetail__Name | string | The name of the technology restriction detail. |
| Customer_id | number | The unique identifier for the customer. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
1034
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully",
"data": [
{
"id": 106,
"TechnologyRestrictionDetail_id": 1034,
"TechnologyRestrictionDetail__Name": "Battery",
"Customer_id": 10000
}
]
}Delete Disposal Technology Restriction ¶
Delete Disposal Technology RestrictionPOST/api/generators/delete_disposal_technology_restriction/
Overview:
The Delete Disposal Technology Restriction API endpoint allows the user to delete disposal technology restriction details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and accepts an array of technology restriction detail IDs, the type of information (in this case, “CUSTOMER”), and the unique identifier for the information. The API returns a success status and a message describing the result of the request. This API is primarily used for managing and deleting technology restriction details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| data | array | An array containing the unique identifier for the data object |
| type_infomation | string | The type of information, in this case “CUSTOMER” |
| infomation_id | number | The unique identifier for the information |
| success | boolean | Indicates if the request was successful |
| message | string | A message describing the result of the request |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"data": [
106
],
"type_infomation": "CUSTOMER",
"infomation_id": 10000
}200Headers
Content-Type: application/jsonBody
{
"success": true,
"message": "Successfully"
}Get List Disposal Site ¶
Get List Disposal SiteGET/api/generators/get_list_disposal_site/
Overview:
The Get List Disposal Site API endpoint retrieves a list of disposal sites associated with a specific generator in the WasteLinq system. This endpoint requires an Authorization token and returns a success status, an array containing the disposal site details, including the unique identifiers for the disposal site, profile coordinator, broker, and user, the name of the disposal site, whether the disposal site is deleted, and the total number of elements in the content array. This API is primarily used for managing and accessing the list of disposal sites for a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the disposal site details. |
| id | number | The unique identifier for the disposal site. |
| Name | string | The name of the disposal site. |
| IsDeleted | boolean | Indicates whether the disposal site is deleted. |
| ProfileCoordinator | number | The unique identifier for the profile coordinator. |
| Broker | number | The unique identifier for the broker. |
| User | number | The user associated with the disposal site. |
| totalElements | number | The total number of elements in the content array. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 1,
"Name": "Company ABC",
"IsDeleted": false,
"ProfileCoordinator": 1000,
"Broker": 10,
"User": 100
}
],
"totalElements": 1
}Custom Fee ¶
Custom FeeGET/api/generators/custom_fee/{customer_id}/
Overview:
The Custom Fee API endpoint retrieves a list of custom fees associated with a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. The API returns a success status, an array containing the fee details, including the unique identifier for the fee, the default fee details, the name, type, value, application, status, creation date, modification date of the fee, whether the fee is different from the default, whether the fee is a network fee, whether the fee is locked, the unique identifier for the creator and modifier of the fee, the unique identifier for the customer, and the total number of elements in the content array. This API is primarily used for managing and accessing the list of custom fees for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the fee details. |
| id | number | The unique identifier for the fee. |
| DefaultFee | object | The default fee details. |
| Name | string | The name of the fee. |
| Type | string | The type of the fee. |
| Value | string | The value of the fee. |
| Apply | string | The application of the fee. |
| Status | string | The status of the fee. |
| Created_date | string | The creation date of the fee. |
| Modified_date | string | The modification date of the fee. |
| IsDifferentFromDefault | boolean | Indicates whether the fee is different from the default. |
| is_network_fee | boolean | Indicates whether the fee is a network fee. |
| is_locked | boolean | Indicates whether the fee is locked. |
| Creator | number | The unique identifier for the creator of the fee. |
| Modifier | number | The unique identifier for the modifier of the fee. |
| Customer | number | The unique identifier for the customer. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"DefaultFee": {
"id": 10,
"Name": "Franchise Fee 1",
"Type": "Rate",
"Value": "8",
"Apply": "All",
"Created_date": "2023-06-30T14:04:29.458042-05:00",
"Modified_date": "2024-03-26T01:33:51.014610-05:00",
"IsDeleted": false,
"Status": "Inactive",
"Creator": 248,
"Modifier": 3804,
"Broker": 31
},
"Name": "Franchise Fee 1",
"Type": "Rate",
"Value": "8",
"Apply": "All",
"Status": "Inactive",
"Created_date": "2023-06-30T14:04:33.782133-05:00",
"Modified_date": "2024-03-26T01:34:07.226096-05:00",
"IsDifferentFromDefault": true,
"is_network_fee": false,
"is_locked": false,
"Creator": 248,
"Modifier": 3804,
"Customer": 41024
}
],
"totalElements": 1
}Pricing ¶
PricingGET/api/generators/pricing/{customer_id}/
Overview:
The Pricing API endpoint retrieves the pricing details associated with a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. The API returns a success status, an object containing the pricing details, including the unique identifier for the pricing, whether the pricing is a network, the unique identifier for the customer, the base container size and rate, the equivalent rate, the pricing protocol, whether document fees are applied, the pricing expiration date, the washout cost, the fuel surcharge rate, whether the pricing is exempt, an array containing the files associated, and the total number of elements in the content array. This API is primarily used for managing and accessing the pricing details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | object | An object containing the pricing details. |
| id | number | The unique identifier for the pricing. |
| is_network | boolean | Indicates whether the pricing is a network. |
| Customer | number | The unique identifier for the customer. |
| Base_Container_Size | number | The base container size. |
| Base_Container_Rate | number | The base container rate. |
| Equilvalent_Rate | string | The equivalent rate . |
| Pricing_Protocol | string | The pricing protocol. |
| Document_Fees_Applied | boolean | Indicates whether document fees are applied. |
| Pricing_Expiration_Date | string | The pricing expiration date. |
| Washout_Cost | null | The washout cost. |
| Fuel_Surcharge_Rate | number | The fuel surcharge rate. |
| Fuel_Surcharge_Exempt | boolean | Indicates whether the generator is exempt from fuel surcharge. |
| files | array | An array containing the files associated. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"id": 1000,
"is_network": false,
"Customer": 10000,
"Base_Container_Size": 100,
"Base_Container_Rate": 0,
"Equilvalent_Rate": "0.00",
"Pricing_Protocol": "",
"Document_Fees_Applied": false,
"Pricing_Expiration_Date": "2024-03-30",
"Washout_Cost": null,
"Fuel_Surcharge_Rate": 9999999,
"Fuel_Surcharge_Exempt": false,
"files": []
},
"totalElements": 1
}Get Container Size List ¶
Get Container Size ListGET/api/generators/get_container_size_list/
Overview:
The Get Container Size List API endpoint retrieves a list of container sizes available for generators in the WasteLinq system. This endpoint requires an Authorization token. The API returns a success status and an array containing the details of each container size, including a unique identifier, size, and weight. The total number of elements in the response is also returned. This API is primarily used for retrieving and managing the list of available container sizes for generators.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the details of the generator. |
| id | number | The unique identifier for the generator. |
| Size | string | The size of the generator. |
| Weight | number | The weight of the generator. |
| totalElements | number | The total number of elements in the response. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10,
"Size": "0.25",
"Weight": 20
}
],
"totalElements": 1
}Change Container Sizes ¶
Change Container SizesGET/api/generators/get_container_size_list/{?size,base_container_rate}
Overview:
The Change Container Sizes API endpoint allows for the modification of container sizes in the WasteLinq system. This endpoint requires an Authorization token. An optional parameter are the base_container_rate and size. The API returns a success status and an object containing the details of the modified container size, including the size, base conversion rate, and equivalent rate. This API is primarily used for managing and modifying the sizes of containers in the system.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| TransCodeSize | object | Contains the details of the container size. |
| Container_Size | string | The size of the container. |
| Base_Conversion | number | The base conversion rate for the container size. |
| Equilvalent_Rate | string | The equivalent rate for the container size. |
Example URI
- size
number(optional)The size of the container to be modified.
- base_container_rate
number(optional)The base conversion rate for the container size. If provided, this value will be used to modify the base conversion rate of the specified container size.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"TransCodeSize": {
"Container_Size": "10",
"Base_Conversion": 0.7,
"Equilvalent_Rate": "0.00"
}
}Material Pricing ¶
Material PricingGET/api/generators/material_pricing/{customer_id}/{?page,pageSize,selectedFields,filter,sort}
Overview:
The Material Pricing API endpoint in the WasteLinq system fetches material pricing details for a specific customer. It requires an Authorization token and a customer_id. The API returns a success status and an array of pricing details, including identifiers for material pricing, customer profile, final TSDF, container type and size, shipping units, process code, cost basis and cost, act basis, custom price, minimum price, activity status, trans type, washout type, and pricing status. It also indicates if it is bulk and the type of pricing. The API also returns arrays of trans types and washout types. Primarily, this API is used for managing and accessing material pricing details for a customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the pricing details. |
| material_pricing_id | string | The unique identifier for the material pricing. |
| ProcessingDetail__CustomerProfile__id | string | The unique identifier for the customer profile. |
| ProcessingDetail__CustomerProfile__Profile_Number | string | The profile number of the customer. |
| ProcessingDetail__CustomerProfile__Name | string | The name of the customer profile. |
| Final_TSDF__Name | string | The name of the final TSDF. |
| Final_TSDF__Approval_Status | string | The approval status of the final TSDF. |
| Container_Type__Code | string | The code of the container type. |
| Container_Size__Size | string | The size of the container. |
| Shipping_Units | string | The shipping units. |
| ProcessCode__Code | string | The process code. |
| Cost_Basis__Name | string | The name of the cost basis. |
| Cost | string | The cost. |
| Min_Cost | string | The minimum cost. |
| Act_Basis__Name | string | The name of the act basis. |
| custom_price | string | The custom price. |
| Min_Price | string | The minimum price. |
| Active | string | Indicates whether the pricing is active. |
| TransType_id | string | The unique identifier for the trans type. |
| WashOutType_id | string | The unique identifier for the washout type. |
| isbulk | string | Indicates whether it is bulk. |
| id | string | The unique identifier for the pricing. |
| status | string | The status of the pricing. |
| network_or_enterprise | string | The type of the pricing, either “Network” or “Enterprise”. |
| TransTypes | array | An array containing the trans types. |
| WashOutTypes | array | An array containing the washout types. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
- page
number(optional)The page number for pagination. Default is 0.
- pageSize
number(optional)The number of items per page for pagination. Default is 100.
- selectedFields
object(optional)The fields to be included in the response.
- filter
string(optional)The filter conditions. Default is “all=,is_showing_cancelled=false”.
- sort
string(optional)The sorting order. Default is “id desc”.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"material_pricing_id": "10000",
"ProcessingDetail__CustomerProfile__id": "10000",
"ProcessingDetail__CustomerProfile__Profile_Number": "100000",
"ProcessingDetail__CustomerProfile__Name": "New Profile #10000",
"Final_TSDF__Name": "Company ABC",
"Final_TSDF__Approval_Status": "Expired",
"Container_Type__Code": "BA",
"Container_Size__Size": "202",
"Shipping_Units": "G",
"ProcessCode__Code": "7600",
"Cost_Basis__Name": "Per Container",
"Cost": "190.000",
"Min_Cost": ".000",
"Act_Basis__Name": "Per Container",
"custom_price": "0",
"Min_Price": "0",
"Active": "Yes",
"TransType_id": "None",
"WashOutType_id": "None",
"isbulk": "False",
"id": "10000",
"status": "2",
"network_or_enterprise": "Network",
"TransTypes": [
{
"id": "0",
"name": "None"
},
{
"id": "785",
"name": "Empty Drum"
},
{
"id": "784",
"name": "Empty Tote"
},
{
"id": "781",
"name": "Package - Container"
},
{
"id": "786",
"name": "Package - Per Hour"
},
{
"id": "782",
"name": "Package - Trip Fee"
}
],
"WashOutTypes": []
}
],
"totalElements": 1
}Products Services Pricing ¶
Products Services PricingGET/api/generators/products_services_pricing/{customer_id}/
Overview:
The Products Services Pricing API endpoint retrieves the product service pricing details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. The API returns a success status and an array containing the product service details, including the unique identifier for the product service, product service details, unit of measure details, product number, product item, general description, price, general ledger revenue account, general ledger cost account, services, DOT description, volume, weight, status, creation date, modification date, vendor type, esc id, type, user, broker, description, size, amount, change indicator, order, network indicator, and the unique identifier for the customer. The API is primarily used for managing and accessing the product service pricing details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the product service details. |
| id | number | The unique identifier for the product service. |
| Product_Service | object | An object containing the product service details. |
| UM | object | An object containing the unit of measure details. |
| Product_Number | number | The product number. |
| Product_Item | string | The product item. |
| General_Description | string | The general description of the product service. |
| Price | string | The price of the product service. |
| GL_Revenue | string | The general ledger revenue account. |
| GL_Cost | string | The general ledger cost account. |
| Services | array | An array containing the services. |
| DOT_Description | null | The DOT description of the product service. |
| Volume | null | The volume of the product service. |
| Weight | null | The weight of the product service. |
| Status | string | The status of the product service. |
| Created_date | null | The creation date of the product service. |
| Modified_date | string | The modification date of the product service. |
| vendor_type | null | The vendor type of the product service. |
| esc_id | null | The esc id of the product service. |
| Type | number | The type of the product service. |
| User | null | The user of the product service. |
| Broker | number | The broker of the product service. |
| Description | string | The description of the product service. |
| Size | string | The size of the product service. |
| Amount | string | The amount of the product service. |
| Is_Change | number | Indicates whether there is a change in the product service. |
| Order | number | The order of the product service. |
| is_network | boolean | Indicates whether the product service is a network. |
| Customer | number | The unique identifier for the customer. |
| totalElements | number | The total number of elements in the content array. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 10000,
"Product_Service": {
"id": 1000,
"UM": {
"id": 100,
"Name": "Each",
"Broker": 10
},
"Product_Number": 100,
"Product_Item": "100",
"General_Description": "TRANSPORTATION - Fuel Surcharge",
"Price": "0",
"GL_Revenue": "408800",
"GL_Cost": "508800",
"Services": [
"Non-Inventory Control Item"
],
"DOT_Description": null,
"Volume": null,
"Weight": null,
"Status": "Active",
"Created_date": null,
"Modified_date": "2020-06-10T07:41:22.234546-05:00",
"vendor_type": null,
"esc_id": null,
"Type": 399,
"User": null,
"Broker": 31
},
"Description": "TRANSPORTATION - Fuel Surcharge",
"Size": "",
"Amount": "0",
"Is_Change": 1,
"Order": 0,
"is_network": false,
"Customer": 41024
}
],
"totalElements": 1
}Products Services ¶
Products ServicesGET/api/generators/products_services/
Overview:
The Products Services API endpoint retrieves the product service details for a specific generator in the WasteLinq system. This endpoint requires an Authorization token. The API returns a success status and an array containing the product service details, including the unique identifier for the product service, unit of measure details, product number, product item, general description, price, general ledger revenue account, general ledger cost account, services, DOT description, volume, weight, status, creation date, modification date, vendor type, esc id, type, user, and broker. The API is primarily used for managing and accessing the product service details for a specific generator.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the product service details. |
| id | number | The unique identifier for the product service. |
| UM | object | An object containing the unit of measure details. |
| Product_Number | number | The product number. |
| Product_Item | string | The product item. |
| General_Description | string | The general description of the product service. |
| Price | string | The price of the product service. |
| GL_Revenue | string | The general ledger revenue account. |
| GL_Cost | string | The general ledger cost account. |
| Services | array | An array containing the services. |
| DOT_Description | null | The DOT description of the product service. |
| Volume | null | The volume of the product service. |
| Weight | null | The weight of the product service. |
| Status | string | The status of the product service. |
| Created_date | null | The creation date of the product service. |
| Modified_date | string | The modification date of the product service. |
| vendor_type | string | The vendor type of the product service. |
| esc_id | null | The esc id of the product service. |
| Type | number | The type of the product service. |
| User | null | The user of the product service. |
| Broker | number | The broker of the product service. |
| totalElements | number | The total number of elements in the content array. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": 1000,
"UM": {
"id": 1000,
"Name": "Each",
"Broker": 10
},
"Product_Number": 10,
"Product_Item": "100",
"General_Description": "TRANSPORTATION - 10gl Cont",
"Price": "0",
"GL_Revenue": "408140",
"GL_Cost": "508140",
"Services": [
"Non-Inventory Control Item"
],
"DOT_Description": null,
"Volume": null,
"Weight": null,
"Status": "Active",
"Created_date": null,
"Modified_date": "2023-06-09T10:33:53.687605-05:00",
"vendor_type": "",
"esc_id": null,
"Type": 399,
"User": null,
"Broker": 31
}
],
"totalElements": 1
}Auto Generate Product Services ¶
Auto Generate Product ServicesPOST/api/generators/auto_generate_product_services/
Overview:
The Auto Generate Product Services API endpoint generates the product service details for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a JSON body containing the customer_id, equivalent_rate, base_containers, bulk_containers, document_fee, eis_exempt, eis_rate, fuel_surcharge_exempt, fuel_surcharge_rate, washout_rate, and is_washout_type. The API returns a success status and an array containing the product service details, including the unique identifier for the product service, product item, general description, amount, unit of measure, change indicator, and size. The API is primarily used for automatically generating and managing the product service details for a specific customer.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| customer_id | number | The unique identifier for the customer. |
| equilvalent_rate | string | The equivalent rate for the customer. |
| base_containers | array | An array containing the base containers for the customer. |
| bulk_containers | array | An array containing the bulk containers for the customer. |
| document_fee | number | The document fee for the customer. |
| eis_exempt | number | Indicates whether the customer is exempt from EIS. |
| eis_rate | number | The EIS rate for the customer. |
| fuel_surcharge_exempt | number | Indicates whether the customer is exempt from fuel surcharge. |
| fuel_surcharge_rate | number | The fuel surcharge rate for the customer. |
| washout_rate | string | The washout rate for the customer. |
| is_washout_type | number | Indicates whether the customer has a washout type. |
| success | boolean | Indicates whether the request was successful. |
| content | array | An array containing the product service details. |
| id | null | The unique identifier for the product service. |
| Product_Service_id | number | The unique identifier for the product service. |
| Product_Item | string | The product item. |
| General_Description | string | The general description of the product service. |
| Amount | string | The amount of the product service. |
| UM | string | The unit of measure for the product service. |
| is_change | boolean | Indicates whether there is a change in the product service. |
| Size | string | The size of the product service. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}Body
{
"customer_id": 10000,
"equilvalent_rate": "0.00",
"base_containers": [],
"bulk_containers": [],
"document_fee": 0,
"eis_exempt": 0,
"eis_rate": 0,
"fuel_surcharge_exempt": 0,
"fuel_surcharge_rate": 100,
"washout_rate": "10",
"is_washout_type": 0
}201Headers
Content-Type: application/jsonBody
{
"success": true,
"content": [
{
"id": null,
"Product_Service_id": 1000,
"Product_Item": "100",
"General_Description": "TRANSPORTATION - Fuel Surcharge",
"Amount": "",
"UM": "Each",
"is_change": false,
"Size": ""
}
]
}Upload File Service Profile ¶
Upload File Service ProfilePOST/api/generators/upload_file_service_profile/{customer_id}/
Overview:
The Upload File Service Profile API endpoint allows for the uploading of a file related to a specific customer’s service profile in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. The file to be uploaded is included in the body of the request as form-data. The API returns a success status and a stringified array containing the file details, including the filename, the full URL of the uploaded file, and a unique identifier for the uploaded file. This API is primarily used for managing and uploading files related to a customer’s service profile.
Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| customer_id | number | The unique identifier for the customer. |
| content | string | A stringified array containing the file details. |
| filename | string | The name of the uploaded file. |
| fullname | string | The full URL of the uploaded file. |
| id | number | The unique identifier for the uploaded file. |
Example URI
- customer_id
number(required)The unique identifier for the customer.
Headers
Content-Type: application/html
Authorization: {TOKEN}Body
------WebKitFormBoundaryYVJK4vBfu6rnpjf2
Content-Disposition: form-data; name="file"; filename="test.html"
Content-Type: text/html
------WebKitFormBoundaryYVJK4vBfu6rnpjf2--
200Headers
Content-Type: application/jsonBody
{
"success": true,
"customer_id": 10000,
"content": "[{\"filename\": \"test.html\", \"fullname\": \"https://upload/test.html\", \"id\": 10000}]"
}Export PDF Price List ¶
Export PDF Price ListGET/api/generators/export_pdf_price_list/{customer_id}/{?list_prodetail,list_unchkprodetail,SAll}
Overview:
The Export PDF Price List API endpoint generates a PDF document containing the price list for a specific customer in the WasteLinq system. This endpoint requires an Authorization token and a customer_id as a parameter. Optional parameters include a comma-separated list of product detail identifiers (list_prodetail), a comma-separated list of unchecked product detail identifiers (list_unchkprodetail), and a flag or filter parameter (SAll). The API returns a PDF document containing the price list for the specified customer. This API is primarily used for generating and exporting price lists in a PDF format.
Example URI
- customer_id
number(required)The unique identifier for the customer.
- list_prodetail
string(optional)A comma-separated list of product detail identifiers.
- list_unchkprodetail
string(optional)A comma-separated list of unchecked product detail identifiers.
- SAll
string(optional)A parameter that could be used as a flag or filter in the API request.
Headers
Content-Type: Query String
Authorization: {TOKEN}200Headers
Content-Type: PDF