{
  "type": "object",
  "required": [
    "appDescription",
    "appName",
    "appUrl",
    "ownerAddressLine1",
    "ownerAddressLine2",
    "ownerCity",
    "ownerCountry",
    "ownerName",
    "ownerPostalCode",
    "ownerState",
    "image"
  ],
  "properties": {
    "image": {
      "type": "string",
      "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcgICAKICAgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB2ZXJzaW9uPSIxLjEiCiAgIHZpZXdCb3g9IjAgMCAwIDAiCiAgIGhlaWdodD0iMCIKICAgd2lkdGg9IjAiPgogICAgPGcvPgo8L3N2Zz4K",
      "description": "An app logo passed as a Base64 encoded image (1:1 SVG file, must be less than 50KB)"
    },
    "appUrl": {
      "type": "string",
      "example": "https://www.finicity.com/",
      "description": "An URL for the app. This will be visible to end users in the FI interface."
    },
    "appName": {
      "$ref": "#/components/schemas/ApplicationName"
    },
    "ownerCity": {
      "type": "string",
      "example": "Murray",
      "description": "City for the business entity that owns the app. Information for registration purposes only and not given to the end user."
    },
    "ownerName": {
      "type": "string",
      "example": "Finicity",
      "description": "Business name for the business entity that owns the app. Information for registration purposes only and not given to the end user."
    },
    "ownerState": {
      "type": "string",
      "example": "UT",
      "description": "State for the business entity that owns the app. Information for registration purposes only and not given to the end user."
    },
    "ownerCountry": {
      "type": "string",
      "example": "USA",
      "description": "Country for the  business entity that owns the app. Information for registration purposes only and not given to the end user."
    },
    "appDescription": {
      "type": "string",
      "example": "The app that makes your budgeting experience awesome",
      "description": "A short description of the app. This will be visible to end users in the FI interface."
    },
    "ownerPostalCode": {
      "type": "string",
      "example": "84123",
      "description": "Zip code for the business entity that owns the app. Information for registration purposes only and not given to the end user."
    },
    "ownerAddressLine1": {
      "$ref": "#/components/schemas/AddressLine1"
    },
    "ownerAddressLine2": {
      "$ref": "#/components/schemas/AddressLine2"
    }
  }
}

{
  "type": "string",
  "example": "123456789",
  "description": "`applicationId` value returned from the Get App Registration Status API and the partner assign the customers to. This cannot be changed once set. Only applicable in cases of partners with multiple registered applications. If the partner only has one app, this can usually be omitted. This field is populated after the app is in a status approved."
}

{
  "type": "string",
  "example": "Awesome Budget App",
  "description": "The name of the application assigned to the customer"
}

{
  "type": "integer",
  "format": "int64",
  "example": 1596175200,
  "description": "The last time the payroll data was updated in the payroll provider's system"
}

{
  "type": "object",
  "required": [
    "assetId"
  ],
  "properties": {
    "assetId": {
      "$ref": "#/components/schemas/AssetId"
    }
  },
  "description": "An asset"
}

{
  "type": "string",
  "example": "097545c5-1c2a-4f20-a5ef-77f0820344c9-2018601178",
  "description": "An asset ID. Generated by Connect or by using the Store Customer Pay Statement API."
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "required": [
    "id",
    "realAccountNumberLast4",
    "availableBalance",
    "availableBalanceDate",
    "clearedBalance",
    "clearedBalanceDate",
    "aggregationStatusCode",
    "currency"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "clearedBalance": {
      "type": "number",
      "example": 222.25,
      "description": "The cleared balance of the account. Also referred as posted balance, current balance, ledger balance"
    },
    "availableBalance": {
      "type": "number",
      "example": 173.47,
      "description": "The available balance of the account"
    },
    "clearedBalanceDate": {
      "$ref": "#/components/schemas/UnixDate"
    },
    "availableBalanceDate": {
      "$ref": "#/components/schemas/UnixDate"
    },
    "aggregationStatusCode": {
      "$ref": "#/components/schemas/AggregationStatusCode"
    },
    "realAccountNumberLast4": {
      "$ref": "#/components/schemas/AccountNumberLast4"
    }
  }
}

