Envestnet · Schema

Statement

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
apr number The APR applied to the balance on the credit card account, as available in the statement.
Note: In case of variable APR, the APR available on the statement might differ from the APR availabl
cashApr number The APR applicable to cash withdrawals on the credit card account.

Applicable containers: creditCard, loan, insurance
billingPeriodStart string The start date of the statement period.

Applicable containers: creditCard, loan, insurance
dueDate string The date by when the minimum payment is due to be paid.
Note: The due date that appears in the statement may differ from the due date at the account-level.

Applicable containers
interestAmount object
statementDate string The date on which the statement is generated.

Applicable containers: creditCard, loan, insurance
cashAdvance object
billingPeriodEnd string The end date of the statement period.

Applicable containers: creditCard, loan, insurance
principalAmount object
loanBalance object
amountDue object
accountId integer Account to which the statement belongs to.

Applicable containers: creditCard, loan, insurance
lastUpdated string The date when the account was last updated by Yodlee.

Applicable containers: creditCard, loan, insurance
isLatest boolean The field is set to true if the statement is the latest generated statement.

Applicable containers: creditCard, loan, insurance
minimumPayment object
lastPaymentDate string The date on which the last payment was done during the billing cycle.

Applicable containers: creditCard, loan, insurance
lastPaymentAmount object
id integer Unique identifier for the statement.

Applicable containers: creditCard, loan, insurance
newCharges object
View JSON Schema on GitHub

JSON Schema

envestnet-statement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Statement",
  "title": "Statement",
  "type": "object",
  "properties": {
    "apr": {
      "type": "number",
      "description": "The APR applied to the balance on the credit card account, as available in the statement.<br><b>Note:</b> In case of variable APR, the APR available on the statement might differ from the APR available at the account-level.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "cashApr": {
      "type": "number",
      "description": "The APR applicable to cash withdrawals on the credit card account.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "billingPeriodStart": {
      "type": "string",
      "description": "The start date of the statement period.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "dueDate": {
      "type": "string",
      "description": "The date by when the minimum payment is due to be paid.<br><b>Note:</b> The due date that appears in the statement may differ from the due date at the account-level.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "interestAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "statementDate": {
      "type": "string",
      "description": "The date on which the statement is generated.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "cashAdvance": {
      "$ref": "#/components/schemas/Money"
    },
    "billingPeriodEnd": {
      "type": "string",
      "description": "The end date of the statement period.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "principalAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "loanBalance": {
      "$ref": "#/components/schemas/Money"
    },
    "amountDue": {
      "$ref": "#/components/schemas/Money"
    },
    "accountId": {
      "type": "integer",
      "description": "Account to which the statement belongs to.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "format": "int64",
      "readOnly": true
    },
    "lastUpdated": {
      "type": "string",
      "description": "The date when the account was last updated by Yodlee.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "isLatest": {
      "type": "boolean",
      "description": "The field is set to true if the statement is the latest generated statement.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "minimumPayment": {
      "$ref": "#/components/schemas/Money"
    },
    "lastPaymentDate": {
      "type": "string",
      "description": "The date on which the last payment was done during the billing cycle.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "readOnly": true
    },
    "lastPaymentAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "id": {
      "type": "integer",
      "description": "Unique identifier for the statement.<br><br><b>Applicable containers</b>: creditCard, loan, insurance<br>",
      "format": "int64",
      "readOnly": true
    },
    "newCharges": {
      "$ref": "#/components/schemas/Money"
    }
  }
}