Accounting APIs

Overview ¶

This section of the documentation provides a comprehensive overview of the Accounting APIs, which are integral to the financial management and operations of our platform. These APIs facilitate a wide range of accounting tasks, from managing invoices and payments to handling financial reporting and analysis. Designed with flexibility and scalability in mind, our Accounting APIs serve as the backbone for financial transactions, ensuring data accuracy, security, and compliance with financial standards.

Key Features

Invoice Management: Automate the creation, update, and retrieval of invoice details. This includes managing invoice dates, amounts, and statuses, providing a seamless invoicing process.
Payment Processing: Facilitate the processing of payments, including the management of payment methods, transaction records, and reconciliation processes.
Account Reconciliation: Simplify the reconciliation of accounts, ensuring accurate and up-to-date financial records.

Security and Compliance

Security and compliance are at the forefront of our Accounting APIs. We employ robust security measures, including SSL encryption, OAuth2 for authentication, and rigorous access controls, to protect sensitive financial data. Additionally, our APIs are designed to comply with major financial regulations and standards, ensuring that your financial operations are both secure and compliant.

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.

Accounting APIs ¶

invoices ¶

invoices
GET`/api/accounting/invoices/{?page,pageSize,filter,generator_id}`

Overview:

The invoices endpoint is designed to retrieve a list of invoices from the system. It allows users to access detailed information about each invoice, including the invoice number, date, amount, status, bill-to details, and synchronization status. The endpoint supports various query parameters to filter, sort, and paginate the results, enabling users to tailor the data retrieval to their specific needs. This functionality is essential for businesses seeking to manage their invoicing efficiently, track financial transactions, and maintain accurate records for accounting and auditing purposes.

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 invoices.
id	number	The ID of the invoice.
invoice_number	number	The invoice number.
order_lists	string	The order lists.
billto_name	string	The name of the bill-to.
created_date	string	The created date.
invoice_date	string	The invoice date.
invoice_status	string	The invoice status.
amount	string	The amount.
syn_status	boolean	The synchronization status.
totalElements	number	The total number of invoices.
invoicing_protocol	string	The invoicing protocol.

Example URI

GET https://test-api.wastelinq.com./api/accounting/invoices/?page=&pageSize=&filter=&generator_id=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
filter: string (optional)
The search filter.
generator_id: string (optional)
The generator ID.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 325765,
      "invoice_number": 213770,
      "order_lists": "583916",
      "billto_name": "Company A",
      "created_date": "04/08/2024",
      "invoice_date": "03/31/2024",
      "invoice_status": "Invoice Issued",
      "amount": "$686.25",
      "syn_status": true
    },
    {
      "id": 325763,
      "invoice_number": 213768,
      "order_lists": "583425",
      "billto_name": "Company B",
      "created_date": "04/08/2024",
      "invoice_date": "03/31/2024",
      "invoice_status": "Invoice Issued",
      "amount": "$3,322.00",
      "syn_status": true
    }
  ],
  "totalElements": 10092,
  "invoicing_protocol": ""
}

get_invoice ¶

get_invoice
GET`/api/accounting/get_invoice/{id}/`

Overview:

The get_invoice endpoint, accessible at /api/invoice/details/, is a GET request that retrieves detailed information about a specific invoice from the system. It allows users to access comprehensive details about the invoice, including the invoice number, date, amount, status, bill-to details, credit card payment information, customer details, broker details, order details, and integration details.

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 invoice details.
id	number	The ID of the invoice.
invoice_number	number	The invoice number.
invoice_date	string	The invoice date.
amount	number	The amount.
status	string	The status of the invoice.
isdelete	boolean	Indicates if the invoice is deleted.
inactive	string	The inactive status.
billto_id	number	The bill-to ID.
billto_name	string	The bill-to name.
credit_card_payment	string	The credit card payment details.
customer_id	number	The customer ID.
customer_name	string	The customer name.
broker_id	number	The broker ID.
created_date	string	The created date.
modified_date	string	The modified date.
creator_id	number	The creator ID.
modifier_id	number	The modifier ID.
arstatus_id	number	The AR status ID.
arstatus_name	string	The AR status name.
project_id	number	The project ID.
project_name	string	The project name.
phase_id	number	The phase ID.
phase_name	string	The phase name.
note	string	The note.
isexternal	boolean	Indicates if the invoice is external.
is_archived	boolean	Indicates if the invoice is archived.
integby_id	number	The integration ID.
integdatetime	string	The integration date and time.
integref	string	The integration reference.
integstatus	string	The integration status.
innvoice_order	array	The invoice order details.
id	number	The ID of the invoice order.
order_id	number	The order ID.
order_number	string	The order number.
billto_name	string	The bill-to name.
billto_contact	string	The bill-to contact.
order_date	string	The order date.
date_created	string	The created date.
status	string	The status of the order.
amount	number	The amount.
amount_change	string	The amount change.
item_status	number	The item status.
hid_convert_to_invoice	boolean	Indicates if the invoice is converted.
extend_buttons	object	The extended buttons.
quickbook_user	string	The QuickBooks user.
btn_pay_credit_card	boolean	Indicates if the credit card payment button is available.
btn_save_netsuite	boolean	Indicates if the NetSuite save button is available.
btn_save_acumatica	boolean	Indicates if the Acumatica save button is available.
btn_save_quickbooks	boolean	Indicates if the QuickBooks save button is available.
btn_update_invoice_acumatica	boolean	Indicates if the Acumatica update button is available.
btn_update_invoice_quickbooks	boolean	Indicates if the QuickBooks update button is available.

