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



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

Type-level description of one Salesforce object and its query
capabilities.

## Type Parameters [#type-parameters]

| Type Parameter                                                                                                                                                              | Default type                 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `Fields` *extends* `Record`\<`string`, `AnySalesforceField`>                                                                                                                | -                            |
| `Parents` *extends* `Record`\<`string`, [`SalesforceParentRelationship`](/docs/core/reference/api/interfaces/SalesforceParentRelationship)\<`string`, `string`, `boolean`>> | `Record`\<`string`, `never`> |
| `Children` *extends* `Record`\<`string`, [`SalesforceChildRelationship`](/docs/core/reference/api/interfaces/SalesforceChildRelationship)\<`string`, `string`>>             | `Record`\<`string`, `never`> |
| `SupportedScope` *extends* `string`                                                                                                                                         | `never`                      |
| `DataCategoryGroups` *extends* `Record`\<`string`, `string`>                                                                                                                | `Record`\<`string`, `never`> |
| `MruEnabled` *extends* `boolean`                                                                                                                                            | `boolean`                    |
| `SetOptionsCapability` *extends* [`SalesforceSetOptionsCapability`](/docs/core/reference/api/type-aliases/SalesforceSetOptionsCapability)                                   | `"none"`                     |
| `FieldsComplete` *extends* `boolean`                                                                                                                                        | `true`                       |

## Properties [#properties]

| Property                                                            | Modifier   | Type                   | Description                                                                |
| ------------------------------------------------------------------- | ---------- | ---------------------- | -------------------------------------------------------------------------- |
| <a id="api-property-fields" /> `fields`                             | `readonly` | `Fields`               | Field definitions keyed by Salesforce field API name.                      |
| <a id="api-property-parents" /> `parents`                           | `readonly` | `Parents`              | Parent relationship definitions keyed by relationship name.                |
| <a id="api-property-children" /> `children`                         | `readonly` | `Children`             | Child relationship definitions keyed by relationship name.                 |
| <a id="api-property-supportedscopes" /> `supportedScopes`           | `readonly` | `SupportedScope`       | Union of `USING SCOPE` values accepted by this object.                     |
| <a id="api-property-datacategorygroups" /> `dataCategoryGroups`     | `readonly` | `DataCategoryGroups`   | Data-category groups and values available to `WITH DATA CATEGORY`.         |
| <a id="api-property-mruenabled" /> `mruEnabled`                     | `readonly` | `MruEnabled`           | Whether MRU-dependent clauses such as `FOR VIEW` are supported.            |
| <a id="api-property-setoptionscapability" /> `setOptionsCapability` | `readonly` | `SetOptionsCapability` | Which Salesforce `SET OPTIONS` variant this object supports.               |
| <a id="api-property-fieldscomplete" /> `fieldsComplete?`            | `readonly` | `FieldsComplete`       | False for field-filtered schemas; server-side FIELDS() cannot be narrowed. |