Openpaye API (v1_1)

Download OpenAPI specification:Download

Absences

Obtenir une abcence

Request

path Parameters

id

required

integer <int32>

Le id de l'abcence

Responses

200

OK

404

NotFound

500

InternalServerError

get/Abcenses/{id}

Récupère la liste des absences dans une plage de dates

Request

query Parameters

contratId required	integer <int32> Le id du contrat
anneeDebut required	integer <int32> Année de début (ex: 2023)
moisDebut required	integer <int32> Mois de début (1 - 12)
anneeFin required	integer <int32> Année de fin (ex: 2023)
moisFin required	integer <int32> Mois de fin (1 - 12)

Responses

200

OK

400

BadRequest

500

InternalServerError

get/Abcenses/periode

Modifier une abcence

Request

Request Body schema:
application/json
required

L'abcence à modifier

id	integer <int32> Le id de l'abcense supplémentaire., ignoré dans la méthode POST
code	string Le code de l'abcense supplémentaire.
date_debut	string <date-time> La date de début de l'abcense.
date_fin	string <date-time> La date de fin de l'abcense.
nbr_heure_by_user	number <double> Le Nombre d'heures
nbr_jour_by_user	number <double> Le Nombre de jours
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/Abcenses

Request samples

Payload

{"id": 0,
"code": "string",
"date_debut": "2019-08-24T14:15:22Z",
"date_fin": "2019-08-24T14:15:22Z",
"nbr_heure_by_user": 0,
"nbr_jour_by_user": 0,
"mois": 1,
"annee": "string"
}

Ajouter une abcence

Request

query Parameters

contratId

required

integer <int32>

Le id du contrat de l'abcence

Request Body schema:
application/json
required

L'abcence à ajouter

id	integer <int32> Le id de l'abcense supplémentaire., ignoré dans la méthode POST
code	string Le code de l'abcense supplémentaire.
date_debut	string <date-time> La date de début de l'abcense.
date_fin	string <date-time> La date de fin de l'abcense.
nbr_heure_by_user	number <double> Le Nombre d'heures
nbr_jour_by_user	number <double> Le Nombre de jours
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/Abcenses

Request samples

Payload

{"id": 0,
"code": "string",
"date_debut": "2019-08-24T14:15:22Z",
"date_fin": "2019-08-24T14:15:22Z",
"nbr_heure_by_user": 0,
"nbr_jour_by_user": 0,
"mois": 1,
"annee": "string"
}

Response samples

200

{ }

BulletinsPaies

Obtenir un bulletin de paie

Request

query Parameters

codeDossier required	string Le code du dossier
matricule required	string Le matricule du salarié
numeroContrat required	string Le numéro de contrat du salarié
moisDebut required	integer <int32> Le mois de début
moisFin required	integer <int32> Le mois de fin
anneeDebut required	integer <int32> L'année de début
anneeFin required	integer <int32> L'année de fin
inclureDocumentDeSortie	boolean Inclure document de sortie

Responses

200

OK

404

NotFound

500

InternalServerError

get/bulletinspaies

Obtenir les détails d'une ligne de bulletin de paie en fonction du mois, de l'année, du contrat et du code.

Request

query Parameters

contratid required	integer <int32> Identifiant du contrat
annee required	integer <int32> Année du bulletin (ex: 2024)
mois required	integer <int32> Mois du bulletin (1=Janvier, etc.)
variableARecuperer required	string code de la ligne

Responses

200

Retourne la ligne/valeur demandé

404

NotFound

500

InternalServerError

get/bulletinspaies/BulletinDetail

Response samples

200

{"id": 0,
"code": "string",
"libellé": "string",
"salaire_base": 0,
"base_s": 0,
"base_p": 0,
"taux_s": 0,
"taux_p": 0,
"montant_pr": 0,
"montant_cs": 0,
"montant_cp": 0
}

Liste les bulletins pour un dossier donné, sur un mois et une année.

Request

query Parameters

codeDossier required	string Code du dossier
annee required	integer <int32> Année
mois required	integer <int32> Mois (1..12)
page	integer <int32> Numéro de page (défaut=1)

Responses

200

OK

get/bulletinspaies/listebulletinspaies

Response samples

200

{ }

CaisseCotisationsApi

Obtenir une caisse de cotisations par son ID.

Request

path Parameters

id

required

integer <int32>

ID de la caisse.

Responses

200

OK

get/CaisseCotisations/{id}

Response samples

200

{ }

Créer une nouvelle caisse de cotisations.

Request

Request Body schema:
application/json
required

Données de la caisse à créer.

