# Client

Represents a client.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activationDate** | **string** | The date when a client was set as active for the first time. | [optional] [readonly] [default to undefined]
**addresses** | [**Array<Address>**](Address.md) | The addresses associated with this client. | [optional] [default to undefined]
**approvedDate** | **string** | The date when a client was approved. | [optional] [readonly] [default to undefined]
**assignedBranchKey** | **string** | The encoded key of the branch a client is assigned to. | [optional] [default to undefined]
**assignedCentreKey** | **string** | The encoded key of the centre a client is assigned to. | [optional] [default to undefined]
**assignedUserKey** | **string** | The encoded key of the user a client is assigned to. | [optional] [default to undefined]
**birthDate** | **string** | The client\'s date of birth. | [optional] [default to undefined]
**clientRoleKey** | **string** | A role which describes the intended use of a client in the system. | [optional] [default to undefined]
**closedDate** | **string** | The date when the client state was changed to closed. | [optional] [readonly] [default to undefined]
**creationDate** | **string** | The date a client was created. | [optional] [readonly] [default to undefined]
**emailAddress** | **string** | The client\'s email address. | [optional] [default to undefined]
**encodedKey** | **string** | The encoded key of the client, which is unique and generated. | [optional] [readonly] [default to undefined]
**firstName** | **string** | The first name, personal name, given name, or forename of the client. | [default to undefined]
**gender** | **string** | The client\'s gender, the options are male or female. | [optional] [default to undefined]
**groupKeys** | **Array<string>** | The groups to which this client belongs. | [optional] [default to undefined]
**groupLoanCycle** | **number** | Number of paid and closed (with \'obligations met\') accounts for a client\'s group; when the closing operation is reverted, this is reduced. | [optional] [readonly] [default to undefined]
**homePhone** | **string** | The client\'s home phone number. | [optional] [default to undefined]
**id** | **string** | The ID of the client, which can be generated and customized - but must be unique. | [optional] [default to undefined]
**idDocuments** | [**Array<IdentificationDocument>**](IdentificationDocument.md) | The identification documents for this client. | [optional] [default to undefined]
**lastModifiedDate** | **string** | The last date a client was modified. | [optional] [readonly] [default to undefined]
**lastName** | **string** | The last name, surname, or family name of the client. | [default to undefined]
**loanCycle** | **number** | Number of paid and closed (with \'obligations met\') accounts for a client; when the closing operation is reverted, this is reduced. | [optional] [readonly] [default to undefined]
**middleName** | **string** | The middle name of the client. | [optional] [default to undefined]
**migrationEventKey** | **string** | The migration event encoded key associated with a client. | [optional] [readonly] [default to undefined]
**mobilePhone** | **string** | The client\'s mobile phone number. | [optional] [default to undefined]
**mobilePhone2** | **string** | The client\'s second mobile phone number. | [optional] [default to undefined]
**notes** | **string** | The additional notes about a client. | [optional] [default to undefined]
**portalSettings** | [**PortalSettings**](PortalSettings.md) |  | [optional] [default to undefined]
**preferredLanguage** | **string** | The client\'s preferred language. This will determine the language for the reports, schedules, and account statements you generate for the client. | [optional] [default to undefined]
**profilePictureKey** | **string** | The encoded key of a client\'s profile picture. | [optional] [readonly] [default to undefined]
**profileSignatureKey** | **string** | The encoded key of the client\'s profile signature. | [optional] [readonly] [default to undefined]
**state** | **string** | The state of a client. It shows where the client is in the client life cycle. | [optional] [default to undefined]

## Example

```typescript
import { Client } from './api';

const instance: Client = {
    activationDate,
    addresses,
    approvedDate,
    assignedBranchKey,
    assignedCentreKey,
    assignedUserKey,
    birthDate,
    clientRoleKey,
    closedDate,
    creationDate,
    emailAddress,
    encodedKey,
    firstName,
    gender,
    groupKeys,
    groupLoanCycle,
    homePhone,
    id,
    idDocuments,
    lastModifiedDate,
    lastName,
    loanCycle,
    middleName,
    migrationEventKey,
    mobilePhone,
    mobilePhone2,
    notes,
    portalSettings,
    preferredLanguage,
    profilePictureKey,
    profileSignatureKey,
    state,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)