BillTos APIs

Overview ¶

The BillTo API provides a comprehensive suite of endpoints for managing billing information within our system. It allows for the retrieval, creation, update, and deletion of “Bill To” entities, which represent the parties responsible for payment in various transactions. This API is designed to streamline billing operations, enhance data accuracy, and improve the efficiency of financial workflows.

Key Features:

Retrieve Bill To Information: Fetch detailed billing information for a specific entity or list all entities with pagination and filtering options.
Create New Bill To: Add new billing entities to the system, including all relevant details such as name, address, and contact information.
Update Existing Bill To: Modify the details of an existing billing entity to keep the information current and accurate.
Delete Bill To: Remove billing entities that are no longer needed or relevant.

This API is essential for businesses looking to automate their billing processes, ensuring that billing information is easily accessible, manageable, and up-to-date.

Bearer Token

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

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

Authorization: Bearer <Your-Bearer-Token>

Replace with your actual bearer token.

For example:

Authorization: Bearer 5262d64b892e8d4341000001

Error Messages

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

BillTos APIs ¶

The BillTos APIs facilitate the management of billing entities, enabling operations such as retrieval, creation, updating, and deletion of bill-to records. These APIs are crucial for maintaining accurate and up-to-date billing information, streamlining financial transactions and enhancing overall operational efficiency.

billtos ¶

billtos
GET`/api/billtos{?page,pageSize,filter,sort}`

Overview:

This endpoint retrieves a list of billing entities, known as “bill tos,” based on specified query parameters such as page number, items per page, search filter, and sort order. It is designed to provide clients with detailed information about their billing contacts, including unique identifiers, customer bill to ID, name, legacy billing ID, contact information, and status. This service is crucial for clients aiming to manage their billing information efficiently, ensuring accurate and up-to-date billing records are accessible. The response includes a comprehensive list of bill tos, facilitating effective billing management and compliance.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of bill tos.
id	integer	The ID of the bill to.
Customer_Bill_To_ID	integer	The customer bill to ID.
Bill_To_Name	string	The name of the bill to.
Legacy_Billing_ID	string	The legacy billing ID.
Billing_Contact	string	The billing contact.
Billing_Phone	string	The billing phone number.
Billing_Email	string	The billing email.
Status	string	The status of the bill to.
IsDelete	boolean	The status of the bill to.
totalElements	integer	The total number of bill tos.

Example URI

GET https://test-api.wastelinq.com./api/billtos?page=&pageSize=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The search filter.
sort: string (optional)
The sort order.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 8,
      "Customer_Bill_To_ID": 16687,
      "Bill_To_Name": "Company A",
      "Legacy_Billing_ID": null,
      "Billing_Contact": "Jane Doe",
      "Billing_Phone": "100-100-1000",
      "Billing_Email": "test@test.com",
      "Status": "Active",
      "IsDelete": false
    }
  ],
  "totalElements": 1
}

get_billto_detail ¶

get_billto_detail
GET`/api/billtos/get_billto_detail{?billToId}`

Overview:

This endpoint retrieves detailed information about a specific bill to entity based on the provided bill to ID. It is designed to provide clients with comprehensive details about a specific bill to, including unique identifiers, name, address, status, contact information, electronic billing status, payment terms, and payment type. This service is essential for clients aiming to access detailed information about a specific bill to entity, facilitating effective billing management and compliance.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The bill to details.
id	integer	The ID of the bill to.
billToName	string	The name of the bill to.
address1	string	The first address line.
address2	string	The second address line.
status	string	The status of the bill to.
city	string	The city.
state	string	The state.
zip	string	The ZIP code.
county	string	The county.
country	string	The country.
electronicBilling	boolean	The electronic billing status.
legecybillingId	string	The legacy billing ID.
outside	boolean	The outside status.
currentBalance	string	The current balance.
creditLine	string	The credit line.
dunBradstreet	string	The Dun & Bradstreet number.
note	string	The note.
paymentTerm	integer	The payment term.
paymentType	string	The payment type.
billToContactArr	array	The list of bill to contacts.
billToContactArr.id	integer	The ID of the bill to contact.
billToContactArr.master_contact_id	integer	The master contact ID.
billToContactArr.firstname	string	The first name of the bill to contact.
billToContactArr.lastname	string	The last name of the bill to contact.
billToContactArr.companytitle	string	The company title of the bill to contact.
billToContactArr.address1	string	The first address line of the bill to contact.
billToContactArr.address2	string	The second address line of the bill to contact.
billToContactArr.city	string	The city of the bill to contact.
billToContactArr.state	string	The state of the bill to contact.
billToContactArr.zip	string	The ZIP code of the bill to contact.
billToContactArr.inactive	boolean	The inactive status of the bill to contact.
billToContactArr.contact	integer	The contact ID of the bill to contact.
billToContactArr.billto_contacts	integer	The bill to contact ID.
billToContactArr.status	string	The status of the bill to contact.
billToContactArr.type	string	The type of the bill to contact.
billToContactArr.email	string	The email of the bill to contact.
billToContactArr.phone	string	The phone number of the bill to contact.

