Edit

Share via

employees resource type (v1.0)

  • Article

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

Method Return Type Description
GET employees employees Get an employee object.
POST employees employees Create an employee object.
PATCH employees employees Update an employee object.
DELETE employees none Delete an employee object.

Subpages

Method Return Type Description
GET employee defaultDimensions default dimensions Gets the default dimensions of employee.
POST employee defaultDimensions default dimensions Creates the default dimensions of employee.
PATCH employee defaultDimensions default dimensions Updates the default dimensions of employee.
DELETE employee defaultDimensions default dimensions Deletes the default dimensions of employee.

Properties

Property Type Description
id GUID The employee ID. Non-editable.
number string The employee number. Read-Only.
displayName string The employee givenName + surname. Read-Only.
givenName string The given name of the employee.
middleName string The middle name of the employee.
surname string The surname of the employee
jobTitle string The full name of the employee
address NAV.PostalAddress Specifies the employee's address. This address will appear on all resource documents for the employee.
phoneNumber string Specifies the employee's telephone number.
mobilePhone string Specifies the employee's mobile telephone number.
email string Specifies the employee's email address.
personalEmail string Specifies the employee's personal email address.
employmentDate date Specifies the date when the employee began to work for the company.
terminationDate date Specifies the date when the employee was terminated, due to retirement or dismissal, for example.
status string Specifies the employee's status. Possible values are Active, Inactive or Terminated
birthDate date Specifies the employee's date of birth.
picture stream The employee picture. Read-Only.
lastModifiedDateTime datetime The 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