{
  "type": "object",
  "required": [
    "accountId",
    "accountDetails",
    "historicDataAvailability",
    "currentReportRequest"
  ],
  "properties": {
    "accountId": {
      "$ref": "#/components/schemas/NumericAccountId"
    },
    "accountDetails": {
      "$ref": "#/components/schemas/ObbAccountDetails"
    },
    "currentReportRequest": {
      "$ref": "#/components/schemas/ObbCurrentReportRequestDetails"
    },
    "balanceAnalyticsMetrics": {
      "$ref": "#/components/schemas/BalanceAnalyticsMetrics"
    },
    "historicDataAvailability": {
      "$ref": "#/components/schemas/ObbDataAvailability"
    }
  }
}

{
  "type": "object",
  "properties": {
    "currentReportRequest": {
      "$ref": "#/components/schemas/ObbCurrentReportRequestDetails"
    },
    "balanceAnalyticsMetrics": {
      "$ref": "#/components/schemas/BalanceAnalyticsMetrics"
    },
    "historicDataAvailability": {
      "$ref": "#/components/schemas/ObbDataAvailability"
    }
  },
  "description": "Balance analytics summarized across all accounts in the report"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "availableBalance": {
      "type": "number",
      "example": 1000.01,
      "description": "Available Balance"
    },
    "availableBalanceDate": {
      "type": "string",
      "example": "2022-02-18T02:34:00-07:00",
      "maxLength": 25,
      "minLength": 25,
      "description": "Available Balance date"
    },
    "currentRunningBalance": {
      "type": "number",
      "example": 1000.01,
      "description": "Current Running Balance Date"
    },
    "currentRunningBalanceDate": {
      "type": "string",
      "example": "2022-02-10T05:00:00-07:00",
      "maxLength": 25,
      "minLength": 25,
      "description": "Current Running Balance date"
    },
    "dailyBalancesForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDailyBalance"
      },
      "default": [],
      "example": [
        {
          "date": "2022-03-22",
          "dayOfWeek": "Sunday",
          "endingBalance": 21527.3
        }
      ],
      "description": "Daily balance of the account over the length of the report"
    },
    "averageDailyBalanceForTheReportTimePeriod": {
      "type": "number",
      "example": -10442.53,
      "description": "Average Daily Balance"
    },
    "averageWeekdayBalanceForTheReportTimePeriod": {
      "type": "number",
      "example": -10442.53,
      "description": "Average Weekday Balance"
    },
    "maximumRunningBalanceForTheReportTimePeriod": {
      "type": "number",
      "example": -28749.44,
      "description": "Maximum Running Balance"
    },
    "minimumRunningBalanceForTheReportTimePeriod": {
      "type": "number",
      "example": -28749.44,
      "description": "Minimum Running Balance"
    },
    "dailyBalancesByWeekdayForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDailyBalance"
      },
      "default": [],
      "example": [
        {
          "date": "2022-03-23",
          "dayOfWeek": "Monday",
          "endingBalance": 21527.3
        }
      ],
      "description": "Daily balance of the account during weekdays over the length of the report"
    },
    "historicNumberOfWeeksAverageBalanceIncreasing": {
      "$ref": "#/components/schemas/ObbNumWeeksAverageBalanceIncreasing"
    },
    "averageDailyBalanceByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Average daily ending balance each month over the report time period"
    },
    "maximumDailyBalanceByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Maximum daily ending balance each month over the report time period"
    },
    "minimumDailyBalanceByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Minimum daily ending balance each month over the report time period"
    },
    "countDailyNegativeBalancesByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndCount"
      },
      "description": "Number of negative daily ending balances each month over the report time period"
    }
  },
  "description": "Balance analytics metrics and calculations"
}

{
  "type": "object",
  "required": [
    "customerId",
    "title",
    "reportHeader"
  ],
  "properties": {
    "title": {
      "$ref": "#/components/schemas/ReportTitle"
    },
    "businessId": {
      "type": "integer",
      "example": 4444,
      "description": "Business ID"
    },
    "customerId": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "reportHeader": {
      "$ref": "#/components/schemas/ObbReportHeader"
    },
    "requesterName": {
      "type": "string",
      "example": "Mortgage ABC LLC",
      "maxLength": 255,
      "minLength": 0,
      "description": "Name of requester"
    },
    "accountResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BalanceAnalyticsAccountResult"
      },
      "description": "Balance results per account"
    },
    "businessSummary": {
      "$ref": "#/components/schemas/BalanceAnalyticsBusinessSummary"
    }
  },
  "description": "Balance analytics report data as JSON"
}

