Employee

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	Mutation Why 200?	`createEmployee`	`EmployeeCreateGLDtoInput`
POST	Update	Mutation Why 200?	`updateEmployee` How to update?	`EmployeeUpdateGLDtoInput`
POST	Delete	Mutation Why 200?	`deleteEmployee`	`EmployeeDeleteGLDtoInput`
POST	Read	Query	`employees filtered by id` Why?
POST	List	Query	`employees`

Description

Employee management.

Allows the identification of a third-party Employee within an organization.
It offers the option to add contacts within the Employee and their details.

Every Employee must have a code, which, depending on the organization’s settings, can be manually entered or automatically generated.

Warning

Depending on the Sage Active solution configuration, creating, updating, or deleting employees may not be allowed.

For example, in the German legislation, employee management is not available.
In other legislations, when connected to a payroll solution, employees may only be available in read-only mode, replicated from the payroll system into Sage Active.
The userAccessPolicyCheck operation can be used to verify whether createEmployee, updateEmployee, and deleteEmployee operations are allowed (response=true) or denied (response=false).

Explore Efficient Record Updates: For comprehensive insights into making precise modifications to records, check out our dedicated page on updates : Key concepts / Updating records

Would you like to see an example of how to add an employee?

graphQL Mutation

mutation ($values: EmployeeCreateGLDtoInput!) {  
  createEmployee(input: $values) {
    id
    code
  }
}

graphQL Variables

{
  "values":{
    "name": "Léon DURANT",
    "shortName": "LEDU",
    "comments":"Employee of the year",
      "addresses": [{
       "firstLine": "123 Generic street",
        "city": "Generic City",
        "zipCode": "12345",
        "countryIsoCodeAlpha2":"FR"
      }]
  }
}

Example of Response

{
    "data": {
        "createEmployee": {
            "id": "e614a276-7de0-4fd2-a10c-e8c29732b530",
            "code": "2"
        }
    }
}

Key	Value
`Authorization`	Bearer Current access Token How to find?
~~`X-TenantId`~~ DeprThis field is now deprecated, and we recommend using an alternative solution	Current tenant id Why deprecated ?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

employees

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDate SSystem field that cannot be assigned	DateTime	Creation Date
modificationDate SSystem field that cannot be assigned	DateTime	Modification Date
sourceType SSystem field that cannot be assigned	GLOBAL IMPORT_FILES PUBLIC_API	indicates the origin of the employee

code NThe value of this field cannot be modified after the record is created	String	Code employee See InfoAdditional information is available in the Info block below	17
name *The value of the field or object is mandatory	String	Employee Name	70
shortName	String	Short Name	70
disabled DIn creation, this field can have a default value automatically calculated	Boolean	Inactive See InfoAdditional information is available in the Info block below
disabledDate DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	DateTime	Inactive date
status RThis field is read-only, its value cannot be assigned	NONE DISABLED ENABLED GDPR_APPLIED	Status
defaultAccountingAccount DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	AccountingAccount	Fields of AccountingAccount
defaultAccountingAccountId	UUID	Ledger General account See InfoAdditional information is available in the Info block below
comments	String	Comments	2000
gdprApplied DIn creation, this field can have a default value automatically calculated	Boolean	GDPR action
gdprAppliedDate DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	DateTime	GDPR date action
businessArea DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	BusinessArea	Fields of BusinessArea
businessAreaId	UUID	Business areas Id
addresses[]	Array	List of addresses
contacts[]	Array	List of contacts

Info

defaultAccountingAccountId : Id of the general account in accountingAccount associated with the employee.
The subAccountType of the account must be EMPLOYEE.
disabled : If TRUE the employee can no longer be used, but will remain in the existing information.

code : Code of the employee.
During creation, it is automatically calculated if the option is active in Sequence Numbers, otherwise it is a mandatory value.
In any cases, it is still possible to assign it to enforce a specific value.
Forcing a value allows you to retrieve an alphanumeric code that can already identify the Employee, even if automatic numbering mode is active.

Forcing a value allows you to retrieve an alphanumeric code that can already identify the Employee, even if automatic numbering mode is active.
- If you force a value, it must be strictly numeric and adhere to the rule of a number being between 10000 and 69999 for customers, and between 70000 and 99999 for suppliers or employees.
Forcing a value allows you to retrieve an alphanumeric code that can already identify the Employee, even if automatic numbering mode is active.

employees/addresses

Attention, only one address is authorized, even if the representation is an array of addresses

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

countryId	UUID	Country Id
country DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Country	Fields of Country
countryIsoCodeAlpha2	String	Country Code See InfoAdditional information is available in the Info block below	2
countryNameRThis field is read-only, its value cannot be assigned	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 / Region / Federal State	25
isMainAddress RThis field is read-only, its value cannot be assigned	Boolean	Is the main address

Info

countryIsoCodeAlpha2 : ISO2 country code.
This field can be used for creation and serves as a simple alternative to assign the country of the address by using the ISO2 code directly, rather than the country ID in the Countries resource.

employees/contacts

Common to customers, suppliers, employees

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

isDefault	Boolean	Main contact (not filterable or sortable)
courtesy	NONE BLANK MISS MR	Courtesy
name	String	First name (John)	35
surname	String	Family name (Smith)	35
jobName	String	Job name	35
jobArea DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	JobArea	Fields of JobArea
jobAreaId	UUID	Job areas Id
emails[]	Array	List of emails
phones[]	Array	List of phones
socialMedias[]	Array	List Social Networking

employees/contacts/emails

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

emailAddress	String	Email address	70
usage	EMPTY INVOICES NOT_SET OTHERS PAYMENTS	Type
isDefault	Boolean	Main mail

employees/contacts/phones

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

number	String	Phone	20
type	EMPTY FAX LANDLINE MOBILE NOT_SET SKYPE WHATS_APP	Type
isDefault	Boolean	Main phone

employees/contacts/socialMedias

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	UUID
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

name	String	Name	30
link	String	Link	100

Quick Links

Description

Warning

Would you like to see an example of how to add an employee?

graphQL Mutation

graphQL Variables

Example of Response

Header

employees

Info

employees/addresses

Info

employees/contacts

employees/contacts/emails

employees/contacts/phones

employees/contacts/socialMedias