Allows you to create new employees used in Xero payrun
PUT {{baseUrl}}/Employees?summarizeErrors=false
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
summarizeErrors | boolean | If false return 200 OK and mix of successfully created objects and any with validation errors |
Request Body
{"Employees"=>[{"EmployeeID"=>"<uuid>", "Status"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "ExternalLink"=>{"LinkType"=>"<string>", "Url"=>"<string>", "Description"=>"<string>"}, "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, {"EmployeeID"=>"<uuid>", "Status"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "ExternalLink"=>{"LinkType"=>"<string>", "Url"=>"<string>", "Description"=>"<string>"}, "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
xero-tenant-id | string | (Required) Xero identifier for Tenant | |
Content-Type | string |
RESPONSES
status: OK
{"Id":"0d6a08e7-6936-4828-a1bc-e4595e0ef778","Status":"OK","ProviderName":"Provider Name Example","DateTimeUTC":"/Date(1552324736508)/","Employees":[{"EmployeeID":"e1ada26b-a10e-4065-a941-af34b53740e3","Status":"ACTIVE","FirstName":"Nick","LastName":"Fury","ExternalLink":{"Url":"http://twitter.com/#!/search/Nick+Fury","Description":"Go to external link"},"UpdatedDateUTC":"/Date(1552324736463+0000)/"}]}