{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Mortgage/Loan) Original date of loan maturity. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "string",
  "example": "u4hstnnak45g-voiepayroll",
  "description": "The report ID of the original payroll report for refresh use cases. If used, only the employment records from the original report will be included in the refreshed report response."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Student Loan) The date the borrower graduated or dropped below half-time enrollment in school. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "object",
  "required": [
    "partnerId",
    "partnerSecret"
  ],
  "properties": {
    "partnerId": {
      "$ref": "#/components/schemas/PartnerId"
    },
    "partnerSecret": {
      "type": "string",
      "example": "aqJ5Ic4SEVx2IgDQ6oR4",
      "description": "Your Partner Secret displayed in the [Developer Dashboard](https://developer.mastercard.com/account/log-in)"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/PartnerCredentials"
    },
    {
      "type": "object",
      "properties": {
        "newPartnerSecret": {
          "type": "string",
          "example": "OrU7tjiA3tIspCgb85xV",
          "description": "A new value for the Partner Secret"
        }
      }
    }
  ],
  "required": [
    "partnerId",
    "partnerSecret",
    "newPartnerSecret"
  ]
}

{
  "type": "string",
  "example": "1234583871234",
  "description": "Your Partner ID displayed in the [Developer Dashboard](https://developer.mastercard.com/account/log-in)"
}

{
  "type": "string",
  "example": "Finicity Test API",
  "description": "Name of a Finicity partner"
}

{
  "type": "string",
  "example": "Weekly",
  "description": "The current pay frequency or how often a regular pay check is:\n\n* `Daily` \n\n* `Weekly` \n\n* `Bi-Weekly` \n\n* `Semi-Monthly` \n\n* `Monthly` \n\n* `Quarterly` \n\n* `Semi-Annual` \n\n* `Annual` \n\n* `Every 2.6 wks` \n\n* `Every 4 wks` \n\n* `Every 5.2 wks` \n\n* `Other`\n"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "regular 1",
      "description": "The normalized category of the earnings with a number appended. The number is the will be the iterating number of the type's occurrence starting at one."
    },
    "type": {
      "$ref": "#/components/schemas/PayStatEarningsCategorizationType"
    },
    "amountYTD": {
      "type": "number",
      "example": 18000,
      "description": "The amount for the earning line being paid out to the employee for the current pay year."
    },
    "description": {
      "type": "string",
      "example": "regular income",
      "description": "The earnings line's pay type description"
    },
    "amountCurrent": {
      "type": "number",
      "example": 6000,
      "description": "The amount for the earning line paid out to the employee for the specified pay period."
    }
  }
}

{
  "type": "string",
  "description": "The categorization based on the earning line's description. Possible values:\n* \"bereavement\"\n\n* \"bonus\"\n\n* \"commission\"\n\n* \"holiday\"\n\n* \"jury duty\"\n\n* \"overtime\"\n\n* \"pension\"\n\n* \"pto\"\n\n* \"regular\"\n\n* \"sick\"\n\n* \"tips\"\n\n* \"unknown\"\n\n* \"vacation\"\n\n* \"reimbursement\"\n\n* \"stock\"\n\n* \"benefit\""
}

{
  "type": "object",
  "required": [
    "label",
    "statement"
  ],
  "properties": {
    "label": {
      "type": "string",
      "example": "lastPayPeriod",
      "description": "The label to be associated with the pay statement. This label will allow the paystub to go through data extraction.\n* `lastPayPeriod`: default label that should be used for the VOIE - Paystub products\n* `lastPayPeriodMinusOne`: the second most recent pay statement\n* `lastPayPeriodMinusTwo`: the third most recent pay statement\n* `previousYearLastPayPeriod` Last pay statement of the previous calendar year\n* `previousYear2LastPayPeriod`: last pay statement of the calendar year 2 years prior\n* `earliestPayPeriod`: the earliest pay statement"
    },
    "statement": {
      "type": "string",
      "example": "VGhpcyBtdXN0IGJlIGFuIGltYWdl",
      "description": "A Base64 encoded pay statement file. Finicity supports PDF, JPG, or PNG files."
    }
  },
  "description": "A pay statement document and pay statement label"
}

