Required Document DMO

The Required Document DMO represents a document that’s required for a given benefit assignment.

Object API Name: RequiredDocument_std__dlm
Category: Unassigned
Availability: Available in 262 and later versions
Primary Key Field: Id

• IndividualId has a FOREIGNKEY relationship with the Individual DMO Id field.
• BenefitAssignmentId has a FOREIGNKEY relationship with the Benefit Assignment DMO Id field.

• AwardYear
• BenefitAssignmentId
• cdp_sys_record_currency
• Comments
• DataSourceId
• DataSourceObjectId
• Description
• Id
• IndividualId
• Instructions
• InternalOrganizationId
• KQ_BenefitAssignmentId
• KQ_Id
• KQ_IndividualId
• Reason
• ReceivedDate
• RequiredDocumentName
• Status
• StatusType

• Field API Name: AwardYear__c
• Data Type: TEXT
• Description: The award year that’s associated with the required document.

• Field API Name: BenefitAssignmentId__c
• Data Type: TEXT
• Description: The reference to the benefit assignment that’s associated with the required document.

• Field API Name: cdp_sys_record_currency__c
• Data Type: TEXT
• Description: System-generated metadata field that stores a 3-letter ISO currency code.

• Field API Name: Comments__c
• Data Type: TEXT
• Description: The processing comments about the required document.

• Field API Name: DataSourceId__c
• Data Type: TEXT
• Description: A unique, system-generated identifier for this record.

• Field API Name: DataSourceObjectId__c
• Data Type: TEXT
• Description: A unique, system-generated identifier for this record.

• Field API Name: Description__c
• Data Type: TEXT
• Description: The description of the required document that’s used in reports and student portals.

• Field API Name: Id__c
• Data Type: TEXT
• Description: Primary key.

• Field API Name: IndividualId__c
• Data Type: TEXT
• Description: The reference to the individual learner that’s associated with the required document.

• Field API Name: Instructions__c
• Data Type: TEXT
• Description: The instructions for the learner to acquire and submit the required document.

• Field API Name: InternalOrganizationId__c
• Data Type: TEXT
• Description: A unique, system-generated identifier for this record.

• Field API Name: KQ_BenefitAssignmentId__c
• Data Type: TEXT
• Description: Key Qualifier system field for BenefitAssignmentId

• Field API Name: KQ_Id__c
• Data Type: TEXT
• Description: Key Qualifier system field for Id

• Field API Name: KQ_IndividualId__c
• Data Type: TEXT
• Description: Key Qualifier system field for IndividualId

• Field API Name: Reason__c
• Data Type: TEXT
• Description: The reason that the learner must submit the required document.

• Field API Name: ReceivedDate__c
• Data Type: DATEONLY
• Description: The date that the institution logged receipt of the required document.

• Field API Name: RequiredDocumentName__c
• Data Type: TEXT
• Description: The name of the required document.

• Field API Name: Status__c
• Data Type: TEXT
• Description: The status of the required document.

• Field API Name: StatusType__c
• Data Type: TEXT
• Description: A text field that allows customers to choose how the status should be treated in the Financial Aid Application. For example, Outstanding would be surfaced in several areas indicating something needs to be done, whereas Complete is not shown by default. Examples: Outstanding, Received, Complete.