Example URI

GET https://test-api.wastelinq.com./api/accounting/get_invoice/id/

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": "336422",
    "invoice_number": 224425,
    "invoice_date": "06/23/2024",
    "amount": 1080,
    "status": "",
    "isdelete": false,
    "inactive": "Active",
    "billto_id": 15735,
    "billto_name": "Company A",
    "credit_card_payment": null,
    "customer_id": null,
    "customer_name": "",
    "broker_id": 31,
    "created_date": "06/23/2024",
    "modified_date": "07/04/2024",
    "creator_id": 150,
    "modifier_id": 1787,
    "arstatus_id": 336,
    "arstatus_name": "Invoice Issued",
    "project_id": null,
    "project_name": "",
    "phase_id": null,
    "phase_name": "",
    "note": null,
    "isexternal": false,
    "is_archived": false,
    "integby_id": 1787,
    "integdatetime": "07/04/2024 07:40 AM",
    "integref": "224425",
    "integstatus": "POSTED BY Jane Doe 07/04/2024 07:40 AM",
    "innvoice_order": [
      {
        "id": 314166,
        "order_id": 563372,
        "order_number": "602641",
        "billto_name": "Company B",
        "billto_contact": "Jane Doe",
        "order_date": "06/04/2024",
        "date_created": "06/04/2024",
        "status": "Invoiced",
        "amount": 1080,
        "amount_change": "",
        "item_status": 0
      }
    ],
    "hid_convert_to_invoice": false,
    "extend_buttons": {
      "quickbook_user": "company_admin",
      "btn_pay_credit_card": false,
      "btn_save_netsuite": false,
      "btn_save_acumatica": true,
      "btn_save_quickbooks": false,
      "btn_update_invoice_acumatica": true,
      "btn_update_invoice_quickbooks": false
    }
  }
}

get_orders_to_create_invoices ¶

get_orders_to_create_invoices
GET`/api/accounting/get_orders_to_create_invoices/{?show_invoiced_invoices,billto_id,project_id,phase_id}`

Overview:

The get_orders_to_create_invoices endpoint is a GET request that retrieves a list of orders that can be used to create invoices. It allows users to access detailed information about each order, including the order ID, number, bill-to details, order date, status, amount, and item status.

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 orders to create invoices.
id	number	The ID of the order.
order_id	number	The order ID.
order_number	string	The order number.
order_name	string	The order name.
customer_id	number	The customer ID.
customer_name	string	The customer name.
date_created	string	The created date.
billto_name	string	The bill-to name.
billto_id	number	The bill-to ID.
billing_contact	string	The billing contact.
billing_contact_id	number	The billing contact ID.
total_amount	number	The total amount.
amount_change	number	The amount change.
project_name	string	The project name.
phase_name	string	The phase name.
status	string	The status of the order.
is_disabled	boolean	Indicates if the order is disabled.
totalElements	number	The total number of orders to create invoices.

Example URI

GET https://test-api.wastelinq.com./api/accounting/get_orders_to_create_invoices/?show_invoiced_invoices=&billto_id=&project_id=&phase_id=

URI Parameters

HideShow

show_invoiced_invoices: boolean (optional)
Indicates if the invoiced invoices should be shown.
billto_id: number (optional)
The bill-to ID.
project_id: number (optional)
The project ID.
phase_id: number (optional)
The phase ID.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 568106,
      "order_id": 568106,
      "order_number": "607375",
      "order_name": "",
      "customer_id": 41024,
      "customer_name": "Company A",
      "date_created": "07/11/2024",
      "billto_name": "Company A",
      "billto_id": 16297,
      "billing_contact": null,
      "billing_contact_id": 16297,
      "total_amount": 165,
      "amount_change": 165,
      "project_name": null,
      "phase_name": null,
      "status": "Unbilled",
      "is_disabled": true
    }
  ],
  "totalElements": 1
}

