If an ID is passed, the existing employee will be updated, otherwise a new employee will be created.

NOTE: the MatchType parameter currently has no effect

An employee may be created with a status of 'Incomplete' by specifying at least the minimum fields; firstName, surname, startDate, employmentType, address details, gender, legalStatus, nationality, coveredByEmploymentAct.
For an employee record to be considered 'Complete' the following groups of data are required:

Basic Details (Name, Start Date, Date of Birth, Gender and Address Details)

Pay Run Defaults (Default Pay Category, Pay Cycle and Location)

Locations (at least one)

Bank Account/s (at least one)

Statutory Details (including Nationality, Legal Status)

If reporting dimensions are enabled for the business, add primary reporting dimension values using "|" as a separator between values.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/employee/unstructured

Path parameters

Query parameters

Request body

The request body takes a complete SgUnstructuredEmployeeModel resource, containing the following writable properties:

{
    "anniversaryDate": "date-time",
    "applyFullCpfRate": "string",
    "automaticallyPayEmployee": "string",
    "bankAccount1_AccountName": "string",
    "bankAccount1_AccountNumber": "string",
    "bankAccount1_AllocatedPercentage": "double",
    "bankAccount1_BankSwift": "string",
    "bankAccount1_BranchCode": "string",
    "bankAccount1_FixedAmount": "double",
    "bankAccount2_AccountName": "string",
    "bankAccount2_AccountNumber": "string",
    "bankAccount2_AllocatedPercentage": "double",
    "bankAccount2_BankSwift": "string",
    "bankAccount2_BranchCode": "string",
    "bankAccount2_FixedAmount": "double",
    "bankAccount3_AccountName": "string",
    "bankAccount3_AccountNumber": "string",
    "bankAccount3_AllocatedPercentage": "double",
    "bankAccount3_BankSwift": "string",
    "bankAccount3_BranchCode": "string",
    "bankAccount3_FixedAmount": "double",
    "coveredByEmploymentAct": "string",
    "cpfExempt": "boolean",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "emailAddress": "string",
    "emergencyContact1_Address": "string",
    "emergencyContact1_AlternateContactNumber": "string",
    "emergencyContact1_ContactNumber": "string",
    "emergencyContact1_Name": "string",
    "emergencyContact1_Relationship": "string",
    "emergencyContact2_Address": "string",
    "emergencyContact2_AlternateContactNumber": "string",
    "emergencyContact2_ContactNumber": "string",
    "emergencyContact2_Name": "string",
    "emergencyContact2_Relationship": "string",
    "employeeGroup": "string",
    "employingEntityId": "string",
    "employingEntityUen": "string",
    "employmentType": "string",
    "endDate": "date-time",
    "ethnicity": "string",
    "externalId": "string",
    "firstName": "string",
    "gender": "string",
    "homePhone": "string",
    "hoursPerDay": "double",
    "hoursPerWeek": "double",
    "id": "int32",
    "identityType": "string",
    "isEnabledForTimesheets": "string",
    "jobTitle": "string",
    "leaveAccrualStartDateType": "string",
    "leaveAnniversarySetting": "string",
    "leaveAnniversarySettingDate": "date-time",
    "leaveTemplate": "string",
    "leaveYearStart": "date-time",
    "legalName": "string",
    "legalStatus": "string",
    "locations": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "nationalRegistrationIdentityExpiryDate": "date-time",
    "nationalRegistrationIdentityNumber": "string",
    "nationality": "string",
    "obtainedApprovalDate": "date-time",
    "obtainedResidencyDate": "date-time",
    "overrideTemplateRate": "string",
    "payConditionRuleSet": "string",
    "payRateTemplate": "string",
    "paySchedule": "string",
    "paySlipNotificationType": "string",
    "postalAddressLine2": "string",
    "postalAddressLine3": "string",
    "postalAddressType": "string",
    "postalBlockNumber": "string",
    "postalCountry": "string",
    "postalLevelNumber": "string",
    "postalPostCode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalStreetName": "string",
    "postalSuburb": "string",
    "postalUnitNumber": "string",
    "preferredName": "string",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "religion": "string",
    "reportingDimensionValues": "string",
    "residentialAddressLine2": "string",
    "residentialAddressLine3": "string",
    "residentialAddressType": "string",
    "residentialBlockNumber": "string",
    "residentialCountry": "string",
    "residentialLevelNumber": "string",
    "residentialPostCode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialStreetName": "string",
    "residentialSuburb": "string",
    "residentialUnitNumber": "string",
    "rosteringNotificationChoices": "string",
    "sdlExempt": "boolean",
    "shgExempt": "boolean",
    "startDate": "date-time",
    "status": "string",
    "surname": "string",
    "tags": "string",
    "terminationReason": "string",
    "tieredLeaveTemplate": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string"
}

Properties

Response

The following HTTP status codes may be returned, optionally with a response resource.