{
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NumericAccountId"
      },
      "description": "The list of account IDs to include in the report. If omitted, all accounts on record for the customer will be used."
    },
    "lengthOfReport": {
      "type": "integer",
      "example": 730,
      "description": "Number of days to search for transactions. Must be one of 30, 90, 180, 270, 365, or 730. If omitted, defaults to 2 years from current time at which the request was received (730 days)."
    }
  },
  "description": "Request parameters from the partner to control the customer accounts included in the report, and the length of time to report on."
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/ReportId"
    },
    "type": {
      "$ref": "#/components/schemas/ReportType"
    },
    "title": {
      "$ref": "#/components/schemas/ReportTitle"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ErrorMessage"
      },
      "description": "In case errors occurred during the report generation"
    },
    "status": {
      "$ref": "#/components/schemas/ReportStatus"
    },
    "requestId": {
      "$ref": "#/components/schemas/ReportRequestId"
    },
    "consumerId": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "customerId": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "consumerSsn": {
      "$ref": "#/components/schemas/SocialSecurityNumberLastDigits"
    },
    "createdDate": {
      "$ref": "#/components/schemas/ReportCreatedDate"
    },
    "customerType": {
      "$ref": "#/components/schemas/CustomerType"
    },
    "requesterName": {
      "$ref": "#/components/schemas/PartnerName"
    }
  },
  "description": "Properties shared by all generated reports"
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAck"
    },
    {
      "type": "object",
      "properties": {
        "portfolioId": {
          "$ref": "#/components/schemas/PortfolioId"
        }
      }
    }
  ],
  "description": "Properties shared by all generated reports having a portfolio ID"
}

{
  "type": "object",
  "properties": {
    "year": {
      "type": "integer",
      "format": "int32",
      "example": 1989,
      "description": "The birthday 4-digit year"
    },
    "month": {
      "type": "integer",
      "format": "int32",
      "example": 8,
      "description": "The birthday 2-digit month (1 is January)"
    },
    "dayOfMonth": {
      "type": "integer",
      "format": "int32",
      "example": 13,
      "description": "The birthday 2-digit day-of-month"
    }
  },
  "description": "A birth date"
}

{
  "type": "object",
  "required": [
    "customerId",
    "consumerId",
    "type"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/BorrowerType"
    },
    "consumerId": {
      "$ref": "#/components/schemas/ConsumerId"
    },
    "customerId": {
      "$ref": "#/components/schemas/CustomerId"
    },
    "optionalConsumerInfo": {
      "$ref": "#/components/schemas/ConsumerInfo"
    }
  }
}

{
  "type": "string",
  "example": "primary",
  "description": "\"primary\" or \"jointBorrower\""
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Borrower"
  },
  "description": "(MVS) Array of borrowers to pass the primary and joint borrower's customer and consumer IDs"
}

{
  "type": "object",
  "properties": {
    "icon": {
      "type": "string",
      "example": "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/icon.svg",
      "description": "File path of the institution's icon. For search results designed at 40 x 40."
    },
    "logo": {
      "type": "string",
      "example": "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/logo.svg",
      "description": "File path of the institution's logo. For white backgrounds designed at 375 x 72, has built in spacing around it to normalize brand sizing."
    },
    "tile": {
      "type": "string",
      "example": "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/tile.svg",
      "description": "File path of institution name logo. For popular banks designed at 160 x 72."
    },
    "primaryColor": {
      "type": "string",
      "example": "#0167AE",
      "description": "Hex code for the institution's primary color"
    },
    "alternateLogo": {
      "type": "string",
      "example": "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/alternateLogo.svg",
      "description": "File path of the institution's alternate logo. For colored backgrounds designed at 375 x 72 has built in spacing around it to normalize brand sizing."
    }
  },
  "description": "All assets are SVGs so can be slightly resized without any issues."
}