Example URI

GET https://test-api.wastelinq.com./api/billtos/get_billto_detail?billToId=

URI Parameters

HideShow

billToId: number (required)
The ID of the bill to.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": 16297,
    "billToName": "Company A",
    "address1": "132, My Street, Kingston, New York 12401.",
    "address2": "132, My Street, Kingston, New York 12401.",
    "status": "Active",
    "city": "New York",
    "state": "NY",
    "zip": "12401",
    "county": null,
    "country": "United States",
    "electronicBilling": false,
    "legecybillingId": null,
    "outside": false,
    "currentBalance": null,
    "creditLine": null,
    "dunBradstreet": null,
    "note": null,
    "paymentTerm": 454,
    "paymentType": null,
    "billToContactArr": [
      {
        "id": 32077,
        "master_contact_id": 60091,
        "firstname": "Jane",
        "lastname": "Doe",
        "companytitle": null,
        "address1": null,
        "address2": null,
        "city": null,
        "state": "",
        "zip": null,
        "inactive": false,
        "contact": 1015673,
        "billto_contacts": 42077,
        "status": "2",
        "type": null,
        "email": "test@test.com",
        "phone": "222-222-2222"
      },
      {
        "id": 5392,
        "master_contact_id": 36808,
        "firstname": null,
        "lastname": null,
        "companytitle": null,
        "address1": null,
        "address2": null,
        "city": null,
        "state": null,
        "zip": null,
        "inactive": null,
        "contact": null,
        "billto_contacts": 15392,
        "status": "2",
        "type": "1",
        "email": "test@test.com",
        "phone": "222-222-2222"
      }
    ]
  }
}

get_contact_billto_by_search_str ¶

get_contact_billto_by_search_str
GET`/api/billtos/get_contact_billto_by_search_str{?searchValue}`

Overview:

This endpoint retrieves a list of bill to contacts based on the specified search value. It is designed to provide clients with detailed information about bill to contacts, including unique identifiers, first name, last name, title, email, and phone number. This service is essential for clients aiming to access detailed information about bill to contacts, facilitating effective billing management and compliance.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of bill to contacts.
id	integer	The ID of the bill to contact.
firstname	string	The first name of the bill to contact.
lastname	string	The last name of the bill to contact.
title	string	The title of the bill to contact.
email	string	The email of the bill to contact.
phone	string	The phone number of the bill to contact.

Example URI

GET https://test-api.wastelinq.com./api/billtos/get_contact_billto_by_search_str?searchValue=

URI Parameters

HideShow

searchValue: string (required)
The search value.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 86676,
      "firstname": "kien",
      "lastname": "test",
      "title": "qa",
      "email": "kienqa@gmail.com",
      "phone": "012-345-6789"
    }
  ]
}

get_master_contact_by_id ¶

get_master_contact_by_id
GET`/api/billtos/get_master_contact_by_id{?id}`

Overview:

This endpoint retrieves detailed information about a specific master contact based on the provided master contact ID. It is designed to provide clients with comprehensive details about a specific master contact, including unique identifiers, first name, last name, title, address, city, state, ZIP code, inactive status, type, company, phone numbers, and email addresses. This service is essential for clients aiming to access detailed information about a specific master contact, facilitating effective billing management and compliance.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The master contact details.
id	integer	The ID of the master contact.
firstname	string	The first name of the master contact.
lastname	string	The last name of the master contact.
title	string	The title of the master contact.
address1	string	The first address line of the master contact.
address2	string	The second address line of the master contact.
city	string	The city of the master contact.
state	string	The state of the master contact.
zip	string	The ZIP code of the master contact.
inactive	boolean	The inactive status of the master contact.
type	string	The type of the master contact.
company	string	The company of the master contact.
phoneList	array	The list of phone numbers.
phoneList.id	integer	The ID of the phone number.
phoneList.label	string	The label of the phone number.
phoneList.phoneNumber	string	The phone number.
phoneList.extensionStr	string	The extension of the phone number.
phoneList.isSelectLabel	boolean	The select label status of the phone number.
emailList	array	The list of email addresses.
emailList.id	integer	The ID of the email address.
emailList.label	string	The label of the email address.
emailList.emailStr	string	The email address.
emailList.isSelectLabel	boolean	The select label status of the email address.

