employees resource type (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents an employee in Business Central.

Note


For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET employeesemployeesGet an employee object.
POST employeesemployeesCreate an employee object.
PATCH employeesemployeesUpdate an employee object.
DELETE employeesnoneDelete an employee object.

Subpages

MethodReturn TypeDescription
GET employee defaultDimensionsdefault dimensionsGets the default dimensions of employee.
POST employee defaultDimensionsdefault dimensionsCreates the default dimensions of employee.
PATCH employee defaultDimensionsdefault dimensionsUpdates the default dimensions of employee.
DELETE employee defaultDimensionsdefault dimensionsDeletes the default dimensions of employee.

Properties

PropertyTypeDescription
idGUIDThe employee ID. Non-editable.
numberstringThe employee number. Read-Only.
displayNamestringThe employee givenName + surname. Read-Only.
givenNamestringThe given name of the employee.
middleNamestringThe middle name of the employee.
surnamestringThe surname of the employee
jobTitlestringThe full name of the employee
addressNAV.PostalAddressSpecifies the employee's address. This address will appear on all resource documents for the employee.
phoneNumberstringSpecifies the employee's telephone number.
mobilePhonestringSpecifies the employee's mobile telephone number.
emailstringSpecifies the employee's email address.
personalEmailstringSpecifies the employee's personal email address.
employmentDatedateSpecifies the date when the employee began to work for the company.
terminationDatedateSpecifies the date when the employee was terminated, due to retirement or dismissal, for example.
statusstringSpecifies the employee's status. Possible values are Active, Inactive or Terminated
birthDatedateSpecifies the employee's date of birth.
picturestreamThe employee picture. Read-Only.
lastModifiedDateTimedatetimeThe last datetime the employee was modified. Read-Only.

Relationships

None

JSON representation

Here is a JSON representation of the resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "jobTitle": "string",
    "address": "NAV.PostalAddress",
    "phoneNumber": "string",
    "mobilePhone": "string",
    "email": "string",
    "personalEmail": "string",
    "employmentDate": "date",
    "terminationDate": "date",
    "status": "string",
    "birthDate": "date",
    "picture": "stream",
    "lastModifiedDateTime": "datetime"
}

Error Codes
Get Employee
Post Employee
Patch Employee
Delete Employee