{
  "type": "object",
  "required": [
    "branding"
  ],
  "properties": {
    "branding": {
      "$ref": "#/components/schemas/Branding"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/NewBusiness"
    },
    {
      "type": "object",
      "properties": {
        "businessId": {
          "$ref": "#/components/schemas/BusinessId"
        },
        "createdDate": {
          "$ref": "#/components/schemas/NoZoneDateTime"
        },
        "modifiedDate": {
          "$ref": "#/components/schemas/NoZoneDateTime"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/AFBusiness"
    },
    {
      "type": "object",
      "properties": {
        "businessId": {
          "$ref": "#/components/schemas/BusinessId"
        }
      }
    }
  ]
}

{
  "type": "string",
  "example": "1112",
  "maxLength": 50,
  "minLength": 1,
  "description": "Unique identifier of the business"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Business"
  },
  "maxItems": 1,
  "minItems": 1
}

{
  "type": "string",
  "example": "ABC Tires Inc",
  "description": "The name of a business"
}

{
  "type": "object",
  "properties": {
    "days": {
      "type": "integer",
      "format": "int32",
      "example": 14,
      "description": "Number of days between the recurring deposits"
    },
    "stopDate": {
      "type": "integer",
      "format": "int64",
      "example": 1587986990,
      "description": "`postedDate` of the final deposit transaction (omitted if status is active)"
    },
    "startDate": {
      "type": "integer",
      "format": "int64",
      "example": 1577986990,
      "description": "`postedDate` of the first deposit transaction"
    }
  }
}

{
  "type": "object",
  "required": [
    "date",
    "depositsCredits"
  ],
  "properties": {
    "date": {
      "type": "string",
      "example": "2020-03-25",
      "maxLength": 10,
      "minLength": 10,
      "description": "Date the deposit transaction was posted"
    },
    "depositsCredits": {
      "type": "number",
      "example": 500,
      "description": "Amount of the deposit"
    },
    "transactionDescription": {
      "type": "string",
      "example": "VENMO            CASHOUT",
      "maxLength": 255,
      "minLength": 0,
      "description": "Description of transaction"
    }
  }
}

{
  "type": "object",
  "required": [
    "date",
    "withdrawalsDebits"
  ],
  "properties": {
    "date": {
      "type": "string",
      "example": "2020-03-25",
      "maxLength": 10,
      "minLength": 10,
      "description": "Date the withdrawal transaction was posted"
    },
    "withdrawalsDebits": {
      "type": "number",
      "example": 15.69,
      "description": "Amount of the withdrawal"
    },
    "transactionDescription": {
      "type": "string",
      "example": "Payment to Chase card ending in",
      "maxLength": 255,
      "minLength": 0,
      "description": "Description of transaction"
    }
  }
}

{
  "type": "object",
  "required": [
    "accountId",
    "accountDetails",
    "historicDataAvailability",
    "currentReportRequest"
  ],
  "properties": {
    "accountId": {
      "$ref": "#/components/schemas/NumericAccountId"
    },
    "accountDetails": {
      "$ref": "#/components/schemas/ObbAccountDetails"
    },
    "currentReportRequest": {
      "$ref": "#/components/schemas/ObbCurrentReportRequestDetails"
    },
    "cashflowAnalyticsMetrics": {
      "$ref": "#/components/schemas/CashFlowAnalyticsMetrics"
    },
    "historicDataAvailability": {
      "$ref": "#/components/schemas/ObbDataAvailability"
    }
  }
}

{
  "type": "object",
  "required": [
    "historicDataAvailability",
    "currentReportRequest"
  ],
  "properties": {
    "currentReportRequest": {
      "$ref": "#/components/schemas/ObbCurrentReportRequestDetails"
    },
    "cashflowAnalyticsMetrics": {
      "$ref": "#/components/schemas/CashFlowAnalyticsMetrics"
    },
    "historicDataAvailability": {
      "$ref": "#/components/schemas/ObbDataAvailability"
    }
  },
  "description": "Cash flow analytics summarized across all accounts in the report"
}

{
  "type": "object",
  "properties": {
    "inflow": {
      "$ref": "#/components/schemas/CashFlowInflowAttributes"
    },
    "outflow": {
      "$ref": "#/components/schemas/CashFlowOutflowAttributes"
    },
    "negativeTriggers": {
      "$ref": "#/components/schemas/CashFlowNegativeTriggers"
    },
    "transactionAnalytics": {
      "$ref": "#/components/schemas/CashFlowTransactionAnalyticsAttributes"
    },
    "revenueForTheReportTimePeriod": {
      "type": "number",
      "example": 43893.44,
      "description": "Sum of all transactions categorized as revenue"
    },
    "revenueByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Sum of all transactions categorized as revenue, split by months"
    }
  },
  "description": "Cash flow analytics metrics and calculations"
}

