Employees
BETA
BETA
| Operation | Type | Object | Dto |
|---|---|---|---|
| Mutation | createEmployees |
EmployeesCreateGLDtoInput |
|
| Mutation | updateEmployees |
EmployeesUpdateGLDtoInput |
|
| Query | employeById |
EmployeesGLDto |
|
| Query | employees |
EmployeesGLDto |
Description
Employees management
Header
| Key | Value |
|---|---|
Authorization |
Bearer Current access Token |
X-TenantId |
Current tenant id obtained from userProfile |
X-OrganizationId |
Current organization Id |
x-api-key |
Primary or secondary subscription key of your app |
employees
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| modificationDate |
datetime | Modification date | |
| creationDate |
datetime | Creation date | |
| code |
string | Code employee | 17 |
| name |
string | Employee Name | 70 |
| shortName | string | Short Name | 70 |
| disabled | boolean | Inactive |
|
| disabledDate | datetime | Inactive date | |
| status |
|
Status | |
| defaultAccountingAccountId | UUID | Main account | |
| comments | string | Comments | 2000 |
| gdprApplied | boolean | GDPR action | |
| gdprAppliedDate | datetime | GDPR date action | |
| businessAreaId | UUID | Business areas Id | |
| addresses[] | Array | List of addresses | |
| contacts[] | Array | List of contacts |
Info
- isDisabled : If TRUE the employee can no longer be used, but will remain in the existing information.
employees/addresses
Attention, only one address is authorized, even if the representation is an array of addresses
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | Id | |
| countryId | UUID | Id Country | |
| countryName |
string | CountryName | |
| name | string | Code | 50 |
| firstLine | string | First Line | 35 |
| secondLine | string | Second Line | 35 |
| city | string | Town | 35 |
| zipCode | string | Postal Code | 9 |
| province | string | Province | 25 |
employees/contacts
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | Id | |
| isDefault | boolean | Main contact | |
| jobAreaId | UUID | Job areas Id | |
| jobName | string | Job name | 35 |
| name | string | First name | 35 |
| courtesy |
|
Type | |
| surname | string | Family name | 35 |
| emails[] | Array | List of emails | |
| phones[] | Array | List of phones | |
| socialMedias[] | Array | List Social Networking |
employees/contacts/emails
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | Id | |
| emailAddress | string | Email address | 70 |
| usage |
|
Type | |
| isDefault | boolean | Main mail |
employees/contacts/phones
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | Id | |
| number | string | Phone | 20 |
| type |
|
Type | |
| isDefault | boolean | Main phone |
employees/contacts/socialMedias
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | UUID | |
| name | string | Name | 30 |
| link | string | Link | 100 |