POST api/v3/Payroll/company/{CompanyId}/location/{LocationId}/employee?ApplicationName={ApplicationName}&ApiKey={ApiKey}

Request Information

URI Parameters

Name	Type	Additional information
CompanyId	string	Required
LocationId	string	Required
ApplicationName	string	Required
ApiKey	string	Required

Body Parameters

Collection of Employees

Name	Type	Additional information
EmployeeGUID	globally unique identifier	Required
LocationGUID	globally unique identifier	None.
EmployeeID	string	Required Max length: 16 Min length: 1 String length: inclusive between 1 and 16
EmployeeLastName	string	Required Max length: 50 Min length: 1 String length: inclusive between 1 and 50
EmployeeFirstName	string	Required Max length: 50 Min length: 1 String length: inclusive between 1 and 50
EmployeeSSN	string	String length: inclusive between 0 and 9
EmployeeBirthDay	date	None.
EmployeeDeleted	boolean	Required
SoftwareVersion	string	String length: inclusive between 0 and 12
EmployeesTimeStamp	date	None.
EmployeesCreationOrigin	string	None.
EmployeesDeletionDate	date	None.
EmployeesTemplateImage	string	None.
EmployessTemplateSize	integer	None.
CompanyGUID	globally unique identifier	Required
EmployeesPhoto	string	None.
EmployeeStartDate	date	None.
EmployeeHomeLocationId	string	None.
EmployeeHomeLocationGUID	globally unique identifier	None.
EmployeeHomeLocationName	string	None.
EmployeeEnrollerGUID	globally unique identifier	None.
EmployeeEnrollerName	string	None.
UpdatePhoto	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "EmployeeGUID": "a685d1b8-e6fe-4147-92d1-5f51a8f8699e",
    "LocationGUID": "01a8dbae-9643-43cc-b27c-e11c53e0f306",
    "EmployeeID": "sample string 2",
    "EmployeeLastName": "sample string 3",
    "EmployeeFirstName": "sample string 4",
    "EmployeeSSN": "sample string 5",
    "EmployeeBirthDay": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeeDeleted": true,
    "SoftwareVersion": "sample string 7",
    "EmployeesTimeStamp": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeesCreationOrigin": "sample string 8",
    "EmployeesDeletionDate": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeesTemplateImage": "sample string 9",
    "EmployessTemplateSize": 1,
    "CompanyGUID": "66b4bd81-c446-4899-8e63-688cec0aa7c6",
    "EmployeesPhoto": "sample string 11",
    "EmployeeStartDate": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeeHomeLocationId": "sample string 12",
    "EmployeeHomeLocationGUID": "1dc0aadf-b00d-451b-adf8-cf6b2cd9535d",
    "EmployeeHomeLocationName": "sample string 13",
    "EmployeeEnrollerGUID": "ea5c04c8-a740-488f-9393-c59fb369c4d2",
    "EmployeeEnrollerName": "sample string 14",
    "UpdatePhoto": true
  },
  {
    "EmployeeGUID": "a685d1b8-e6fe-4147-92d1-5f51a8f8699e",
    "LocationGUID": "01a8dbae-9643-43cc-b27c-e11c53e0f306",
    "EmployeeID": "sample string 2",
    "EmployeeLastName": "sample string 3",
    "EmployeeFirstName": "sample string 4",
    "EmployeeSSN": "sample string 5",
    "EmployeeBirthDay": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeeDeleted": true,
    "SoftwareVersion": "sample string 7",
    "EmployeesTimeStamp": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeesCreationOrigin": "sample string 8",
    "EmployeesDeletionDate": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeesTemplateImage": "sample string 9",
    "EmployessTemplateSize": 1,
    "CompanyGUID": "66b4bd81-c446-4899-8e63-688cec0aa7c6",
    "EmployeesPhoto": "sample string 11",
    "EmployeeStartDate": "2026-06-08T08:54:23.8963502-04:00",
    "EmployeeHomeLocationId": "sample string 12",
    "EmployeeHomeLocationGUID": "1dc0aadf-b00d-451b-adf8-cf6b2cd9535d",
    "EmployeeHomeLocationName": "sample string 13",
    "EmployeeEnrollerGUID": "ea5c04c8-a740-488f-9393-c59fb369c4d2",
    "EmployeeEnrollerName": "sample string 14",
    "UpdatePhoto": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmployees xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MPSWebApi.Models">
  <Employees>
    <CompanyGUID>66b4bd81-c446-4899-8e63-688cec0aa7c6</CompanyGUID>
    <EmployeeBirthDay>2026-06-08T08:54:23.8963502-04:00</EmployeeBirthDay>
    <EmployeeDeleted>true</EmployeeDeleted>
    <EmployeeEnrollerGUID>ea5c04c8-a740-488f-9393-c59fb369c4d2</EmployeeEnrollerGUID>
    <EmployeeEnrollerName>sample string 14</EmployeeEnrollerName>
    <EmployeeFirstName>sample string 4</EmployeeFirstName>
    <EmployeeGUID>a685d1b8-e6fe-4147-92d1-5f51a8f8699e</EmployeeGUID>
    <EmployeeHomeLocationGUID>1dc0aadf-b00d-451b-adf8-cf6b2cd9535d</EmployeeHomeLocationGUID>
    <EmployeeHomeLocationId>sample string 12</EmployeeHomeLocationId>
    <EmployeeHomeLocationName>sample string 13</EmployeeHomeLocationName>
    <EmployeeID>sample string 2</EmployeeID>
    <EmployeeLastName>sample string 3</EmployeeLastName>
    <EmployeeSSN>sample string 5</EmployeeSSN>
    <EmployeeStartDate>2026-06-08T08:54:23.8963502-04:00</EmployeeStartDate>
    <EmployeesCreationOrigin>sample string 8</EmployeesCreationOrigin>
    <EmployeesDeletionDate>2026-06-08T08:54:23.8963502-04:00</EmployeesDeletionDate>
    <EmployeesPhoto>sample string 11</EmployeesPhoto>
    <EmployeesTemplateImage>sample string 9</EmployeesTemplateImage>
    <EmployeesTimeStamp>2026-06-08T08:54:23.8963502-04:00</EmployeesTimeStamp>
    <EmployessTemplateSize>1</EmployessTemplateSize>
    <LocationGUID>01a8dbae-9643-43cc-b27c-e11c53e0f306</LocationGUID>
    <SoftwareVersion>sample string 7</SoftwareVersion>
    <UpdatePhoto>true</UpdatePhoto>
  </Employees>
  <Employees>
    <CompanyGUID>66b4bd81-c446-4899-8e63-688cec0aa7c6</CompanyGUID>
    <EmployeeBirthDay>2026-06-08T08:54:23.8963502-04:00</EmployeeBirthDay>
    <EmployeeDeleted>true</EmployeeDeleted>
    <EmployeeEnrollerGUID>ea5c04c8-a740-488f-9393-c59fb369c4d2</EmployeeEnrollerGUID>
    <EmployeeEnrollerName>sample string 14</EmployeeEnrollerName>
    <EmployeeFirstName>sample string 4</EmployeeFirstName>
    <EmployeeGUID>a685d1b8-e6fe-4147-92d1-5f51a8f8699e</EmployeeGUID>
    <EmployeeHomeLocationGUID>1dc0aadf-b00d-451b-adf8-cf6b2cd9535d</EmployeeHomeLocationGUID>
    <EmployeeHomeLocationId>sample string 12</EmployeeHomeLocationId>
    <EmployeeHomeLocationName>sample string 13</EmployeeHomeLocationName>
    <EmployeeID>sample string 2</EmployeeID>
    <EmployeeLastName>sample string 3</EmployeeLastName>
    <EmployeeSSN>sample string 5</EmployeeSSN>
    <EmployeeStartDate>2026-06-08T08:54:23.8963502-04:00</EmployeeStartDate>
    <EmployeesCreationOrigin>sample string 8</EmployeesCreationOrigin>
    <EmployeesDeletionDate>2026-06-08T08:54:23.8963502-04:00</EmployeesDeletionDate>
    <EmployeesPhoto>sample string 11</EmployeesPhoto>
    <EmployeesTemplateImage>sample string 9</EmployeesTemplateImage>
    <EmployeesTimeStamp>2026-06-08T08:54:23.8963502-04:00</EmployeesTimeStamp>
    <EmployessTemplateSize>1</EmployessTemplateSize>
    <LocationGUID>01a8dbae-9643-43cc-b27c-e11c53e0f306</LocationGUID>
    <SoftwareVersion>sample string 7</SoftwareVersion>
    <UpdatePhoto>true</UpdatePhoto>
  </Employees>
</ArrayOfEmployees>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.