Example URI

GET https://test-api.wastelinq.com./api/billtos/get_master_contact_by_id?id=

URI Parameters

HideShow

id: number (required)
The ID of the master contact.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "company": "",
    "phoneList": [
      {
        "id": 0,
        "label": "Work",
        "phoneNumber": "111-111-1111",
        "extensionStr": null,
        "isSelectLabel": false
      }
    ],
    "emailList": [
      {
        "id": 0,
        "label": "Work",
        "emailStr": "htran@wastelinq.com",
        "isSelectLabel": false
      }
    ],
    "id": 35701,
    "firstname": "test",
    "lastname": "test",
    "title": null,
    "address1": "14173 Northwest Freeway #134",
    "address2": null,
    "city": "Houston",
    "state": "TX",
    "zip": "77388",
    "inactive": false,
    "type": "0"
  }
}

create_billto_contact_data ¶

create_billto_contact_data
POST`/api/billtos/create_billto_contact_data`

Overview:

This endpoint creates a new bill to contact based on the provided contact data. It is designed to allow clients to add new bill to contacts to their billing entities, facilitating effective billing management and compliance. The service requires clients to provide detailed contact information, including first name, last name, title, address, city, state, ZIP code, phone numbers, and email addresses. This service is essential for clients aiming to add new bill to contacts to their billing entities, ensuring accurate and up-to-date billing records are maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The new bill to contact details.
Company	string	The company of the bill to contact.
Phone	string	The phone number of the bill to contact.
Email	string	The email of the bill to contact.
id	integer	The ID of the bill to contact.
master_contact_id	integer	The master contact ID.
firstname	string	The first name of the bill to contact.
lastname	string	The last name of the bill to contact.
title	string	The title of the bill to contact.
address1	string	The first address line of the bill to contact.
address2	string	The second address line of the bill to contact.
city	string	The city of the bill to contact.
state	string	The state of the bill to contact.
zip	string	The ZIP code of the bill to contact.
inactive	boolean	The inactive status of the bill to contact.
contactNumber	integer	The contact number of the bill to contact.
vendorNumber	integer	The vendor number of the bill to contact.
status	string	The status of the bill to contact.

Example URI

POST https://test-api.wastelinq.com./api/billtos/create_billto_contact_data

Request

HideShow

Headers

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

Body

{
  "company": "",
  "phoneList": [
    {
      "id": 0,
      "label": "Work",
      "phoneNumber": "222-222-2222",
      "extensionStr": null,
      "isSelectLabel": false
    }
  ],
  "emailList": [
    {
      "id": 0,
      "label": "Work",
      "emailStr": "test@test.com",
      "isSelectLabel": false
    }
  ],
  "id": 35701,
  "firstname": "test",
  "lastname": "test",
  "title": null,
  "address1": "132, My Street, Kingston, New York 12401.",
  "address2": "132, My Street, Kingston, New York 12401.",
  "city": "Kingston",
  "state": "NY",
  "zip": "12401",
  "inactive": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "Company": "",
    "Phone": "222-222-2222",
    "Email": "test@test.com",
    "id": null,
    "master_contact_id": 35701,
    "firstname": "test",
    "lastname": "test",
    "title": null,
    "address1": "132, My Street, Kingston, New York 12401.",
    "address2": "132, My Street, Kingston, New York 12401.",
    "city": "Kingston",
    "state": "NY",
    "zip": "12401",
    "inactive": false,
    "contactNumber": 36134,
    "vendorNumber": 1023332,
    "status": "Active"
  }
}

add_new_contact_billto ¶

add_new_contact_billto
POST`/api/billtos/add_new_contact_billto`

