{
"id": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"paymentAgreementID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"tenantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"programID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"buyerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"merchantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"buyerGivenName": "string",
"loanStatus": "string",
"loanSubstatus": "string",
"maturityDate": "2020-12-31",
"startUpgradeWindowDate": "2020-12-31",
"endUpgradeWindowDate": "2020-12-31",
"originalBdam": {
"currency": "USD",
"value": 50000
},
"balanceOwed": {
"currency": "USD",
"value": 50000
},
"bdamRemaining": {
"currency": "USD",
"value": 50000
},
"bdamPercentage": 0,
"loanSettledDate": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"loanOriginalAmortization": 0,
"tradeInPaymentId": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"linkedPaymentAgreementID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"electionHistory": [
{
"id": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"electionDate": "2020-12-31",
"election": "KEEP"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | true | none | id of the UpgradeableLoan entity |
| paymentAgreementID | string(uuid) | true | none | id of the associated payment agreement |
| tenantID | string(uuid) | true | none | id of the tenant |
| programID | string(uuid) | true | none | id of the program |
| buyerID | string(uuid) | true | none | id of the buyer |
| merchantID | string(uuid) | true | none | id of the merchant |
| buyerGivenName | string | true | none | name of the buyer |
| loanStatus | string | true | none | Status of the loan |
| loanSubstatus | string | true | none | Substatus of the loan |
| maturityDate | string(date) | true | none | the date of maturity |
| startUpgradeWindowDate | string(date) | true | none | the start date of the upgrade window |
| endUpgradeWindowDate | string(date) | true | none | the end date of the upgrade window |
| originalBdam | object | true | none | Original BDAM value |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| balanceOwed | object | true | none | the remaining balance owed |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| bdamRemaining | object | true | none | Remaining BDAM value |
| ➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
| ➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
| bdamPercentage | number(double) | true | none | Percentage of BDAM |
| loanSettledDate | string(uuid) | true | none | Date when the loan was settled |
| loanOriginalAmortization | integer | true | none | Original amortization value of the loan |
| tradeInPaymentId | string(uuid) | true | none | id of the trade in payment |
| linkedPaymentAgreementID | string(uuid) | true | none | id of the linked payment agreement in the Upgrade election |
| electionHistory | [object] | true | none | none |
| ➥ id | string(uuid) | true | none | A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls. |
| ➥ electionDate | string(date) | true | none | The date value formatted per RFC3339. This does not allow nulls. |
| ➥ election | string | true | none | none |
Enumerated Values
| Value |
|---|
| KEEP |
| RETURN |
| UPGRADE |