# M1_INCOME_EMPLOYMENT_RECORD --- title: M1_INCOME_EMPLOYMENT_RECORD description: This schema represents a comprehensive record of an individual's income sources, employment details, and financial status. It includes information such as employer details, job title, salary, employment type, and work history. --- This schema represents a comprehensive record of an individual's income sources, employment details, and financial status. It includes information such as employer details, job title, salary, employment type, and work history. {% json-schema schema={ "title": "M1_INCOME_EMPLOYMENT_RECORD Schema", "type": "object", "description": "Representation of the Income Employment record for an individual\n", "properties": { "record_date": { "type": "string", "description": "Date on which the record was generated", "format": "MM/DD/YYYY" }, "pay_date": { "type": "string", "description": "Payment date", "format": "MM/DD/YYYY" }, "interval": { "type": "object", "description": "Interval for which the income employment details is denoted", "properties": { "start_date": { "type": "string", "description": "start date of the interval", "format": "MM/DD/YYYY" }, "end_date": { "type": "string", "description": "end date of the interval", "format": "MM/DD/YYYY" } } }, "employee": { "type": "object", "description": "Details about the employee", "properties": { "service_details": { "type": "object", "description": "Service details of the employee", "properties": { "employee_id": { "type": "string", "description": "employee_id provided by the employer" }, "hire_date": { "type": "string", "description": "Hire date of the employee", "format": "MM/DD/YYYY" }, "status": { "type": "string", "description": "Status of employee with the employer", "enum": [ "ACTIVE", "INACTIVE", "TERMINATED", "UNKNOWN" ] }, "salary": { "type": "number", "description": "Salary of the employee" }, "salary_basis": { "type": "string", "description": "Basis of salary", "enum": [ "HOURLY", "MONTHLY", "SEMI_MONTHLY", "WEEKLY", "BI_WEEKLY", "ANNUAL", "OTHER" ] }, "termination_date": { "type": "string", "description": "Termination date of the employee", "format": "MM/DD/YYYY" }, "termination_reason": { "type": "string", "description": "Termination reason" } } }, "first_name": { "type": "string", "description": "First name of the employee", "maxLength": 45 }, "middle_name": { "type": "string", "description": "Middle name of the employee", "maxLength": 45 }, "last_name": { "type": "string", "description": "Last Name of the employee", "maxLength": 45 }, "email": { "type": "string", "description": "Email address of the employee" }, "prefix": { "type": "string", "description": "Name prefix", "maxLength": 5 }, "suffix": { "type": "string", "description": "Name suffix", "maxLength": 5 }, "gender": { "type": "string", "description": "Gender of the employee", "maxLength": 1 }, "date_of_birth": { "type": "string", "description": "Date of Birth of the employee in MM/DD/YYYY format.", "format": "MM/DD/YYYY", "pattern": "/(0[1-9]|1[012])[- \\/.](0[1-9]|[12][0-9]|3[01])[- \\/.](19|20)\\d\\d/'" }, "phone_number": { "type": "string", "description": "Phone number of the employee" }, "ssn": { "type": "string", "description": "SSN of the employee" }, "address": { "type": "object", "description": "Address of the employee", "properties": { "addr1": { "type": "string", "description": "Address Line 1" }, "addr2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "zipcode": { "type": "string", "description": "Zipcode for the address" }, "country": { "type": "object", "description": "Country information", "properties": { "name": { "type": "string", "description": "Name of the country" }, "a2_code": { "type": "string", "description": "Alpha-2 code for the country" } } } } } } }, "employer": { "type": "object", "description": "Details about the employer", "properties": { "name": { "type": "string", "description": "Name of the employer" }, "phone_number": { "type": "string", "description": "Phone number of the employer" }, "address": { "type": "object", "description": "Address of the employer", "properties": { "addr1": { "type": "string", "description": "Address Line 1" }, "addr2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "zipcode": { "type": "string", "description": "Zipcode for the address" }, "country": { "type": "object", "description": "Country information", "properties": { "name": { "type": "string", "description": "Name of the country" }, "a2_code": { "type": "string", "description": "Alpha-2 code for the country" } } } } } } }, "roles": { "type": "array", "description": "Array of objects representing roles of an Individual during their employment", "items": { "properties": { "position": { "type": "object", "description": "Position details of an Individual", "properties": { "name": { "type": "string", "description": "Name of the position" }, "title": { "type": "string", "description": "Title of the position" } } }, "type": { "type": "string", "description": "Type of position", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACT", "OTHER" ] }, "supervisor": { "type": "string", "description": "Name of supervisor" }, "interval": { "type": "object", "description": "Interval details for the role", "properties": { "start_date": { "type": "string", "description": "start date of the interval", "format": "MM/DD/YYYY" }, "end_date": { "type": "string", "description": "end date of the interval", "format": "MM/DD/YYYY" } } }, "location": { "type": "object", "description": "Location details for the role", "properties": { "name": { "type": "string", "description": "Name of location" }, "address": { "type": "object", "description": "Address of the location", "properties": { "addr1": { "type": "string", "description": "Address Line 1" }, "addr2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "zipcode": { "type": "string", "description": "Zipcode for the address" }, "country": { "type": "object", "description": "Country information", "properties": { "name": { "type": "string", "description": "Name of the country" }, "a2_code": { "type": "string", "description": "Alpha-2 code for the country" } } } } }, "department": { "type": "string", "description": "Department during the deployment" } } } } } }, "earnings": { "type": "array", "description": "Array of objects representing earnings", "items": { "properties": { "type": { "type": "string", "description": "Type of the earnings", "enum": [ "SALARY", "WAGE", "INVESTMENT", "RENTAL", "COMMISSION", "INTEREST", "GIFTS", "ALLOWANCE", "GOVERNMENT_PAYMENT", "DIVIDENDS", "RETIREMENT_PENSION", "TAX_REFUND", "UNEMPLOYMENT", "TRANSFER_IN", "OTHER_DEPOSITS", "OTHER" ] }, "basis": { "type": "string", "description": "Basis unit of the payment", "enum": [ "HOURLY", "MONTHLY", "SEMI_MONTHLY", "WEEKLY", "ANNUAL", "BI_WEEKLY", "OTHER" ] }, "interval": { "type": "object", "description": "Interval for which the earnings is denoted", "properties": { "start_date": { "type": "string", "description": "start date of the interval", "format": "MM/DD/YYYY" }, "end_date": { "type": "string", "description": "end date of the interval", "format": "MM/DD/YYYY" } } }, "amounts": { "type": "array", "description": "Array of objects representing earning amounts", "items": { "properties": { "currency": { "type": "string", "description": "Currency of the payment", "enum": [ "USD", "OTHER" ] }, "type": { "type": "string", "description": "Type of earning", "enum": [ "GROSS", "NET", "REGULAR", "OVERTIME", "BONUS", "COMMISSION", "OTHER" ] }, "ytd_flag": { "type": "boolean", "description": "Indicates if the amount given is year to date" }, "value": { "type": "number", "description": "Value of earning amount" }, "description": { "type": "string", "description": "Description of amount" }, "rate": { "type": "number", "description": "Pay rate of the employee" }, "hours": { "type": "string", "description": "Number of hours worked" } } } } } } }, "deductions": { "type": "array", "description": "Deductions of the employee", "items": { "properties": { "type": { "type": "string", "description": "Type of deduction", "enum": [ "OTHER" ] }, "interval": { "type": "object", "description": "Interval for which the deduction is denoted", "properties": { "start_date": { "type": "string", "description": "start date of the interval", "format": "MM/DD/YYYY" }, "end_date": { "type": "string", "description": "end date of the interval", "format": "MM/DD/YYYY" } } }, "amounts": { "type": "array", "description": "Array of objects representing deduction amounts", "items": { "properties": { "currency": { "type": "string", "description": "Currency of the deduction", "enum": [ "USD", "OTHER" ] }, "type": { "type": "string", "description": "Type of deduction", "enum": [ "OTHER" ] }, "ytd_flag": { "type": "boolean", "description": "Indicates if the amount given is year to date" }, "value": { "type": "number", "description": "Value of deduction amount" } } } } } } }, "deposits": { "type": "array", "description": "Employee Deposits", "items": { "type": "object", "properties": { "method": { "type": "string", "description": "Type of Deposit", "enum": [ "DIRECT_DEPOSIT", "OTHER" ] }, "account_name": { "type": "string", "description": "Name of account" }, "account_number": { "type": "string", "description": "Bank account number" }, "transit_number": { "type": "string", "description": "Transit number of the bank" }, "account_type": { "type": "string", "description": "Type of account", "enum": [ "CHECKING", "SAVING", "OTHER" ] }, "amount": { "type": "object", "description": "Amount of the deposits", "properties": { "currency": { "type": "string", "description": "Currency of the amount. e.g. `USD`, `CAD`" }, "value": { "type": "number", "description": "Value of deposited amount" } } } } } }, "benefits": { "type": "array", "description": "Benefits for the employee", "items": { "properties": { "type": { "type": "string", "description": "Type of benefit", "enum": [ "OTHER" ] }, "interval": { "type": "object", "description": "Interval for which the benefit is denoted", "properties": { "start_date": { "type": "string", "description": "start date of the interval", "format": "MM/DD/YYYY" }, "end_date": { "type": "string", "description": "end date of the interval", "format": "MM/DD/YYYY" } } }, "amounts": { "type": "array", "description": "Array of objects representing benefit amounts", "items": { "properties": { "currency": { "type": "string", "description": "Currency of the benefit", "enum": [ "USD", "OTHER" ] }, "type": { "type": "string", "description": "Type of benefit", "enum": [ "OTHER" ] }, "ytd_flag": { "type": "boolean", "description": "Indicates if the amount given is year to date" }, "value": { "type": "number", "description": "Value of benefit amount" } } } } } } } } } /%}