Overview:

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The new bill to contact details.
Company	string	The company of the bill to contact.
Phone	string	The phone number of the bill to contact.
Email	string	The email of the bill to contact.
id	integer	The ID of the bill to contact.
master_contact_id	integer	The master contact ID.
firstname	string	The first name of the bill to contact.
lastname	string	The last name of the bill to contact.
title	string	The title of the bill to contact.
address1	string	The first address line of the bill to contact.
address2	string	The second address line of the bill to contact.
city	string	The city of the bill to contact.
state	string	The state of the bill to contact.
zip	string	The ZIP code of the bill to contact.
inactive	boolean	The inactive status of the bill to contact.
contactNumber	integer	The contact number of the bill to contact.
vendorNumber	integer	The vendor number of the bill to contact.
status	string	The status of the bill to contact.

Example URI

POST https://test-api.wastelinq.com./api/billtos/add_new_contact_billto

Request

HideShow

Headers

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

Body

{
  "id": null,
  "firstname": "kien",
  "lastname": "test",
  "title": "qa",
  "phoneList": [
    {
      "label": "Work",
      "phoneNumber": "012-345-6789",
      "extensionStr": "",
      "isSelectLabel": false,
      "id": 1
    }
  ],
  "emailList": [
    {
      "label": "Work",
      "emailStr": "kienqa@gmail.com",
      "isSelectLabel": false,
      "id": 1
    }
  ],
  "address1": "test",
  "address2": "test",
  "city": "test",
  "state": "CO",
  "zip": "10001",
  "inactive": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "Company": "",
    "Phone": "012-345-6789",
    "Email": "kienqa@gmail.com",
    "id": null,
    "master_contact_id": 86678,
    "firstname": "kien",
    "lastname": "test",
    "title": "qa",
    "address1": "test",
    "address2": "test",
    "city": "test",
    "state": "CO",
    "zip": "10001",
    "inactive": false,
    "contactNumber": 1040302,
    "vendorNumber": 10425,
    "status": "Active"
  }
}

edit_contact_billto ¶

edit_contact_billto
POST`/api/billtos/edit_contact_billto`

Overview:

This endpoint updates an existing bill to contact based on the provided contact data. It is designed to allow clients to modify bill to contacts in their billing entities, facilitating effective billing management and compliance. The service requires clients to provide detailed contact information, including first name, last name, title, address, city, state, ZIP code, phone numbers, and email addresses. This service is essential for clients aiming to update bill to contacts in their billing entities, ensuring accurate and up-to-date billing records are maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	object	The new bill to contact details.
Company	string	The company of the bill to contact.
Phone	string	The phone number of the bill to contact.
Email	string	The email of the bill to contact.
id	integer	The ID of the bill to contact.
master_contact_id	integer	The master contact ID.
firstname	string	The first name of the bill to contact.
lastname	string	The last name of the bill to contact.
title	string	The title of the bill to contact.
address1	string	The first address line of the bill to contact.
address2	string	The second address line of the bill to contact.
city	string	The city of the bill to contact.
state	string	The state of the bill to contact.
zip	string	The ZIP code of the bill to contact.
inactive	boolean	The inactive status of the bill to contact.
contactNumber	integer	The contact number of the bill to contact.
vendorNumber	integer	The vendor number of the bill to contact.
status	string	The status of the bill to contact.

Example URI

POST https://test-api.wastelinq.com./api/billtos/edit_contact_billto

Request

HideShow

Headers

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

Body

{
  "id": null,
  "firstname": "kien",
  "lastname": "test",
  "title": "qa",
  "phoneList": [
    {
      "label": "Work",
      "phoneNumber": "012-345-6789",
      "extensionStr": "",
      "isSelectLabel": false,
      "id": 1
    }
  ],
  "emailList": [
    {
      "label": "Work",
      "emailStr": "kienqa@gmail.com",
      "isSelectLabel": false,
      "id": 1
    }
  ],
  "address1": "test",
  "address2": "test",
  "city": "test",
  "state": "CO",
  "zip": "10001",
  "inactive": false
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {}
}

add_new_billto ¶

add_new_billto
POST`/api/billtos/add_new_billto`

Overview:

This endpoint creates a new bill to entity based on the provided bill to data. It is designed to allow clients to add new bill to entities to their billing records, facilitating effective billing management and compliance. The service requires clients to provide detailed bill to information, including name, address, status, contact information, electronic billing status, payment terms, and payment type. This service is essential for clients aiming to add new bill to entities to their billing records, ensuring accurate and up-to-date billing information is maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
billToId	integer	The ID of the new bill to.
id	string	The ID of the new bill to.
billToName	string	The name of the new bill to.
legecybillingId	string	The legacy billing ID of the new bill to.
address1	string	The first address line of the new bill to.
status	string	The status of the new bill to.
address2	string	The second address line of the new bill to.
city	string	The city of the new bill to.
state	string	The state of the new bill to.
zip	string	The ZIP code of the new bill to.
county	string	The county of the new bill to.
country	string	The country of the new bill to.
outside	boolean	The outside status of the new bill to.
note	string	The note of the new bill to.
currentBalance	string	The current balance of the new bill to.
paymentTerm	integer	The payment term of the new bill to.
electronicBilling	boolean	The electronic billing status of the new bill to.
creditLine	string	The credit line of the new bill to.
paymentType	string	The payment type of the new bill to.
dunBradstreet	string	The Dun & Bradstreet number of the new bill to.
customerContact	string	The customer contact of the new bill to.
customerPhone	string	The customer phone number of the new bill to.
customerFax	string	The customer fax number of the new bill to.
customerPhoneExt	string	The customer phone extension of the new bill to.
networkBroker	string	The network broker of the new bill to.
loa_files	array	The list of LOA files.
billToContactArr	array	The list of bill to contacts.
master_contact_id	integer	The master contact ID of the bill to contact.
billto_contacts	integer	The bill to contact ID of the bill to contact.
contact	integer	The contact ID of the bill to contact.
type	string	The type of the bill to contact.
firstname	string	The first name of the bill to contact.
lastname	string	The last name of the bill to contact.
companytitle	string	The company title of the bill to contact.
phone	string	The phone number of the bill to contact.
email	string	The email of the bill to contact.
status	string	The status of the bill to contact.
inactive	boolean	The inactive status of the bill to contact.

Example URI

POST https://test-api.wastelinq.com./api/billtos/add_new_billto

Request

HideShow

Headers

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

Body