add_invoice ¶

add_invoice
POST`/api/accounting/add_invoice/{?proforma}`

Overview:

The add_invoice endpoint is a POST request that is used to create a new invoice in the system. It allows users to specify the invoice details, including the invoice number, date, amount, status, bill-to details, credit card payment information, customer details, broker details, order details, and integration details. The endpoint supports various query parameters to customize the invoice creation process, enabling users to generate invoices with specific criteria.

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 invoice details.
id	number	The ID of the invoice.
invoice_number	number	The invoice number.
invoice_date	string	The invoice date.
amount	number	The amount.
status	string	The status of the invoice.
isdelete	boolean	Indicates if the invoice is deleted.
inactive	string	The inactive status.
billto_id	number	The bill-to ID.
billto_name	string	The bill-to name.
credit_card_payment	string	The credit card payment details.
customer_id	number	The customer ID.
customer_name	string	The customer name.
broker_id	number	The broker ID.
created_date	string	The created date.
modified_date	string	The modified date.
creator_id	number	The creator ID.
modifier_id	number	The modifier ID.
arstatus_id	number	The AR status ID.
arstatus_name	string	The AR status name.
project_id	number	The project ID.
project_name	string	The project name.
phase_id	number	The phase ID.
phase_name	string	The phase name.
note	string	The note.
isexternal	boolean	Indicates if the invoice is external.
is_archived	boolean	Indicates if the invoice is archived.
integby_id	number	The integration ID.
integdatetime	string	The integration date and time.
integref	string	The integration reference.
integstatus	string	The integration status.
innvoice_order	array	The invoice order details.
id	number	The ID of the invoice order.
order_id	number	The order ID.
order_number	string	The order number.
billto_name	string	The bill-to name.
billto_contact	string	The bill-to contact.
order_date	string	The order date.
date_created	string	The created date.
status	string	The status of the order.
amount	number	The amount.
amount_change	string	The amount change.
item_status	number	The item status.
hid_convert_to_invoice	boolean	Indicates if the invoice is converted.
extend_buttons	object	The extended buttons.
quickbook_user	string	The QuickBooks user.
btn_pay_credit_card	boolean	Indicates if the credit card payment button is available.
btn_save_netsuite	boolean	Indicates if the NetSuite save button is available.
btn_save_acumatica	boolean	Indicates if the Acumatica save button is available.
btn_save_quickbooks	boolean	Indicates if the QuickBooks save button is available.
btn_update_invoice_acumatica	boolean	Indicates if the Acumatica update button is available.
btn_update_invoice_quickbooks	boolean	Indicates if the QuickBooks update button is available.

Example URI

POST https://test-api.wastelinq.com./api/accounting/add_invoice/?proforma=

URI Parameters

HideShow

proforma: boolean (optional)
Indicates if the invoice is a proforma invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": 336440,
    "invoice_number": 224443,
    "invoice_date": "",
    "amount": 0,
    "status": "preview",
    "isdelete": false,
    "inactive": "Inactive",
    "billto_id": null,
    "billto_name": "",
    "credit_card_payment": false,
    "customer_id": null,
    "customer_name": "",
    "broker_id": 31,
    "created_date": "07/11/2024",
    "modified_date": "07/11/2024",
    "creator_id": 1774,
    "modifier_id": 1774,
    "arstatus_id": 336,
    "arstatus_name": "Invoice Issued",
    "project_id": null,
    "project_name": "",
    "phase_id": null,
    "phase_name": "",
    "note": null,
    "isexternal": false,
    "is_archived": false,
    "integby_id": null,
    "integdatetime": "07/11/2024 07:51 AM",
    "integref": "",
    "integstatus": "",
    "innvoice_order": [],
    "hid_convert_to_invoice": false,
    "extend_buttons": {
      "quickbook_user": "company_admin",
      "btn_pay_credit_card": false,
      "btn_save_netsuite": false,
      "btn_save_acumatica": true,
      "btn_save_quickbooks": false,
      "btn_update_invoice_acumatica": true,
      "btn_update_invoice_quickbooks": false
    }
  }
}

edit_invoice ¶

edit_invoice
POST`/api/accounting/edit_invoice/`

Overview:

