API WorkDo Dash SaaS Add-On

Introduction

The API Docs Generator is a powerful Add-On that provides complete API documentation for the WorkDo Dash platform. This Add-On helps developers and technical teams access detailed API information, including endpoints, headers, parameters, and response examples. The documentation covers 15 major modules of the platform and enables users to build custom applications, integrate external systems, or test APIs manually using tools like Postman.

How to Install the Add-On?

To Set Up the API Add-On, you can follow this link: Setup Add-On.

How to use the API Add-On?

Generate Api Docs

After purchasing and installing this Add-On, go to your dashboard sidebar and search for the API Docs Add-On.

To access the API documentation, navigate to the Api Docs section from your main dashboard. The documentation is organized by 14 modules, making it easy to find the specific APIs you need for your integration project.

The section includes a general introduction that explains how to use the APIs effectively. This overview covers authentication requirements, common headers, and basic usage guidelines that apply across all API endpoints.

Each module contains powerful API listings with complete technical details. For every API endpoint, you’ll find the API name, exact endpoint URL, required headers for authentication and data format, input parameters with their data types and validation rules, example success responses showing the expected data structure, and example error responses with common error codes and messages.

Introduction Management

This comprehensive API documentation is your gateway to harnessing the power of WorkDo Dash’s features, allowing you to streamline your work, boost productivity, and bring your projects to the next level.

This API documentation is a resource for developers, both seasoned and new, who want to leverage WorkDo Dash’s capabilities within their applications. Here’s what you can expect to find.

You can see the example with the help of this URL: https://example.com

The endpoints section covers GET to retrieve data, POST to create new data, POST to update existing data, and DELETE to remove data. You can use HTTP methods like GET to retrieve data, POST to create new data, POST to update existing data, and DELETE to remove data.

Request parameters are used to customize the behavior of your API requests and provide more specific details when interacting with the API. For WorkDo Dash, you might have the following types of request parameters: Query Parameters to filter or sort data when retrieving information, Request Headers for authentication and additional metadata about the request, and Request Body containing JSON data to be created or updated.

WorkDo Dash’s API typically responds with data in JSON format. The response typically includes an HTTP status code indicating the outcome of the request, and the actual data is contained within the “data” field.

Authentication Management

Authentication APIs provide the essential login functionality, token refresh capabilities for maintaining sessions, and logout procedures to securely end user sessions.

The login endpoint POST /api/login requires headers with “Accept”: “application/json” and parameters including email like “john@example.com” and password like “john****”.

Error responses return 422 Unprocessable Content with “success”: false, “message”: “Validation When validation is an error.

Error responses return 400 Unauthorized with “success”: false, “message”: “The provided” when credentials are invalid.

Successful login responses return 200 OK with “success”: true and authorisation containing token and type “bearer” for subsequent API calls.

The auth refresh endpoint POST /api/refresh uses authorization headers with a Bearer token for session management.

Successful refresh responses return detailed user information, including 200 OK with “success”: true, and user details, id, name, email, mobile_no, type : “company”, avatar: “URL”, lang: “en” and token.

User Management

• User APIs for user administration, role management, and profile operations.

Warehouse Management

• Warehouse APIs for warehouse configuration and warehouse transfers management.

Product & Service Management

• Product & Service section APIs manage product categories, taxes, measurement units, products, and stock management with warehouse integration.

Purchase Invoice Management

• Purchase Invoice APIs for Purchase Invoice List, Create, Detail, Update, Delete, Invoice Post management.

Purchase Return Management

• APIs for handling Purchase Return List, Create, Return Detail, Delete, Approve, Complete processing.

Sales Proposal Management

• Sales Proposal APIs for proposal management and conversion processes.

Sales Invoice Management

• Sales Invoice APIs handle invoice list, creation, Update, Delete, Invoice Post management.

Sales Invoice Return Management

• APIs for managing sales Invoice Return List, Create, Detail, Delete, Approve and Complete.

Account Management

• The Account section APIs allow you to manage Customers, Vendors, Bank Accounts, Chart of Accounts, Revenues, Expenses, Credit Notes, Debit Notes, Vendor Payments, Customer Payments, Bank Transaction, Bank Transfers records. You can perform operations like listing records, creating new entries, viewing details, updating information, and deleting records as needed.
• The Account module includes quick list APIs for retrieving simple client and vendor lists, Gl Account List, along with revenue and expense categories for dropdown selections and quick references.

Project Management

• Project section APIs manage projects, tasks, bugs, milestones, files, and various reports with their associated stages and workflows.

POS Management

• POS APIs handle point-of-sale operations, including order management and Order Details.

CRM Management

• CRM section APIs cover Pipeline management, lead and deal stages, labels, sources, and complete Lead management, and Deal management. You can manage tasks, users, products, sources, emails, discussions, files, and calls associated with both leads and deals.