{
  "id": "",
  "billToName": "apitest01",
  "legecybillingId": "apitest01",
  "address1": "apitest01",
  "status": "Active",
  "address2": "apitest01",
  "city": "apitest01",
  "state": "DE",
  "zip": "10001",
  "county": "apitest01",
  "country": "United States",
  "outside": false,
  "note": "apitest01",
  "currentBalance": "",
  "paymentTerm": 461,
  "electronicBilling": false,
  "creditLine": "",
  "paymentType": "",
  "dunBradstreet": "",
  "customerContact": "",
  "customerPhone": "",
  "customerFax": "",
  "customerPhoneExt": "",
  "networkBroker": "",
  "loa_files": [],
  "billToContactArr": [
    {
      "master_contact_id": 34681,
      "billto_contacts": 1023262,
      "contact": 35116,
      "type": "1",
      "firstname": "Jane",
      "lastname": "Doe",
      "companytitle": "test",
      "phone": "123 123-1234 Extension: 123",
      "email": "test@gmail.com",
      "status": "1",
      "inactive": false
    }
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "billToId": 27797
}

edit_billto ¶

edit_billto
POST`/api/billtos/edit_billto`

Overview:

This endpoint updates an existing bill to entity based on the provided bill to data. It is designed to allow clients to modify bill to entities in their billing records, facilitating effective billing management and compliance. The service requires clients to provide detailed bill to information, including name, address, status, contact information, electronic billing status, payment terms, and payment type. This service is essential for clients aiming to update bill to entities in their billing records, ensuring accurate and up-to-date billing information is maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
billToId	integer	The ID of the bill to.
id	string	The ID of the bill to.
billToName	string	The name of the bill to.
address1	string	The first address line of the bill to.
address2	string	The second address line of the bill to.
status	string	The status of the bill to.
city	string	The city of the bill to.
state	string	The state of the bill to.
zip	string	The ZIP code of the bill to.
county	string	The county of the bill to.
country	string	The country of the bill to.
outside	boolean	The outside status of the bill to.
note	string	The note of the bill to.
currentBalance	string	The current balance of the bill to.
paymentTerm	integer	The payment term of the bill to.
paymentType	string	The payment type of the bill to.
electronicBilling	boolean	The electronic billing status of the bill to.
creditLine	string	The credit line of the bill to.
dunBradstreet	string	The Dun & Bradstreet number of the bill to.
billToContactArr	array	The list of bill to contacts.
billToContactArr.id	integer	The ID of the bill to contact.
billToContactArr.master_contact_id	integer	The master contact ID of the bill to contact.
billToContactArr.firstname	string	The first name of the bill to contact.
billToContactArr.lastname	string	The last name of the bill to contact.
billToContactArr.companytitle	string	The company title of the bill to contact.
billToContactArr.address1	string	The first address line of the bill to contact.
billToContactArr.address2	string	The second address line of the bill to contact.
billToContactArr.city	string	The city of the bill to contact.
billToContactArr.state	string	The state of the bill to contact.
billToContactArr.zip	string	The ZIP code of the bill to contact.
billToContactArr.inactive	boolean	The inactive status of the bill to contact.
billToContactArr.contact	integer	The contact ID of the bill to contact.
billToContactArr.billto_contacts	integer	The bill to contact ID of the bill to contact.
billToContactArr.status	string	The status of the bill to contact.
billToContactArr.type	string	The type of the bill to contact.
billToContactArr.email	string	The email of the bill to contact.
billToContactArr.phone	string	The phone number of the bill to contact.

Example URI

POST https://test-api.wastelinq.com./api/billtos/edit_billto

Request

HideShow

Headers

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

Body

{
  "id": 27797,
  "billToName": "apitest01",
  "address1": "apitest01",
  "address2": "apitest01",
  "status": "Active",
  "city": "apitest01",
  "state": "DE",
  "zip": "10001",
  "county": "apitest01",
  "country": "United States",
  "electronicBilling": false,
  "legecybillingId": "apitest01",
  "outside": false,
  "currentBalance": "",
  "creditLine": "",
  "dunBradstreet": "",
  "note": "apitest01",
  "paymentTerm": 461,
  "paymentType": null,
  "billToContactArr": [
    {
      "id": 69776,
      "master_contact_id": 34681,
      "firstname": "Jane",
      "lastname": "Doe",
      "companytitle": "test",
      "address1": "test",
      "address2": "test",
      "city": "test",
      "state": "GA",
      "zip": "10001",
      "inactive": false,
      "contact": 35116,
      "billto_contacts": 1023262,
      "status": "2",
      "type": "1",
      "email": "test@gmail.com",
      "phone": "123 123-1234"
    }
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "billToId": 27797
}

billto_loa_upload_files ¶

billto_loa_upload_files
POST`/api/billtos/billto_loa_upload_files{?billToId}`

Overview:

This endpoint uploads a Letter of Authorization (LOA) file for a specific bill to entity based on the provided bill to ID. It is designed to allow clients to upload LOA files to their billing entities, facilitating effective billing management and compliance. The service requires clients to provide the bill to ID and the LOA file to upload. This service is essential for clients aiming to upload LOA files to their billing entities, ensuring accurate and up-to-date billing records are maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
billToId	integer	The ID of the bill to.
file	file	The file to upload.

Example URI

POST https://test-api.wastelinq.com./api/billtos/billto_loa_upload_files?billToId=

URI Parameters

HideShow

billToId: number (required)
The ID of the bill to.

Request

HideShow

Headers

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

Body

{
  "file": "test.file"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "billToId": "16297"
}

get_network_billto_broker ¶

get_network_billto_broker
GET`/api/billtos/get_network_billto_broker`

Overview:

This endpoint retrieves a list of network bill to brokers. It is designed to provide clients with detailed information about network bill to brokers, including unique identifiers and names. This service is essential for clients aiming to access detailed information about network bill to brokers, facilitating effective billing management and compliance.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	array	The list of network bill to brokers.
id	integer	The ID of the network bill to broker.
Broker_Name	string	The name of the network bill to broker.

Example URI

GET https://test-api.wastelinq.com./api/billtos/get_network_billto_broker

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 28,
      "Broker_Name": "AUTOMATION_TEST"
    },
    {
      "id": 36,
      "Broker_Name": "Company A"
    },
    {
      "id": 109,
      "Broker_Name": "Test ESC"
    },
    {
      "id": 95,
      "Broker_Name": "Company A"
    },
    {
      "id": 122,
      "Broker_Name": "Company B"
    }
  ]
}

upload_file_standard_cost ¶

upload_file_standard_cost
POST`/api/billtos/upload_file_standard_cost{?effectiveDate,effectiveTime,updateStandardCostCaseByCase}`

