Inbound - Employees

This document outlines the structure and specifications for importing employee data into the POS system. It includes XML and JSON examples, defines all relevant fields for employees, such as identifiers, personal details, employment information, roles, and store access.

Example

XML:

<?xml version="1.0" encoding="UTF-8"?>
<Employees generated="2021-10-12T11:00:00.000+02:00">
    <Employee>
        <EmployeeId>123456</EmployeeId>
        <SalesPersonId>REP001</SalesPersonId>
        <EmployeeCardId>9120001234561</EmployeeCardId>
        <FirstName>First</FirstName>
        <LastName>Last</LastName>
        <ShortName>Short</ShortName>
        <HomeStoreId>0001</HomeStoreId>
        <Language>nl-NL</Language>
        <FunctionId>F001</FunctionId>
        <DeviatingRoleId>Supervisor</DeviatingRoleId>
        <StartOfEmployment>2020-01-01</StartOfEmployment>
        <EndOfEmployment>2099-12-31</EndOfEmployment>
        <ContractHours>40</ContractHours>
    <DiscountBalanceStartDate>2020-03-01</DiscountBalanceStartDate>
        <AdditionalInformation>
            <PreferredHand>Left</PreferredHand>
            <PaymentPreSelectionType>Blocked</PaymentPreSelectionType>
        </AdditionalInformation>
        <AccessStores>
            <AccessStore>
                <StoreId>0002</StoreId>
                <AccessStartDate>2020-01-01</AccessStartDate>
                <AccessEndDate>2020-01-07</AccessEndDate>
            </AccessStore>
        </AccessStores>
    </Employee>
</Employees>

JSON:

{
  "Employees": {
    "generated": "2025-05-19T10:15:30Z",
    "Employee": [
      {
        "EmployeeId": "123123",
        "SalesPersonId": "123123",
        "EmployeeCardId": "123123123",
        "FirstName": "Stef",
        "LastName": "Staal",
        "ShortName": "SS",
        "HomeStoreId": "0802",
        "Language": "nl-NL",
        "FunctionId": "01",
        "StartOfEmployment": "2020-01-15",
        "EndOfEmployment": "2099-12-31",
        "AdditionalInformation": {
          "PreferredHand": "Right",
          "PaymentPreSelectionType": "Cash"
        },
        "AccessStores": [
          {
            "StoreId": "0801",
            "AccessStartDate": "2020-01-15",
            "AccessEndDate": "2099-12-31"
          }
        ],
        "ContractHours": 40,
        "DiscountBalanceStartDate": "2020-03-15"
      },
      {
        "EmployeeId": "123321",
        "FirstName": "Bob",
        "LastName": "Smith",
        "HomeStoreId": "0801",
        "Language": "nl",
        "FunctionId": "02",
        "AccessStores": []
      }
    ]
  }
}

Employees Definition

Field	Type	Optional	Comment
@generated	DateTime	X	The Date and time the file was generated
Employees	Employee[]

Employee Definition

Field	Type	Optional	Comment
EmployeeId	string
SalesPersonId	string	X
EmployeeCardId	string	X
FirstName	string	X*	First name (optional when last name is provided)
LastName	string	X*	Last name (optional when first name is provided)
ShortName	string	X
HomeStoreId	string	X	Store Id employee is linked to by default
Language	string		Language code, either ISO 639-1 (nl, en, fr, etc.) or as language culure name (nl-NL, en-GB, fr-FR)
FunctionId	string		Function id
DeviatingRoleId	string	X	Linked role when deviated from function role
StartOfEmployment	date	X	Date start of employement
EndOfEmployment	date	X	Date end of employement
AdditionalInformation	AdditionalInfo	X
AccessStores	AccessStore[]
ContractHours	int	X
DiscountBalanceStartDate	date	X	The date when employee discount becomes available, for example 2 months after start of employment

AdditionalInfo Definition

Field	Type	Optional	Comment
PreferredHand	string	X	Identifies the preferred hand, possible values: - Right (default) - Left
PaymentPreSelectionType	string	X	Identifies the selected payment type for transactions with employee discount (specific functionality), possible values: - Blocked (default) - Cash - OnAccount

AccessStore Definition

Field	Type	Optional	Comment
StoreId	string
AccessStartDate	date	X	Start of access to store
AccessEndDate	date	X	End of access to store

Schema

XSD
JSON

Version History

Version	Available from ROS Version	Author	Comment
1.0		Ed de Jong	Initial document
1.1		Ed de Jong	Added AccessStores element
1.2	1.229.100	Stephan Geissler	Added ContractHours
1.3	1.250.100	Stephan Geissler	Added DiscountBalanceStartDate