HRM Management

• HRM APIs handle employee management, organizational structure, attendance tracking, leave management, payroll processing, and various HR records including Awards, Promotions, Resignations, Terminations, Warnings, Complaints, Employee Transfers, holidays, events, documents, Announcements, and Acknowledgments.

Each API endpoint in the documentation includes practical examples that you can copy and use directly in your development environment or testing tools. The response examples show both successful operations and common error scenarios, helping you implement proper error handling in your applications.

Modules Wise APIs List :

• Authentication :

  • Login
  • Token Refresh
  • Logout

• User :

  • User : List, Create, Update, Delete, Profile Update, Password Update, Reset Password, Verify
  • Role : List
  • User Log : List
  • Staff Users : List
  • Client Users : List
  • Vendor Users : List

• Warehouse :

  • Warehouse : List, Create, Detail, Update, Delete
  • Transfer : List, Create Request Data, Create, Delete

• Product & Service :

  • Product Category : List, Create, Update, Delete
  • Tax : List, Create, Update, Delete
  • Unit : List, Create, Update, Delete
  • Product : List, Create, Detail, Update, Delete
  • Product Stock : List, Add
  • Warehouse Product : List

• Purchase Invoice :

  • Invoice : List, Create, Detail, Update, Delete, Post

• Purchase Return :

  • Return : List, Create, Detail, Delete, Approve, Complete

• Sales Proposal :

  • Proposal : List, Create, Detail, Update, Delete, Sent, Accept, Reject, Convert to Invoice

• Sales Invoice :

  • Invoice : List, Create, Detail, Update, Delete, Post

• Sales Invoice Return :

  • Return : List, Create, Detail, Delete, Approve, Complete

• Account :

  • Get Clients : Simple client list
  • Get Vendors : Simple vendor list
  • Customer : List, Create, Update, Delete
  • Vendor : List, Create, Update, Delete
  • Gl Account : List
  • Bank Account : List, Create, Update, Delete
  • Revenue Categories : List
  • Revenue : List, Create, Update, Delete, Approve, Post
  • Expense Categories : List
  • Expense : List, Create, Update, Delete, Approve, Post
  • Account Types : List
  • Chart of Account : List
  • Bank Transaction : List
  • Bank Transfer : List
  • Vendor Payments : List
  • Customer Payments : List
  • Credit Note : List
  • Debit Note : List

• Project :

  • Project : List, Create, Detail, Update, Delete
  • Project Member : Delete
  • Project Client : List, Invite, Delete
  • Project Milestone : List, Create, Update, Delete
  • Project File : Create, Delete
  • Task : Task Board, Create, Detail, Update, Delete
  • Task Comment : Create, Delete
  • Task Subtask : Create, Update
  • Bug Status : List
  • Bug : List, Create, Detail, Update, Delete
  • Bug Comment : Create, Delete
  • Project Report : List, Detail
  • Task Stage : List, Order, Create, Update, Delete
  • Bug Stage : List, Order, Create, Update, Delete

• POS :

  • Order : List, Detail

• CRM :

  • Pipeline : List, Create, Update, Delete
  • Lead Stage : List, Create, Update, Delete
  • Deal Stage : List, Create, Update, Delete
  • Labels : List, Create, Update, Delete
  • Sources : List, Create, Update, Delete
  • Lead : List, Create, Detail, Update, Delete, Add Label, Convert To Deal
  • Lead Task : Create, Update, Delete
  • Lead User : Create, Delete
  • Lead Product : Create, Delete
  • Lead Source : Create, Delete
  • Lead Email : Create
  • Lead Discussion : Create
  • Lead File : Create, Delete
  • Lead Call : Create, Update, Delete
  • Deal : List, Create, Detail, Update, Delete, Add Label
  • Deal Task : Create, Update, Delete
  • Deal User : Create, Delete
  • Deal Product : Create, Delete
  • Deal Source : Create, Delete
  • Deal Email : Create
  • Deal Discussion : Create
  • Deal File : Create, Delete
  • Deal Client : Create, Delete
  • Deal Call : Create, Update, Delete

• HRM :

  • Employee : List, Create, Detail, Update, Delete
  • Attendance : List, Create, Update, Delete
  • Leave Types : List
  • Leave Applications : List, Create, Update, Delete, Update Status
  • Leave Balances : Check
  • Payroll : List, Detail
  • Payslip : Generate
  • Shifts : List
  • Branches : List
  • Departments : List
  • Designations : List
  • Document Types : List
  • Holidays : List
  • Awards : List
  • Promotions : List
  • Resignations : List
  • Terminations : List
  • Warnings : List
  • Complaints : List
  • Employee Transfers : List
  • Documents : List
  • Acknowledgments : List
  • Announcements : List
  • Events : List