Customer | Client

Gestion des clients d'un compte X.

Liste des clients

GET https://api.edgequery.io/api/x/customers

Récupération de l'ensemble des clients du compte associé à l'utilisateur connecté.

Headers

Name	Type	Description
Authentication	string	Passage du token d'identification récupéré lors du Login de l'utilisateur

200 Récupération sous forme d'une chaîne JSON de la liste des clients

{
   "success":true,
   "data":[
      {
         "id":6458715,
         "company":"Client n°1",
         "address_street":"1 rue des prés",
         "address_postal":"67640",
         "address_city":"Lipsheim",
         "address_country_id":1,
         "customer_payment":0,
         "vat":"FR48741254",
         "reg1":"4154-12114-25110",
         "reg2":"RCS Strasbourg n\u00b0487454",
         "xcpm":"22",
         "email":"[email protected]",
         "phone":"03 88 64 22 00",
         "created_at":"10\/02\/2020",
         "updated_at":"19\/02\/2020"
      },
      {
         "id":45471546,
         "company":"Client n°2",
         "address_street":"1 rue des fleurs",
         "address_postal":"68740",
         "address_city":"Orbey",
         "address_country_id":1,
         "customer_payment":1,
         "vat":"FR48741254",
         "reg1":"4154-12114-25110",
         "reg2":"RCS Colmar n\u00b0487454",
         "xcpm":"17.85",
         "email":"[email protected]",
         "phone":"03 88 64 22 00",
         "created_at":"10\/02\/2020",
         "updated_at":"12\/02\/2020"
      }
   ],
   "message":"Customer retrieved successfully."
}

Détail d'un client

GET https://api.edgequery.io/api/x/customers/{id}

Récupération d'un client en fonction de son identifiant unique.

Path Parameters

Name	Type	Description
id	integer	Identifiant unique d'un client dans la base. Sous forme d'un entier.

Headers

Name	Type	Description
Authentication	string	Passage du token d'identification récupéré lors du Login de l'utilisateur

200

{
   "success":true,
   "data":{
      "id":6,
      "company":"Mon Client",
      "address_street":"1 rue des fleurs",
      "address_postal":"68740",
      "address_city":"Orbey",
      "address_country_id":1,
      "customer_payment":1,
      "vat":"FR48741254",
      "reg1":"4154-12114-25110",
      "reg2":"RCS Colmar n\u00b0487454",
      "xcpm":"17.85",
      "email":"[email protected]",
      "phone":"03 88 64 22 00",
      "created_at":"10\/02\/2020",
      "updated_at":"10\/02\/2020"
   },
   "message":"Customer retrieved successfully."
}

404

Création d'un client

POST https://api.edgequery.io/api/x/customers

Création d'un nouveau client associé au compte de l'utilisateur de l'API.

Headers

Name	Type	Description
Authentication	string	Passage du token d'identification récupéré lors du Login de l'utilisateur

Request Body

Name	Type	Description
phone	string	Numéro de téléphone par défaut
email	string	Adresse email par défaut
xcpm	number	Valeur du CPM pratiqué chez ce client en euro H.T.e
reg2	string	Numéro d'enregistrement 2 (généralement le registre de commerce)
reg1	string	Numéro d'enregistrement 1 (généralement le SIRET)
vat	string	Code TVA du client
customer_payment	boolean	Indique si un client est tier de facturation (1) ou non (0). Utiliser uniquement avec les comptes de type "Agence".
address_city	string	Adresse du client : ville
address_postal	string	Adresse du client : code postal
address_street	string	Adresse du client : rue
company	string	Raison sociale du client
code	string	code interne du client

200

{
   "success":true,
   "data":{
      "id":4,
      "company":"Mon Client",
      "address_street":"1 rue des fleurs",
      "address_postal":"68740",
      "address_city":"Mulhouse",
      "address_country_id":1,
      "customer_payment":"1",
      "vat":"FR48741254",
      "reg1":"4154-12114-25110",
      "reg2":"RCS Colmar n\u00b0487454",
      "xcpm":"17.85",
      "email":"[email protected]",
      "phone":"03 88 64 22 00",
      "created_at":"10\/02\/2020",
      "updated_at":"11\/02\/2020"
   },
   "message":"Customer created successfully."
}

Mise à jour d'un client

PUT https://api.edgequery.io/api/x/customers/{id}

Modification d'un client par son identifiant unique.

Query Parameters

Name	Type	Description
id	integer	Identifiant unique d'un client

Headers

Name	Type	Description
Authentication	string	Passage du token d'identification récupéré lors du Login de l'utilisateur

Request Body

Name	Type	Description
phone	string	Numéro de téléphone par défaut
email	string	Adresse email par défaut
xcpm	number	Valeur du CPM pratiqué chez ce client en euro H.T.e
reg2	string	Numéro d'enregistrement 2 (généralement le registre de commerce)
reg1	string	Numéro d'enregistrement 1 (généralement le SIRET)
vat	string	Code TVA du client
customer_payment	boolean	Indique si un client est tier de facturation (1) ou non (0). Utiliser uniquement avec les comptes de type "Agence".
address_city	string	Adresse du client : ville
address_postal	string	Adresse du client : code postal
address_street	string	Adresse du client : rue
company	string	Raison sociale du client
code	string	code interne du client

200

{
   "success":true,
   "data":{
      "id":4,
      "company":"Mon Client",
      "address_street":"1 rue des fleurs",
      "address_postal":"68740",
      "address_city":"Mulhouse",
      "address_country_id":1,
      "customer_payment":"1",
      "vat":"FR48741254",
      "reg1":"4154-12114-25110",
      "reg2":"RCS Colmar n\u00b0487454",
      "xcpm":"17.85",
      "email":"[email protected]",
      "phone":"03 88 64 22 00",
      "created_at":"10\/02\/2020",
      "updated_at":"11\/02\/2020"
   },
   "message":"Customer updated successfully."
}

Suppression d'un client

DELETE https://api.edgequery.io/api/x/customers/{id}

Suppression d'un client en fonction de son identifiant unique.

Path Parameters

Name	Type	Description
id	integer	Identifiant unique d'un client dans la base. Sous forme d'un entier.

Headers

Name	Type	Description
Authentication	string	Passage du token d'identification récupéré lors du Login de l'utilisateur

200