{
  "type": "object",
  "required": [
    "assetIds"
  ],
  "properties": {
    "assetIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssetId"
      },
      "description": "A list of pay statement asset IDs"
    },
    "extractEarnings": {
      "$ref": "#/components/schemas/ExtractEarnings"
    },
    "extractDeductions": {
      "$ref": "#/components/schemas/ExtractDeductions"
    },
    "extractDirectDeposit": {
      "$ref": "#/components/schemas/ExtractDirectDeposit"
    }
  },
  "description": "Data to be included within the pay statement report"
}

{
  "type": "object",
  "required": [
    "billable",
    "assetId",
    "employer",
    "employee",
    "payStat",
    "monthlyIncome",
    "institutions"
  ],
  "properties": {
    "assetId": {
      "type": "string",
      "example": "6f8fb0a0-e882-4f57-b672-cf53f1397581",
      "description": "The asset ID of the stored pay statement"
    },
    "endDate": {
      "type": "integer",
      "format": "int64",
      "example": 1558722600,
      "description": "The end of the pay period"
    },
    "payDate": {
      "type": "integer",
      "format": "int64",
      "example": 1559241000,
      "description": "The listed pay date for the pay statement"
    },
    "payStat": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PayStat"
      },
      "description": "Information pertaining to the earnings on the pay statement"
    },
    "billable": {
      "type": "boolean",
      "example": true,
      "description": "This will display true if the pay statement is billable. If a pay statement has been digitized previously, this will display as false as it will not be billable."
    },
    "employee": {
      "$ref": "#/components/schemas/Employee"
    },
    "employer": {
      "$ref": "#/components/schemas/Employer"
    },
    "errorCode": {
      "type": "integer",
      "format": "int32",
      "example": 0,
      "description": "Error code for the asset"
    },
    "netPayYTD": {
      "type": "number",
      "example": 36000,
      "description": "The total accumulation of pay after deductions for the employee for the current pay year"
    },
    "payPeriod": {
      "type": "string",
      "example": "LastPayPeriod",
      "description": "The pay period of the pay statement"
    },
    "startDate": {
      "type": "integer",
      "format": "int64",
      "example": 1557513000,
      "description": "The beginning of the pay period"
    },
    "grossPayYTD": {
      "type": "number",
      "example": 72600,
      "description": "The total accumulation of pay before deductions for the employee for the current pay year"
    },
    "errorMessage": {
      "type": "string",
      "example": "Some error message",
      "description": "Error message for the asset"
    },
    "institutions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [],
      "description": "Not populated for the voieWithStatement style of paystub report. For the VOIE - Paystub (with TXVerify) reports this would include details of the financial institution accounts and income streams with matching transactions to the pay statement."
    },
    "netPayCurrent": {
      "type": "number",
      "example": 1802.22,
      "description": "The total pay after deductions for the employee for the current pay period"
    },
    "directDeposits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DirectDeposit"
      },
      "description": "Information pertaining to the direct deposits on the pay statement"
    },
    "grossPayCurrent": {
      "type": "number",
      "example": 24200,
      "description": "The total pay before deductions for the employee for the current pay period"
    },
    "payrollProvider": {
      "type": "string",
      "example": "Finicity",
      "description": "The payroll provider extracted from the pay statement"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAckWithPortfolioId"
    },
    {
      "type": "object",
      "properties": {
        "endDate": {
          "$ref": "#/components/schemas/ReportEndDate"
        },
        "assetIds": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AssetId"
          }
        },
        "startDate": {
          "$ref": "#/components/schemas/ReportStartDate"
        },
        "reportStyle": {
          "$ref": "#/components/schemas/ReportStyle"
        },
        "payStatements": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/VOIEPayStatement"
          },
          "description": "Extracted pay statement details"
        },
        "numberOfBillableAssets": {
          "type": "integer",
          "format": "int32",
          "example": 1,
          "description": "Total number of billable pay statements included in the report"
        }
      }
    }
  ],
  "description": "A Pay Statement report"
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAckWithPortfolioId"
    },
    {
      "type": "object",
      "properties": {
        "constraints": {
          "$ref": "#/components/schemas/PayStatementReportConstraints"
        }
      }
    }
  ],
  "required": [
    "id",
    "portfolioId",
    "customerType",
    "customerId",
    "requestId",
    "requesterName",
    "createdDate",
    "title",
    "consumerId",
    "consumerSsn",
    "type",
    "status",
    "constraints"
  ],
  "description": "A Pay Statement report being generated"
}

