Create Employing Entity

Creates a new employing entity for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "blockNumber": "string",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "countryId": "string",
    "externalReferenceId": "string",
    "id": "int32",
    "isInternationalAddress": "boolean",
    "levelNumber": "string",
    "name": "string",
    "paySlipFromEmailAddress": "string",
    "postcode": "string",
    "signatoryName": "string",
    "uen": "string",
    "unitNumber": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
addressLine3 string String
blockNumber string String
contactEmailAddress string String
contactFaxNumber string String
contactName string String
contactPhoneNumber string String
countryId string String
externalReferenceId string String
id int32 Int32
isInternationalAddress boolean Boolean
levelNumber string String
name string String
paySlipFromEmailAddress string String
postcode string String
signatoryName string String
uen string String
unitNumber string String

Response

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

Status code Description Resource
200 OK

OK

 SgEmployingEntityModel