{
  "type": "object",
  "required": [
    "customerId",
    "title",
    "reportHeader"
  ],
  "properties": {
    "title": {
      "$ref": "#/components/schemas/ReportTitle"
    },
    "businessId": {
      "type": "integer",
      "example": 4444,
      "description": "Business ID"
    },
    "customerId": {
      "$ref": "#/components/schemas/NumericCustomerId"
    },
    "reportHeader": {
      "$ref": "#/components/schemas/ObbReportHeader"
    },
    "totalRevenue": {
      "type": "number",
      "example": 904909.33,
      "description": "The total revenue"
    },
    "requesterName": {
      "type": "string",
      "example": "Mortgage ABC LLC",
      "maxLength": 255,
      "minLength": 0,
      "description": "Name of requester"
    },
    "accountResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowAnalyticsAccountResult"
      },
      "description": "Cash flow results per account"
    },
    "businessSummary": {
      "$ref": "#/components/schemas/CashFlowAnalyticsBusinessSummary"
    }
  },
  "description": "Cash Flow Analytics report data as JSON"
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowBalances",
    "minDailyBalance",
    "maxDailyBalance",
    "twelveMonthAverageDailyBalance",
    "sixMonthAverageDailyBalance",
    "twoMonthAverageDailyBalance",
    "twelveMonthStandardDeviationOfDailyBalance",
    "twoMonthStandardDeviationOfDailyBalance",
    "numberOfDaysPositiveBalance"
  ],
  "properties": {
    "maxDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Max Daily Balance across entire transaction history"
    },
    "minDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Min daily balance across entire transaction history"
    },
    "monthlyCashFlowBalances": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowBalances"
      },
      "description": "List of attributes for each month"
    },
    "numberDaysNegativeBalance": {
      "type": "string",
      "example": "6",
      "description": "Number of Days Negative Balance over entire transaction history"
    },
    "numberOfDaysPositiveBalance": {
      "type": "string",
      "example": "0",
      "description": "Number of Days positive balance over entire transaction history"
    },
    "sixMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across six months for the account"
    },
    "twoMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across two months for the account"
    },
    "twelveMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across twelve months for the account"
    },
    "sixMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across six months for the account"
    },
    "twoMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across two months for the account"
    },
    "twelveMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across twelve months for the account"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowBalanceSummaries",
    "minDailyBalance",
    "maxDailyBalance",
    "twelveMonthAverageDailyBalance",
    "sixMonthAverageDailyBalance",
    "twoMonthAverageDailyBalance",
    "twelveMonthStandardDeviationOfDailyBalance",
    "twoMonthStandardDeviationOfDailyBalance",
    "numberOfDaysNegativeBalance",
    "numberOfDaysPositiveBalance"
  ],
  "properties": {
    "maxDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Max Daily Balance across entire transaction history for all accounts"
    },
    "minDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Min Daily Balance across entire transaction history  for all accounts"
    },
    "numberOfDaysNegativeBalance": {
      "type": "string",
      "example": "6",
      "description": "Number of Days Negative Balance over entire transaction history for all accounts"
    },
    "numberOfDaysPositiveBalance": {
      "type": "string",
      "example": "11",
      "description": "Number of Days Positive Balance over entire transaction history for all accounts"
    },
    "sixMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across six months for all accounts"
    },
    "twoMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across two months for all accounts"
    },
    "twelveMonthAverageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance across twelve months for all accounts"
    },
    "monthlyCashFlowBalanceSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowBalanceSummaries"
      },
      "description": "List of attributes for each month"
    },
    "sixMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across six months for all accounts"
    },
    "twoMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across two months for all accounts"
    },
    "twelveMonthStandardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance across twelve months for all accounts"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowCharacteristics",
    "averageMonthlyNet",
    "averageMonthlyNetLessTransfers"
  ],
  "properties": {
    "averageMonthlyNet": {
      "type": "number",
      "example": 2350,
      "description": "Average (Total Credits - Total Debits) for the account"
    },
    "twelveMonthTotalNet": {
      "type": "number",
      "example": 12500,
      "description": "Sum of all monthly (Total Credits - Total Debits) each month for the account"
    },
    "averageMonthlyNetLessTransfers": {
      "type": "number",
      "example": 1000,
      "description": "Average (Total Credits - Total Debits) without transfers for the account"
    },
    "monthlyCashFlowCharacteristics": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowCharacteristics"
      },
      "description": "List of attributes for each month"
    },
    "twelveMonthTotalNetLessTransfers": {
      "type": "number",
      "example": 12400,
      "description": "Sum of all monthly (Total Credits - Total Debits) without transfers for the account"
    },
    "sixMonthAverageTotalCreditsLessTotalDebits": {
      "type": "number",
      "example": 55555,
      "description": "6 Month Average (Total Credits - Total Debits)"
    },
    "twoMonthAverageTotalCreditsLessTotalDebits": {
      "type": "number",
      "example": 55555,
      "description": "2 Month Average (Total Credits - Total Debits)"
    },
    "sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 55555,
      "description": "6 Month Average (Total Credits - Total Debits) - (Without Transfers)"
    },
    "twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 55555,
      "description": "2 Month Average (Total Credits - Total Debits) - (Without Transfers)"
    }
  }
}