{
  "type": "object",
  "required": [
    "paystatementReport"
  ],
  "properties": {
    "paystatementReport": {
      "$ref": "#/components/schemas/PayStatementData"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    }
  }
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "Limits the pay statement history in the VOIE - Payroll report income record. Pay statements are only included if the payDate of the statement is equal to or greater than the start date requested. Date should be in Unix epoch time (in seconds). See: Handling Epoch Dates and Times."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Credit Card/Line Of Credit) Due date for the next payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "object",
  "required": [
    "accountNumberDisplay",
    "financialInstitution",
    "institutionIcon",
    "currency",
    "status",
    "accountName",
    "accountOwner",
    "accountType",
    "beginningBalance",
    "averageMonthlyBalance",
    "currentBalance",
    "beginDate",
    "endDate",
    "totalNonSufficientFunds",
    "daysSinceNonsufficientFunds"
  ],
  "properties": {
    "status": {
      "$ref": "#/components/schemas/AccountStatus"
    },
    "endDate": {
      "type": "string",
      "example": "2023-06-01",
      "description": "End date of account"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "beginDate": {
      "type": "string",
      "example": "2023-06-01",
      "description": "Begin date of account"
    },
    "accountName": {
      "type": "string",
      "example": "My 401k",
      "description": "The account name from the institution"
    },
    "accountType": {
      "$ref": "#/components/schemas/AccountType"
    },
    "accountOwner": {
      "type": "object",
      "required": [
        "name",
        "address"
      ],
      "properties": {
        "zip": {
          "$ref": "#/components/schemas/ZipCode"
        },
        "city": {
          "$ref": "#/components/schemas/City"
        },
        "name": {
          "$ref": "#/components/schemas/AccountOwnerName"
        },
        "state": {
          "$ref": "#/components/schemas/State"
        },
        "address": {
          "$ref": "#/components/schemas/Address"
        }
      },
      "description": "The account owner information"
    },
    "currentBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Current balance of account"
    },
    "institutionIcon": {
      "type": "string",
      "example": "https://my-sample-app.com/12345/some-icon.jpg",
      "description": "URL of institution icon"
    },
    "beginningBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Beginning balance of account"
    },
    "accountNumberDisplay": {
      "type": "string",
      "example": "2222",
      "description": "Last four digits of the account"
    },
    "financialInstitution": {
      "type": "string",
      "example": "FinBank",
      "description": "Name of the account's institution"
    },
    "averageMonthlyBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Monthly average balance of account"
    },
    "totalNonsufficientFunds": {
      "type": "number",
      "example": 123.45,
      "description": "Total of NSF transactions in this account"
    },
    "daysSinceNonsufficientFunds": {
      "type": "integer",
      "example": 3,
      "description": "Days since the latest NSF transaction for this account"
    }
  },
  "description": "Account-level summary of transactions"
}

