Edit

Share via

Create employees

  • Article

Create an employee object in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/employees

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply a JSON representation of an employees object.

Response

If successful, this method returns 201 Created response code and an employees object in the response body.

Example

Request

Here is an example of a request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/employees
Content-type: application/json

{
  "id": "258bb9c0-44e3-ea11-bb43-000d3a2feca1",
  "number": "AH",
  "givenName": "Annette",
  "middleName": "",
  "surname": "Hill",
  "jobTitle": "Secretary",
  "addressLine1": "677 Fifth Avenue",
  "addressLine2": "",
  "city": "",
  "state": "",
  "country": "",
  "postalCode": "",
  "phoneNumber": "4465-4899-4643",
  "mobilePhone": "4564-4564-7831",
  "email": "",
  "personalEmail": "ah@contoso.com",
  "employmentDate": "2001-06-01",
  "terminationDate": "0001-01-01",
  "status": "Active",
  "birthDate": "1973-12-12",
  "statisticsGroupCode": ""
}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "258bb9c0-44e3-ea11-bb43-000d3a2feca1",
  "number": "AH",
  "displayName": "Annette Hill",
  "givenName": "Annette",
  "middleName": "",
  "surname": "Hill",
  "jobTitle": "Secretary",
  "addressLine1": "677 Fifth Avenue",
  "addressLine2": "",
  "city": "",
  "state": "",
  "country": "",
  "postalCode": "",
  "phoneNumber": "4465-4899-4643",
  "mobilePhone": "4564-4564-7831",
  "email": "",
  "personalEmail": "ah@contoso.com",
  "employmentDate": "2001-06-01",
  "terminationDate": "0001-01-01",
  "status": "Active",
  "birthDate": "1973-12-12",
  "statisticsGroupCode": "",
  "lastModifiedDateTime": "2017-03-16T14:57:19.497Z" 
}

Tips for working with the APIs
employee
Get employee
Delete employee
Update employee