{
  "type": "object",
  "required": [
    "averageMonthlyNet",
    "averageMonthlyNetLessTransfers",
    "twelveMonthTotalNet",
    "twelveMonthTotalNetLessTransfers",
    "sixMonthAverageTotalCreditsLessTotalDebits",
    "sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers",
    "twoMonthAverageTotalCreditsLessTotalDebits"
  ],
  "properties": {
    "averageMonthlyNet": {
      "type": "number",
      "example": 1250,
      "description": "Average monthly net amount"
    },
    "twelveMonthTotalNet": {
      "type": "number",
      "example": 12500,
      "description": "Sum of all monthly (Total Credits - Total Debits) each month by the account"
    },
    "averageMonthlyNetLessTransfers": {
      "type": "number",
      "example": 1000,
      "description": "Average monthly net less transfers"
    },
    "twelveMonthTotalNetLessTransfers": {
      "type": "number",
      "example": 12400,
      "description": "Sum of all monthly (Total Credits - Total Debits) without transfers by the account"
    },
    "monthlyCashFlowCharacteristicsSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowCharacteristicsSummaries"
      },
      "description": "List of attributes for each month"
    },
    "sixMonthAverageTotalCreditsLessTotalDebits": {
      "type": "number",
      "example": 55555,
      "description": "6 Month Average (Total Credits - Total Debits) across all accounts"
    },
    "twoMonthAverageTotalCreditsLessTotalDebits": {
      "type": "number",
      "example": 55555,
      "description": "2 Month Average (Total Credits - Total Debits) across all accounts"
    },
    "sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 55555,
      "description": "6 Month Average (Total Credits - Total Debits) - (Without Transfers) across all accounts"
    },
    "twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 55555,
      "description": "2 Month Average (Total Credits - Total Debits) - (Without Transfers) across all accounts"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowCredits"
  ],
  "properties": {
    "sixMonthCreditTotal": {
      "type": "number",
      "example": 750,
      "description": "Sum of six month credit transactions"
    },
    "twoMonthCreditTotal": {
      "type": "number",
      "example": 150,
      "description": "Sum of two month credit transactions"
    },
    "monthlyCashFlowCredits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowCredits"
      },
      "description": "List of attributes for each month"
    },
    "twelveMonthCreditTotal": {
      "type": "number",
      "example": 1200,
      "description": "Sum of all credit transactions for each month by account"
    },
    "sixMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 500,
      "description": "Sum of six month credit transactions without transfers"
    },
    "twoMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 100,
      "description": "Sum of two month credit transactions without transfers"
    },
    "twelveMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 1000,
      "description": "Sum of all monthly credit transactions without transfers for the account"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowCreditSummaries",
    "twelveMonthCreditTotal",
    "twelveMonthCreditTotalLessTransfers",
    "sixMonthCreditTotal",
    "sixMonthCreditTotalLessTransfers",
    "twoMonthCreditTotal",
    "twoMonthCreditTotalLessTransfers"
  ],
  "properties": {
    "sixMonthCreditTotal": {
      "type": "number",
      "example": 750,
      "description": "Six month sum of all credit transactions"
    },
    "twoMonthCreditTotal": {
      "type": "number",
      "example": 150,
      "description": "Two month sum of all credit transactions"
    },
    "twelveMonthCreditTotal": {
      "type": "number",
      "example": 1200,
      "description": "Sum of all credit transactions for each month for all accounts"
    },
    "monthlyCashFlowCreditSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowCreditSummaries"
      },
      "description": "List of attributes for each month"
    },
    "sixMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 500,
      "description": "Six month sum of all monthly credit transactions without transfers for all accounts"
    },
    "twoMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 100,
      "description": "Two month sum of all monthly credit transactions without transfers for all accounts"
    },
    "twelveMonthCreditTotalLessTransfers": {
      "type": "number",
      "example": 1000,
      "description": "Sum of all monthly credit transactions without transfers for all accounts"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowDebits"
  ],
  "properties": {
    "sixMonthDebitTotal": {
      "type": "number",
      "example": 750,
      "description": "Six month sum of all debit transactions"
    },
    "twoMonthDebitTotal": {
      "type": "number",
      "example": 150,
      "description": "Two month sum of all debit transactions"
    },
    "monthlyCashFlowDebits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlycashflowDebits"
      },
      "description": "List of attributes for each month"
    },
    "twelveMonthDebitTotal": {
      "type": "number",
      "example": 1200,
      "description": "Sum of all monthly debit transactions for each month by account"
    },
    "sixMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": 500,
      "description": "Six month sum of all debit transactions without transfers for the account"
    },
    "twoMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": 100,
      "description": "Two month sum of all debit transactions without transfers for the account"
    },
    "twelveMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": 1000,
      "description": "Sum of all monthly debit transactions without transfers for the account"
    }
  }
}

