V3 Create Correspondent Purchase Advice Log

post

https://api.elliemae.com/encompass/v3/loans/{loanId}/cpaTrackingLogs

Creates a new Correspondent Purchase Advice (CPA) snapshot log for a given loan.

This API added with the 26.3 release of Encompass.

Usage Notes

The following is the flow process:

This API allows a CPA log to be created. An empty object is provided in the request.
Once a log is created, field 5120 CPAConfirmed is set to true. No additional logs can be created while 5120 CPAConfirmed = true.
To revise and create a new CPA log, call the V3 Update Loan API endpoint and use action=ReviseCPA. This will automatically set 5120 CPAConfirmed back to false.
The process starts over again.

A maximum of 10 logs can be created per loan.

Path Params

loanId

string

required

The unique identifier of the loan.

Query Params

lockId

string

The lock identifier for the loan, if the loan is locked for editing.

Body Params

string

The Correspondent Purchase Advice log ID.

status

string

The status of the Correspondent Purchase Advice. . Possible values: Active, Inactive

firstScheduledPaymentAmount

number

RetrieveOnly. The Correspondent Purchase Advice first scheduled payment amount.

firstPaymentDate

date

yyyy-MM-dd

RetrieveOnly. The Correspondent Purchase Advice first payment date.

currentPrincipal

number

RetrieveOnly. The Correspondent Purchase Advice additional purchase details purchased principal.

finalBuyPrice

number

RetrieveOnly. The Correspondent Purchase Advice additional adjusters final buy price.

purchaseDetailsInterest

number

RetrieveOnly. The Correspondent Purchase Advice additional purchase details interest.

purchaseDetailsInterestDays

integer

RetrieveOnly. The Correspondent Purchase Advice additional purchase details interest days.

purchaseDate

date

yyyy-MM-dd

RetrieveOnly. The Correspondent Purchase Advice date.

anticipatedPurchaseDate

date

yyyy-MM-dd

RetrieveOnly. The Correspondent Purchase Advice payment history calculator anticipated purchase date.

loanAmount

number

RetrieveOnly. The total loan amount.

purchaseDetailsPurchasedPrincipal

number

RetrieveOnly. The Correspondent Purchase Advice additional purchase details purchased principal.

wireAmount

number

RetrieveOnly. The Correspondent Purchase Advice additional purchase details additional total amount.

paymentHistoryCalculatedPurchasedPrincipal

number

RetrieveOnly. The Correspondent Purchase Advice payment history calculator calculated purchased principal.

comments

string

RetrieveOnly. The Correspondent Purchase Advice comments.

createdDate

date-time

yyyy-MM-ddTHH:mm:ssZ

RetrieveOnly. The date/time that the log was created.

createdBy

object

RetrieveOnly. The entity that created the CPA log as defined in the EntityReferenceContract.

modifiedBy

string

RetrieveOnly. The entity that last updated the CPA log.

modifiedDate

date-time

yyyy-MM-ddTHH:mm:ssZ

RetrieveOnly. The date/time that the CPA log was last modified.

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

201Created