GET /firms/FIRM_ID/customers.json

liste des clients, par groupe de 30 résultats.

Paramètres optionnels :

• page : numéro de page
• api_id : recherche exacte sur le champ api_id
• api_custom : recherche partielle sur le champ api_custom
• company : recherche partielle sur le nom de société
• last_name : recherche partielle sur le nom de famille
• email : recherche partielle sur l'email
• with_sepa : par défaut, les données SEPA ne sont pas exportées. Seule la clé API de l'administrateur de la société permet d'exporter les données SEPA, et vous devez explicitement demander ces informations en utilisant la valeur 1.
• mode : en l'absence de précision, le système retourne uniquement les clients actifs. Vous pouvez utiliser les valeurs suivantes pour retourner différents groupes de clients:
  • all : retourne tous les clients (actifs ou archivés)
  • company : retourne uniquement les professionnels actifs
  • individual : retourne uniquement les particuliers actifs
  • archived : retourne uniquement les clients archivés

Tri

Par défaut, les clients sont triés par ordre croissant de nom mnémotechnique.
Vous pouvez trier les résultats selon différentes méthodes en utilisant les paramètres suivants

• sort:
  • asc : tri croissant
  • desc : tri décroissant
• order : type de tri
  • last_invoice : tri par date de dernière facture au client
  • last_paid : tri par date de dernier paiement du client
  • created : tri par date de création
  • updated : tri par date de dernière modification

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "https://www.facturation.pro/firms/FIRM_ID/customers.json"

Réponse

[{
  "account_code": "411PANDORA",
  "api_custom": null,
  "api_id": null,
  "category_id": 4847,
  "city": "Neuilly-sur-Seine",
  "civility": null,
  "company_name": "pandora",
  "country": "FR",
  "currency": "EUR",
  "default_vat": null,
  "discount": null,
  "email": null,
  "fax": "",
  "first_name": "",
  "id": 180371,
  "individual": false,
  "language": null,
  "last_invoiced_on": "2012-07-28",
  "last_name": "",
  "mobile": "",
  "pay_before": "30fm",
  "penalty": null,
  "phone": "",
  "short_name": "pandora",
  "siret": "53165179200016",
  "street": "171 avenue Charles de Gaulle",
  "validity": null,
  "vat_exemption": null,
  "vat_number": "",
  "website": null,
  "zip_code": "92200"
}, {
  "account_code": "411SPOTIFY",
  "api_custom": null,
  "api_id": null,
  "category_id": null,
  "city": "Paris",
  "civility": null,
  "company_name": "spotify",
  "country": "FR",
  "currency": "EUR",
  "default_vat": null,
  "discount": null,
  "email": null,
  "fax": "",
  "first_name": "",
  "id": 180369,
  "individual": false,
  "language": null,
  "last_invoiced_on": "2013-02-28",
  "last_name": "",
  "mobile": "",
  "pay_before": "30",
  "penalty": null,
  "phone": "",
  "short_name": "spotify",
  "siret": null,
  "street": "11 bis rue christophe colomb",
  "validity": null,
  "vat_exemption": null,
  "vat_number": "",
  "website": null,
  "zip_code": "75008"
}]

GET /firms/FIRM_ID/customers/ID.json

Affiche le détail du client n° ID

Paramètres optionnels :

• with_sepa: par défaut, les données SEPA ne sont pas retournée par l'API. Seule la clé API de l'administrateur de la société permet d'accéder aux données SEPA, et vous devez explicitement demander ces informations en utilisant la valeur 1. Lorsque vous demandez à accéder aux informations SEPA avec une clé API autre que celle de l'administrateur du compte, le système retourne une erreur de type 403

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID.json"

Réponse