The edit_invoice endpoint is a POST request that is used to update an existing invoice in the system. It allows users to modify the details of an invoice, including the invoice number, date, amount, status, bill-to details, credit card payment information, customer details, broker details, order details, and integration details.

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 invoice details.
id	number	The ID of the invoice.
invoice_number	number	The invoice number.
invoice_date	string	The invoice date.
amount	number	The amount.
status	string	The status of the invoice.
isdelete	boolean	Indicates if the invoice is deleted.
inactive	string	The inactive status.
billto_id	number	The bill-to ID.
billto_name	string	The bill-to name.
credit_card_payment	string	The credit card payment details.
customer_id	number	The customer ID.
customer_name	string	The customer name.
broker_id	number	The broker ID.
created_date	string	The created date.
modified_date	string	The modified date.
creator_id	number	The creator ID.
modifier_id	number	The modifier ID.
arstatus_id	number	The AR status ID.
arstatus_name	string	The AR status name.
project_id	number	The project ID.
project_name	string	The project name.
phase_id	number	The phase ID.
phase_name	string	The phase name.
note	string	The note.
isexternal	boolean	Indicates if the invoice is external.
is_archived	boolean	Indicates if the invoice is archived.
integby_id	number	The integration ID.
integdatetime	string	The integration date and time.
integref	string	The integration reference.
integstatus	string	The integration status.
innvoice_order	array	The invoice order details.
id	number	The ID of the invoice order.
order_id	number	The order ID.
order_number	string	The order number.
billto_name	string	The bill-to name.
billto_contact	string	The bill-to contact.
order_date	string	The order date.
date_created	string	The created date.
status	string	The status of the order.
amount	number	The amount.
amount_change	string	The amount change.
item_status	number	The item status.
hid_convert_to_invoice	boolean	Indicates if the invoice is converted.
extend_buttons	object	The extended buttons.
quickbook_user	string	The QuickBooks user.
btn_pay_credit_card	boolean	Indicates if the credit card payment button is available.
btn_save_netsuite	boolean	Indicates if the NetSuite save button is available.
btn_save_acumatica	boolean	Indicates if the Acumatica save button is available.
btn_save_quickbooks	boolean	Indicates if the QuickBooks save button is available.
btn_update_invoice_acumatica	boolean	Indicates if the Acumatica update button is available.
btn_update_invoice_quickbooks	boolean	Indicates if the QuickBooks update button is available.

Example URI

POST https://test-api.wastelinq.com./api/accounting/edit_invoice/

Request

HideShow

Headers

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

Body

{
  "id": "336442",
  "invoice_number": 224445,
  "invoice_date": "07/11/2024",
  "amount": 0,
  "status": "",
  "isdelete": false,
  "inactive": "Active",
  "billto_id": 16297,
  "billto_name": "Company A",
  "credit_card_payment": null,
  "customer_id": null,
  "customer_name": "",
  "broker_id": 31,
  "created_date": "07/12/2024",
  "modified_date": "07/12/2024",
  "creator_id": 150,
  "modifier_id": 150,
  "arstatus_id": 336,
  "arstatus_name": "Invoice Issued",
  "project_id": null,
  "project_name": "",
  "phase_id": null,
  "phase_name": "",
  "note": null,
  "isexternal": false,
  "is_archived": false,
  "integby_id": 150,
  "integdatetime": "07/12/2024 02:07 AM",
  "integref": "224445",
  "integstatus": "POSTED BY Jane Doe 07/12/2024 02:07 AM",
  "innvoice_order": [
    {
      "id": 314181,
      "order_id": 568046,
      "order_number": "607315",
      "billto_name": "Company A",
      "billto_contact": null,
      "order_date": "07/01/2024",
      "date_created": "07/01/2024",
      "status": "Invoiced",
      "amount": 0,
      "amount_change": "",
      "item_status": 0
    }
  ],
  "hid_convert_to_invoice": false,
  "extend_buttons": {
    "quickbook_user": "company_admin",
    "btn_pay_credit_card": false,
    "btn_save_netsuite": false,
    "btn_save_acumatica": true,
    "btn_save_quickbooks": false,
    "btn_update_invoice_acumatica": true,
    "btn_update_invoice_quickbooks": false
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": "336442",
    "invoice_number": 224445,
    "invoice_date": "07/11/2024",
    "amount": 0,
    "status": "",
    "isdelete": false,
    "inactive": "Active",
    "billto_id": 16297,
    "billto_name": "Company A",
    "credit_card_payment": null,
    "customer_id": null,
    "customer_name": "",
    "broker_id": 31,
    "created_date": "07/12/2024",
    "modified_date": "07/12/2024",
    "creator_id": 150,
    "modifier_id": 1774,
    "arstatus_id": 336,
    "arstatus_name": "Invoice Issued",
    "project_id": null,
    "project_name": "",
    "phase_id": null,
    "phase_name": "",
    "note": null,
    "isexternal": false,
    "is_archived": false,
    "integby_id": 150,
    "integdatetime": "07/12/2024 02:07 AM",
    "integref": "224445",
    "integstatus": "POSTED BY Jane Doe 07/12/2024 02:07 AM",
    "innvoice_order": [
      {
        "id": 314181,
        "order_id": 568046,
        "order_number": "607315",
        "billto_name": "Company A",
        "billto_contact": null,
        "order_date": "07/01/2024",
        "date_created": "07/01/2024",
        "status": "Invoiced",
        "amount": 0,
        "amount_change": "",
        "item_status": 0
      }
    ],
    "hid_convert_to_invoice": false,
    "extend_buttons": {
      "quickbook_user": "company_admin",
      "btn_pay_credit_card": false,
      "btn_save_netsuite": false,
      "btn_save_acumatica": true,
      "btn_save_quickbooks": false,
      "btn_update_invoice_acumatica": true,
      "btn_update_invoice_quickbooks": false
    }
  }
}

