V3 Manage Gifts and Grants

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/applications/{applicationId}/giftsGrants

Use this API to manage the Gifts and Grants collection for an application at once. You can perform one of these operations in a single transaction on all the entries in this collection:

add to add new Gifts and Grants
update to update existing Gifts and Grants in the application
reorder to swap the order of the existing Gifts and Grants in the application
delete to delete Gifts and Grants entries from the application

Path Params

loanId

string

required

Unique identifier of the loan.

applicationId

string

required

Unique identifier of the Application or Borrower Pair in the loan for which VOGGs need to be retrieved..

Query Params

action

string

Action to be performed. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier of additional loans in the loan.

assetType

string

Type of asset.

attention

string

Person's name or department.

source

string

Source of gifts and grants.

otherSourceDescription

string

Description of other source of gifts and grants.

holderAddressCity

string

City of the gift and grants holder's address.

holderAddressPostalCode

string

Postal Code of the gift and grants holder's address.

holderAddressState

string

State of the gift and grants holder's address.

holderAddressStreetLine1

string

Street Line 1 of the gift and grants holder's address.

holderEmail

string

Email Address of the gifts and grants holder.

holderFax

string

Fax Number of the gifts and grants holder.

holderName

string

Name of the gifts and grants holder.

holderPhone

string

Phone number of the gifts and grants holder.

amount

number

Amount of gifts and grants on the loan.

owner

string

Owner of the gifts and grants holder.

title

string

Title of the user verifying the gifts and grants.

printAttachmentIndicator

boolean

Indicates if the attachment is to be printed.

printUserNameIndicator

boolean

Indicates if the user's name is to be printed.

printUserJobTitleIndicator

boolean

Job Title of the user verifying the gifts and grants

depositedIndicator

boolean

Indicates if the Gift and Grant is deposited.

titlePhone

string

Phone Number of the user verifying the gifts and grants.

titleFax

string

Fax number of the user verifying the gifts and grants.

giftorGrantDate

string

Date on which gifts and grants were assigned to the borrower.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Response

Choose an example:

application/json

200OK