Beehexa Customization SQL Account Rest API (1.0)

SQL Account is an accounting software from Malaysia that is suitable for all businesses, from small businesses to large organizations. It is crucial to find a business solution that suits the nature of your business. The right accounting software will broaden the horizons and expand business opportunities for you.

This is a comprehensive REST API for managing SQL accounts. It provides endpoints for user authentication, customer data management, sales transactions, and stock control. Use this API to integrate your applications with the SQL Account software.

Metadata

KeyValue
releaseDate10 Mar 2025
keywordSQL Account Rest API
Download OpenAPI description
Languages
Servers
Mock server
https://docs.beehexa.com/_mock/api/sql-account/docs/
https://sqlaccountrestapi.beehexa.com/

SQL Account App

Provides authentication, system module retrieval, user actions, and application updates.

Operations

Authenticates a user and retrieves their account info

Request

This endpoint allows users to authenticate with their credentials. If authentication is successful, user information is returned.

Bodyapplication/json
usernamenumber or stringnon-emptyrequired
Example: "ADMIN"
One of:
non-empty
numbernon-empty
passwordnumber or stringnon-emptyrequired
Example: "ADMIN"
One of:
non-empty
numbernon-empty
curl -i -X POST \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "ADMIN",
    "password": "ADMIN"
  }'

Responses

Returns application information

Bodyapplication/json
sqlAccountAppInfoobject(SqlAccountAppInfo)
releaseInfoobject(ReleaseInfo)
Response
application/json
{ "sqlAccountAppInfo": { "title": "SQL Account Education Edition - Testing Company [2025]", "releaseDate": "2024-08-19", "buildNo": 854, "version": "5.2024.994.854" }, "releaseInfo": { "API_VERSION": "release-0.0.46", "PORT": 5001, "APP_NAME": "SQLACC_API_IIS", "APP_DIR": "C:/Users/Admin/Code/SQLAccountPackage", "DEPLOYMENT_METHOD": "IIS", "APP_POOL_NAME": "SQLACC_API_IISPool", "LATEST_VERSION": "release-0.0.46" } }

Retrieves application information

Request

This API returns general information about the application.

curl -i -X GET \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/info

Responses

Returns application information

Bodyapplication/json
sqlAccountAppInfoobject(SqlAccountAppInfo)
releaseInfoobject(ReleaseInfo)
Response
application/json
{ "sqlAccountAppInfo": { "title": "SQL Account Education Edition - Testing Company [2025]", "releaseDate": "2024-08-19", "buildNo": 854, "version": "5.2024.994.854" }, "releaseInfo": { "API_VERSION": "release-0.0.46", "PORT": 5001, "APP_NAME": "SQLACC_API_IIS", "APP_DIR": "C:/Users/Admin/Code/SQLAccountPackage", "DEPLOYMENT_METHOD": "IIS", "APP_POOL_NAME": "SQLACC_API_IISPool", "LATEST_VERSION": "release-0.0.46" } }

Retrieves available user actions

Request

This endpoint returns a list of actions that users can perform.

curl -i -X GET \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/actions

Responses

Returns application action names

Bodyapplication/jsonArray [
string
]
Response
application/json
[]

Retrieves available system modules

Request

This API provides details about the available system modules.

curl -i -X GET \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/modules

Responses

Returns application module names

Bodyapplication/jsonArray [
string
]
Response
application/json
[]

Retrieves business objects

Request

This endpoint returns all available business objects in the system.

curl -i -X GET \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/biz-objects

Responses

Returns application business object names

Bodyapplication/json
bizObjectsArray of objects
Response
application/json
{ "bizObjects": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }

Retrieves details of a specific business object

Request

This API returns detailed information about a given business object.

Path
bizObjectNamestringrequired

The name of the business object

Example: AR_CUSTOMER
curl -i -X GET \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/biz-objects/AR_CUSTOMER

Responses

Returns application business object details

Bodyapplication/json
namenumber or string
Example: "AR_PM"
One of:
number
datasetsArray of objects(BizObjectInfoDataset)
Response
application/json
{ "name": "AR_CUSTOMER", "datasets": [ {}, {}, {}, {}, {} ] }

Updates the application

Request

This API triggers an update process for the application.

curl -i -X POST \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/app/update

Responses

Returns application update status

Bodyapplication/json
statusnumber or string
Example: "Update process starated. IIS will restart in 10 seconds. Please close every swagger window."
One of:
number
Response
application/json
{ "status": "Update process starated. Service will restart soon." }

SQL Account BizObject

Manages business objects, including querying, creating, updating, and transferring entities.

Operations

SQL Account Customer

Handles customer data retrieval based on email, code, and date filters.

Operations

SQL Account Customer Invoice

Retrieves customer invoices based on document numbers, date filters, and transaction history.

Operations

SQL Account Customer Payment

Manages customer payments, including retrieval by document number and payment history tracking.

Operations

SQL Account History

Provides access to system logs, log details, and historical transaction downloads.

Operations

SQL Account Sales Invoice

Retrieves sales invoices by document number and filters based on transaction dates.

Operations

SQL Account Sales Order

Handles sales orders, including retrieval by document number and transaction history.

Operations

SQL Account Stock Adjustment

Manages stock adjustments, including retrieval by document number and date-based filters.

Operations

SQL Account Stock Item

Retrieves stock item details based on code and historical transaction data.

Operations

SQL Account Stock Item Template

Provides access to predefined stock item templates for inventory standardization.

Operations