# SalesforceFieldDescription (/docs/codegen/api/interfaces/SalesforceFieldDescription)



[@kysoql/codegen](/docs/codegen/api) / SalesforceFieldDescription

Field metadata required to render a generated Kysoql schema.

## Properties [#properties]

| Property                                                               | Modifier   | Type                                                                                          | Description                                                                  |
| ---------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| <a id="api-property-name" /> `name`                                    | `readonly` | `string`                                                                                      | Salesforce field API name.                                                   |
| <a id="api-property-type" /> `type`                                    | `readonly` | `string`                                                                                      | Salesforce Describe field type.                                              |
| <a id="api-property-nillable" /> `nillable`                            | `readonly` | `boolean`                                                                                     | Whether Salesforce reports the field as nillable.                            |
| <a id="api-property-filterable" /> `filterable`                        | `readonly` | `boolean`                                                                                     | Whether Salesforce reports the field as filterable.                          |
| <a id="api-property-sortable" /> `sortable`                            | `readonly` | `boolean`                                                                                     | Whether Salesforce reports the field as sortable.                            |
| <a id="api-property-groupable" /> `groupable`                          | `readonly` | `boolean`                                                                                     | Whether Salesforce reports the field as groupable.                           |
| <a id="api-property-aggregatable" /> `aggregatable`                    | `readonly` | `boolean`                                                                                     | Whether Salesforce reports the field as aggregatable.                        |
| <a id="api-property-custom" /> `custom`                                | `readonly` | `boolean`                                                                                     | Whether this is a custom Salesforce field.                                   |
| <a id="api-property-referenceto" /> `referenceTo?`                     | `readonly` | readonly `string`\[]                                                                          | Target object API names for reference fields.                                |
| <a id="api-property-relationshipname" /> `relationshipName?`           | `readonly` | `string` \| `null`                                                                            | Parent relationship name supplied by Salesforce, if any.                     |
| <a id="api-property-namepointing" /> `namePointing?`                   | `readonly` | `boolean`                                                                                     | Whether Salesforce marks the field as a polymorphic name-pointing reference. |
| <a id="api-property-polymorphicforeignkey" /> `polymorphicForeignKey?` | `readonly` | `boolean`                                                                                     | Whether Salesforce marks the field as a polymorphic foreign key.             |
| <a id="api-property-picklistvalues" /> `picklistValues?`               | `readonly` | readonly [`SalesforcePicklistValue`](/docs/codegen/api/interfaces/SalesforcePicklistValue)\[] | Picklist values returned by Describe for this field.                         |