employee resource type

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 employeeemployeeGets an employee object.
DELETE employeenoneDeletes an employee object.
POST employeeemployeeCreates an employee object.
PATCH employeeemployeeUpdates an employee object.
NavigationReturn TypeDescription
picturepictureGets the picture of the employee.
defaultDimensionsdefaultDimensionsGets the defaultdimensions of the employee.
timeRegistrationEntriestimeRegistrationEntriesGets the timeregistrationentries of the employee.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the employee.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the employee. Non-editable.
numberstringSpecifies the number of the employee.
displayNamestringSpecifies the employee's name. This name will appear on all sales documents for the employee.
givenNamestringThe given name of the employee.
middleNamestringThe middle name of the employee.
surnamestringThe surname of the employee.
jobTitlestringThe job title of the employee.
addressLine1stringSpecifies the employee's address. This address will appear on all sales documents for the employee.
addressLine2stringSpecifies the employee's address. This address will appear on all sales documents for the employee.
citystringSpecifies the employee's city.
statestringSpecifies the employee's state.
countrystringSpecifies the employee's country.
postalCodestringSpecifies the employee's postal code.
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.
statusNAV.employeeStatusSpecifies the status of the employee. It can be "Active", "Inactive" or "Terminated".
birthDatedateSpecifies the employee's date of birth.
statisticsGroupCodestringThe employee's statistics group code.
bankBranchNumberstring
bankAccountNumberstring
ibanstring
lastModifiedDateTimedatetimeThe last datetime the employee was modified. Read-Only.

JSON representation

Here's a JSON representation of the employee resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "jobTitle": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "mobilePhone": "string",
    "email": "string",
    "personalEmail": "string",
    "employmentDate": "date",
    "terminationDate": "date",
    "status": "NAV.employeeStatus",
    "birthDate": "date",
    "statisticsGroupCode": "string",
    "bankBranchNumber": "string",
    "bankAccountNumber": "string",
    "iban": "string",
    "lastModifiedDateTime": "datetime"
}

GET employee
DELETE employee
POST employee
PATCH employee