delete_invoice ¶

delete_invoice
DELETE`/api/accounting/delete_invoice/`

Overview:

The delete_invoice endpoint is a DELETE request that is used to delete an existing invoice from the system. It allows users to remove an invoice from the system, ensuring that the invoice is no longer accessible or visible in the system.

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.
id	number	The ID of the invoice.

Example URI

DELETE https://test-api.wastelinq.com./api/accounting/delete_invoice/

Request

HideShow

Headers

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

Body

{
  "id": "336442"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

email_invoice_info ¶

email_invoice_info
POST`/api/accounting/email_invoice_info`

Overview:

The email_invoice_info endpoint is designed to send invoice details via email to a specified recipient. It allows users to provide the recipient’s email address, subject, and message, along with the invoice details to be included in the email.

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 email invoice information.
billto_name	string	The name of the bill-to.
billto_email	string	The email of the bill-to.
company_name	string	The company name.
email_subject	string	The email subject.
order_list	string	The order list.
bcc_emails	array	The list of BCC emails.
email	string	The email.
email_body	string	The email body.
doc_files	array	The list of document files.

Example URI

POST https://test-api.wastelinq.com./api/accounting/email_invoice_info

Request

HideShow

Headers

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

Body

{
  "id": 336449
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "billto_name": "Company A",
    "billto_email": "janedoe@test.com",
    "company_name": "Company A",
    "email_subject": "Company A Invoice # 224452",
    "order_list": "607384",
    "bcc_emails": [
      {
        "email": "invoicing@wastelinq.coms"
      }
    ],
    "email_body": "Thank you for your business. Please click on the link below to view your invoice. We look forward to serving again in the future.%0D %0DPlease click test.wastelinq.com/download/invoice_pdf/ to view invoice.",
    "doc_files": []
  }
}

filter_phases ¶

filter_phases
GET`/api/accounting/filter/filter_phases/`

Overview:

The filter_phases endpoint is designed to retrieve a list of phases that can be used to filter invoices. It allows users to access detailed information about each phase, including the phase ID, name, and description.

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 phases.

Example URI

GET https://test-api.wastelinq.com./api/accounting/filter/filter_phases/

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

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

filter_projects ¶

filter_projects
GET`/api/accounting/filter/filter_projects/{?billto_id}`

Overview:

The filter_projects endpoint is designed to retrieve a list of projects that can be used to filter invoices. It allows users to access detailed information about each project, including the project ID and name.

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 projects.
id	number	The ID of the project.
Name	string	The name of the project.

Example URI

GET https://test-api.wastelinq.com./api/accounting/filter/filter_projects/?billto_id=

URI Parameters

HideShow

billto_id: number (optional)
The bill-to ID.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 563,
      "Name": "Removal of Haz Lead Blocks"
    },
    {
      "id": 3213,
      "Name": "test"
    }
  ]
}

filter_ARstatus ¶

filter_ARstatus
GET`/api/accounting/filter/filter_ARstatus/`

Overview:

The filter_ARstatus endpoint is designed to retrieve a list of AR statuses that can be used to filter invoices. It allows users to access detailed information about each AR status, including the AR status ID and name. The endpoint provides a complete overview of the AR statuses, enabling users to filter invoices based on specific criteria. This functionality is essential for businesses seeking to manage their invoicing efficiently, track financial transactions, and maintain accurate records for accounting and auditing purposes.

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 AR statuses.
id	number	The ID of the AR status.
Name	string	The name of the AR status.

Example URI

GET https://test-api.wastelinq.com./api/accounting/filter/filter_ARstatus/

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 411,
      "Name": "Emailed"
    },
    {
      "id": 362,
      "Name": "Paid in Full"
    },
    {
      "id": 361,
      "Name": "Partial Payment"
    },
    {
      "id": 360,
      "Name": "Bad Debt"
    },
    {
      "id": 345,
      "Name": "Cost Only"
    },
    {
      "id": 340,
      "Name": "Overpayment"
    },
    {
      "id": 336,
      "Name": "Invoice Issued"
    },
    {
      "id": 335,
      "Name": "None"
    }
  ]
}