Overview:

This endpoint uploads a file containing standard cost data for a specific bill to entity. It is designed to allow clients to upload standard cost data files to their billing entities, facilitating effective billing management and compliance. The service requires clients to provide the effective date, effective time, and update standard cost case by case. This service is essential for clients aiming to upload standard cost data files to their billing entities, ensuring accurate and up-to-date billing records are maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.
content	string	The status of the file upload.
message	string	The message.

Example URI

POST https://test-api.wastelinq.com./api/billtos/upload_file_standard_cost?effectiveDate=&effectiveTime=&updateStandardCostCaseByCase=

URI Parameters

HideShow

effectiveDate: string (required)
The effective date.
effectiveTime: string (required)
The effective time.
updateStandardCostCaseByCase: boolean (required)
The update standard cost case by case.

Request

HideShow

Headers

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

Body

{
  "file": "test.file"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": "{\"Status\": \"OK\"}",
  "message": null
}

task_update_price_managment_billto ¶

task_update_price_managment_billto
POST`/api/billtos/task_update_price_managment_billto`

Overview:

This endpoint updates the price management for a specific bill to entity. It is designed to allow clients to update the price management for their billing entities, facilitating effective billing management and compliance. The service requires clients to provide the bill to ID, the effective date, and the effective time. This service is essential for clients aiming to update the price management for their billing entities, ensuring accurate and up-to-date billing records are maintained.

Request Body and Response Description:

Name	Data Type	Description
Authorization	string	The authorization token required to access the endpoint.
success	boolean	The status of the request.

Example URI

POST https://test-api.wastelinq.com./api/billtos/task_update_price_managment_billto

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": "true"
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

BillTos APIs ¶

billtos ¶

billtosGET/api/billtos{?page,pageSize,filter,sort}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_billto_detail ¶

get_billto_detailGET/api/billtos/get_billto_detail{?billToId}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_contact_billto_by_search_str ¶

get_contact_billto_by_search_strGET/api/billtos/get_contact_billto_by_search_str{?searchValue}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_master_contact_by_id ¶

get_master_contact_by_idGET/api/billtos/get_master_contact_by_id{?id}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

create_billto_contact_data ¶

create_billto_contact_dataPOST/api/billtos/create_billto_contact_data

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

add_new_contact_billto ¶

add_new_contact_billtoPOST/api/billtos/add_new_contact_billto

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

edit_contact_billto ¶

edit_contact_billtoPOST/api/billtos/edit_contact_billto

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

add_new_billto ¶

add_new_billtoPOST/api/billtos/add_new_billto

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

edit_billto ¶

edit_billtoPOST/api/billtos/edit_billto

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Other APIs docs

Bearer Token

Error Messages

billtos
GET`/api/billtos{?page,pageSize,filter,sort}`

Overview:

Request Body and Response Description:

get_billto_detail
GET`/api/billtos/get_billto_detail{?billToId}`

Overview:

Request Body and Response Description:

get_contact_billto_by_search_str
GET`/api/billtos/get_contact_billto_by_search_str{?searchValue}`

Overview:

Request Body and Response Description:

get_master_contact_by_id
GET`/api/billtos/get_master_contact_by_id{?id}`

Overview:

Request Body and Response Description:

create_billto_contact_data
POST`/api/billtos/create_billto_contact_data`

Overview:

Request Body and Response Description:

add_new_contact_billto
POST`/api/billtos/add_new_contact_billto`

Overview:

Request Body and Response Description:

edit_contact_billto
POST`/api/billtos/edit_contact_billto`

Overview:

Request Body and Response Description:

add_new_billto
POST`/api/billtos/add_new_billto`

Overview:

Request Body and Response Description:

edit_billto
POST`/api/billtos/edit_billto`

Overview:

Request Body and Response Description:

billto_loa_upload_files
POST`/api/billtos/billto_loa_upload_files{?billToId}`

Overview:

Request Body and Response Description:

get_network_billto_broker
GET`/api/billtos/get_network_billto_broker`

Overview:

Request Body and Response Description:

upload_file_standard_cost
POST`/api/billtos/upload_file_standard_cost{?effectiveDate,effectiveTime,updateStandardCostCaseByCase}`

Overview:

Request Body and Response Description:

task_update_price_managment_billto
POST`/api/billtos/task_update_price_managment_billto`

Overview:

Request Body and Response Description: