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

SQL Account BizObject

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

Operations

Executes a query on business objects

Request

This endpoint allows querying business objects using a raw SQL statement with optional parameters. It supports pagination via offset and limit.

Bodyapplication/json

Query request parameters

sqlnumber or string
Example: "SELECT * FROM AR_CUSTOMER"
One of:
number
offsetnumber or string
Example: 0
One of:
number
limitnumber or string
Example: 1
One of:
number
curl -i -X POST \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/biz-objects/query \
  -H 'Content-Type: application/json' \
  -d '{
    "sql": "SELECT * FROM AR_CUSTOMER",
    "offset": 0,
    "limit": 1
  }'

Responses

Returns the queried business object

Bodyapplication/json
arrays
Response
application/json
[ { "CODE": "300-A0001", "CONTROLACCOUNT": "300-000", "COMPANYNAME": "A HOME FURNISHING & SERVICE", "COMPANYNAME2": "", "COMPANYCATEGORY": "----", "AREA": "KL", "AGENT": "Yuki", "BIZNATURE": "", "CREDITTERM": "30 Days", "CREDITLIMIT": "30000", "OVERDUELIMIT": "0", "STATEMENTTYPE": "O", "CURRENCYCODE": "----", "OUTSTANDING": "1455", "ALLOWEXCEEDCREDITLIMIT": "T", "ADDPDCTOCRLIMIT": "T", "AGINGON": "I", "STATUS": "A", "PRICETAG": "", "CREATIONDATE": "2023-02-25T00:00:00", "TAX": "", "TAXEXEMPTNO": "", "TAXEXPDATE": "", "BRN": "", "BRN2": "", "GSTNO": "", "SALESTAXNO": "", "SERVICETAXNO": "", "TIN": "", "IDTYPE": 0, "IDNO": "", "TOURISMNO": "", "SIC": "", "SUBMISSIONTYPE": 0, "IRBM_CLASSIFICATION": "", "PEPPOLID": "", "BUSINESSUNIT": "", "TAXAREA": "", "ATTACHMENTS": "", "REMARK": "", "NOTE": "", "LASTMODIFIED": 1723112184 } ]

Adds a new business object

Request

This endpoint creates a new business object of the specified entity type. The request body must contain valid business object data.

Path
entityTypestringrequired

Type of the business object

Default ""
Example: AR_CUSTOMER
Bodyapplication/json

Business object data

dataobject
curl -i -X POST \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/biz-objects/AR_CUSTOMER \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "COMPANYNAME": "TestCompany",
      "cdsBranch": [
        {
          "BRANCHNAME": "TestBranch"
        }
      ]
    }
  }'

Responses

Returns the details of the newly added business object

Bodyapplication/json
property name*anyadditional property
Response
application/json
{ "CODE": "300-T0002", "CONTROLACCOUNT": "300-000", "COMPANYNAME": "TestCompany", "COMPANYNAME2": {}, "COMPANYCATEGORY": "----", "AREA": "----", "AGENT": "----", "BIZNATURE": {}, "CREDITTERM": "30 Days", "CREDITLIMIT": 30000, "OVERDUELIMIT": 0, "STATEMENTTYPE": "O", "CURRENCYCODE": "----", "OUTSTANDING": 0, "ALLOWEXCEEDCREDITLIMIT": "T", "ADDPDCTOCRLIMIT": "T", "AGINGON": "I", "PRICETAG": {}, "CREATIONDATE": "2025-03-06T00:00:00", "TAX": {}, "TAXEXEMPTNO": {}, "TAXEXPDATE": {}, "BRN": {}, "BRN2": {}, "GSTNO": {}, "SALESTAXNO": {}, "SERVICETAXNO": {}, "TIN": {}, "IDType": 0, "IDNo": {}, "TourismNo": {}, "SIC": {}, "SUBMISSIONTYPE": 0, "IRBM_CLASSIFICATION": {}, "PeppolID": {}, "BusinessUnit": {}, "TAXAREA": {}, "ATTACHMENTS": {}, "REMARK": {}, "NOTE": {}, "STATUS": "A", "LASTMODIFIED": 1741253392, "DIRTY": true, "sdsBranch": [ 14, "300-T0002", "B", "TestBranch", {}, {}, {}, {}, {}, {}, {}, "", {}, {}, {}, {}, {}, {}, {}, {} ], "sdsCreditControl": [ {}, {}, {}, {}, {} ], "sdsBankAcc": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "sdsTariff": [ {}, {}, {}, {}, {} ] }

Updates an existing business object

Request

This endpoint updates a business object by matching the specified field key and value. The request body should contain the updated data.

Path
entityTypestringrequired

The type of business object

Default ""
Example: ST_ITEM
fieldKeystringrequired

Field key used to identify the object

Default ""
Example: CODE
fieldValuestringrequired

Field value corresponding to the key

Default ""
Example: ISCT
Bodyapplication/json

Updated business object data

mainKeynumber or string
Example: "DOCKEY"
One of:
number
dataobject
curl -i -X PUT \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/biz-objects/ST_ITEM/CODE/ISCT \
  -H 'Content-Type: application/json' \
  -d '{
    "mainKey": "DOCKEY",
    "data": {
      "DESCRIPTION": "Test Description",
      "cdsUOM": [
        {
          "REFPRICE": "6868"
        }
      ]
    }
  }'

Responses

Returns the updated business object details

Bodyapplication/json
property name*anyadditional property
Response
application/json
{ "DOCKEY": 10, "CODE": "ISCT", "DESCRIPTION": "Test Description", "DESCRIPTION2": {}, "DESCRIPTION3": {}, "STOCKGROUP": "FURNITURE", "STOCKCONTROL": "T", "COSTINGMETHOD": 1, "SERIALNUMBER": "F", "SHELF": {}, "MINQTY": 0, "MAXQTY": 0, "SUOM": {}, "REORDERLEVEL": 0, "REORDERQTY": 1, "SLTAX": {}, "PHTAX": {}, "TARIFF": {}, "IRBM_Classification": 22, "STOCKMATRIX": {}, "DEFUOM_ST": {}, "DEFUOM_SL": {}, "DEFUOM_PH": {}, "SCRIPTCODE": {}, "ISACTIVE": "T", "CREATIONDATE": "2024-08-08T00:00:00", "PICTURE": {}, "PICTURECLASS": {}, "ATTACHMENTS": {}, "NOTE": {}, "UOM": "UNIT", "REFCOST": 220, "REFPRICE": 6868, "ITEMTYPE": "-", "LEADTIME": 0, "BOM_LEADTIME": 0, "BOM_ASMCOST": 0, "BALSQTY": 10, "BALSUOMQTY": 0, "REMARK1": {}, "REMARK2": {}, "BARCODE": {}, "LASTMODIFIED": 1741254748, "DIRTY": true, "sdsUOM": [ "ISCT", "UNIT", 1, 220, 6868, {}, {}, {}, {}, 1 ], "sdsOpeningBalance": [ 4, "ISCT", "----", "", "----", 1000, 10, 0, 220, 2200, 2200 ], "sdsCustomerPrice": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "sdsSupplierPrice": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "sdsCategory": [ {}, {} ], "sdsBOM": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "sdsAltStockItem": [ {}, {}, {} ], "sdsCustomerItem": [ {}, {}, {}, {}, {} ], "sdsSupplierItem": [ {}, {}, {}, {}, {} ], "sdsBarcode": [ {}, {}, {}, {} ] }

Transfers a business object from one entity type to another

Request

This endpoint allows transferring a business object from one entity type to another. It requires the source entity type, target entity type, and document number for transfer.

Bodyapplication/json

Transfer details

fromEntityTypenumber or string
Example: "SL_SO"
One of:
number
toEntityTypenumber or string
Example: "SL_IV"
One of:
number
docNonumber or string
Example: "SO-00005"
One of:
number
curl -i -X POST \
  https://docs.beehexa.com/_mock/api/sql-account/docs/api/biz-objects/transfer \
  -H 'Content-Type: application/json' \
  -d '{
    "fromEntityType": "SL_SO",
    "toEntityType": "SL_IV",
    "docNo": "SO-00005"
  }'

Responses

Returns the details of the transferred business object

Bodyapplication/json
property name*anyadditional property
Response
application/json
{ "DOCKEY": 68, "DOCNO": "IV-00018", "DOCNOEX": {}, "DOCDATE": "2025-03-06T00:00:00", "POSTDATE": "2025-03-06T00:00:00", "TAXDATE": "2025-03-06T00:00:00", "EIVDATETIME": {}, "CODE": "300-W0002", "COMPANYNAME": "WENDY DESIGN GROUP", "ADDRESS1": "No 45, Road Hibiscus 33,", "ADDRESS2": "Setia Eco, 40170, Shah Alam, Selangor.", "ADDRESS3": {}, "ADDRESS4": {}, "POSTCODE": {}, "CITY": {}, "STATE": {}, "COUNTRY": null, "PHONE1": "03-3485 8657", "MOBILE": {}, "FAX1": {}, "ATTENTION": "Miss Wendy Ng", "AREA": "Selangor", "AGENT": "Ashley", "PROJECT": "----", "TERMS": "30 Days", "CURRENCYCODE": "----", "CURRENCYRATE": 1, "SHIPPER": "----", "DESCRIPTION": null, "CANCELLED": "F", "DOCAMT": 1300, "LOCALDOCAMT": 1300, "D_AMOUNT": 0, "VALIDITY": {}, "DELIVERYTERM": {}, "CC": {}, "DOCREF1": {}, "DOCREF2": {}, "DOCREF3": {}, "DOCREF4": {}, "BRANCHNAME": "BILLING", "DADDRESS1": "No 45, Road Hibiscus 33,", "DADDRESS2": "Setia Eco, 40170, Shah Alam, Selangor.", "DADDRESS3": {}, "DADDRESS4": {}, "DPOSTCODE": {}, "DCITY": {}, "DSTATE": {}, "DCOUNTRY": null, "DATTENTION": "Miss Wendy Ng", "DPHONE1": "03-3485 8657", "DMOBILE": {}, "DFAX1": {}, "TAXEXEMPTNO": {}, "SALESTAXNO": {}, "SERVICETAXNO": {}, "TIN": {}, "IDTYPE": 0, "IDNO": {}, "TOURISMNO": {}, "SIC": {}, "INCOTERMS": {}, "SUBMISSIONTYPE": 0, "IRBM_STATUS": 0, "IRBM_INTERNALID": {}, "IRBM_UUID": {}, "IRBM_LONGID": {}, "ATTACHMENTS": {}, "NOTE": {}, "UPDATECOUNT": {}, "TRANSFERABLE": "T", "PRINTCOUNT": 0, "sdsDocDetail": [ 70, 68, 2000, "", "", "LD/White", "----", "", "----", "Intelligent tracks lightcycle desk light (White)", "", {}, "", 1, "UNIT", 1, 1, 0, 650, "2024-07-01T00:00:00", "", "", "", "", 22, "", 0, 0, 0, 650, 650, 650, 650, "500-300", "T", "SO", 18, 20, "T", "", "", {}, [], 0, "T" ], "CHANGED": "T", "DocNoSetKey": 13, "NextDocNo": {} }

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