{
  "type": "object",
  "required": [
    "monthlyCashFlowDebitSummaries",
    "twelveMonthDebitTotal",
    "twelveMonthDebitTotalLessTransfers",
    "sixMonthDebitTotal",
    "sixMonthDebitTotalLessTransfers",
    "twoMonthDebitTotal",
    "twoMonthDebitTotalLessTransfers"
  ],
  "properties": {
    "sixMonthDebitTotal": {
      "type": "number",
      "example": -750,
      "description": "Six month sum of all debit transactions by account"
    },
    "twoMonthDebitTotal": {
      "type": "number",
      "example": -150,
      "description": "Two month sum of all debit transactions by account"
    },
    "twelveMonthDebitTotal": {
      "type": "number",
      "example": -1200,
      "description": "Sum of all monthly debit transactions for each month by account"
    },
    "monthlyCashFlowDebitSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CashFlowMonthlyCashFlowDebitSummaries"
      },
      "description": "List of attributes for each month"
    },
    "sixMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": -500,
      "description": "Six month sum of all debit transactions without transfers for the account"
    },
    "twoMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": -100,
      "description": "Two month sum of all debit transactions without transfers for the account"
    },
    "twelveMonthDebitTotalLessTransfers": {
      "type": "number",
      "example": -1000,
      "description": "Sum of all monthly debit transactions without transfers for the account"
    }
  }
}

{
  "type": "object",
  "required": [
    "minimumDepositByMonthForTheReportTimePeriod",
    "maximumDepositByMonthForTheReportTimePeriod",
    "sumDepositsByMonthForTheReportTimePeriod",
    "countDepositsByMonthForTheReportTimePeriod",
    "historicCountOfDepositTransactions"
  ],
  "properties": {
    "historicSumOfDeposits": {
      "type": "number",
      "example": 389.22,
      "description": "Sum of ALL deposits over entire known history of the account (may exceed requested length of report)"
    },
    "historicCountOfDepositTransactions": {
      "type": "integer",
      "example": 20,
      "description": "Count of ALL deposits over entire known history of the account (may exceed requested length of report)"
    },
    "sumDepositsByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Sum of all deposits during periods in the report"
    },
    "countDepositsByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndCount"
      },
      "description": "Count of all deposits during periods in the report"
    },
    "averageDepositByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Average value of deposits during periods in the report"
    },
    "maximumDepositByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Maximum deposit value for different periods in the report"
    },
    "minimumDepositByMonthForTheReportTimePeriod": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObbDateRangeAndAmount"
      },
      "description": "Minimum deposit value for different periods in the report"
    }
  },
  "description": "Inflow Attributes"
}

