Basic Requests

For Account list, the following endpoints are required:

Method	URL	Description
GET	`/api/account/form`	Create an entry form
POST	`/api/account/{id}`	Get an entry detail
POST	`/api/accounts/edit`	Edit an entry
POST	`/api/accounts/delete-list`	Delete an entry
POST	`/api/accounts/restore-list`	Restore an entry

Create an Entry

GET:
/{db}/api/account/form

Example Response:

{
  "data": {
    "formId": "FNNNNP",
    "formName": "Client",
    "createBillingData": true
  },
  "form": {
    "title": "New account",
    "returnUrl": "/{db}/list/accounts/{formid}"
  },
  "meta": {
    "createdAt": "2023-11-15T12:34:56Z"
  }
}

Get an Entry Detail

Returns an entry profile by id.

POST:
/{db}/api/account/{id}

Example Response:

{
  "id": "W2999K",
  "code": "00092",
  "name": "   ,  ",
  "firstDate": null,
  "tabs": [
    "accountAmount",
    "activities_tab",
    "deals_tab",
    "sales_tab",
    "invoice_tab"
  ]
}

Edit an Entry

POST:
/{db}/api/accounts/edit/{id}?id={id}

Example Response:

{
  "entity": {
    "id": "22999K",
    "no": "00135",
    "name": "New Account",
    "title": null,
    "contacts": {},
    "firstName": "New",
    "middleName": null,
    "lastName": "Test"
  }
}

Delete an Entry

Deletes an entry by id.

GET:
/{db}/api/accounts/delete/{id}

Example Response:

{
  "success": "Success! You have deleted the Account!"
}

Restore an Entry

Restores an entry by id.

POST:
/{db}/api/accounts/restore-list

Example Response:

{
  "success": "Accounts restored successfully"
}

Filters

You can filter data based on specific parameters. Queries accept filters with this syntax:

POST:
/{db}/api/grid/filters/:filterType/search/accounts

Parameters

startDate (string): Start date for filtering (format: YYYY-MM-DD).
endDate (string): End date for filtering (format: YYYY-MM-DD HH:MM:SS).
refs (string): Reference code for filtering (varies by filter types).

Example: Filter Accounts by Date and Reference

POST:
/{db}/api/grid/filters/:filtertype/search/accounts

Example Response:

[
  {
    "value": "empty-value",
    "label": "Without Group",
    "key": "empty-value",
    "selected": "0"
  },
  {
    "label": "User",
    "selected": "0",
    "value": "accountId",
    "key": "accountId"
  }
]