# Custom Field Definition

### What is Custom Field Definition?

In the XoroERP system, each module contains a specific set of fields designed to define the entities associated with that module. For example, the item module includes universally required fields like Item Number, Cost, UPC, and Barcode. However, businesses might often require additional fields specific to their operations. Keeping that in mind,  Xoro provides you with the ability to add your own fields to customize the system as per your needs. Depending on the business model, the ***Custom Fields*** could be added in a few Xoro modules such as Invoice, Invoice Item Line, Sales Order, Sales Order Detail, Customer, Sales Order Detail, etc.

Custom Fields are similar to the standard fields that come built-in to the Xoro system. You can create the custom fields from the "Custom Field Definition" module.

There are 50 Custom Fields that are available in the ***Custom Field Definition*** module.

Custom Fields can be created for different “**Transaction Types**”.

The Custom Fields can be added to the following Transaction Types:

* Account
* ASN
* Bill of Material
* Bill Of Material Item Line
* Charge Entry 3PL
* Credit Memo
* Credit Memo Line
* Customer
* Estimate
* Estimate Detail
* Invoice
* Invoice Item Line
* Item
* Item Receipt Line Detail
* Item Vendor Mapping
* Manufacturing Order
* Manufacture Order Item Lines
* Packing Slip
* Packing Slip Detail
* Purchase Order
* Purchase Order Detail
* RMA
* RMA Detail
* Sales Order
* Sales Order Detail
* Sales Receipt Item Line&#x20;
* Vendor

### Creating Custom Fields

When creating a custom field, you will begin by defining the transaction type, then enter the field name and define the values accepted for the field.

{% hint style="info" %}
*To create the custom field, go to: **Menu > Admin > Custom Field Definition***
{% endhint %}

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2Fs0EjOMnsoNcbuKF6RYID%2Fimage.png?alt=media&#x26;token=b4b1d76f-bb09-469d-ac5a-f291e1009491" alt=""><figcaption></figcaption></figure>

#### Custom Field Definition Fields

| Field              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Transaction Type   | This field allows users  to define the module to which the custom field will be associated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Custom Field       | This allows users to enter the name for the custom field.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Custom Field Value | <p>Here users can choose the value type that will be accepted in the custom fields. This ensures that the data entered into the field is in the correct format. The following value types are available for selection from a dropdown menu:</p><ul><li><strong>Text</strong>: Accepts any form of textual data.</li><li><strong>Number</strong>: Allows only numerical values.</li><li><strong>List</strong>: Enables you to define a list of pre-defined options from which a user can choose. If this type is selected, you can add the options as a comma-separated list.</li><li><strong>Date</strong>: Users can select or enter a date.</li><li><strong>Multi-Select List</strong>: Similar to the "List" option, but users can select multiple values from the predefined list.</li><li><p><strong>Multi-line Text:</strong> Allows users to capture <strong>paragraph-style, free-form text</strong>, offering greater flexibility for storing detailed information.</p><p>Additionally, to ensure a clean and user-friendly interface, a <strong>“Show More”</strong> toggle has been implemented for long custom field values.</p></li></ul><p><em><strong>Please note: For the "List" and "Multi-Select List" options, you can enable the "Custom Source" option to specify a custom source, which allows for the addition of a custom script that can dynamically generate the list values.</strong></em></p> |

Once all the custom fields have been defined for a transaction, click on "**Save**" to create the custom fields.&#x20;

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2Fq8mQBkUK3AsMEuDqcZbx%2Fimage.png?alt=media&#x26;token=6017201c-8b69-465a-87ec-239aab71bd7f" alt=""><figcaption></figcaption></figure>

Once the custom fields for a module are created, they will be visible under the **Custom Field** tab of that module. So, if you have defined the custom field "Item", the added Custom fields can be seen under the Custom Fields tab of the Item.

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2FGmM3e8FyjT4Z92MpDg28%2Fimage.png?alt=media&#x26;token=565fa6e5-ed50-40ff-9454-e0f650f844ff" alt=""><figcaption></figcaption></figure>

All the custom fields added in the system can be viewed and updated through the [**Custom Field Definition Centre**](https://docs.xorosoft.com/xoroerp-1/admin/custom-field-definition/custom-field-definition-centre).

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2FjQWAou0m78yZiSapJa0c%2Fimage.png?alt=media&#x26;token=1eda4e4c-3ebb-428f-a2e3-4e534d4675cf" alt=""><figcaption></figcaption></figure>