{
  "type": "object",
  "properties": {
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InsufficientFundsTransaction"
      },
      "description": "Transactions categorized as NSF"
    },
    "sumOfTransactionsForTheReportTimePeriod": {
      "type": "number",
      "example": -1.65,
      "description": "Sum of all NSF transactions during the report"
    },
    "countOfTransactionsForTheReportTimePeriod": {
      "type": "integer",
      "example": 1,
      "description": "Count of all NSF transactions during the report"
    }
  },
  "description": "Non-Sufficient Fund Fees"
}

{
  "type": "object",
  "required": [
    "month",
    "minDailyBalance",
    "maxDailyBalance",
    "averageDailyBalance",
    "numberOfDaysNegativeBalance",
    "numberOfDaysPositiveBalance"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "maxDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Max Daily Balance for each month for all accounts"
    },
    "minDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Min Daily Balance for each month for all accounts"
    },
    "averageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance for each month for all accounts"
    },
    "numberOfDaysNegativeBalance": {
      "type": "string",
      "example": "6",
      "description": "Number of Days Negative Balance for each month for all accounts"
    },
    "numberOfDaysPositiveBalance": {
      "type": "string",
      "example": "0",
      "description": "Number of Days Positive Balance for each month for all accounts"
    },
    "standardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20.45454545",
      "description": "Standard Deviation of Daily Balance for each month for all accounts"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "minDailyBalance",
    "maxDailyBalance",
    "averageDailyBalance",
    "numberOfDaysNegativeBalance",
    "numberOfDaysPositiveBalance"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "maxDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Max Daily Balance for each month"
    },
    "minDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Min Daily Balance for each month"
    },
    "averageDailyBalance": {
      "type": "number",
      "example": 3479.39,
      "description": "Average Daily Balance for each month"
    },
    "numberOfDaysNegativeBalance": {
      "type": "string",
      "example": "6",
      "description": "Number of Days Negative Balance for each month"
    },
    "numberOfDaysPositiveBalance": {
      "type": "string",
      "example": "0",
      "description": "Number of Days positive balance for each month"
    },
    "standardDeviationOfDailyBalance": {
      "type": "string",
      "example": "20",
      "description": "Standard Deviation of Daily Balance for each month"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "totalCreditsLessTotalDebits",
    "totalCreditsLessTotalDebitsLessTransfers",
    "averageTransactionAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "averageTransactionAmount": {
      "type": "number",
      "example": 10,
      "description": "Average transaction amount by month"
    },
    "totalCreditsLessTotalDebits": {
      "type": "number",
      "example": 15000,
      "description": "Total Credits - Total Debits by month"
    },
    "totalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 11000,
      "description": "Total Credits - Total Debits by month (Without Transfers)"
    }
  }
}

{
  "type": "object",
  "required": [
    "month",
    "totalCreditsLessTotalDebits",
    "totalCreditsLessTotalDebitsLessTransfers",
    "averageTransactionAmount"
  ],
  "properties": {
    "month": {
      "type": "integer",
      "format": "int64",
      "example": 1512111600,
      "description": "One instance for each complete calendar month in the report"
    },
    "averageTransactionAmount": {
      "type": "number",
      "example": 10,
      "description": "Average transaction amount across all accounts"
    },
    "totalCreditsLessTotalDebits": {
      "type": "number",
      "example": 15000,
      "description": "Total Credits - Total Debits by month across all accounts"
    },
    "totalCreditsLessTotalDebitsLessTransfers": {
      "type": "number",
      "example": 11000,
      "description": "Total Credits - Total Debits by month (Without Transfers) across all accounts"
    }
  }
}