PUT api/Import/{importType}

Import data. Types are defined per company.

Request Information

URI Parameters

Name	Description	Type	Additional information
importType	EmpBase type only	string	Required

Body Parameters

string

Request Formats

application/json, text/json

Sample:

{
    "identification": 
    {
        "clientid": "06a187c9-a748-418b-84e2-e62a9d3afceb",
        "clientname": "ClientName",
        "payrollid": "PAY666",
        "outputdate": "2021-07-05T06:10:13.796Z",
        "outputid": "55"
    },
    "basedata": 
    [
        {
            "EmployeeNumber": "101046",
            "Surname": "Employee",
            "Forenames": "Test",
            "Title": "Mrs",
            "NINumber": "AB123456C",
            "NITableLetter": "A",
            "AddressLine1": "1 Test Street",
            "AddressLine2": "The Town",
            "AddressLine3": "The County",
            "AddressLine4": "",
            "PostCode": "CO7 1DD",
            "DateOfBirth": "1984-08-14T00:00:00.000Z",
            "StartDate": "2019-01-01T00:00:00.000Z",
            "DateLeft": "",
            "BankSortCode": "12-12-12",
            "BankNo": "12345678",
            "BuildingSocietyRollNo": "",
            "Department": "703",
            "Division": "803",
            "Location": "903",
            "CostCentre1": "1003",
            "CostCentrePercent1": "100",
            "CurrentHours": "40.0000",
            "WorkEmailAddress": "example@example.com",
            "CurrentBasicPay": "17000.00",
            "CurrentPayStartDate": "2019-01-01T00:00:00.000Z",
            "PayBasis": "Salaried",
            "MethodOfPayment": "BACS",
            "ID": "14607",
            "WorkingDays": "-YYYYY-",
            "Sex": "F",
            "MonHrs": "7",
            "TueHrs": "5",
            "WedHrs": "8",
            "ThuHrs": "10",
            "FriHrs": "9",
            "SatHrs": "0",
            "SunHrs": "0",
            "PayElementRateName": "Term Time Hourly",
            "PayElementRate": "9",
            "HourlyRate": "8.17"
        }
    ],
    "allowance": 
    [
        {
            "EmployeeNumber": "101046",
            "Code": "C013",
            "Value": "258.00",
            "StartDate": "2019-02-01T00:00:00.000Z",
            "EndDate": ""
        }
    ],
    "payment": 
    [
        {
            "EmployeeNumber": "101046",
            "Code": "C010",
            "Value": "1000.00",
            "Date": "2019-01-25T00:00:00.000Z"
        }
    ],
    "time": 
    [
        {
            "EmployeeNumber": "101046",
            "Code": "C010",
            "Amount": "1000.00",
            "Date": "2019-01-25T00:00:00.000Z",
            "CostCentreCode": "",
            "ProjectCode": "",
            "Hours": "37"
        }
    ]
}

application/xml, text/xml

Sample:

<identification>
    <clientid>06a187c9-a748-418b-84e2-e62a9d3afceb</clientid>
    <clientname>ClientName</clientname>
    <payrollid>PAY666</payrollid>
    <outputdate>2021-07-05T06:10:13.796Z</outputdate>
    <outputid>55</outputid>
</identification>
<basedata>
    <EmployeeNumber>101046</EmployeeNumber>
    <Surname>Employee</Surname>
    <Forenames>Test</Forenames>
    <Title>Mrs</Title>
    <NINumber>AB123456C</NINumber>
    <NITableLetter>A</NITableLetter>
    <AddressLine1>1 Test Street</AddressLine1>
    <AddressLine2>The Town</AddressLine2>
    <AddressLine3>The County</AddressLine3>
    <AddressLine4></AddressLine4>
    <PostCode>CO7 1DD</PostCode>
    <DateOfBirth>1984-08-14T00:00:00.000Z</DateOfBirth>
    <StartDate>2019-01-01T00:00:00.000Z</StartDate>
    <DateLeft></DateLeft>
    <BankSortCode>12-12-12</BankSortCode>
    <BankNo>12345678</BankNo>
    <BuildingSocietyRollNo></BuildingSocietyRollNo>
    <Department>703</Department>
    <Division>803</Division>
    <Location>903</Location>
    <CostCentre1>1003</CostCentre1>
    <CostCentrePercent1>100</CostCentrePercent1>
    <CurrentHours>40.0000</CurrentHours>
    <WorkEmailAddress>example @example.com</WorkEmailAddress>
    <CurrentBasicPay>17000.00</CurrentBasicPay>
    <CurrentPayStartDate>2019-01-01T00:00:00.000Z</CurrentPayStartDate>
    <PayBasis>Salaried</PayBasis>
    <MethodOfPayment>BACS</MethodOfPayment>
    <ID>14607</ID>
    <WorkingDays>-YYYYY-</WorkingDays>
    <Sex>F</Sex>
    <MonHrs>7</MonHrs>
    <TueHrs>5</TueHrs>
    <WedHrs>8</WedHrs>
    <ThuHrs>10</ThuHrs>
    <FriHrs>9</FriHrs>
    <SatHrs>0</SatHrs>
    <SunHrs>0</SunHrs>
    <PayElementRateName>Term Time Hourly</PayElementRateName>
    <PayElementRate>9</PayElementRate>
    <HourlyRate>8.17</HourlyRate>
</basedata>
<allowance>
    <EmployeeNumber>101046</EmployeeNumber>
    <Code>C013</Code>
    <Value>258.00</Value>
    <StartDate>2019-02-01T00:00:00.000Z</StartDate>
    <EndDate></EndDate>
</allowance>
<payment>
    <EmployeeNumber>101046</EmployeeNumber>
    <Code>C010</Code>
    <Value>1000.00</Value>
    <Date>2019-01-25T00:00:00.000Z</Date>
</payment>
<time>
    <EmployeeNumber>101046</EmployeeNumber>
    <Code>C010</Code>
    <Amount>1000.00</Amount>
    <Date>2019-01-25T00:00:00.000Z</Date>
    <CostCentreCode></CostCentreCode>
    <ProjectCode></ProjectCode>
    <Hours>37</Hours>
</time>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

{
    "result": "OK"
}

{
    "result": "Error",
    "message": "Unable to save: the..."
}

application/xml, text/xml

Sample:

<ResultWithMessage>
    <result>OK</result>
</ResultWithMessage>

<ResultWithMessage>  
    <result>Error</result>
    <message>Unable to save: the...</message>
</ResultWithMessage>