> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CustomField

> A custom attribute synced from the HRIS: a coded field whose Value is stored canonically as a string and tagged with its so consumers can interpret it as a str…

A custom attribute synced from the HRIS: a coded field whose `Value` is stored canonically as a string and tagged with its [Kind](https://klef.ai/docs/connector-sdk/reference/model-workers-customfields/customfield.md) so consumers can interpret it as a string, boolean, or date.

```csharp
public sealed record CustomField : IEquatable<CustomField>
```

**Implements:** `IEquatable<CustomField>`

## Constructors

```csharp
public CustomField(string Code, string Name, CustomFieldKind Kind, string Value)
```

A custom attribute synced from the HRIS: a coded field whose `Value` is stored canonically as a string and tagged with its [Kind](https://klef.ai/docs/connector-sdk/reference/model-workers-customfields/customfield.md) so consumers can interpret it as a string, boolean, or date.

### Parameters

**Code** `string` *required*

**Name** `string` *required*

**Kind** `CustomFieldKind` *required*

**Value** `string` *required*

## Properties

**Code** `string` *required*

**Kind** `CustomFieldKind` *required*

**Name** `string` *required*

**Value** `string` *required*

## Methods

### AsBoolean()

```csharp
public bool? AsBoolean()
```

#### Returns

`bool?`

### AsDateTime()

```csharp
public Instant? AsDateTime()
```

#### Returns

`Instant?`

### AsNumber()

```csharp
public decimal? AsNumber()
```

#### Returns

`decimal?`

### Deconstruct()

```csharp
public void Deconstruct(out string Code, out string Name, out CustomFieldKind Kind, out string Value)
```

#### Parameters

**Code** `string` *required*

**Name** `string` *required*

**Kind** `CustomFieldKind` *required*

**Value** `string` *required*

### Equals()

```csharp
public bool Equals(CustomField? other)
```

#### Parameters

**other** `CustomField` *required*

#### Returns

`bool`

```csharp
public override bool Equals(object? obj)
```

#### Parameters

**obj** `object` *required*

#### Returns

`bool`

### GetHashCode()

```csharp
public override int GetHashCode()
```

#### Returns

`int`

### operator !=()

```csharp
public static bool operator !=(CustomField? left, CustomField? right)
```

#### Parameters

**left** `CustomField` *required*

**right** `CustomField` *required*

#### Returns

`bool`

### operator ==()

```csharp
public static bool operator ==(CustomField? left, CustomField? right)
```

#### Parameters

**left** `CustomField` *required*

**right** `CustomField` *required*

#### Returns

`bool`

### ToString()

```csharp
public override string ToString()
```

#### Returns

`string`

### Typed()

```csharp
public static CustomField Typed(string code, string name, CustomFieldKind kind, string value)
```

A custom field of `kind`, with a number in its invariant form. A number that does not parse is kept as text, and an unanswered one keeps its kind.

#### Parameters

**code** `string` *required*

**name** `string` *required*

**kind** `CustomFieldKind` *required*

**value** `string` *required*

#### Returns

`CustomField`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.