Companies
The Companies entity represents the organizational units within the system.
Fields
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier (Primary Key). |
name | String | Human-readable name of the company. |
description | String | Detailed description of the company. |
address | String | Physical or legal address of the company. |
registrationCode | String | Official registration code or tax ID. |
createdAt | DateTime | Metadata: Creation timestamp. |
createdBy | Relation | User who created the record. |
updatedAt | DateTime | Metadata: Last update timestamp. |
deletedAt | DateTime | Metadata: Deletion timestamp (for soft delete). |
removedBy | Relation | User who removed the record. |
Get List of Companies
Fetch a list of companies with specified fields and filters.
Endpoint: POST /core/data/Companies/select
Example Request:
json
{
"fields": {
"id": true,
"name": true,
"registrationCode": true,
"address": true
},
"orderBy": [
{
"field": "name",
"order": "asc"
}
],
"limit": 100,
"offset": 0
}Get Single Company
Retrieve details for a specific company by ID.
Endpoint: POST /core/data/Companies/select
Example Request:
json
{
"fields": {
"id": true,
"name": true,
"description": true,
"address": true,
"registrationCode": true,
"createdAt": true
},
"conditions": {
"filters": [
{
"field": "id",
"comparator": "=",
"value": 1
}
]
},
"limit": 1
}