{
  "account_code": "411PANDORA",
  "api_custom": null,
  "api_id": null,
  "category_id": 4847,
  "city": "Neuilly-sur-Seine",
  "civility": null,
  "company_name": "pandora",
  "country": "FR",
  "currency": "EUR",
  "default_vat": null,
  "discount": null,
  "email": null,
  "fax": "",
  "first_name": "",
  "id": ID,
  "individual": false,
  "language": null,
  "last_invoiced_on": "2012-07-28",
  "last_name": "",
  "mobile": "",
  "pay_before": "30fm",
  "penalty": null,
  "phone": "",
  "short_name": "pandora",
  "siret": "53165179200016",
  "street": "171 avenue Charles de Gaulle",
  "validity": null,
  "vat_exemption": null,
  "vat_number": "",
  "website": null,
  "zip_code": "92200"
}

POST /firms/FIRM_ID/customers.json

Création d'un nouveau client. On obtient en retour le code JSON du client créé, avec l'ID qui lui a été attribué.

Remarque

Par défaut, en l'absence d'indication spécifique, chaque client créé est de type professionnel, et si vous n'avez pas indiqué de nom d'entreprise, celui ci est automatiquement dérivé du prénom et du nom du client. Lorsque vous créez un client particulier, vous devez donc le préciser en affectant la valeur true au champ individual.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X POST \
 -d '{"company_name":"A small company","individual":false}' \
 "https://www.facturation.pro/firms/FIRM_ID/customers.json"

Réponse

Status: 201 Created
Location: /firms/FIRM_ID/customers/180374.json

{
  "account_code": "411ASMALLCO",
  "api_custom": null,
  "api_id": null,
  "category_id": null,
  "city": null,
  "civility": null,
  "company_name": "A small company",
  "country": null,
  "currency": "EUR",
  "default_vat": null,
  "discount": null,
  "email": null,
  "fax": null,
  "first_name": null,
  "id": 180374,
  "individual": false,
  "language": null,
  "last_invoiced_on": null,
  "last_name": null,
  "mobile": null,
  "pay_before": null,
  "penalty": null,
  "phone": null,
  "short_name": "A small company",
  "siret": null,
  "street": null,
  "validity": null,
  "vat_exemption": null,
  "vat_number": null,
  "website": null,
  "zip_code": null
}

PATCH /firms/FIRM_ID/customers/ID.json

Mise à jour d'un client existant.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X PATCH \
 -d '{"company_name":"A big company","email":"boss@bigcompany.com"}' \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID.json"

Réponse

Status: 200 OK

DELETE /firms/FIRM_ID/customers/ID.json

Supprime le client identifié par son ID, ainsi que tous les devis associés à ce client.
Un client ne peut être supprimé que s'il n'a jamais été facturé.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -X DELETE \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID.json"

Réponse

Status: 200 OK

POST /firms/FIRM_ID/customers/ID/archive.json

Archive le client identifié par son ID, ce qui permet de le masquer de la liste des clients.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -X POST \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID/archive.json"

Réponse

Status: 200 OK

POST /firms/FIRM_ID/customers/ID/unarchive.json

Restaure le client archivé, identifié par son ID. Ce client peut à nouveau être facturé et redevient visible dans la liste des clients.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -X POST \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID/unarchive.json"

Réponse

Status: 200 OK

GET /firms/FIRM_ID/customers/ID/quotes.json

liste des devis du client ID, par groupe de 30 résultats.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID/quotes.json"

Réponse

Cette fonction est un raccourci vers la liste des devis, liste restreinte aux devis du client ID.
La réponse est donc une redirection vers la requête à exécuter sur la liste des devis.

Status: 302 Redirected
Location: /firms/FIRM_ID/quotes.json?customer_id=180371

GET /firms/FIRM_ID/customers/ID/invoices.json

liste des factures du client ID, par groupe de 30 résultats.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "https://www.facturation.pro/firms/FIRM_ID/customers/ID/invoices.json"

Réponse

Cette fonction est un raccourci vers la liste des factures, liste restreinte aux factures du client ID.
La réponse est donc une redirection vers la requête à exécuter sur la liste des factures.

Status: 302 Redirected
Location: /firms/{FIRM_ID}/invoices.json?customer_id=180371