Openpaye API (v1_1)

Download OpenAPI specification:Download

Authentication

basic

Basic HTTP Authentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

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:

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 [ 0 .. 50 ] characters

Le numéro de contrat

ancien_numero_contrat_dsn
string [ 0 .. 50 ] characters

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

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)
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
{
  • "id": 0,
  • "code_etablissement": "string",
  • "matricule_salarie": "string",
  • "numero_contrat": "string",
  • "ancien_numero_contrat_dsn": "string",
  • "emploi_conventionnel": 0,
  • "ccn": 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": {
    },
  • "horaires": {
    },
  • "type_salaire": "string",
  • "ne_pas_calculer_premier_bulletin": true,
  • "mois_a_exclure": {
    },
  • "nbr_jour_annuels_prevus": 0,
  • "tags": "string"
}

Ajouter un contrat

Request
query Parameters
dossierId
required
integer <int32>

Le id du dossier

Request Body schema:

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 [ 0 .. 50 ] characters

Le numéro de contrat

ancien_numero_contrat_dsn
string [ 0 .. 50 ] characters

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

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)
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
{
  • "id": 0,
  • "code_etablissement": "string",
  • "matricule_salarie": "string",
  • "numero_contrat": "string",
  • "ancien_numero_contrat_dsn": "string",
  • "emploi_conventionnel": 0,
  • "ccn": 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": {
    },
  • "horaires": {
    },
  • "type_salaire": "string",
  • "ne_pas_calculer_premier_bulletin": true,
  • "mois_a_exclure": {
    },
  • "nbr_jour_annuels_prevus": 0,
  • "tags": "string"
}
Response samples
{ }

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}

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:

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
{
  • "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:

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
{
  • "id": 0,
  • "code": "string",
  • "siret": "stringstrings",
  • "nom_dossier": "string",
  • "adresse_email": "string",
  • "telephone": "string",
  • "nom_contact": "string",
  • "qualite": 0,
  • "annee": "string"
}
Response samples
{ }

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}

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:

l'établissement à modifier

id
integer <int32>

Le id de l'établissement, ignoré dans la méthode POST

code
required
string [ 0 .. 5 ] 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

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)
Responses
200

OK

400

BadRequest

404

NotFound

500

InternalServerError

put/etablissements
Request samples
{
  • "id": 0,
  • "code": "strin",
  • "raison_sociale": "string",
  • "etablissement_principal": true,
  • "siret": "stringstrings",
  • "adresse": {
    },
  • "forme_juridique": 0,
  • "civilite": "string",
  • "activite": "string",
  • "ape": "strin",
  • "libelle_ape": "string",
  • "ccn": 0,
  • "ccn2": 0,
  • "ccn3": 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": {
    }
}

Ajouter un établissement

Request
query Parameters
dossierId
required
integer <int32>

Le id du dossier

Request Body schema:

l'établissement à ajouter

id
integer <int32>

Le id de l'établissement, ignoré dans la méthode POST

code
required
string [ 0 .. 5 ] 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

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)
Responses
200

OK

201

Created

400

BadRequest

404

NotFound

409

Conflict

500

InternalServerError

post/etablissements
Request samples
{
  • "id": 0,
  • "code": "strin",
  • "raison_sociale": "string",
  • "etablissement_principal": true,
  • "siret": "stringstrings",
  • "adresse": {
    },
  • "forme_juridique": 0,
  • "civilite": "string",
  • "activite": "string",
  • "ape": "strin",
  • "libelle_ape": "string",
  • "ccn": 0,
  • "ccn2": 0,
  • "ccn3": 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": {
    }
}
Response samples
{ }

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}

Primes

Obtenir une prime

Request
path Parameters
id
required
integer <int32>

Le id de la prime

Responses
200

OK

404

NotFound

500

InternalServerError

get/Primes/{id}

Modifier une prime

Request
Request Body schema:
id
integer <int32>

Le id de la prime, ignoré dans la méthode POST

code
string

Le code de la prime

montant
required
number <double>

Le montant de la prime

mois
integer <int32> [ 1 .. 12 ]

Mois

annee
string [ 2010 .. 2050 ] ^[0-9]*$
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
{
  • "id": 0,
  • "code": "string",
  • "montant": 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:

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
required
number <double>

Le montant de la prime

mois
integer <int32> [ 1 .. 12 ]

Mois

annee
string [ 2010 .. 2050 ] ^[0-9]*$
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
{
  • "id": 0,
  • "code": "string",
  • "montant": 0,
  • "mois": 1,
  • "annee": "string",
  • "ccn": 0
}
Response samples
{ }

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:

Le salarié à modifier

id
integer <int32>

Le id du salarié, ignoré dans la méthode POST

matricule_salarie
required
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)
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
{
  • "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": {
    },
  • "email": "string",
  • "telephone": "string",
  • "banque": {
    }
}

Ajouter un salarié

Request
query Parameters
dossierId
required
integer <int32>

Le id du dossier

Request Body schema:

Le salarié à ajouter

id
integer <int32>

Le id du salarié, ignoré dans la méthode POST

matricule_salarie
required
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)
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
{
  • "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": {
    },
  • "email": "string",
  • "telephone": "string",
  • "banque": {
    }
}
Response samples
{ }

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}