Back to Ascentis Hr & Payroll Made Easy Home
PhonePartner Log-in
 
 
 
 
 
 
 

HRIS PAYROLL RECRUITING TIME AND ATTENDANCE SELF-SERVICE CARRIER CONNECT PAYROLL CONNECT
IMPLEMENTATION ASCENTIS HR TRAINING ASCENTIS PAYROLL TRAINING
BENEFITS BROKERS HR CONSULTING FIRMS MPay BUREAUS MS DYNAMICS SL RESELLERS SAGE ACCPAC RESELLERS HOW TO BECOME A PARTNER
DOWNLOADS & DOCUMENTATION GO-TO-ASSIST LEAP FILE
WEBINAR WEBINAR ARCHIVE CASE STUDIES | VIDEO INTERVIEWS WHITE PAPERS ASCENTIS BLOG HR, BENEFITS & PAYROLL NEWS JOIN US ON FACEBOOK FOLLOW US ON TWITTER
FREQUENTLY ASKED QUESTIONS EXECUTIVE TEAM UPCOMING EVENTS PRESS RELEASES CAREERS CONTACT ASCENTIS

Fields
Home > Resources > Fields

This API returns fields available for new hires with standard Ascentis fields identified by their name. This name should be used when sending values to /newhire. Additionally, the field descriptor contains: a human readable description is included, a default value, and a required attribute if the field is mandatory to create a new hire. Enumerated fields contain a list of value descriptors for each allowed value.

Resource URL

https://serverurl/path/v1.1/fields


Example Request
GET https://serverurl/api/v1.1/fields
Return Value
List of Ascentis Fields
  1. <clientdata>
  2.        <standardfields>
  3.               <stdfld name="[FieldName]" type="[Type]" length="[Length]" description="[Description]" required="[Required]"> default="[DefaultValue]"></stdfld>
  4.                      <value description="[Value Description]">[Value]</value>
  5.                      ...
  6.                </stdfld>
  7.                ...
  8.        </standardfields>
  9.        <doctypes>
  10.               <doctype name="[AttachmentName]" type="[AttachmentType]" id="[attachment type id]"/>
  11.                ...
  12.        </doctypes>
  13. </clientdata>