{
  "properties": {
    "status": {
      "type": "string",
      "example": "success",
      "description": "Report status"
    },
    "riskScore": {
      "type": "number",
      "example": 82.45,
      "description": "Calculated risk score"
    },
    "accountSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentHistoryAccountSummary"
      },
      "description": "Account-level summary of transactions"
    },
    "transactionHistory": {
      "type": "integer",
      "example": 12,
      "description": "Months of transactions"
    },
    "transactionsSummary": {
      "$ref": "#/components/schemas/PaymentHistoryTransactionsSummary"
    },
    "customerSummaryByMonths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentHistoryCustomerMonthlySummary"
      },
      "description": "Customer-level summary of transactions per month"
    }
  },
  "description": "Payment History computed analytics"
}

{
  "type": "object",
  "required": [
    "month",
    "averageBalance",
    "closingBalance",
    "openingBalance",
    "totalDeposits",
    "totalWithdrawals",
    "nonSufficientFunds",
    "insurancePayments",
    "taxPayments",
    "recurringExpensePayments",
    "missedRecurringExpensePayments",
    "recurringLoanPayments",
    "missedRecurringLoanPayments"
  ],
  "properties": {
    "month": {
      "type": "string",
      "example": "2023-06-01",
      "description": "Date of the month"
    },
    "taxPayments": {
      "type": "number",
      "example": 123.45,
      "description": "Total of tax payment transactions for the month"
    },
    "totalDeposits": {
      "type": "number",
      "example": 123.45,
      "description": "Total of deposit transactions for the month"
    },
    "averageBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Average balance for the month"
    },
    "closingBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Closing balance for the month"
    },
    "openingBalance": {
      "type": "number",
      "example": 123.45,
      "description": "Opening balance for the month"
    },
    "totalWithdrawals": {
      "type": "number",
      "example": 123.45,
      "description": "Total of withdrawal transactions for the month"
    },
    "insurancePayments": {
      "type": "number",
      "example": 123.45,
      "description": "Total of insurance payment transactions for the month"
    },
    "nonSufficientFunds": {
      "type": "number",
      "example": 3,
      "description": "Total of NSF transactions for the month"
    },
    "recurringLoanPayments": {
      "type": "number",
      "example": 543.21,
      "description": "Total of recurring loan payment transactions for the month"
    },
    "recurringExpensePayments": {
      "type": "number",
      "example": 543.21,
      "description": "Total of recurring expense payment transactions for the month"
    },
    "missedRecurringLoanPayments": {
      "type": "number",
      "example": 123.45,
      "description": "Total of missed recurring loan payment transactions for the month"
    },
    "missedRecurringExpensePayments": {
      "type": "number",
      "example": 123.45,
      "description": "Total of missed recurring expense payment transactions for the month"
    }
  },
  "description": "Customer-level summary of transactions in a month"
}

{
  "type": "object",
  "required": [
    "customerId",
    "title",
    "reportHeader"
  ],
  "properties": {
    "title": {
      "$ref": "#/components/schemas/ReportTitle"
    },
    "analytics": {
      "$ref": "#/components/schemas/PaymentHistoryAnalytics"
    },
    "accountIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NumericAccountId"
      },
      "description": "List of account IDs included in the report"
    },
    "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"
    }
  },
  "description": "Payment history report data as JSON",
  "x-konfig-properties": {
    "reportHeader": {
      "description": "Customer and report metadata"
    }
  }
}

{
  "type": "object",
  "required": [
    "totalNonSufficientFunds",
    "averageMonthlyNonSufficientFunds",
    "totalDeposits",
    "averageMonthlyDeposits",
    "totalWithdrawals",
    "averageMonthlyWithdrawals",
    "beginDate",
    "endDate"
  ],
  "properties": {
    "endDate": {
      "type": "string",
      "description": "ISO-8601 date of latest transaction"
    },
    "beginDate": {
      "type": "string",
      "description": "ISO-8601 date of earliest transaction"
    },
    "totalDeposits": {
      "type": "number",
      "description": "Total of deposit transactions"
    },
    "totalWithdrawals": {
      "type": "number",
      "description": "Total of withdrawals transactions"
    },
    "averageMonthlyDeposits": {
      "type": "number",
      "description": "Monthly average of deposit transactions"
    },
    "totalNonSufficientFunds": {
      "type": "number",
      "description": "Total of NSF transactions"
    },
    "averageMonthlyWithdrawals": {
      "type": "number",
      "description": "Monthly average of withdrawal transactions"
    },
    "averageMonthlyNonSufficientFunds": {
      "type": "number",
      "description": "Monthly average of NSF transactions"
    }
  },
  "description": "Top-level summary of transactions"
}

