POST api/CpyEmployee/Post?companyId={companyId}

Create or update an employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

The code of the company

string

Required

Body Parameters

CpyEmployee
NameDescriptionTypeAdditional information
PEmployeeID

Code d’employé

string

Required

Max length: 15

Min length: 1

PEmployeeClass

Code de classe à laquelle appartient cet employé

string

Max length: 15

PInactive

Inactif, si inactif, les champs « Date de désactivation » et « Motif » deviendront disponibles

byte

None.

PLastName

Nom de l’employé

string

Max length: 20

PFirstName

Prénom de l’employé

string

Max length: 15

PMiddleName

Deuxième prénom de l’employé s’il y a lieu

string

Max length: 15

PAddress1

Adresse ligne 1

string

Max length: 60

PAddress2

Adresse ligne 2

string

Max length: 60

PCity

Ville

string

Max length: 35

PProvince

Province

string

Max length: 5

PCountry

Pays

string

Max length: 60

PPostalCode

Code postal

string

Max length: 10

PPhoneNumber

Téléphone

string

Matching regular expression pattern: \d{0,14}

Max length: 14

PSocialInsuranceNumber

Numéro sécurité sociale

string

Matching regular expression pattern: \d{9}

PBirthDate

Date de naissance

date

None.

PGender

Sexe: 1:Not reported; 2:Male; 3:Female

integer

Range: inclusive between 1 and 3

PDepartment

Service (département) de l’employé

string

Max length: 6

PJobTitle

Poste de l’employé

string

Max length: 6

PStartDate

Date de début

date

None.

PDateEmployeeInactivated

Si l’employé est mis inactif, date de mise en inactivité

date

None.

PReasonInactivated

Si l’employé est mis inactif, raison du départ de l’employé

string

Max length: 30

PTaxableProvince

Province d’imposition de l’employé

string

Max length: 3

PUserDefined1

Champ défini 1 (champs additionnels dans les paramètres de contrôle de la paie)

string

Max length: 20

PUserDefined2

Champ défini 2 (champs additionnels dans les paramètres de contrôle de la paie)

string

Max length: 20

PVacationPayPercent

Pourcentage de paie de vacances

integer

None.

PPaymentMethod

Mode de paiement, Façon que la paie sera versée à l'employé

integer

Range: inclusive between 1 and 3

PSupervisor

Code de l'employé du supérieur immédiat de l'employé

string

Max length: 15

jobfiscaltype

183030000:Employee; 183030001:Self-employed person; 183030002:Non-resident; 183030003:Corporation; 183030004:Self-employed person (T4A) with taxes

integer

Range: inclusive between 183030000 and 183030004

PEmployeeTemplateId

Code de l'employé 'modèle', sert aux valeurs par défaut lors de la création

string

Max length: 15

CompanyTemplateId

Companie GP de l'employé 'modèle', sert aux valeurs par défaut lors de la création

string

Max length: 5

Request Formats

application/json, text/json

Sample:
{
  "PEmployeeID": "sample string 1",
  "PEmployeeClass": "sample string 2",
  "PInactive": 64,
  "PLastName": "sample string 3",
  "PFirstName": "sample string 4",
  "PMiddleName": "sample string 5",
  "PAddress1": "sample string 6",
  "PAddress2": "sample string 7",
  "PCity": "sample string 8",
  "PProvince": "sample string 9",
  "PCountry": "sample string 10",
  "PPostalCode": "sample string 11",
  "PPhoneNumber": "sample string 12",
  "PSocialInsuranceNumber": "sample string 13",
  "PBirthDate": "2025-12-11T10:29:53.193832-05:00",
  "PGender": 1,
  "PDepartment": "sample string 14",
  "PJobTitle": "sample string 15",
  "PStartDate": "2025-12-11T10:29:53.193832-05:00",
  "PDateEmployeeInactivated": "2025-12-11T10:29:53.193832-05:00",
  "PReasonInactivated": "sample string 16",
  "PTaxableProvince": "sample string 17",
  "PUserDefined1": "sample string 18",
  "PUserDefined2": "sample string 19",
  "PVacationPayPercent": 1,
  "PPaymentMethod": 1,
  "PSupervisor": "sample string 20",
  "jobfiscaltype": 1,
  "PEmployeeTemplateId": "sample string 21",
  "CompanyTemplateId": "sample string 22"
}

application/xml, text/xml

Sample:
<CpyEmployee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Jovaco.WebServices.Web.Models">
  <CompanyTemplateId>sample string 22</CompanyTemplateId>
  <PAddress1>sample string 6</PAddress1>
  <PAddress2>sample string 7</PAddress2>
  <PBirthDate>2025-12-11T10:29:53.193832-05:00</PBirthDate>
  <PCity>sample string 8</PCity>
  <PCountry>sample string 10</PCountry>
  <PDateEmployeeInactivated>2025-12-11T10:29:53.193832-05:00</PDateEmployeeInactivated>
  <PDepartment>sample string 14</PDepartment>
  <PEmployeeClass>sample string 2</PEmployeeClass>
  <PEmployeeID>sample string 1</PEmployeeID>
  <PEmployeeTemplateId>sample string 21</PEmployeeTemplateId>
  <PFirstName>sample string 4</PFirstName>
  <PGender>1</PGender>
  <PInactive>64</PInactive>
  <PJobTitle>sample string 15</PJobTitle>
  <PLastName>sample string 3</PLastName>
  <PMiddleName>sample string 5</PMiddleName>
  <PPaymentMethod>1</PPaymentMethod>
  <PPhoneNumber>sample string 12</PPhoneNumber>
  <PPostalCode>sample string 11</PPostalCode>
  <PProvince>sample string 9</PProvince>
  <PReasonInactivated>sample string 16</PReasonInactivated>
  <PSocialInsuranceNumber>sample string 13</PSocialInsuranceNumber>
  <PStartDate>2025-12-11T10:29:53.193832-05:00</PStartDate>
  <PSupervisor>sample string 20</PSupervisor>
  <PTaxableProvince>sample string 17</PTaxableProvince>
  <PUserDefined1>sample string 18</PUserDefined1>
  <PUserDefined2>sample string 19</PUserDefined2>
  <PVacationPayPercent>1</PVacationPayPercent>
  <jobfiscaltype>1</jobfiscaltype>
</CpyEmployee>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.