Valuekeep DevelopmentWorkshops and Employees
DevelopmentWorkshops and Employees
Workshops and Employees
Back | List of Articles

How to create an employee?

Last changed in 26/12/2024

This method allows to create an employee in a simplified manner.

The method to be used when creating an employee: POST url/api/mytenant/myorganization/workshopscore/employees
Json example for creating an employee:
{

    "externalReferenceID": "125522",

    "isInternalEmployee": true,

    "contractStartDate": "2020-11-09T00:00:00",

    "contractEndDate": "2027-08-08T00:00:00",

    "remarks": null,

    "partyKey": "0002",

    "name": "João",

    "keyword": null,

    "companyTaxID": null,

    "electronicMail": null,

    "telephone": "125125125",

    "mobile": "125125125",

    "websiteUrl": "http://valuekeep.com",

    "notes": null,

    "picture": null,

    "pictureThumbnail": null,

    "streetName": "Rua Manuel da Silva ",

    "buildingNumber": "145",

    "postalZone": "1478-125",

    "cityName": "",

    "contactName": null,

    "contactTitle": null,

    "username": null,

    "employeeExpertises": [

        {

            "expertise": "AVAC"

        }

    ],

    "schedulingGroup": "TRA",

    "currency": "EUR",

    "country": "PT",

    "culture": "PT-PT"

}

This method allows to create an employee according to the parameters filled in:

  • externalreferenceID: External reference ID.
  • isInternalEmployee: This field is filled in with "true" or "false" and it specifies if it is an internal employee or not. This field is mandatory.
  • contractStartDate: Contract start date.
  • contractEndDate: Contract end date.
  • remarks: Employee extension remarks.
  • partyKey: Employee key. Mandatory field.
  • name: Short description of the employee. This field is mandatory.
  • keyword: Short description of the employee.
  • companyTaxID: Tax IDnumber.
  • electronicMail: Employee email.
  • telephone: Telephone number.
  • mobile: Mobile phone number.
  • websiteUrl: Website.
  • notes: Entity extension remarks.
  • picture: the image.
  • streetName: Street.
  • buildingNumber: Building number.
  • postalZone: Postal code.
  • cityName: City.
  • contactName: Short description of the employee.
  • username: User name.
  • employeeExpertises: Expertise key.
  • schedulingGroup: Scheduling group key. This field is mandatory.
  • currency: The currency's key. This field is mandatory.
  • country: The country's key. This field is mandatory.
  • culture: The culture's key. This field is mandatory.

When this method is executed successfully, it returns HttpStatusCode.201Created.

Bookmark or share this article
Esta página foi útil?
Obrigado pelo seu voto.
Related Articles
How to create a supplier? How to create a customer? How to create a supplier? How to create a customer? How to create an employee?