FieldName: Name of the field. This field name is unique.
Type: Type of the field among: string, date, boolean, integer, double.
Description: Human readable description of the field.
Required: (optional) if true, the field is required to create a new hire.
Default: (optional) if included this is the default value for new hires if field is not specified. If the field is required, this is the suggested default.
Value Description: if the value tag is included this is the description of the given value for this field.
Value: if the value tag is included this is one of the allowed value for the field.
Attachment Name: Human readable type of attachment (e.g. "Resume", "I-9"...)
Attachment Type: Type of attachment ("Employee", "Benefits", "Compensation"). This will tell you where the attachment will end up in Ascentis HR.
Attachment ID: ID of the attachment. You will need this identifier when uploading a new attachment.
Return Example
  1. <clientdata>
  2.        <standardfields>
  3.               <stdfld name="LastName" type="string" length="80" description="Last Name" required="true"></stdfld>
  4.               <stdfld name="FirstName" type="string" length="80" description="First Name" required="true"></stdfld>
  5.               <stdfld name="MiddleName" type="string" length="40" description="Middle Name" default=""></stdfld>
  6.               <stdfld name="SSN" type="string" length="25" description="SSN" required="true"></stdfld>
  7.               <stdfld name="Email" type="string" length="80" description="Work E-mail Address" default=""></stdfld>
  8.               <stdfld name="OtherEmail" type="string" length="80" description="Other E-mail Address" default=""></stdfld>
  9.               <stdfld name="Disabled" type="boolean" description="Currently Disabled" default="false"></stdfld>
  10.               <stdfld name="DisabledVt" type="boolean" description="Disabled Veteran" default="false"></stdfld>
  11.               <stdfld name="OtherVet" type="boolean" description="Other Protected Veteran" default="false"></stdfld>
  12.               <stdfld name="EEOStatus" type="string" length="1" description="EEO-1 Job Category" default="">
  13.                      <value description="First/Mid-Level Officials and Managers">M</value>
  14.                      <value description="Executive/Senior Level Officials and Managers">X</value>
  15.                      <value description="Professionals">P</value>
  16.                      <value description="Technicians">T</value>
  17.                      <value description="Sales Workers">S</value>
  18.                      <value description="Administrative Support Workers">C</value>
  19.                      <value description="Craft Workers">R</value>
  20.                      <value description="Operatives">O</value>
  21.                      <value description="Laborers and Helpers">L</value>
  22.                      <value description="Service Workers">W</value>
  23.               </stdfld>
  24.               <stdfld name="EEO4JobCategory" type="string" length="1" description="EEO-4 Job Category" default="">
  25.                      <value description="Administrative Support">S</value>
  26.                      <value description="Officials and Administrators">O</value>
  27.                      <value description="Paraprofessionals">A</value>
  28.                      <value description="Professionals">P</value>
  29.                      <value description="Protective Service Workers">V</value>
  30.                      <value description="Service/Maintenance">M</value>
  31.                      <value description="Skilled Craft Workers">C</value>
  32.                      <value description="Technicians">T</value>
  33.               </stdfld>
  34.               <stdfld name="EmpAddr1" type="string" length="80" description="Address Line 1" default=""></stdfld>
  35.               <stdfld name="EmpAddr2" type="string" length="80" description="Address Line 2" default=""></stdfld>
  36.               <stdfld name="EmpCity" type="string" length="80" description="City" default=""></stdfld>
  37.               <stdfld name="EmpCntry" type="string" length="80" description="Country" default="USA"></stdfld>
  38.               <stdfld name="EmpHPhone" type="string" length="40" description="Home Phone Number" default=""></stdfld>
  39.               <stdfld name="EmpI9Date" type="date" length="8" description="I-9 Review Date" default=""></stdfld>
  40.               <stdfld name="EmpI9Stats" type="string" length="1" description="I-9 Status" default="">
  41.                      <value description="Completed">C</value>
  42.                      <value description="Not Complete">N</value>
  43.                      <value description="Not Applicable">T</value>
  44.               </stdfld>
  45.               <stdfld name="EmpID" type="string" length="35" description="Employee ID" default=""></stdfld>
  46.               <stdfld name="EmpState" type="string" length="2" description="State" default=""></stdfld>
  47.               <stdfld name="EmpZipCode" type="string" length="10" description="Zip Code" default=""></stdfld>
  48.               <stdfld name="EthnicOrg" type="string" length="1" description="EEO Ethnic Origin" default="">
  49.                      <value description="American Indian or Alaska Native">I</value>
  50.                      <value description="Asian">S</value>
  51.                      <value description="Black or African American">A</value>
  52.                      <value description="Hispanic or Latino">H</value>
  53.                      <value description="Native Hawaiian or Other Pacific Islander">W</value>
  54.                      <value description="White">C</value>
  55.                      <value description="Two or More Races">R</value>
  56.               </stdfld>
  57.               <stdfld name="HireDate" type="date" length="8" description="Hire Date" required="true"></stdfld>
  58.               <stdfld name="MarStatus" type="string" length="1" description="Marital Status" default="">
  59.                      <value description="Unknown">N</value>
  60.                      <value description="Single">S</value>
  61.                      <value description="Single w/ Children">C</value>
  62.                      <value description="Married">M</value>
  63.                      <value description="Married w/ Children&gt;">U</value>
  64.                      <value description="Divorced">D</value>
  65.                      <value description="Separated">X</value>
  66.                      <value description="Domestic Partnership">P</value>
  67.                      <value description="Domestic Partnership w/ Children">Z</value>
  68.                      <value description="Widow(er)">W</value>
  69.               </stdfld>
  70.               <stdfld name="Sex" type="string" length="1" description="Gender" default="M">
  71.                      <value description="Male">M</value>
  72.                      <value description="Female">F</value>
  73.               </stdfld>
  74.               <stdfld name="SuperVFlg" type="boolean" description="Supervisor?" default="false"></stdfld>
  75.               <stdfld name="Veteran" type="boolean" description="Veteran" default="false"></stdfld>
  76.               <stdfld name="VietnamVet" type="boolean" description="Vietnam Era Veteran" default="false"></stdfld>
  77.               <stdfld name="ArmFrcSrvMdlVet" type="boolean" description="Armed Forces Service Medal Veteran" default="false"></stdfld>
  78.               <stdfld name="ActDutyRelDate" type="date" length="8" description="Active Duty Release Date" default=""></stdfld>
  79.               <stdfld name="VisaType" type="string" length="80" description="Visa Type" default="">
  80.                      <value description="A-1">A-1</value>
  81.                      <value description="A-2">A-2</value>
  82.                      <value description="A-3">A-3</value>
  83.                      <value description="B-1">B-1</value>
  84.                      <value description="B-2">B-2</value>
  85.                      <value description="C-1">C-1</value>
  86.                      <value description="C-1D">C-1D</value>
  87.                      <value description="C-2">C-2</value>
  88.                      <value description="C-3">C-3</value>
  89.                      <value description="C-4">C-4</value>
  90.                      <value description="D-1">D-1</value>
  91.                      <value description="D-2">D-2</value>
  92.                      <value description="E-1">E-1</value>
  93.                      <value description="E-2">E-2</value>
  94.                      <value description="F-1">F-1</value>
  95.                      <value description="F-2">F-2</value>
  96.                      <value description="G-1">G-1</value>
  97.                      <value description="G-2">G-2</value>
  98.                      <value description="G-3">G-3</value>
  99.                      <value description="G-4">G-4</value>
  100.                      <value description="G-5">G-5</value>
  101.                      <value description="H-1B">H-1B</value>
  102.                      <value description="H-1C">H-1C</value>
  103.                      <value description="H-2A">H-2A</value>
  104.                      <value description="H-2B">H-2B</value>
  105.                      <value description="H-3">H-3</value>
  106.                      <value description="H-4">H-4</value>
  107.                      <value description="I">I</value>
  108.                      <value description="J-1">J-1</value>
  109.                      <value description="J-2">J-2</value>
  110.                      <value description="K-1">K-1</value>
  111.                      <value description="K-2">K-2</value>
  112.                      <value description="K-3">K-3</value>
  113.                      <value description="K-4">K-4</value>
  114.                      <value description="L-1A">L-1A</value>
  115.                      <value description="L-1B">L-1B</value>
  116.                      <value description="L-2">L-2</value>
  117.                      <value description="M-1">M-1</value>
  118.                      <value description="M-2">M-2</value>
  119.                      <value description="N-8">N-8</value>
  120.                      <value description="N-9">N-9</value>
  121.                      <value description="NAFTA">NAFTA</value>
  122.                      <value description="NATO-1">NATO-1</value>
  123.                      <value description="NATO-2">NATO-2</value>
  124.                      <value description="NATO-3">NATO-3</value>
  125.                      <value description="NATO-4">NATO-4</value>
  126.                      <value description="NATO-5">NATO-5</value>
  127.                      <value description="NATO-6">NATO-6</value>
  128.                      <value description="NATO-7">NATO-7</value>
  129.                      <value description="O-1">O-1</value>
  130.                      <value description="O-2">O-2</value>
  131.                      <value description="O-3">O-3</value>
  132.                      <value description="P-1">P-1</value>
  133.                      <value description="P-1">P-1</value>
  134.                      <value description="P-2">P-2</value>
  135.                      <value description="P-3">P-3</value>
  136.                      <value description="P-4">P-4</value>
  137.                      <value description="Q-1">Q-1</value>
  138.                      <value description="Q-2">Q-2</value>
  139.                      <value description="Q-3">Q-3</value>
  140.                      <value description="R-1">R-1</value>
  141.                      <value description="R-2">R-2</value>
  142.                      <value description="S-5">S-5</value>
  143.                      <value description="S-6">S-6</value>
  144.                      <value description="T-1">T-1</value>
  145.                      <value description="T-2">T-2</value>
  146.                      <value description="T-3">T-3</value>
  147.                      <value description="T-4">T-4</value>
  148.                      <value description="TD">TD</value>
  149.                      <value description="TN">TN</value>
  150.                      <value description="TPS">TPS</value>
  151.                      <value description="TWOV">TWOV</value>
  152.                      <value description="U-1">U-1</value>
  153.                      <value description="U-2">U-2</value>
  154.                      <value description="U-3">U-3</value>
  155.                      <value description="U-4">U-4</value>
  156.                      <value description="V-1">V-1</value>
  157.                      <value description="V-2">V-2</value>
  158.                      <value description="V-3">V-3</value>
  159.               </stdfld>
  160.               <stdfld name="VisaNumber" type="string" length="40" description="Visa Number" default=""></stdfld>
  161.               <stdfld name="VisaExpires" type="date" length="8" description="Visa Expiration Date" default=""></stdfld>
  162.               <stdfld name="Citizenshp" type="char" length="1" description="Citizenship" default="">
  163.                      <value description="US Citizen">U</value>
  164.                      <value description="US National">N</value>
  165.                      <value description="Permanent Resident">F</value>
  166.                      <value description="Alien Allowed to Work">A</value>
  167.                      <value description="Other">O</value>
  168.                      <value description="Not Applicable">T</value>
  169.               </stdfld>
  170.               <!-- Job -->
  171.               <stdfld name="JobStartDate" type="date" length="8" description="Job Start Date" default="HireDate"></stdfld>
  172.               <stdfld name="DeptID" type="integer" length="4" description="Department" default="">
  173.                      <value description="Shipping/Receiving">7</value>
  174.                      <value description="Human Resources">9</value>
  175.                      <value description="Accounting">10</value>
  176.                      <value description="New Sales">11</value>
  177.               </stdfld>
  178.               <stdfld name="DivisionID" type="integer" length="4" description="Division" default="">
  179.                      <value description="Distribution">4</value>
  180.                      <value description="Corporate">5</value>
  181.                      <value description="Sales">6</value>
  182.               </stdfld>
  183.               <stdfld name="LocationID" type="integer" length="4" description="Location" default="">
  184.                      <value description="Dallas">3</value>
  185.                      <value description="Seattle">4</value>
  186.                      <value description="Dublin">6</value>
  187.                      <value description="Louisville">7</value>
  188.                      <value description="New York">8</value>
  189.                      <value description="Pittsburgh">9</value>
  190.                      <value description="Richmond">10</value>
  191.               </stdfld>
  192.               <stdfld name="JobTitleID" type="integer" length="4" description="Job Title" default="">
  193.                      <value description="CEO">15</value>
  194.                      <value description="VP - Sales">16</value>
  195.                      <value description="VP - Operations">17</value>
  196.                      <value description="Accountant">18</value>
  197.                      <value description="HR Manager">19</value>
  198.                      <value description="Customer Service Rep">20</value>
  199.                      <value description="Sales Representative">21</value>
  200.                      <value description="Truck Driver">22</value>
  201.                      <value description="Warehouse Floor Supervisor">23</value>
  202.                      <value description="PC Technician">24</value>
  203.                      <value description="Warehouse Stocker">25</value>
  204.                      <value description="Heavy Equipment Operator">26</value>
  205.                      <value description="Systems Administrator">27</value>
  206.                      <value description="Accounting Assistant">28</value>
  207.               </stdfld>
  208.               <!-- Salary -->
  209.               <stdfld name="SalaryStartDate" type="date" length="8" description="Compensation Effective Date" default="HireDate"></stdfld>
  210.               <stdfld name="HoursPerWk" type="numeric" length="9" description="Hours Per Week" default="45.00"></stdfld>
  211.               <stdfld name="PayPeriod" type="string" length="1" description="Pay Period" default="B">
  212.                      <value description="Daily">D</value>
  213.                      <value description="Weekly">W</value>
  214.                      <value description="Bi-Weekly">B</value>
  215.                      <value description="Semi-Monthly">S</value>
  216.                      <value description="Monthly">M</value>
  217.               </stdfld>
  218.               <stdfld name="SalaryAmt" type="numeric" length="9" description="Amount" default="0.00"></stdfld>
  219.               <stdfld name="SalaryType" type="string" length="1" description="Salary Type" default="E">
  220.                      <value description="Salary Exempt">E</value>
  221.                      <value description="Hourly Non-Exempt">H</value>
  222.                      <value description="Salary Non-Exempt">N</value>
  223.                      <value description="Hourly Exempt">X</value>
  224.               </stdfld>
  225.               <stdfld name="SalaryUnit" type="string" length="1" description="Salary Unit" default="Y">
  226.                      <value description="Hour">H</value>
  227.                      <value description="Day">D</value>
  228.                      <value description="Week">W</value>
  229.                      <value description="Month">M</value>
  230.                      <value description="Year">Y</value>
  231.               </stdfld>
  232.               <stdfld name="PayrollDirectory" type="string" length="25" description="Payroll Directory" default="C">
  233.                      <value description="Sales">A</value>
  234.                      <value description="Admin">B</value>
  235.                      <value description="Laborers &amp; Drivers">C</value>
  236.                      <value description="Executive">D</value>
  237.                      <value description="EOG">E</value>
  238.               </stdfld>
  239.               <!-- EmploymentStatus -->
  240.               <stdfld name="EmpStatusStartDate" type="date" length="8" description="Employment Status Start Date" default="HireDate"></stdfld>
  241.               <stdfld name="EmpStatus" type="string" length="1" description="Employment Status" default="F">
  242.                      <value description="Full Time">F</value>
  243.                      <value description="Part Time">P</value>
  244.                      <value description="Terminated">X</value>
  245.                      <value description="Retired">R</value>
  246.                      <value description="Temporary">T</value>
  247.                      <value description="Contract">C</value>
  248.                      <value description="Seasonal">O</value>
  249.                      <value description="Suspended">S</value>
  250.                      <value description="COBRA Dependent Only">Z</value>
  251.                      <value description="LOA - Workers' Comp.">W</value>
  252.                      <value description="LOA - FMLA">A</value>
  253.                      <value description="LOA - Disability">D</value>
  254.                      <value description="LOA - Maternity">M</value>
  255.                      <value description="LOA - Military">I</value>
  256.                      <value description="LOA - Parental Leave">N</value>
  257.                      <value description="LOA - Personal">L</value>
  258.                      <value description="LOA - Other">H</value>
  259.               </stdfld>
  260.        </standardfields>
  261.        <doctypes>
  262.               <doctype type="Employee" id="257" name="Resume" />
  263.               <doctype type="Employee" id="258" name="Application" />
  264.               <doctype type="Employee" id="259" name="Other" />
  265.               <doctype type="Employee" id="390" name="Quiz" />
  266.               <doctype type="Compensation" id="260" name="Review" />
  267.               <doctype type="Compensation" id="261" name="Other" />
  268.               <doctype type="Benefits" id="262" name="Enrollment Forms" />
  269.               <doctype type="Benefits" id="263" name="Other" />
  270.        </doctypes>
  271. </clientdata>
  272.  


  • Choose different API...
    • Employee Finder
    • Find API Fields
    • File Attachments
    • Benefit Enrollments
    • Compensation
    • Employee data
    • Employee Benefits
    • Find a Benefit Plan
    • User Defined Fields
    • Job
    • New Hire
    • Updates
    • Direct Deposits
    • Change Log
    • COBRA
    • Emergency Contacts
    • Company Jobs
    • Company Locations
    • Raw Data


Resource Information
Requires Authentication?Yes
Response Formatsjson
xml
HTTP MethodsGET
Request ContentN/A
Return Code200: Response Completed
403: Incorrect Authorization


Home | Solutions | Professional Services | Partners | Case Studies | Support | About Us | Blog | Contact Us | Site Map

Ascentis offers a comprehensive suite of on-demand HRIS/HRMS HR software, employee self-service, online payroll, applicant tracking system, and time and attendance software solutions. Our HRIS software/ HR management software, online payroll services, recruiting software, and online timesheet products are easy to set up, use, and are fully backed by friendly customer support professionals. Ascentis has been an innovative leader in human resource software since 1980.