Skip to main content

# MilestoneInfo

    type MilestoneInfo = {
      daysToFinish: number;
      daysToFinishDate: string;
      doneIndicator: boolean;
      loanAssociate: {
         role: {
            entityId: string;
            entityName: string;
            entityType: string;
         };
         writeAccess: boolean;
      };
      milestoneId: string;
      name: string;
      reviewedIndicator: boolean;
      role: {
         entityId: string;
         entityName: string;
         entityType: string;
      };
      roleRequired: boolean;
      user: null | unknown;
    };

Milestone related information

## Properties​

### daysToFinish​

    daysToFinish: number;

Number of days to finish the milestone

### daysToFinishDate​

    daysToFinishDate: string;

Date by which the milestone should be finished (ISO 8601 format)

### doneIndicator​

    doneIndicator: boolean;

Indicates if the milestone is marked as done

### loanAssociate​

    loanAssociate: {
      role: {
         entityId: string;
         entityName: string;
         entityType: string;
      };
      writeAccess: boolean;
    };

Information about the loan associate

Name | Type | Description
--- | --- | ---
`role` | { `entityId`: `string`; `entityName`: `string`; `entityType`: `string`; } | Role information of the loan associate
`role.entityId` | `string` | Unique identifier for the role
`role.entityName` | `string` | Name of the role
`role.entityType` | `string` | Type of the entity (e.g., Role)
`writeAccess` | `boolean` | Indicates if the loan associate has write access

### milestoneId​

    milestoneId: string;

Unique identifier for the milestone

### name​

    name: string;

Name of the milestone

### reviewedIndicator​

    reviewedIndicator: boolean;

Indicates if the milestone has been reviewed

### role​

    role: {
      entityId: string;
      entityName: string;
      entityType: string;
    };

Role information for the milestone

Name | Type | Description
--- | --- | ---
`entityId` | `string` | Unique identifier for the role
`entityName` | `string` | Name of the role
`entityType` | `string` | Type of the entity (e.g., Role)

### roleRequired​

    roleRequired: boolean;

Indicates if the role is required for the milestone

### user​

    user: null | unknown;

User associated with the milestone (can be null)