{"id":36239,"date":"2024-08-21T13:59:09","date_gmt":"2024-08-21T12:59:09","guid":{"rendered":"https:\/\/developers.ila.cegid.com\/valuekeep\/\/"},"modified":"2024-12-26T15:21:01","modified_gmt":"2024-12-26T14:21:01","slug":"webapi-creating-an-employee","status":"publish","type":"valuekeep","link":"https:\/\/developers.ila.cegid.com\/en\/valuekeep\/development-en\/workshops-and-employees\/article\/webapi-creating-an-employee","title":{"rendered":"How to create an employee?"},"content":{"rendered":"<section class=\"av_textblock_section \"  itemscope=\"itemscope\" itemtype=\"https:\/\/schema.org\/CreativeWork\" ><div class='avia_textblock  '   itemprop=\"text\" ><p>This method allows to create an employee in a simplified manner.<\/p>\n<div>The method to be used when creating an employee: POST url\/api\/mytenant\/myorganization\/workshopscore\/employees<\/div>\n<div>Json example for creating an employee:<\/div>\n<div>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"json\">{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"externalReferenceID\":\u00a0\"125522\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"isInternalEmployee\":\u00a0true,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"contractStartDate\":\u00a0\"2020-11-09T00:00:00\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"contractEndDate\":\u00a0\"2027-08-08T00:00:00\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"remarks\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"partyKey\":\u00a0\"0002\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"name\":\u00a0\"Jo\u00e3o\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"keyword\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"companyTaxID\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"electronicMail\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"telephone\":\u00a0\"125125125\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"mobile\":\u00a0\"125125125\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"websiteUrl\":\u00a0\"http:\/\/valuekeep.com\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"notes\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"picture\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"pictureThumbnail\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"streetName\":\u00a0\"Rua\u00a0Manuel\u00a0da\u00a0Silva\u00a0\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"buildingNumber\":\u00a0\"145\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"postalZone\":\u00a0\"1478-125\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"cityName\":\u00a0\"\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"contactName\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"contactTitle\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"username\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"employeeExpertises\":\u00a0[\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"expertise\":\u00a0\"AVAC\"\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\u00a0\u00a0\u00a0\u00a0],\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"schedulingGroup\":\u00a0\"TRA\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"currency\":\u00a0\"EUR\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"country\":\u00a0\"PT\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"culture\":\u00a0\"PT-PT\"\r\n\r\n}<\/pre>\n<\/div>\n<p>This method allows to create an employee according to the parameters filled in:<\/p>\n<ul>\n<li>externalreferenceID: External reference ID.<\/li>\n<li>isInternalEmployee: This field is filled in with &#8220;true&#8221; or &#8220;false&#8221; and it specifies if it is an internal employee or not. This field is mandatory.<\/li>\n<li>contractStartDate: Contract start date.<\/li>\n<li>contractEndDate: Contract end date.<\/li>\n<li>remarks: Employee extension remarks.<\/li>\n<li>partyKey: Employee key. Mandatory field.<\/li>\n<li>name: Short description of the employee. This field is mandatory.<\/li>\n<li>keyword: Short description of the employee.<\/li>\n<li>companyTaxID: Tax IDnumber.<\/li>\n<li>electronicMail: Employee email.<\/li>\n<li>telephone: Telephone number.<\/li>\n<li>mobile: Mobile phone number.<\/li>\n<li>websiteUrl: Website.<\/li>\n<li>notes:\u00a0Entity extension remarks.<\/li>\n<li>picture: the image.<\/li>\n<li>streetName:\u00a0Street.<\/li>\n<li>buildingNumber: Building number.<\/li>\n<li>postalZone:\u00a0Postal code.<\/li>\n<li>cityName:\u00a0City.<\/li>\n<li>contactName: Short description of the employee.<\/li>\n<li>username: User name.<\/li>\n<li>employeeExpertises: Expertise key.<\/li>\n<li>schedulingGroup: Scheduling group key. This field is mandatory.<\/li>\n<li>currency: The currency&#8217;s key. This field is mandatory.<\/li>\n<li>country: The country&#8217;s key. This field is mandatory.<\/li>\n<li>culture: The culture&#8217;s key. This field is mandatory.<\/li>\n<\/ul>\n<p>When this method is executed successfully, it returns HttpStatusCode.201Created.<\/p>\n<div><\/div>\n<div><\/div>\n<\/div><\/section>\n","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":0,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","format":"standard","tags":[895],"videos_tax":[],"post-type":[],"categoria-valuekeep":[945],"class_list":["post-36239","valuekeep","type-valuekeep","status-publish","format-standard","hentry","tag-employees","categoria-valuekeep-workshops-and-employees"],"_links":{"self":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36239","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep"}],"about":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/types\/valuekeep"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/comments?post=36239"}],"version-history":[{"count":0,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36239\/revisions"}],"wp:attachment":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/media?parent=36239"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/tags?post=36239"},{"taxonomy":"videos_tax","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/videos_tax?post=36239"},{"taxonomy":"post-type","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/post-type?post=36239"},{"taxonomy":"categoria-valuekeep","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/categoria-valuekeep?post=36239"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}