--- updatedAt: 2025-06-02T22:58:50.000Z agentTools: projectIndex: https://developer.retrotax-aci.com/llms.txt --- # put # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2018-11-19T07:39:37Z", "title": "Retrotax TCID" }, "paths": { "/employees/{employee_id}": { "put": { "parameters": [ { "name": "X-DOCUMENTS-BG", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "X-AUTH-TOKEN", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "X-AUTH-IV", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "X-Content-Type-Options": { "schema": { "type": "string" } }, "Pragma": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "400": { "description": "400 response", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "X-Content-Type-Options": { "schema": { "type": "string" } }, "Pragma": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } } } }, "401": { "description": "401 response", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "X-Content-Type-Options": { "schema": { "type": "string" } }, "Pragma": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } } } }, "403": { "description": "403 response", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "X-Content-Type-Options": { "schema": { "type": "string" } }, "Pragma": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } } } }, "404": { "description": "404 response", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "X-Content-Type-Options": { "schema": { "type": "string" } }, "Pragma": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ] } } }, "servers": [ { "url": "https://api.retrotax-aci.com" } ], "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" } }, "schemas": { "EmployeeResponse": { "type": "object", "properties": { "employee_info": { "type": "object", "properties": { "location_id": { "type": "integer", "description": "The location id of the employee. The location id can be obtained for a company using the locations resource." }, "foreign_payroll_id": { "type": "string", "description": "An optional identifier representing the employee’s ID in an external system. If an external system needs to persist its internal employee reference within RetroTax, it can provide this value during the POST request.", "default": "123456" }, "first_name": { "type": "string", "description": "Employee's first name.", "default": "Oliver" }, "last_name": { "type": "string", "description": "Employee's last name.", "default": "Queen" }, "suffix": { "type": "string", "description": "Possible String Options: Jr., Sr.,II, III, IV.", "default": "Jr." }, "address_line_1": { "type": "string", "description": "Employee's address line 1", "default": "9000 Gennesse Avenue" }, "address_line_2": { "type": "string", "description": "Employee's address line 2", "default": "University Townne Center" }, "city": { "type": "string", "description": "Employee's city of residence. ", "default": "San Diego" }, "zip": { "type": "string", "description": "Employee's zip code. 5 numerical digits and an optional 4 digit extension (e.g. 33706 or 46214-2524).", "default": "92122" }, "state": { "type": "string", "description": "Employee's state of residence. 2 letter state abbreviation.", "default": "CA" }, "county_id": { "type": "string", "description": "Employee's county id.", "default": "12" }, "ssn": { "type": "integer", "description": "Employee's 9 digit Social Security Number with dashes. Format: XXX-XX-XXXX. Include leading zeroes if less than 9 digits." }, "dob": { "type": "string", "format": "date", "description": "Date of Birth. U.S. date formats only." }, "rehire": { "type": "boolean", "description": "Whether or not the employee has ever worked for this company before." }, "is_applicant": { "type": "boolean", "description": "This field indicates whether the record is employee OR applicant." } } }, "application_status": { "type": "object", "properties": { "code": { "type": "string", "description": "Status code of employee.", "default": "SS" }, "description": { "type": "string", "description": "Description of the status code.", "default": "Oliver" } } }, "qualifications": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of TargetGroup/Zone" }, "max_credit": { "type": "integer", "description": "Max credit of TargetGroup/Zone" }, "type": { "type": "string", "description": "Indicate current qualification is TargetGroup/Zone" } } } }, "hiring_manager_info": { "type": "object", "properties": { "occupation_id": { "type": "integer", "description": "The code of the employee's job position (e.g. hostess, processor, etc). Obtained from the occupation's resource. Make sure you pass in the code of the occupation." }, "starting_wage": { "type": "string", "description": "Employee's starting wage." }, "dgi": { "type": "string", "format": "date", "description": "Date gave information (dgi). U.S. date formats only." }, "dojo": { "type": "string", "format": "date", "description": "Date of job offer (dojo). U.S. date formats only." }, "doh": { "type": "string", "format": "date", "description": "Date of hire (doh). U.S. date formats only." }, "dsw": { "type": "string", "format": "date", "description": "Date started work (dsw). U.S. date formats only." } } }, "questionnaire": { "type": "object", "properties": { "afdc": { "type": "boolean", "description": "Whether or not employee or member of their household received Temporary Assistance to Needy Families (TANF) at any time since August 5, 1997." }, "food_stamps": { "type": "boolean", "description": "Whether or not employee or member of their household received food stamps during past 6 months." }, "ssi": { "type": "boolean", "description": "Received SSI during past 6 months." }, "voc_rehab": { "type": "boolean", "description": "Whether or not the employee received vocational rehabilitation services within the past 2 years." }, "veteran": { "type": "boolean", "description": "Whether or not the employee is a veteran of the United States Military." }, "unemployed": { "type": "boolean", "description": "Whether or not the employee has ever been unemployed at any time during the last 12 months." }, "felon": { "type": "boolean", "description": "Whether or not employee was convicted of felony or released from prison in last 12 months." }, "cdib": { "type": "boolean", "description": "Whether or not the employee or the employee?s spouse is a member of a Native American Tribe." }, "ca_farmer": { "type": "boolean", "description": "Whether or not the employee is a migrant or seasonal farm worker. Default: false." }, "ca_foster": { "type": "boolean", "description": "Whether or not the employee is the child of foster parents. Default: false." }, "ca_cal_works": { "type": "boolean", "description": "Whether or not the employee is a recipient of CalWorks. Default: false." }, "ca_misdemeanor": { "type": "boolean", "description": "Whether or not the employee has ever been convicted of a misdemeanor. Default: false." }, "ca_wia": { "type": "boolean", "description": "Whether or not the employee is a recipient of the Workforce Investment Act. Default: false." }, "sc_fib": { "type": "boolean", "description": "Whether or not the employee is a recipient of South Carolina Family Independence Benefits. Default: false." }, "conditional_cert": { "type": "boolean", "description": "Conditional Certification" } } }, "voc_rehab_info": { "type": "object", "properties": { "is_agency": { "type": "boolean", "description": "Received vocational rehabilitation services from a vocational rehabilitation agency." }, "dept_va": { "type": "boolean", "description": "Whether or not employee received vocational rehabilitation services from department of veterans affairs." }, "ttw": { "type": "boolean", "description": " Whether employee received vocational rehabilitation services from an Employment Network (Ticket to Work Program)." }, "address_line_1": { "type": "string", "description": "Agency address line 1." }, "address_line_2": { "type": "string", "description": "Agency address line 2." }, "agency_name": { "type": "string", "description": "Name of the vocational rehabilitation center." }, "city": { "type": "string", "description": "Agency city." }, "county": { "type": "string", "description": "Agency county." }, "phone": { "type": "string", "description": "Agency phone #." }, "state": { "type": "string", "description": "Agency state. Please use 2 digit state code from the states resource" }, "zip": { "type": "string", "description": "Agency?s zip code. 5 numerical digits and an optional 4 digit extension (e.g. 33706 or 46214-2524)." } } }, "felon_info": { "type": "object", "properties": { "conviction_date": { "type": "string", "format": "date", "description": "Date of conviction. U.S. date formats only." }, "release_date": { "type": "string", "format": "date", "description": "Date of release. U.S. date formats only." }, "is_federal_conviction": { "type": "boolean", "description": "Federal felony conviction." }, "is_state_conviction": { "type": "boolean", "description": "State felony conviction." }, "parole_officer_name": { "type": "string", "description": "Parole officer name." }, "parole_officer_phone": { "type": "string", "description": "12 character limit (e.g. 317-925-0553)." }, "felony_state": { "type": "string", "description": "Felony state code(e.g MI, CA)." }, "felony_county": { "type": "string", "description": "Felony county ID(e.g 12)." } } }, "veteran_info": { "type": "object", "properties": { "disabled": { "type": "boolean", "description": "Whether or not the veteran is classified as a Disabled Veteran." }, "branch": { "type": "string", "description": "Please look at the branches resource for the complete list of branches. Possible Options: Army, Army Reserve, Army National Guard, Marine Corps, Marine Corps Reserve, Navy, Navy Reserve, Air Force, Air Force Reserve, Air Guard, Coast Guard, Coast Guard Reserve." }, "service_start": { "type": "string", "format": "date", "description": "Military service from date. U.S. date formats only." }, "service_stop": { "type": "string", "format": "date", "description": "Military service to date. U.S. date formats only." } } }, "foodstamps_recipient_info": { "type": "object", "properties": { "city_received": { "type": "string", "description": "City where benefits received." }, "county_received": { "type": "string", "description": "County where benefits received" }, "name": { "type": "string", "description": "Recipient?s name" }, "relationship": { "type": "string", "description": "Recipient relationship to employee" }, "state_received": { "type": "string", "description": "State where benefits received. 2 letter state abbreviation." } } }, "afdc_recipient_info": { "type": "object", "properties": { "city_received": { "type": "string", "description": "City where benefits received." }, "county_received": { "type": "string", "description": "County where benefits received" }, "name": { "type": "string", "description": "Recipient?s name" }, "relationship": { "type": "string", "description": "Recipient relationship to employee" }, "state_received": { "type": "string", "description": "State where benefits received. 2 letter state abbreviation." } } }, "unemployment_info": { "type": "object", "properties": { "compensated": { "type": "boolean", "description": "Whether or not the veteran is classified as a Disabled Veteran." }, "compensation_start_date": { "type": "string", "format": "date", "description": "The start date the employee began receiving compensation for unemployment." }, "compensation_end_date": { "type": "string", "format": "date", "description": "The end date the employee stopped receiving compensation for unemployment." }, "unemployment_start_date": { "type": "string", "format": "date", "description": "The start date the employee became unemployed." }, "unemployment_end_date": { "type": "string", "format": "date", "description": "The last day of unemployment for the employee." } } }, "nyy_questionnaire_info": { "type": "object", "properties": { "nyy_area": { "type": "string", "description": "currently live in the town, or city limits, of the following target area, check one: Albany, Brookhaven, Buffalo, Hempstead, Mount Vernon, New Rochelle, New York City (5 boroughs), Rochester, Schenectady, Syracuse, Utica, White Plains, Yonkers." }, "nyy_phone": { "type": "string", "description": "Phone number" }, "is_attending_highschool": { "type": "boolean", "description": "Is currently attending high school" }, "is_attending_hse_program": { "type": "boolean", "description": "Is currently enrolled in a High School Equivalency (HSE) program" }, "employment_statement": { "type": "boolean", "description": "Are any of the following four statements true? 1. I am currently unemployed, 2. I was unemployed prior to completing this application, 3. I do not have enough paid work, 4. The work I have does not make use of my skills and training." }, "have_guardian_permission": { "type": "boolean", "description": "Is applicant/employee 16 or 17 years old. and have his parent's or guardian's permission to submit this application" }, "guardian_first_name": { "type": "string", "description": "Parent/Guardian first name" }, "guardian_last_name": { "type": "string", "description": "Parent/Guardian last name" }, "guardian_contact": { "type": "string", "description": "Parent/Guardian phone number" }, "have_working_paper": { "type": "boolean", "description": "S/he have working papers" }, "educational_statement": { "type": "boolean", "description": "Are any of the following five statements true? 1. I have a high school diploma, 2. I have a General Education Development diploma (GED), 3. I have High School Equivalency (HSE) diploma, 4. I have satisfactorily completed a Test for Assessing Secondary Completion (TASC) exam, 5. I am enrolled in a Treatment Accountability for Safer Communities (TASC) program." }, "other_certification_statement": { "type": "boolean", "description": "New York Youth Jobs Program Youth Certification Qualifications" } } } }, "title": "employee_info" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```