{
  "type": "object",
  "required": [
    "accountNumber",
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "example": "ach",
      "description": "The type of payment instruction:\n1. ACH: when payment instruction type is ACH (Automated Clearing House)\n2. RTP: when payment instruction type is RTP (Real-Time Payments)"
    },
    "descriptors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Descriptor"
      },
      "description": "List of descriptors"
    },
    "accountNumber": {
      "type": "string",
      "example": "124344454",
      "description": "The account number from the institution"
    },
    "transferInEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether transfer to this account is enabled or not. Applicable for \"RTP\" type only."
    },
    "transferOutEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether transfer from this account is enabled or not. Applicable for \"RTP\" type only."
    }
  }
}

{
  "type": "object",
  "properties": {
    "paymentInstruction": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentInstruction"
      },
      "description": "List of payment instructions"
    }
  },
  "description": "A list of payment instructions"
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Mortgage/Loan) Date of final payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "string",
  "example": "018b8f10-fdf8-0ef7-ded5-34a17c34d86f",
  "description": "The payroll accountId associated with the payroll account (employer or payroll provider)."
}

{
  "type": "object",
  "required": [
    "ssn",
    "dob"
  ],
  "properties": {
    "dob": {
      "$ref": "#/components/schemas/ConsumerDateOfBirth"
    },
    "ssn": {
      "$ref": "#/components/schemas/SocialSecurityNumberNoHyphens"
    },
    "reportId": {
      "$ref": "#/components/schemas/OriginalPayrollReportId"
    }
  }
}

{
  "type": "object",
  "properties": {
    "reportId": {
      "$ref": "#/components/schemas/ReportId"
    },
    "employmentIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmploymentId"
      },
      "description": "An array of employmentIds"
    },
    "payrollAccountIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PayrollAccountId"
      },
      "description": "An array of payrollAccountIds"
    },
    "payrollDataRetrievalId": {
      "type": "string",
      "example": "hahvhe2k0000",
      "description": "An ID to identify the data retrieved from the payroll providers for the report."
    }
  }
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "example": "99999",
      "description": "Employee zip code as stated by the employer in the payroll system"
    },
    "city": {
      "type": "string",
      "example": "City",
      "description": "Employee city as stated by the employer in the payroll system"
    },
    "state": {
      "type": "string",
      "example": "TX",
      "description": "Employee state as stated by the employer in the payroll system"
    },
    "address1": {
      "type": "string",
      "example": "Address 1",
      "description": "Employee address as stated by the employer in the payroll system"
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "John Doe Smith",
      "description": "Full name of the employee: first, middle (if stated), and last name"
    },
    "address": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PayrollEmployeeAddress"
      },
      "description": "Array of addresses"
    },
    "givenName": {
      "type": "string",
      "example": "John",
      "description": "First name of employee"
    },
    "familyName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name of employee"
    },
    "middleName": {
      "type": "string",
      "example": "Doe",
      "description": "Middle name of employee, if stated"
    }
  }
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "example": "99999",
      "description": "Employer zip code as stated by the employer in the payroll system"
    },
    "city": {
      "type": "string",
      "example": "City",
      "description": "Employer city as stated by the employer in the payroll system"
    },
    "state": {
      "type": "string",
      "example": "TX",
      "description": "Employer state as stated by the employer in the payroll system"
    },
    "address1": {
      "type": "string",
      "example": "Address 1",
      "description": "Employer address as stated by the employer in the payroll system"
    }
  }
}

{
  "type": "object",
  "required": [
    "asOfDate",
    "employerName",
    "payrollSource",
    "employee",
    "employment",
    "income"
  ],
  "properties": {
    "income": {
      "$ref": "#/components/schemas/PayrollVOEIncomeRecord"
    },
    "asOfDate": {
      "$ref": "#/components/schemas/AsOfDate"
    },
    "employee": {
      "$ref": "#/components/schemas/PayrollEmployeeRecord"
    },
    "employment": {
      "$ref": "#/components/schemas/PayrollEmploymentRecord"
    },
    "employerName": {
      "$ref": "#/components/schemas/EmployerName"
    },
    "payrollSource": {
      "type": "string",
      "example": "finPayroll",
      "description": "The name of the payroll source where the data was retrieved"
    }
  }
}

{
  "type": "object",
  "required": [
    "asOfDate",
    "employerName",
    "payrollSource",
    "employee",
    "employment",
    "income"
  ],
  "properties": {
    "income": {
      "$ref": "#/components/schemas/PayrollVOIEIncomeRecord"
    },
    "asOfDate": {
      "$ref": "#/components/schemas/AsOfDate"
    },
    "employee": {
      "$ref": "#/components/schemas/PayrollEmployeeRecord"
    },
    "employment": {
      "$ref": "#/components/schemas/PayrollEmploymentRecord"
    },
    "employerName": {
      "$ref": "#/components/schemas/EmployerName"
    },
    "employmentId": {
      "$ref": "#/components/schemas/EmploymentId"
    },
    "payrollSource": {
      "type": "string",
      "example": "finPayroll",
      "description": "The name of the payroll source where the data was retrieved"
    }
  }
}

{
  "type": "object",
  "required": [
    "employerName",
    "employmentStatusCode",
    "employmentStatusName",
    "workLevelStatus"
  ],
  "properties": {
    "employerName": {
      "$ref": "#/components/schemas/EmployerName"
    },
    "latestPayDate": {
      "type": "integer",
      "format": "int64",
      "example": 1596175200,
      "description": "The most recent pay date from an employer"
    },
    "legalEntityId": {
      "type": "string",
      "example": "752760000",
      "description": "Employer identification number (EIN)"
    },
    "positionTitle": {
      "type": "string",
      "example": "Shift Supervisor",
      "description": "Employee job title"
    },
    "workLevelCode": {
      "type": "string",
      "example": "FT",
      "description": "The abbreviate code for the employment level names (workLevelName) that we receive from the employer"
    },
    "workLevelName": {
      "type": "string",
      "example": "Full Time-Regular",
      "description": "The employment level name is whatever we receive from the employer, such as full time, part time, temp, contractor, and more"
    },
    "latestHireDate": {
      "type": "integer",
      "format": "int64",
      "example": 1527832800,
      "description": "If an employee leaves the company and returns later, then the employer states the latest hire date at the company"
    },
    "employerAddress": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PayrollEmployerAddress"
      },
      "description": "Array of addresses"
    },
    "workLevelStatus": {
      "type": "string",
      "example": "Full Time",
      "description": "The categorized work level status. Enumerations are:\n\n* `Temporary`\n\n* `Seasonal`\n\n* `Retired`\n\n* `Student`\n\n* `Full Time`\n\n* `Part Time`\n\n* `Unspecified`\n\nThis is a new field, currently enabled only for testing reports. It will be added for all reports in August 2021.\n"
    },
    "daysSinceLastPay": {
      "type": "integer",
      "format": "int32",
      "example": 10,
      "description": "The number of days since an employee was last paid"
    },
    "originalHireDate": {
      "type": "integer",
      "format": "int64",
      "example": 1527832800,
      "description": "The original hired date of an employee at the company"
    },
    "positionDuration": {
      "type": "string",
      "example": "P1Y6M0D",
      "description": "The length of time an employee has been employed at their current or latest position for this employment in ISO 8601 format (eg P1Y6M0D)"
    },
    "employmentEndDate": {
      "type": "integer",
      "format": "int64",
      "example": 1527832800,
      "description": "The date an employee ended their employment at the company"
    },
    "employmentDuration": {
      "type": "string",
      "example": "P1Y6M0D",
      "description": "The length of time an employee has been employed with that employer in ISO 8601 format (e.g. P1Y6M0D)"
    },
    "employmentStatusCode": {
      "type": "string",
      "example": "A",
      "description": "'Status codes: `A` - Active, `NLE` - No Longer Employed, `L` - Leave, `O` - Other', `I` - Inactive, `U` - Unknown'"
    },
    "employmentStatusName": {
      "type": "string",
      "example": "Active",
      "description": "'Status name: `Active`, `No Longer Employed`, `Leave` or `Other`, `Inactive`, or `Unknown`'"
    },
    "latestPayPeriodEndDate": {
      "type": "integer",
      "format": "int64",
      "example": 1596175201,
      "description": "The most recent pay period’s end date."
    },
    "derivedEmploymentStatus": {
      "type": "boolean",
      "example": true,
      "description": "Describes the employment status - it will be true if it is not directly stated by the employer, and false otherwise"
    },
    "numberPayCadenceWithoutPay": {
      "type": "integer",
      "format": "int32",
      "example": 1,
      "description": "The number of pay cadences an employee has not been paid; determined by the pay frequency"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseReportAckWithPortfolioId"
    },
    {
      "type": "object",
      "properties": {
        "constraints": {
          "$ref": "#/components/schemas/PayrollReportConstraintsOut"
        },
        "reportStyle": {
          "$ref": "#/components/schemas/ReportStyle"
        }
      }
    }
  ],
  "required": [
    "id",
    "portfolioId",
    "customerType",
    "customerId",
    "requestId",
    "requesterName",
    "createdDate",
    "title",
    "consumerId",
    "consumerSsn",
    "type",
    "status",
    "constraints"
  ],
  "description": "A Payroll report being generated"
}

{
  "type": "object",
  "required": [
    "payrollData"
  ],
  "properties": {
    "purpose": {
      "$ref": "#/components/schemas/PurposeCode"
    },
    "payrollData": {
      "$ref": "#/components/schemas/PayrollData"
    },
    "marketSegment": {
      "$ref": "#/components/schemas/MarketSegment"
    },
    "excludeEmpInfo": {
      "$ref": "#/components/schemas/ExcludeEmpInfo"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "payStatementsFromDate": {
      "$ref": "#/components/schemas/PayStatementsFromDate"
    }
  }
}

{
  "type": "object",
  "required": [
    "payrollData"
  ],
  "properties": {
    "payrollData": {
      "$ref": "#/components/schemas/PayrollDataOut"
    },
    "reportCustomFields": {
      "$ref": "#/components/schemas/ReportCustomFields"
    },
    "payStatementsFromDate": {
      "$ref": "#/components/schemas/UnixDate"
    }
  }
}

{
  "type": "object",
  "properties": {
    "payFrequency": {
      "$ref": "#/components/schemas/PayFrequency"
    }
  }
}

{
  "type": "object",
  "properties": {
    "payType": {
      "type": "string",
      "example": "Daily",
      "description": "The current pay type:\n\n* `Salary`\n\n* `Hourly`\n\n* `Daily`\n"
    },
    "basePayRate": {
      "type": "number",
      "example": 1234.56,
      "description": "The current base or regular pay rate. Please use in conjunction with the `basePayRateUnit` field."
    },
    "annualIncome": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AnnualIncome"
      },
      "description": "The annual pay for the current year, through prior year 2 (as available)\n\nThis is a mandatory field only for VOIE-payroll report type."
    },
    "payFrequency": {
      "$ref": "#/components/schemas/PayFrequency"
    },
    "monthlyIncome": {
      "$ref": "#/components/schemas/MonthlyIncome"
    },
    "basePayRateUnit": {
      "type": "string",
      "example": "Annual",
      "description": "Unit for the base pay rate:\n\n* `Hourly`\n\n* `Daily`\n\n* `Weekly`\n\n* `Bi-Weekly`\n\n* `Semi-Monthly`\n\n* `Monthly`\n\n* `Quarterly`\n\n* `Semi-Annual`\n\n* `Annual`\n\n* `Every 2.6 wks`\n\n* `Every 5.2 wks`\n\n* `Other`\n"
    },
    "directPayStatements": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DirectPayStatements"
      },
      "description": "An array of payment histories for each available paycheck"
    },
    "oldestPayStatementAvailable": {
      "type": "string",
      "example": 1527832900,
      "description": "The date of the oldest direct pay statement available from the payroll source, as measured by the oldest `payDate` from all the pay statements delivered."
    }
  }
}

