Contact
Hire Us
Package
Download
Account

The Account schema defines the structure and API endpoints for managing account records in SiteMesh. It includes fields for account identification, contact details, address, geolocation, currency, and timestamps.

Schema Columns

Column ID Type Key Filter Description
AccountIDTEXTYesEQUALSUnique identifier
AccountNameTEXTNoLIKEName of the account
AccountWebsiteTEXTNoLIKEWebsite URL
AccountPhoneTEXTNoLIKEPhone number
AccountEmailTEXTNoLIKEEmail address
AccountStreet1TEXTNoLIKEAddress line 1
AccountStreet2TEXTNoLIKEAddress line 2
AccountCityTEXTNoLIKECity
AccountStateTEXTNoLIKEState/Province
AccountCountryTEXTNoLIKECountry
AccountPostCodeTEXTNoLIKEPostal/ZIP code
AccountLatitudeDOUBLENo-Latitude (geo)
AccountLongitudeDOUBLENo-Longitude (geo)
AccountCurrencyTEXTNoEQUALSCurrency code (e.g., USD)
AccountActivityTIMESTAMPNo-Last activity timestamp
AccountCreatedTIMESTAMPNo-Creation timestamp
AccountUpdatedTIMESTAMPNo-Last update timestamp
AccountDeletedTIMESTAMPNoEQUALSDeletion timestamp

Sorting

  • Default sort: AccountName (ascending)

API Endpoints

All endpoints require a valid authentication token. Some actions are restricted to users with the [admin] role.

  • account/count (POST): Count accounts matching filter parameters.
    Permissions: [admin] (all accounts), non-admin (only their accounts).
    Body: JSON with filter parameters.
    Returns: Count as a string.
  • account/list (POST): List accounts matching filter parameters.
    Permissions: [admin] only.
    Body: JSON with filter parameters.
    Returns: JSON array of account objects.
  • account/get (POST): Get a single account by AccountID.
    Permissions: [admin] (any account), non-admin (their own account).
    Body: { "AccountID": "<id>" }
    Returns: JSON object or "null" if not found.
  • account/save (POST): Create or update an account.
    Permissions: [admin] (all fields), non-admin (their own account, cannot edit AccountCurrency or AccountDeleted).
    Body: JSON with account fields.
    Returns: JSON object for the saved account.

Notes

  • All endpoints return "Unauthorized" (401) if the token is missing or expired.
  • Non-admin users have restricted access and cannot modify certain fields.
  • Filtering supports EQUALS and LIKE as specified in the schema columns.

Example Requests

POST /account/count
Headers: { Authorization: Bearer <token> }
Body: { "AccountName": "Acme Corp" }
            
POST /account/get
Headers: { Authorization: Bearer <token> }
Body: { "AccountID": "12345" }