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
Method | Return Type | Description |
---|---|---|
GET employee | employee | Gets a employee object. |
DELETE employee | none | Deletes a employee object. |
POST employee | employee | Creates a employee object. |
PATCH employee | employee | Updates a employee object. |
Navigation
Navigation | Return Type | Description |
---|---|---|
picture | picture | Gets the picture of the employee. |
defaultDimensions | defaultDimensions | Gets the defaultdimensions of the employee. |
timeRegistrationEntries | timeRegistrationEntries | Gets the timeregistrationentries of the employee. |
documentAttachments | documentAttachments | Gets the documentattachments of the employee. |
Properties
Property | Type | Description |
---|---|---|
id | GUID | The unique ID of the employee. Non-editable. |
number | string | Specifies the number of the employee. |
displayName | string | Specifies the employee's name. This name will appear on all sales documents for the employee. |
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 job title of the employee. |
addressLine1 | string | Specifies the employee's address. This address will appear on all sales documents for the employee. |
addressLine2 | string | Specifies the employee's address. This address will appear on all sales documents for the employee. |
city | string | Specifies the employee's city. |
state | string | Specifies the employee's state. |
country | string | Specifies the employee's country. |
postalCode | string | Specifies the employee's postal code. |
phoneNumber | string | Specifies the employee's telephone number. |
mobilePhone | string | Specifies the employee's mobile telephone number. |
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 | NAV.employeeStatus | Specifies the status of the employee. It can be "Active", "Inactive" or "Terminated". |
birthDate | date | Specifies the employee's date of birth. |
statisticsGroupCode | string | The employee's statistics group code. |
lastModifiedDateTime | datetime | The last datetime the employee was modified. Read-Only. |
JSON representation
Here is 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",
"lastModifiedDateTime": "datetime"
}