account_receivables ¶

account_receivables
GET`/api/accounting/account_receivables/`

Overview:

The account_receivables endpoint is designed to retrieve a list of account receivables from the system. It allows users to access detailed information about each account receivable, including the invoice number, date, amount, status, bill-to details, and synchronization status.

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 account receivables.
id	number	The ID of the account receivable.
billto_name	string	The name of the bill-to.
oldest_date	string	The oldest date.
num_invoices	number	The number of invoices.
origin_amount	number	The origin amount.
amount_due	number	The amount due.
totalElements	number	The total number of account receivables.

Example URI

GET https://test-api.wastelinq.com./api/accounting/account_receivables/

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 16297,
      "billto_name": "Company A",
      "oldest_date": "06/10/2022",
      "num_invoices": 2,
      "origin_amount": 447.19,
      "amount_due": 447.19
    }
  ],
  "totalElements": 684
}

get_payment ¶

get_payment
GET`/api/accounting/get_payment/{id}/`

Overview:

The get_payment endpoint, accessible at /api/accounting/get_payment/{id}/, is a GET request that retrieves detailed information about a specific payment from the system. It allows users to access comprehensive details about the payment, including the payment ID, date, amount, status, payment method, customer details, invoice details, and integration details.

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 payment details.
billto	string	The bill-to name.
discount_val	number	The discount value.
payment_val	number	The payment value.
origin_val	number	The origin value.
amount_due	number	The amount due.
invoices	array	The list of invoices.
id	number	The ID of the invoice.
bill_id	number	The bill ID.
invoice_date	string	The invoice date.
invoice_number	number	The invoice number.
origin_amount	number	The origin amount.
amount_due	number	The amount due.
discount_val	string	The discount value.
payment_val	string	The payment value.
is_writeoff	boolean	Indicates if the invoice is written off.

Example URI

GET https://test-api.wastelinq.com./api/accounting/get_payment/id/

URI Parameters

HideShow

id: number (required)
The ID of the payment.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "billto": "Company A",
    "discount_val": 0,
    "payment_val": 0,
    "origin_val": 447.19,
    "amount_due": 447.19,
    "invoices": [
      {
        "id": 229243,
        "bill_id": 16297,
        "invoice_date": "06/10/2022",
        "invoice_number": 117279,
        "origin_amount": 447.19,
        "amount_due": 447.19,
        "discount_val": "",
        "payment_val": "",
        "is_writeoff": false
      },
      {
        "id": 336441,
        "bill_id": 16297,
        "invoice_date": "07/11/2024",
        "invoice_number": 224444,
        "origin_amount": 0,
        "amount_due": 0,
        "discount_val": "",
        "payment_val": "",
        "is_writeoff": false
      }
    ]
  }
}

update_payment ¶

update_payment
POST`/api/accounting/update_payment/{id}`

Overview:

The update_payment endpoint, accessible at /api/accounting/update_payment/{id}, is a POST request that is used to update the payment details in the system. It allows users to modify the payment value, discount value, and amount due for a specific payment.

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.
invoices	array	The list of invoices.
id	number	The ID of the invoice.
bill_id	number	The bill ID.
invoice_date	string	The invoice date.
invoice_number	number	The invoice number.
origin_amount	number	The origin amount.
amount_due	number	The amount due.
discount_val	string	The discount value.
payment_val	string	The payment value.
is_writeoff	boolean	Indicates if the invoice is written off.
checknumber	string	The check number.
checkdate	string	The check date.
credittype	string	The credit type.
creditnumber	string	The credit number.

Example URI

POST https://test-api.wastelinq.com./api/accounting/update_payment/id

URI Parameters

HideShow

id: number (required)
The ID of the payment.

Request

HideShow

Headers

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

Body

{
  "invoices": [
    {
      "id": 205477,
      "bill_id": 16297,
      "invoice_date": "01/02/2022",
      "invoice_number": 93519,
      "origin_amount": 898,
      "amount_due": 898,
      "discount_val": "",
      "payment_val": "",
      "is_writeoff": false
    },
    {
      "id": 229243,
      "bill_id": 16297,
      "invoice_date": "06/10/2022",
      "invoice_number": 117279,
      "origin_amount": 447.19,
      "amount_due": 447.19,
      "discount_val": "",
      "payment_val": "",
      "is_writeoff": false
    }
  ],
  "checknumber": "",
  "checkdate": "",
  "credittype": "------",
  "creditnumber": ""
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

get_payment_histories ¶

get_payment_histories
GET`/api/accounting/get_payment_histories/{id}/`

Overview:

The get_payment_histories endpoint, accessible at /api/accounting/get_payment_histories/{id}/, is a GET request that is used to retrieve the payment histories for a specific payment.

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 payment histories.
id	number	The ID of the payment history.
invoice_number	number	The invoice number.
invoice_date	string	The invoice date.
origin_amount	number	The origin amount.
amount_due	number	The amount due.
payment	list	The list of payments.

Example URI

GET https://test-api.wastelinq.com./api/accounting/get_payment_histories/id/

URI Parameters

HideShow

id: number (required)
The ID of the payment.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": "202428",
    "invoice_number": 90471,
    "invoice_date": "12/10/2021",
    "original_amount": 3884.75,
    "amount_due": 3884.75,
    "payments": []
  }
}

del_payment_histories ¶

del_payment_histories
DELETE`/api/accounting/del_payment_histories/`

Overview:

The del_payment_histories endpoint, accessible at /api/accounting/del_payment_histories/, is a DELETE request that is used to delete a payment history from the system.

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.
payment	list	The list of payments.

Example URI

DELETE https://test-api.wastelinq.com./api/accounting/del_payment_histories/

Request

HideShow

Headers

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

Body

{
  "payments": []
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

invoice_save_to_netsuite ¶

invoice_save_to_netsuite
GET`/api/accounting/invoice_save_to_netsuite/{id}`

Overview:

The invoice_save_to_netsuite endpoint, accessible at /api/accounting/invoice_save_to_netsuite/{id}, is a GET request that is used to save an invoice to NetSuite.

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.
message	string	The message.

Example URI

GET https://test-api.wastelinq.com./api/accounting/invoice_save_to_netsuite/id

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "message": "Invoice .... was saved successfully to NetSuite."
}

save_to_quickbooks ¶

save_to_quickbooks
GET`/api/accounting/save_to_quickbooks/{id}`

Overview:

The save_to_quickbooks endpoint, accessible at /api/accounting/save_to_quickbooks/{id}, is a GET request that is used to save an invoice to QuickBooks. It allows users to export an invoice to QuickBooks, ensuring that the financial data is synchronized between the two systems.

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.
message	string	The message.

Example URI

GET https://test-api.wastelinq.com./api/accounting/save_to_quickbooks/id

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "message": "Invoice 224452 was saved successfully to Acumatica."
}

update_invoice_from_acumatica_quickbooks ¶

update_invoice_from_acumatica_quickbooks
GET`/api/accounting/update_invoice_from_acumatica_quickbooks/{id}`

Overview:

The update_invoice_from_acumatica_quickbooks endpoint, accessible at /api/accounting/update_invoice_from_acumatica_quickbooks/{id}, is a GET request that is used to update an invoice from Acumatica or QuickBooks.

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.
message	string	The message.

Example URI

GET https://test-api.wastelinq.com./api/accounting/update_invoice_from_acumatica_quickbooks/id

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "message": "Status of invoice: Not Paid"
}

make_invoice_external ¶

make_invoice_external
GET`/api/accounting/make_invoice_external/{id}`

Overview:

The make_invoice_external endpoint, accessible at /api/accounting/make_invoice_external/{id}, is a GET request that is used to make an invoice external.

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	boolean	The content.

Example URI

GET https://test-api.wastelinq.com./api/accounting/make_invoice_external/id

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

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

get_orderinvoices ¶

get_orderinvoices
GET`/api/accounting/get_orderinvoices/{id}`

Overview:

The get_orderinvoices endpoint, accessible at /api/accounting/get_orderinvoices/{id}, is a GET request that is used to retrieve the invoices associated with a specific order.

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.
order_status	string	The order status.
content	array	The list of order invoices.
totalElements	number	The total number of order invoices.

Example URI

GET https://test-api.wastelinq.com./api/accounting/get_orderinvoices/id

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "order_status": 393,
  "content": [],
  "totalElements": 0
}

create_proforma_invoice_for_order ¶

create_proforma_invoice_for_order
POST`/api/accounting/create_proforma_invoice_for_order/{id}/`

Overview:

The endpoint is designed to create a proforma invoice for an order. It allows users to generate a proforma invoice for a specific order, ensuring that the financial data is synchronized between the two systems.

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 invoice details.
msg	string	The message.
invoice_id	number	The invoice ID.

Example URI

POST https://test-api.wastelinq.com./api/accounting/create_proforma_invoice_for_order/id/

URI Parameters

HideShow

id: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "msg": "successful",
    "invoice_id": 339047
  }
}

create_invoice_for_order ¶

create_invoice_for_order
POST`/api/accounting/create_invoice_for_order/{id}/`

Overview:

The create_invoice_for_order endpoint, accessible at /api/accounting/create_invoice_for_order/{id}/, is a POST request that is used to create an invoice for an order. It allows users to generate an invoice for a specific order, ensuring that the financial data is synchronized between the two systems.

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 invoice details.
msg	string	The message.
invoice_id	number	The invoice ID.
order_logistics_statcode	string	The order logistics status code.
netsuite_invoice_url	string	The NetSuite invoice URL.
netsuite_invoice_id	string	The NetSuite invoice ID.

Example URI

POST https://test-api.wastelinq.com./api/accounting/create_invoice_for_order/id/

URI Parameters

HideShow

id: number (required)
The ID of the order.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "msg": "successful",
    "invoice_id": 339049,
    "order_logistics_statcode": "20",
    "netsuite_invoice_url": "",
    "netsuite_invoice_id": ""
  }
}

invoiceprinting_pdf ¶

invoiceprinting_pdf
GET`/api/accounting/invoiceprinting_pdf/?{ids}/`

Overview:

The invoiceprinting_pdf endpoint, accessible at /api/accounting/invoiceprinting_pdf/?{ids}/, is a GET request that is used to retrieve the PDF file of an invoice.

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 invoice details.
msg	string	The message.
invoice_id	number	The invoice ID.

Example URI

GET https://test-api.wastelinq.com./api/accounting/invoiceprinting_pdf/?ids/

URI Parameters

HideShow

ids: number (required)
The ID of the invoice.

Request

HideShow

Headers

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

Response 200

HideShow

Headers

Content-Type: PDF

Body

{
    PDF file
}

Menu ¶

Other APIs docs ¶

Overview ¶

Key Features ¶

Security and Compliance ¶

Bearer Token ¶

Error Messages ¶

Accounting APIs ¶

invoices ¶

invoicesGET/api/accounting/invoices/{?page,pageSize,filter,generator_id}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_invoice ¶

get_invoiceGET/api/accounting/get_invoice/{id}/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_orders_to_create_invoices ¶

get_orders_to_create_invoicesGET/api/accounting/get_orders_to_create_invoices/{?show_invoiced_invoices,billto_id,project_id,phase_id}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

add_invoice ¶

add_invoicePOST/api/accounting/add_invoice/{?proforma}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

edit_invoice ¶

edit_invoicePOST/api/accounting/edit_invoice/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

delete_invoice ¶

delete_invoiceDELETE/api/accounting/delete_invoice/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

email_invoice_info ¶

email_invoice_infoPOST/api/accounting/email_invoice_info

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Body

Headers

Body

filter_phases ¶

filter_phasesGET/api/accounting/filter/filter_phases/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_projects ¶

filter_projectsGET/api/accounting/filter/filter_projects/{?billto_id}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Other APIs docs

Key Features

Security and Compliance

Bearer Token

Error Messages

invoices
GET`/api/accounting/invoices/{?page,pageSize,filter,generator_id}`

Overview:

Request Body and Response Description:

get_invoice
GET`/api/accounting/get_invoice/{id}/`

Overview:

Request Body and Response Description:

get_orders_to_create_invoices
GET`/api/accounting/get_orders_to_create_invoices/{?show_invoiced_invoices,billto_id,project_id,phase_id}`

Overview:

Request Body and Response Description:

add_invoice
POST`/api/accounting/add_invoice/{?proforma}`

Overview:

Request Body and Response Description:

edit_invoice
POST`/api/accounting/edit_invoice/`

Overview:

Request Body and Response Description:

delete_invoice
DELETE`/api/accounting/delete_invoice/`

Overview:

Request Body and Response Description:

email_invoice_info
POST`/api/accounting/email_invoice_info`

Overview:

Request Body and Response Description:

filter_phases
GET`/api/accounting/filter/filter_phases/`

Overview:

Request Body and Response Description:

filter_projects
GET`/api/accounting/filter/filter_projects/{?billto_id}`

Overview:

Request Body and Response Description:

filter_ARstatus
GET`/api/accounting/filter/filter_ARstatus/`

Overview:

Request Body and Response Description:

account_receivables
GET`/api/accounting/account_receivables/`

Overview:

Request Body and Response Description:

get_payment
GET`/api/accounting/get_payment/{id}/`

Overview:

Request Body and Response Description:

update_payment
POST`/api/accounting/update_payment/{id}`

Overview:

Request Body and Response Description:

get_payment_histories
GET`/api/accounting/get_payment_histories/{id}/`

Overview:

Request Body and Response Description:

del_payment_histories
DELETE`/api/accounting/del_payment_histories/`

Overview:

Request Body and Response Description:

invoice_save_to_netsuite
GET`/api/accounting/invoice_save_to_netsuite/{id}`

Overview:

Request Body and Response Description:

save_to_quickbooks
GET`/api/accounting/save_to_quickbooks/{id}`

Overview:

Request Body and Response Description: