> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/backoffice/enitites/entity-type.md).
# Entity Type
### **Overview**
The Entity Type feature allows administrators to manage different types of entities used in DinePlan, such as Members, Tables, and Customers. Administrators can create new entity types, configure their general settings and custom fields, modify existing configurations, remove entity types when they are no longer required, and arrange the entity types in a preferred order.
### **Screen Elements**
| **Screen Element** | **Description** |
| ------------------------------ | -------------------------------------------------------------------- |
| Entity Type List | Displays the available entity types. |
| Search | Search for a specific entity type. |
| Add Entity Type | Opens the screen to create a new entity type. |
| Edit Entity Type | Opens the selected entity type for modification. |
| Delete Entity Type | Deletes the selected entity type after confirmation. |
| Sort Entity Types | Allows entity types to be reordered. |
| General Settings | Contains the basic configuration options for the entity type. |
| Name | Specifies the name of the entity type. |
| Entity Name | Specifies the entity name. |
| Display Format | Specifies the display format for the entity. |
| Primary Field Name | Specifies the primary field name. |
| Primary Field Format | Specifies the format of the primary field. |
| Warehouse Type | Specifies the warehouse type. |
| Account Type | Specifies the account type. |
| Account Name Template | Specifies the account name template. |
| Account Balance Display Format | Specifies the format for displaying the account balance. |
| Stop Merging | Controls the Stop Merging option. |
| Custom Fields | Allows custom fields to be added and configured for the entity type. |
| Add Custom Field | Adds a new custom field. |
| Delete Custom Field | Deletes a selected custom field. |
| Custom Field Name | Specifies the name of the custom field. |
| Field Type | Specifies the type of the custom field. |
| Editing Format | Specifies the editing format for the custom field. |
| Values | Specifies the values available for the custom field. |
| Hidden | Controls whether the custom field is hidden. |
| Mandatory | Specifies whether the custom field is mandatory. |
| Close | Closes the Entity Type screen. |
### **Working**
#### **Add an Entity Type**
1. From the Entity Type List, select "Add Entity Type".
2. Enter the required entity type name in "Name".
3. Enter the required details in "Entity Name", "Display Format", "Primary Field Name", and "Primary Field Format".
4. Configure "Warehouse Type", "Account Type", "Account Name Template", "Account Balance Display Format", and "Stop Merging" as required.
5. Select "Custom Fields" to add custom fields, if required.
6. Select "Add Custom Field" and configure the required custom field details.
7. Select "Save" to save the entity type.
#### **Edit an Entity Type**
1. From the Entity Type List, select the required entity type.
2. Select "Edit Entity Type".
3. Update the required general settings or custom fields.
4. Select "Save" to save the changes.
#### **Delete an Entity Type**
1. Select the entity type you want to remove from the Entity Type List.
2. Select "Delete Entity Type".
3. A confirmation message is displayed.
4. Select "Yes" to delete the entity type or "No" to cancel the operation.
#### **Change Sort Order**
1. From the Entity Type List, select "Sort Entity Types".
2. Drag and drop the entity types to arrange them in the required order.
3. Select "OK" to save the new sort order.
### **Use Case**
* Create entity types for different types of records such as Members, Tables, and Customers.
* Configure general settings according to the requirements of the entity type.
* Define a primary field to identify the entity.
* Configure display and account-related formats for the entity type.
* Add custom fields to capture additional information for an entity.
* Mark custom fields as "Hidden" or "Mandatory" based on the required configuration.
* Edit existing entity types when their configuration needs to be updated.
* Arrange entity types in a preferred order for easier access and management.
### **Notes**
* The "Name" field is required when creating an entity type.
* Custom fields can be added and configured from the "Custom Fields" section.
* Deleting an entity type requires confirmation.
* Use "Sort Entity Types" to change the display order of entity types.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://help.rbsgo.com/dineplan/backoffice/enitites/entity-type.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
.png?alt=media)
