# SalesforceFieldMetadata (/docs/core/reference/api/interfaces/SalesforceFieldMetadata)



[@kysoql/core](/docs/core/reference/api) / SalesforceFieldMetadata

Metadata that describes Salesforce field capabilities in a Kysoql schema.

## Properties [#properties]

| Property                                                           | Modifier   | Type      | Description                                                               |
| ------------------------------------------------------------------ | ---------- | --------- | ------------------------------------------------------------------------- |
| <a id="api-property-salesforcetype" /> `salesforceType`            | `readonly` | `string`  | Salesforce Describe field type, such as `string`, `date`, or `reference`. |
| <a id="api-property-nullable" /> `nullable`                        | `readonly` | `boolean` | Whether Salesforce can return `null` for this field.                      |
| <a id="api-property-filterable" /> `filterable`                    | `readonly` | `boolean` | Whether the field can be referenced in a `WHERE` predicate.               |
| <a id="api-property-sortable" /> `sortable`                        | `readonly` | `boolean` | Whether the field can be referenced in `ORDER BY`.                        |
| <a id="api-property-groupable" /> `groupable`                      | `readonly` | `boolean` | Whether the field can be referenced in `GROUP BY`.                        |
| <a id="api-property-referenceto" /> `referenceTo?`                 | `readonly` | `string`  | Referenced Salesforce object name for a relationship field, when known.   |
| <a id="api-property-relationshipname" /> `relationshipName?`       | `readonly` | `string`  | Parent relationship name used for dotted relationship traversal.          |
| <a id="api-property-activepicklistvalue" /> `activePicklistValue?` | `readonly` | `string`  | Active picklist values represented by the generated field type.           |
| <a id="api-property-aggregatable" /> `aggregatable?`               | `readonly` | `boolean` | Whether the field can be passed to Salesforce aggregate functions.        |
| <a id="api-property-custom" /> `custom?`                           | `readonly` | `boolean` | Whether the field is a custom Salesforce field.                           |
| <a id="api-property-polymorphic" /> `polymorphic?`                 | `readonly` | `boolean` | Whether the relationship can target more than one Salesforce object type. |