id	integer <int32> L'identifiant unique de la caisse de cotisations, ignoré dans la méthode POST
nom_caisse	string Le Nom de la caisse
code_dsn	string Le Code de la caisse
adresse_caisse	string L'Adresse de la caisse
etablissement_id	integer <int32> L'ID de l'établissement associé.
type_cotisation required	string Le type de cotisation.
exclus_de_calcul_dsn	boolean Indique si la caisse est exclue du calcul DSN.
numero_affiliation	string [ 0 .. 20 ] characters Le numéro d'affiliation.
type_paiement	string Le type de paiement.
periodicite_paiement	string La périodicité de paiement.
date_paiement	string La date de paiement.
iban	string Le code IBAN.
bic	string [ 8 .. 11 ] characters ^([A-Z]{6}[A-Z2-9][A-NP-Z1-9])(X{3}\|[A-WY-Z0-... Le code BIC.

Responses

200

OK

post/CaisseCotisations

Request samples

Payload

{"id": 0,
"nom_caisse": "string",
"code_dsn": "string",
"adresse_caisse": "string",
"etablissement_id": 0,
"type_cotisation": "string",
"exclus_de_calcul_dsn": true,
"numero_affiliation": "string",
"type_paiement": "string",
"periodicite_paiement": "string",
"date_paiement": "string",
"iban": "string",
"bic": "stringst"
}

Response samples

200

{ }

Contrats

Obtenir tous les contrats

Request

query Parameters

dossierId	integer <int32> Le id du dossier
page	integer <int32> Le numéro de la page

Responses

200

OK

404

NotFound

500

InternalServerError

get/contrats

Modifier un contrat

Request

Request Body schema:
application/json
required

Le contrat à modifier

id	integer <int32> Le id du contrat, ignoré dans la méthode POST
code_etablissement required	string Le code de l'établissement
matricule_salarie required	string Le matricule du salarié
numero_contrat required	string Le numéro de contrat
ancien_numero_contrat_dsn	string L'ancien numéro de contrat
emploi_conventionnel	integer <int32> Le code de l'emploi conventionnel, voir la liste des codes Emplois Conventionnels
ccn	integer <int32> Le code de la convention collective, voir la liste des codes CCN
idcc	integer <int32> Le code de la convention collective, voir la liste des codes IDCC
emploi	string La nature de l'emploi
type_contrat_travail required	integer <int32> Le code type de contrat de travail, voir la liste des codes Types de Contrats de Tavail
type_contrat_temps_partiel	integer <int32> Le code type de contrat à temps partiel, voir la liste des codes Types de Contrats à Temps Partiel
statut_professionnel required	integer <int32> Le code statut professionnel, voir la liste des code Statuts Professionnel
regime_retraite	integer <int32> Le code régime de retraite, voir la liste des code Régime de Retraite
cas_particuliers	integer <int32> Le code cas particuliers, voir la liste des code Cas Particuliers
salaire_mensuel	number <double> Le salaire mensuel
date_anciennete	string La date d'anciennete, format: jj/MM/aaaa
date_fin_previsionnelle_contrat	string Date de fin prévisionnelle du contrat, format: jj/MM/aaaa
date_debut_contrat	string Date de début de contrat, format: jj/MM/aaaa
nbr_heures_travail_mensuel_majorees	number <double> Le nombre d’heures de travail mensuelles majorées
salaire_horaire	number <double> le salaire horaire
salarie_temps_partiel	boolean Si salarié à temps partiel
forfait_jour	boolean Si forfait jour
	object (JoursHebdomadaires)
	object (Horaires)
	object (DepartSalarieDto)
type_salaire	stringMensuel\|Horaire Le mode du salaire: Mensuel ou Horaire
ne_pas_calculer_premier_bulletin	boolean Mettez true pour ne pas calculer le premier bulletin
	object (MoisAExclure)
nbr_jour_annuels_prevus	number <double> Le nombre Jours Annuels Prévus Au Contrat
tags	string Les tags, spératé par un ","

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/contrats

Request samples

Payload

{"id": 0,
"code_etablissement": "string",
"matricule_salarie": "string",
"numero_contrat": "string",
"ancien_numero_contrat_dsn": "string",
"emploi_conventionnel": 0,
"ccn": 0,
"idcc": 0,
"emploi": "string",
"type_contrat_travail": 0,
"type_contrat_temps_partiel": 0,
"statut_professionnel": 0,
"regime_retraite": 0,
"cas_particuliers": 0,
"salaire_mensuel": 0,
"date_anciennete": "string",
"date_fin_previsionnelle_contrat": "string",
"date_debut_contrat": "string",
"nbr_heures_travail_mensuel_majorees": 0,
"salaire_horaire": 0,
"salarie_temps_partiel": true,
"forfait_jour": true,
"jours_hebdomadaires": {"jours_hebdo": 0,
"jour_lundi": 0,
"jour_mardi": 0,
"jour_mercredi": 0,
"jour_jeudi": 0,
"jour_vendredi": 0,
"jour_samedi": 0,
"jour_dimanche": 0
},
"horaires": {"horaire_travail": 0,
"horaire_hebdo": 0,
"horaire_lundi": 0,
"horaire_mardi": 0,
"horaire_mercredi": 0,
"horaire_jeudi": 0,
"horaire_vendredi": 0,
"horaire_samedi": 0,
"horaire_dimanche": 0
},
"depart_salarie": {"date_sortie": "string",
"bulletin_post_contrat": true,
"bulletin_post_contrat_du": "string",
"bulletin_post_contrat_au": "string",
"motif_sortie": 0,
"date_notification_rupture": "string",
"date_notification_signature": "string",
"date_engagement_procedure": "string",
"maitien_affiliation_salarie": true,
"transaction_en_cours": true,
"dernier_jour_travaille_et_payer": "string",
"statut_particulier_salarie": 0,
"type_realisation_paiement_preavis01": 0,
"preavis_de01": "string",
"preavis_au01": "string",
"type_realisation_paiement_preavis02": 0,
"preavis_de02": "string",
"preavis_au02": "string",
"type_realisation_paiement_preavis03": 0,
"preavis_de03": "string",
"preavis_au03": "string"
},
"type_salaire": "string",
"ne_pas_calculer_premier_bulletin": true,
"mois_a_exclure": {"exclure_janvier": true,
"exclure_fevrier": true,
"exclure_mars": true,
"exclure_avril": true,
"exclure_mai": true,
"exclure_juin": true,
"exclure_juillet": true,
"exclure_aout": true,
"exclure_septembre": true,
"exclure_octobre": true,
"exclure_novembre": true,
"exclure_decembre": true
},
"nbr_jour_annuels_prevus": 0,
"tags": "string"
}

Ajouter un contrat

Request

query Parameters

dossierId

required

integer <int32>

Le id du dossier

Request Body schema:
application/json
required

Le contrat à ajouter

id	integer <int32> Le id du contrat, ignoré dans la méthode POST
code_etablissement required	string Le code de l'établissement
matricule_salarie required	string Le matricule du salarié
numero_contrat required	string Le numéro de contrat
ancien_numero_contrat_dsn	string L'ancien numéro de contrat
emploi_conventionnel	integer <int32> Le code de l'emploi conventionnel, voir la liste des codes Emplois Conventionnels
ccn	integer <int32> Le code de la convention collective, voir la liste des codes CCN
idcc	integer <int32> Le code de la convention collective, voir la liste des codes IDCC
emploi	string La nature de l'emploi
type_contrat_travail required	integer <int32> Le code type de contrat de travail, voir la liste des codes Types de Contrats de Tavail
type_contrat_temps_partiel	integer <int32> Le code type de contrat à temps partiel, voir la liste des codes Types de Contrats à Temps Partiel
statut_professionnel required	integer <int32> Le code statut professionnel, voir la liste des code Statuts Professionnel
regime_retraite	integer <int32> Le code régime de retraite, voir la liste des code Régime de Retraite
cas_particuliers	integer <int32> Le code cas particuliers, voir la liste des code Cas Particuliers
salaire_mensuel	number <double> Le salaire mensuel
date_anciennete	string La date d'anciennete, format: jj/MM/aaaa
date_fin_previsionnelle_contrat	string Date de fin prévisionnelle du contrat, format: jj/MM/aaaa
date_debut_contrat	string Date de début de contrat, format: jj/MM/aaaa
nbr_heures_travail_mensuel_majorees	number <double> Le nombre d’heures de travail mensuelles majorées
salaire_horaire	number <double> le salaire horaire
salarie_temps_partiel	boolean Si salarié à temps partiel
forfait_jour	boolean Si forfait jour
	object (JoursHebdomadaires)
	object (Horaires)
	object (DepartSalarieDto)
type_salaire	stringMensuel\|Horaire Le mode du salaire: Mensuel ou Horaire
ne_pas_calculer_premier_bulletin	boolean Mettez true pour ne pas calculer le premier bulletin
	object (MoisAExclure)
nbr_jour_annuels_prevus	number <double> Le nombre Jours Annuels Prévus Au Contrat
tags	string Les tags, spératé par un ","

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/contrats

Request samples

Payload

{"id": 0,
"code_etablissement": "string",
"matricule_salarie": "string",
"numero_contrat": "string",
"ancien_numero_contrat_dsn": "string",
"emploi_conventionnel": 0,
"ccn": 0,
"idcc": 0,
"emploi": "string",
"type_contrat_travail": 0,
"type_contrat_temps_partiel": 0,
"statut_professionnel": 0,
"regime_retraite": 0,
"cas_particuliers": 0,
"salaire_mensuel": 0,
"date_anciennete": "string",
"date_fin_previsionnelle_contrat": "string",
"date_debut_contrat": "string",
"nbr_heures_travail_mensuel_majorees": 0,
"salaire_horaire": 0,
"salarie_temps_partiel": true,
"forfait_jour": true,
"jours_hebdomadaires": {"jours_hebdo": 0,
"jour_lundi": 0,
"jour_mardi": 0,
"jour_mercredi": 0,
"jour_jeudi": 0,
"jour_vendredi": 0,
"jour_samedi": 0,
"jour_dimanche": 0
},
"horaires": {"horaire_travail": 0,
"horaire_hebdo": 0,
"horaire_lundi": 0,
"horaire_mardi": 0,
"horaire_mercredi": 0,
"horaire_jeudi": 0,
"horaire_vendredi": 0,
"horaire_samedi": 0,
"horaire_dimanche": 0
},
"depart_salarie": {"date_sortie": "string",
"bulletin_post_contrat": true,
"bulletin_post_contrat_du": "string",
"bulletin_post_contrat_au": "string",
"motif_sortie": 0,
"date_notification_rupture": "string",
"date_notification_signature": "string",
"date_engagement_procedure": "string",
"maitien_affiliation_salarie": true,
"transaction_en_cours": true,
"dernier_jour_travaille_et_payer": "string",
"statut_particulier_salarie": 0,
"type_realisation_paiement_preavis01": 0,
"preavis_de01": "string",
"preavis_au01": "string",
"type_realisation_paiement_preavis02": 0,
"preavis_de02": "string",
"preavis_au02": "string",
"type_realisation_paiement_preavis03": 0,
"preavis_de03": "string",
"preavis_au03": "string"
},
"type_salaire": "string",
"ne_pas_calculer_premier_bulletin": true,
"mois_a_exclure": {"exclure_janvier": true,
"exclure_fevrier": true,
"exclure_mars": true,
"exclure_avril": true,
"exclure_mai": true,
"exclure_juin": true,
"exclure_juillet": true,
"exclure_aout": true,
"exclure_septembre": true,
"exclure_octobre": true,
"exclure_novembre": true,
"exclure_decembre": true
},
"nbr_jour_annuels_prevus": 0,
"tags": "string"
}

Response samples

200

{ }

Obtenir un contrat

Request

path Parameters

id

required

integer <int32>

Le id du contrat

Responses

200

OK

404

NotFound

500

InternalServerError

get/contrats/{id}

Supprimer un contrat

Request

path Parameters

id

required

integer <int32>

Le id du contrat à supprimer

Responses

200

OK

404

NotFound

500

InternalServerError

delete/contrats/{id}

ContratSortant

Détermine si un contrat est considéré comme sortant en fonction de sa date.

Request

query Parameters

id required	integer <int32> ID du contrat.
annee required	integer <int32> Année de référence pour la vérification.
mois required	integer <int32> Mois de référence pour la vérification.

Responses

200

OK

404

NotFound

500

InternalServerError

get/ContratSortant

Dossiers

Obtenir tous les dossiers

Request

query Parameters

page	integer <int32> le numéro de la page

Responses

200

OK

404

NotFound

500

InternalServerError

get/dossiers

Modifier un dossier

Request

Request Body schema:
application/json
required

Dossier à modifier

id	integer <int32> Le id du dossier, ignoré dans la méthode POST
code required	string [ 0 .. 10 ] characters
siret	string [ 13 .. 14 ] characters ^[0-9]*$
nom_dossier required	string [ 0 .. 50 ] characters Le nom du dossier
adresse_email	string L'adresse email du contact
telephone	string [ 0 .. 15 ] characters Le téléphone du contact
nom_contact	string [ 0 .. 100 ] characters Le nom du contact
qualite	integer <int32> [0-9]{1,} Le code qualité, voir liste des codes Qualités
annee	string [ 2010 .. 2050 ] ^[0-9]*$ L'année du dossier

Responses

200

OK

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

put/dossiers

Request samples

Payload

{"id": 0,
"code": "string",
"siret": "stringstrings",
"nom_dossier": "string",
"adresse_email": "string",
"telephone": "string",
"nom_contact": "string",
"qualite": 0,
"annee": "string"
}

Ajouter un dossier

Request

Request Body schema:
application/json
required

Le dossier à ajouter

id	integer <int32> Le id du dossier, ignoré dans la méthode POST
code required	string [ 0 .. 10 ] characters
siret	string [ 13 .. 14 ] characters ^[0-9]*$
nom_dossier required	string [ 0 .. 50 ] characters Le nom du dossier
adresse_email	string L'adresse email du contact
telephone	string [ 0 .. 15 ] characters Le téléphone du contact
nom_contact	string [ 0 .. 100 ] characters Le nom du contact
qualite	integer <int32> [0-9]{1,} Le code qualité, voir liste des codes Qualités
annee	string [ 2010 .. 2050 ] ^[0-9]*$ L'année du dossier

Responses

200

OK

201

Created

400

BadRequest

409

Conflict

500

InternalServerError

post/dossiers

Request samples

Payload

{"id": 0,
"code": "string",
"siret": "stringstrings",
"nom_dossier": "string",
"adresse_email": "string",
"telephone": "string",
"nom_contact": "string",
"qualite": 0,
"annee": "string"
}

Response samples

200

{ }

Obtenir un dossier par son id

Request

path Parameters

id

required

integer <int32>

Le id du dossier

Responses

200

OK

404

NotFound

500

InternalServerError

get/dossiers/{id}

Supprimer un dossier

Request

path Parameters

id

required

integer <int32>

le id du dossier à supprimer

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

delete/dossiers/{id}

Obtenir le id d'un dossier par son siret

Request

path Parameters

siret

required

string

Le siret du dossier

Responses

200

OK

404

NotFound

500

InternalServerError

get/dossiers/siret/{siret}

DSNs

Obtenir une DSN

Request

query Parameters

codeDossier required	string Le code du dossier
codeEtablissement required	string
mois required	integer <int32> Le mois de la DSN
annee required	integer <int32> L'année de la DSN
format	string Le format (txt, pdf)

Responses

200

OK

404

NotFound

500

InternalServerError

get/DSNs

Editions

Obtenir un édition

Request

query Parameters

codeDossier required	string Le code du dossier
moisDebut required	integer <int32> Le mois de début
moisFin required	integer <int32> Le mois de fin
annee required	integer <int32> L'année
format	string Le format (Excel, PDF, QUICKBOOKS, INFORCE, QUADRATUS, CIEL, FEC)

Responses

200

OK

404

NotFound

500

InternalServerError

get/editions

Etablissements

Obtenir tous les établissements

Request

query Parameters

dossierId	integer <int32> le id du dossier
page	integer <int32> le numéro de la page

Responses

200

OK

404

NotFound

500

InternalServerError

get/etablissements

Modifier un établissement

Request

Request Body schema:
application/json
required

l'établissement à modifier

id	integer <int32> Le id de l'établissement, ignoré dans la méthode POST
code required	string [ 0 .. 15 ] characters Le code de l'établissement
raison_sociale required	string La raison sociale
etablissement_principal	boolean Si c'est un établissement principal
siret	string [ 13 .. 14 ] characters ^[0-9]*$ Le SIRET de l'établissement
	object (AdresseEtablissement)
forme_juridique required	integer <int32> La forme juridique, voir la liste des code Formes Juridiques
civilite	string La civilité si la forme juridique "Particuliers" est selectionnée, voir la liste des codes Civilités
activite	string L'activité de l'établissement
ape	string = 5 characters APE
libelle_ape	string Le libellé APE
ccn	integer <int32> Le code de la convention collective 1, voir la liste des codes CCN
ccn2	integer <int32> Le code de la convention collective 2, voir la liste des codes CCN
ccn3	integer <int32> Le code de la convention collective 3, voir la liste des codes CCN
ccn4	integer <int32> Le code de la convention collective 4, voir la liste des codes CCN
ccn5	integer <int32> Le code de la convention collective 5, voir la liste des codes CCN
avenant	boolean Si avenant
numero_cotisant	string [ 0 .. 18 ] characters ^[0-9]*$ Le numéro cotisant, ne doit contenir que des caractères numériques
date_radiation	string <date-time> La date de radiation si forme juridique "Particuliers" est selectionnée
code_risque_at	string Le code risque AT
taux_at	number <double> Le taux AT
is_taux_versement_transport	boolean Si taux de versement transport
taux_versement_transport	number <double> Taux versement transport si "IsTauxVersementTransport" est true
	object (BanqueDto)
	object (GestionCongesPayesDto)

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/etablissements

Request samples

Payload

{"id": 0,
"code": "string",
"raison_sociale": "string",
"etablissement_principal": true,
"siret": "stringstrings",
"adresse": {"adress_postale": "string",
"adress_postale2": "string",
"complement_adress": "string",
"code_postal": "string",
"ville": "string",
"code_insee": "string",
"code_distribution_etranger": "string",
"pays": "string"
},
"forme_juridique": 0,
"civilite": "string",
"activite": "string",
"ape": "strin",
"libelle_ape": "string",
"ccn": 0,
"ccn2": 0,
"ccn3": 0,
"ccn4": 0,
"ccn5": 0,
"avenant": true,
"numero_cotisant": "string",
"date_radiation": "2019-08-24T14:15:22Z",
"code_risque_at": "string",
"taux_at": 0,
"is_taux_versement_transport": true,
"taux_versement_transport": 0,
"banque": {"virement": true,
"code_bic": "stringst",
"iban": "string"
},
"gestion_conges_payes": {"mois_cloture_droits_cp": 0,
"report_automatique_conges_payes": true,
"gestion_absences_conges_heures_sur_bulletins": true,
"decompte_conges_payes": "string",
"valorisation_conges_payes": "string",
"bloquer_gestion_conges_payes": true,
"etablissement_affilie_caisse_conges_payes": true
}
}

Ajouter un établissement

Request

query Parameters

dossierId

required

integer <int32>

Le id du dossier

Request Body schema:
application/json
required

l'établissement à ajouter

id	integer <int32> Le id de l'établissement, ignoré dans la méthode POST
code required	string [ 0 .. 15 ] characters Le code de l'établissement
raison_sociale required	string La raison sociale
etablissement_principal	boolean Si c'est un établissement principal
siret	string [ 13 .. 14 ] characters ^[0-9]*$ Le SIRET de l'établissement
	object (AdresseEtablissement)
forme_juridique required	integer <int32> La forme juridique, voir la liste des code Formes Juridiques
civilite	string La civilité si la forme juridique "Particuliers" est selectionnée, voir la liste des codes Civilités
activite	string L'activité de l'établissement
ape	string = 5 characters APE
libelle_ape	string Le libellé APE
ccn	integer <int32> Le code de la convention collective 1, voir la liste des codes CCN
ccn2	integer <int32> Le code de la convention collective 2, voir la liste des codes CCN
ccn3	integer <int32> Le code de la convention collective 3, voir la liste des codes CCN
ccn4	integer <int32> Le code de la convention collective 4, voir la liste des codes CCN
ccn5	integer <int32> Le code de la convention collective 5, voir la liste des codes CCN
avenant	boolean Si avenant
numero_cotisant	string [ 0 .. 18 ] characters ^[0-9]*$ Le numéro cotisant, ne doit contenir que des caractères numériques
date_radiation	string <date-time> La date de radiation si forme juridique "Particuliers" est selectionnée
code_risque_at	string Le code risque AT
taux_at	number <double> Le taux AT
is_taux_versement_transport	boolean Si taux de versement transport
taux_versement_transport	number <double> Taux versement transport si "IsTauxVersementTransport" est true
	object (BanqueDto)
	object (GestionCongesPayesDto)

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/etablissements

Request samples

Payload

{"id": 0,
"code": "string",
"raison_sociale": "string",
"etablissement_principal": true,
"siret": "stringstrings",
"adresse": {"adress_postale": "string",
"adress_postale2": "string",
"complement_adress": "string",
"code_postal": "string",
"ville": "string",
"code_insee": "string",
"code_distribution_etranger": "string",
"pays": "string"
},
"forme_juridique": 0,
"civilite": "string",
"activite": "string",
"ape": "strin",
"libelle_ape": "string",
"ccn": 0,
"ccn2": 0,
"ccn3": 0,
"ccn4": 0,
"ccn5": 0,
"avenant": true,
"numero_cotisant": "string",
"date_radiation": "2019-08-24T14:15:22Z",
"code_risque_at": "string",
"taux_at": 0,
"is_taux_versement_transport": true,
"taux_versement_transport": 0,
"banque": {"virement": true,
"code_bic": "stringst",
"iban": "string"
},
"gestion_conges_payes": {"mois_cloture_droits_cp": 0,
"report_automatique_conges_payes": true,
"gestion_absences_conges_heures_sur_bulletins": true,
"decompte_conges_payes": "string",
"valorisation_conges_payes": "string",
"bloquer_gestion_conges_payes": true,
"etablissement_affilie_caisse_conges_payes": true
}
}

Response samples

200

{ }

Obtenir un établissement par son id

Request

path Parameters

id

required

integer <int32>

le id de l'établissement

Responses

200

OK

404

NotFound

500

InternalServerError

get/etablissements/{id}

Supprimer un établissement

Request

path Parameters

id

required

integer <int32>

Le id de l'établissement à supprimer

Responses

200

OK

404

NotFound

500

InternalServerError

delete/etablissements/{id}

HeuresSupplementaires

Modifier une heure supplementaire

Request

Request Body schema:
application/json
required

L'heure supplementaire à modifier

id	integer <int32> Le id de l'heure supplémentaire., ignoré dans la méthode POST
code	string Le code de l'heure supplémentaire.
nombre required	number <double> Le nombre d'heures supplémentaires.
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/HeuresSupplementaires

Request samples

Payload

{"id": 0,
"code": "string",
"nombre": 0,
"mois": 1,
"annee": "string"
}

Ajouter une heure supplementaire

Request

query Parameters

contratId

required

integer <int32>

Le id du contrat de l'heure supplementaire

Request Body schema:
application/json
required

L'heure supplementaire à ajouter

id	integer <int32> Le id de l'heure supplémentaire., ignoré dans la méthode POST
code	string Le code de l'heure supplémentaire.
nombre required	number <double> Le nombre d'heures supplémentaires.
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/HeuresSupplementaires

Request samples

Payload

{"id": 0,
"code": "string",
"nombre": 0,
"mois": 1,
"annee": "string"
}

Response samples

200

{ }

NetEntrepriseApi

Mettre à jour les informations NetEntreprise d'un dossier

Request

query Parameters

dossierId

required

integer <int32>

ID du dossier

Request Body schema:
application/json
required

Données NetEntreprise

id	integer <int32> Le ID du NetEntreprise, ignoré dans la méthode POST.
parametrage_domaine	boolean Indique si c'est un paramétrage de domaine.
dossier_id	integer <int32> L'ID du dossier associé.
nom required	string Le nom
prenom required	string Le prénom
siret required	string = 14 characters ^[0-9]*$ Le numéro SIRET de l'entreprise (14 chiffres numériques).
civilite	string La civilité de la personne (M., MME).
email	string L'adresse email.
telephone	string^([0-9\/\+ \-]*)$ Le numéro de téléphone.
fax	string^([0-9\/\+ \-]*)$ Le numéro de fax.
mot_pass	string Le mot de passe associé.

Responses

200

OK

put/NetEntreprise

Request samples

Payload

{"id": 0,
"parametrage_domaine": true,
"dossier_id": 0,
"nom": "string",
"prenom": "string",
"siret": "stringstringst",
"civilite": "string",
"email": "string",
"telephone": "string",
"fax": "string",
"mot_pass": "string"
}

Response samples

200

{ }

Ajouter des informations NetEntreprise à un dossier

Request

query Parameters

dossierId

required

integer <int32>

ID du dossier

Request Body schema:
application/json
required

Données NetEntreprise

id	integer <int32> Le ID du NetEntreprise, ignoré dans la méthode POST.
parametrage_domaine	boolean Indique si c'est un paramétrage de domaine.
dossier_id	integer <int32> L'ID du dossier associé.
nom required	string Le nom
prenom required	string Le prénom
siret required	string = 14 characters ^[0-9]*$ Le numéro SIRET de l'entreprise (14 chiffres numériques).
civilite	string La civilité de la personne (M., MME).
email	string L'adresse email.
telephone	string^([0-9\/\+ \-]*)$ Le numéro de téléphone.
fax	string^([0-9\/\+ \-]*)$ Le numéro de fax.
mot_pass	string Le mot de passe associé.

Responses

200

OK

400

BadRequest

500

InternalServerError

post/NetEntreprise

Request samples

Payload

{"id": 0,
"parametrage_domaine": true,
"dossier_id": 0,
"nom": "string",
"prenom": "string",
"siret": "stringstringst",
"civilite": "string",
"email": "string",
"telephone": "string",
"fax": "string",
"mot_pass": "string"
}

Response samples

200

{ }

Options

Modifier une option

Request

Request Body schema:
application/json
required

L'option à modifier

id	integer <int32> Le id de l'option supplémentaire., ignoré dans la méthode POST
code	string Le code de l'option supplémentaire.
valeur1	number <double> La Valeur 1.
valeur2	number <double> La Valeur 2.
valeur3	number <double> La Valeur 3.
date1	string <date-time> La Date 1.
date2	string <date-time> La Date 2.
date3	string <date-time> La Date 3.
actif1	boolean Actif 1.
actif2	boolean Actif 2.
actif3	boolean Actif 3.
actif4	boolean Actif 4.
actif5	boolean Actif 5.
actif6	boolean Actif 6.
actif7	boolean Actif 7.
actif8	boolean Actif 8.
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/Options

Request samples

Payload

{"id": 0,
"code": "string",
"valeur1": 0,
"valeur2": 0,
"valeur3": 0,
"date1": "2019-08-24T14:15:22Z",
"date2": "2019-08-24T14:15:22Z",
"date3": "2019-08-24T14:15:22Z",
"actif1": true,
"actif2": true,
"actif3": true,
"actif4": true,
"actif5": true,
"actif6": true,
"actif7": true,
"actif8": true,
"mois": 1,
"annee": "string"
}

Ajouter une option

Request

query Parameters

contratId

required

integer <int32>

Le id du contrat de la option

Request Body schema:
application/json
required

L'option à ajouter

id	integer <int32> Le id de l'option supplémentaire., ignoré dans la méthode POST
code	string Le code de l'option supplémentaire.
valeur1	number <double> La Valeur 1.
valeur2	number <double> La Valeur 2.
valeur3	number <double> La Valeur 3.
date1	string <date-time> La Date 1.
date2	string <date-time> La Date 2.
date3	string <date-time> La Date 3.
actif1	boolean Actif 1.
actif2	boolean Actif 2.
actif3	boolean Actif 3.
actif4	boolean Actif 4.
actif5	boolean Actif 5.
actif6	boolean Actif 6.
actif7	boolean Actif 7.
actif8	boolean Actif 8.
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/Options

Request samples

Payload

{"id": 0,
"code": "string",
"valeur1": 0,
"valeur2": 0,
"valeur3": 0,
"date1": "2019-08-24T14:15:22Z",
"date2": "2019-08-24T14:15:22Z",
"date3": "2019-08-24T14:15:22Z",
"actif1": true,
"actif2": true,
"actif3": true,
"actif4": true,
"actif5": true,
"actif6": true,
"actif7": true,
"actif8": true,
"mois": 1,
"annee": "string"
}

Response samples

200

{ }

Primes

Modifier une prime

Request

Request Body schema:
application/json
required

La prime à modifier

id	integer <int32> Le id de la prime, ignoré dans la méthode POST
code	string Le code de la prime
montant	number <double> Le montant de la prime
bases	number <double> La baseS de la prime
tauxs	number <double> Le tauxS de la prime
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année
ccn	integer <int32> Le code de la convention collective, voir la liste des codes CCN

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/Primes

Request samples

Payload

{"id": 0,
"code": "string",
"montant": 0,
"bases": 0,
"tauxs": 0,
"mois": 1,
"annee": "string",
"ccn": 0
}

Ajouter une prime

Request

query Parameters

contratId

required

integer <int32>

Le id du contrat de la prime

Request Body schema:
application/json
required

La prime à ajouter

id	integer <int32> Le id de la prime, ignoré dans la méthode POST
code	string Le code de la prime
montant	number <double> Le montant de la prime
bases	number <double> La baseS de la prime
tauxs	number <double> Le tauxS de la prime
mois	integer <int32> [ 1 .. 12 ] Mois
annee	string [ 2010 .. 2050 ] ^[0-9]*$ Année
ccn	integer <int32> Le code de la convention collective, voir la liste des codes CCN

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/Primes

Request samples

Payload

{"id": 0,
"code": "string",
"montant": 0,
"bases": 0,
"tauxs": 0,
"mois": 1,
"annee": "string",
"ccn": 0
}

Response samples

200

{ }

Salaries

Obtenir tous les salariés

Request

query Parameters

dossierId	integer <int32> Le id du dossier
page	integer <int32> Le numéro de la page

Responses

200

OK

404

NotFound

500

InternalServerError

get/salaries

Modifier un salarié

Request

Request Body schema:
application/json
required

Le salarié à modifier

id	integer <int32> Le id du salarié, ignoré dans la méthode POST
matricule_salarie	string [ 0 .. 50 ] characters Le matricule du salarié
civilite	integer <int32> La civilité du salarié, voir la liste des codes Civilités
nom required	string [ 0 .. 50 ] characters Le nom du salarié
nom_naissance	string [ 0 .. 100 ] characters Le nom de naissance du salarié
nom_jeune_fille	string Le nom de la jeune fille de la salarié
prenom	string [ 0 .. 100 ] characters Le prénom du salarié
situation_familiale	integer <int32> La situation familiale du salarié, voir la liste des codes Situations Familiales
numero_ss_cle	string [ 14 .. 15 ] characters Le numéro de sécurité sociale + Clé
numero_ss_cle_temp	string Le numéro de sécurité sociale + Clé temporaire
date_naissance	string La date de naissance du salarié
nationalite	string La nationalié du salarié, voir la liste des code Pays
commune_naissance	string La commune de naissance du salarié
departement	string Le département du salarié
pays_naissance	string Le pays de naissance du salarié, voir la liste des codes Pays
nbr_enfants_charge	integer <int32> Le nombre d'enfants à charge
	object (AdresseSalarieDto)
contrat_en_cours	boolean
email	string L'email du salarié
telephone	string^([0-9\/\+ \-]*)$ Le téléphone du salarié
	object (BanqueDto)

Responses

200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/salaries

Request samples

Payload

{"id": 0,
"matricule_salarie": "string",
"civilite": 0,
"nom": "string",
"nom_naissance": "string",
"nom_jeune_fille": "string",
"prenom": "string",
"situation_familiale": 0,
"numero_ss_cle": "stringstringst",
"numero_ss_cle_temp": "string",
"date_naissance": "string",
"nationalite": "string",
"commune_naissance": "string",
"departement": "string",
"pays_naissance": "string",
"nbr_enfants_charge": 0,
"adresse": {"numero_voie": "string",
"complement": "string",
"code_postal": "strin",
"ville": "string",
"pays": "string",
"domicilie_fiscal_hors_france": true,
"frontalier": true,
"code_distribution_etranger": "string",
"code_insee": "string"
},
"contrat_en_cours": true,
"email": "string",
"telephone": "string",
"banque": {"virement": true,
"code_bic": "stringst",
"iban": "string"
}
}

Ajouter un salarié

Request

query Parameters

dossierId

required

integer <int32>

Le id du dossier

Request Body schema:
application/json
required

Le salarié à ajouter

id	integer <int32> Le id du salarié, ignoré dans la méthode POST
matricule_salarie	string [ 0 .. 50 ] characters Le matricule du salarié
civilite	integer <int32> La civilité du salarié, voir la liste des codes Civilités
nom required	string [ 0 .. 50 ] characters Le nom du salarié
nom_naissance	string [ 0 .. 100 ] characters Le nom de naissance du salarié
nom_jeune_fille	string Le nom de la jeune fille de la salarié
prenom	string [ 0 .. 100 ] characters Le prénom du salarié
situation_familiale	integer <int32> La situation familiale du salarié, voir la liste des codes Situations Familiales
numero_ss_cle	string [ 14 .. 15 ] characters Le numéro de sécurité sociale + Clé
numero_ss_cle_temp	string Le numéro de sécurité sociale + Clé temporaire
date_naissance	string La date de naissance du salarié
nationalite	string La nationalié du salarié, voir la liste des code Pays
commune_naissance	string La commune de naissance du salarié
departement	string Le département du salarié
pays_naissance	string Le pays de naissance du salarié, voir la liste des codes Pays
nbr_enfants_charge	integer <int32> Le nombre d'enfants à charge
	object (AdresseSalarieDto)
contrat_en_cours	boolean
email	string L'email du salarié
telephone	string^([0-9\/\+ \-]*)$ Le téléphone du salarié
	object (BanqueDto)

Responses

200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/salaries

Request samples

Payload

{"id": 0,
"matricule_salarie": "string",
"civilite": 0,
"nom": "string",
"nom_naissance": "string",
"nom_jeune_fille": "string",
"prenom": "string",
"situation_familiale": 0,
"numero_ss_cle": "stringstringst",
"numero_ss_cle_temp": "string",
"date_naissance": "string",
"nationalite": "string",
"commune_naissance": "string",
"departement": "string",
"pays_naissance": "string",
"nbr_enfants_charge": 0,
"adresse": {"numero_voie": "string",
"complement": "string",
"code_postal": "strin",
"ville": "string",
"pays": "string",
"domicilie_fiscal_hors_france": true,
"frontalier": true,
"code_distribution_etranger": "string",
"code_insee": "string"
},
"contrat_en_cours": true,
"email": "string",
"telephone": "string",
"banque": {"virement": true,
"code_bic": "stringst",
"iban": "string"
}
}

Response samples

200

{ }

Obtenir un salarié par son id

Request

path Parameters

id

required

integer <int32>

Le id du salarié

Responses

200

OK

404

NotFound

500

InternalServerError

get/salaries/{id}

Supprimer un salarié

Request

path Parameters

id

required

integer <int32>

Le id du salarié à supprimer

Responses

200

OK

404

NotFound

500

InternalServerError

delete/salaries/{id}

SoldeToutComptes

Obtenir un bulletin de paie

Request

query Parameters

codeDossier required	string Le code du dossier
matricule required	string Le matricule du salarié
numeroContrat required	string Le numéro de contrat du salarié

Responses

200

OK

404

NotFound

500

InternalServerError

get/soldeToutcomptes

Variables

Variables_GetVariables

Request

query Parameters

dossierId required	integer <int32>
type required	string
mois required	integer <int32>

Responses

200

OK

404

NotFound

500

InternalServerError

get/variables

VariablesBulletinsApi

Obtenir la variable d'un bulletin de paie

Request

query Parameters

contratId required	integer <int32> Le id du contrat
annee required	integer <int32> L'année de la variable à récupérer
mois required	integer <int32> Le mois de la variable à récupérer
variableARecuperer required	string Le nom de la variable à récupérer

Responses

200

OK

404

NotFound

500

InternalServerError

get/variablesbulletins

Obtenir la variable d'un bulletin de paie

Request

query Parameters

contratId required	integer <int32> Le id du contrat
annee required	integer <int32> L'année de la variable à récupérer
mois required	integer <int32> Le mois de la variable à récupérer

Responses

200

OK

404

NotFound

500

InternalServerError

get/variablesbulletins/CompteursConges

VariablesRepriseDossier

Obtenir valeur variable reprise dossier

Request

query Parameters

contratId required	integer <int32> Le id du contrat
nomVariable required	string Le nom de la variable reprise dossier

Responses

200

OK

404

NotFound

500

InternalServerError

get/VariablesRepriseDossier

Ajouter une variable reprise dossier

Request

query Parameters

contratId required	integer <int32> Le id du contrat
nomVariable required	string Le nom de la variable reprise dossier
valeur required	string La valeur de la variable reprise dossier

Responses

200

OK

404

NotFound

500

InternalServerError

post/VariablesRepriseDossier

Response samples

200

{ }

Openpaye API (v1_1)

Absences

Obtenir une abcence

path Parameters

Récupère la liste des absences dans une plage de dates

query Parameters

Modifier une abcence

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter une abcence

query Parameters

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

BulletinsPaies

Obtenir un bulletin de paie

query Parameters

Obtenir les détails d'une ligne de bulletin de paie en fonction du mois, de l'année, du contrat et du code.

query Parameters

Liste les bulletins pour un dossier donné, sur un mois et une année.

query Parameters

CaisseCotisationsApi

Obtenir une caisse de cotisations par son ID.

path Parameters

Créer une nouvelle caisse de cotisations.

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Contrats

Obtenir tous les contrats

query Parameters

Modifier un contrat

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter un contrat

query Parameters

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Obtenir un contrat

path Parameters

Supprimer un contrat

path Parameters

ContratSortant

Détermine si un contrat est considéré comme sortant en fonction de sa date.

query Parameters

Dossiers

Obtenir tous les dossiers

query Parameters

Modifier un dossier

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter un dossier

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Obtenir un dossier par son id

path Parameters

Supprimer un dossier

path Parameters

Obtenir le id d'un dossier par son siret

path Parameters

DSNs

Obtenir une DSN

query Parameters

Editions

Obtenir un édition

query Parameters

Etablissements

Obtenir tous les établissements

query Parameters

Modifier un établissement

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter un établissement

query Parameters

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Obtenir un établissement par son id

path Parameters

Supprimer un établissement

path Parameters

HeuresSupplementaires

Modifier une heure supplementaire

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter une heure supplementaire

query Parameters

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

NetEntrepriseApi

Mettre à jour les informations NetEntreprise d'un dossier

query Parameters

Request Body schema: application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Ajouter des informations NetEntreprise à un dossier

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required