{
  "type": "object",
  "properties": {
    "estimatedMonthlyBasePay": {
      "type": "number",
      "example": 2000,
      "description": "The estimated monthly base pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyBonusPay": {
      "type": "number",
      "example": 20,
      "description": "The estimated monthly bonus pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyOvertimePay": {
      "type": "number",
      "example": 50,
      "description": "The estimated monthly overtime pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyCommissionPay": {
      "type": "number",
      "example": 50,
      "description": "The estimated commission bonus pay amount for the employment from the paystub, calculated by Finicity"
    }
  }
}

{
  "type": "object",
  "properties": {
    "estimatedMonthlyBasePay": {
      "type": "number",
      "example": 2000,
      "description": "The estimated monthly base pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyBonusPay": {
      "type": "number",
      "example": 20,
      "description": "The estimated monthly bonus pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyOtherPay": {
      "type": "number",
      "example": 150,
      "description": "The estimated monthly other pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyTotalPay": {
      "type": "number",
      "example": 2120,
      "description": "The estimated monthly total pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyOvertimePay": {
      "type": "number",
      "example": 50,
      "description": "The estimated monthly overtime pay amount for the employment from the paystub, calculated by Finicity"
    },
    "estimatedMonthlyCommissionPay": {
      "type": "number",
      "example": 50,
      "description": "The estimated commission bonus pay amount for the employment from the paystub, calculated by Finicity"
    }
  }
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "End date of period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "integer",
  "format": "int64",
  "example": 1607450357,
  "description": "(Checking/Savings/CD/MoneyMarket) Start date of period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}

{
  "type": "string",
  "example": "Vodafone UK ltd.",
  "description": "The company that provides voice and/or data services for the phone number. Carriers are returned at the MVNO level."
}

{
  "type": "string",
  "example": "61",
  "description": "Country calling code of the phone number as defined by ITU-T E.123 and E.164 international standards (max length 3)\"."
}

{
  "type": "string",
  "example": "UK",
  "description": "The ISO-3166 alpha-2 country code associated with the phone number."
}

{
  "type": "number",
  "example": 54,
  "description": "Count of days since the combination of phone and email was first observed in Ekata's Identity Network. If that combination has not been observed before, `phoneEmailFirstSeenDays` will be 0."
}

{
  "type": "number",
  "example": 42,
  "description": "Count of days since the phone was last observed in Ekata's Identity Network. If the phone has not been observed before, `phoneLastSeenDays` will be 0."
}

{
  "type": "string",
  "example": "mobile",
  "description": "The line type of the phone number.\n* landline - traditional wired phone line.\n* fixed-voip - VoIP-based fixed line phones.\n* mobile - wireless phone line.\n* voicemail - voicemail-only service.\n* toll-free - callee pays for call.\n* premium - caller pays a premium for the call-e.g., 976 area code.\n* non-fixed-voip - Skype, for example * other - anything that does not match the previous categories."
}