# Agreement

A legal Agreement for an Account.

## Example Usage

```typescript
import { Agreement } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: Agreement = {};
```

## Fields

| Field                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                  | Description                                                                                                                                                                                                               | Example                                                                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `affirmationTime`                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                        | The time recorded relating to when a given agreement is `AFFIRMED` by the Customer; This is set to the time when the affirmation is processed by AFS                                                                      |                                                                                                                                                                                                                           |
| `agreementId`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | An Apex-generated identifier used to reference a single legal agreement associated with the account                                                                                                                       | fa2f181c-f2fb-4bc2-b75a-79302c634ae5                                                                                                                                                                                      |
| `agreementName`                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | The friendly name of the agreement; Typically mirrors the enrollment it is attached to (e.g., `LENDING_FULLY_PAID_STOCK_LOAN`)                                                                                            | Standard Customer Account Agreement - IBD (EN)                                                                                                                                                                            |
| `agreementSource`                                                                                                                                                                                                         | [components.AgreementSource](../../models/components/agreementsource.md)                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | An internal indicator from where the agreement was generated; Typically `ACCOUNTS_SERVICE` if accessing our public APIs                                                                                                   | ACCOUNTS_SERVICE                                                                                                                                                                                                          |
| `agreementState`                                                                                                                                                                                                          | [components.AgreementState](../../models/components/agreementstate.md)                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                        | The status of an agreement which blocks an enrollment; `REQUIRED` if not yet received, or `AFFIRMED` if acknowledgement has been received by AFS                                                                          | AFFIRMED                                                                                                                                                                                                                  |
| `agreementUri`                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | A URI referencing a static PDF containing the legalese of a given agreement; All agreements of the same nature link to the same publicly-available PDF.                                                                   | https://public-documents.apexapis.com/account-agreements/SCAA-IBD-20230525-EN.pdf                                                                                                                                         |
| `agreementVersion`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | An internal version number based on typographical revisions of the related agreement; Version numbers are automatically updated when new agreements are available and should be of no technical concern to the integrator | 20230525                                                                                                                                                                                                                  |
| `enrollmentId`                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | A system-generated unique identifier referencing a single instance of an enrollment; Used to access the record after creation                                                                                             | cd47a802-5a6b-4d32-b497-c4f6d5ce0be8                                                                                                                                                                                      |
| `legalEntityId`                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | References a single entity                                                                                                                                                                                                | 42567868-9373-4872-9d24-2e33f6c19b75                                                                                                                                                                                      |
| `legalNaturalPersonId`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | References a single natural person                                                                                                                                                                                        | e6716139-da77-46d1-9f15-13599161db0b                                                                                                                                                                                      |
| `name`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                        | The name field Format: accounts/{account}/agreements/{agreement}                                                                                                                                                          | accounts/01HC3MAQ4DR9QN1V8MJ4CN1HMK/agreements/fa2f181c-f2fb-4bc2-b75a-79302c634ae5                                                                                                                                       |