Liste des suivis commerciaux

GET /firms/FIRM_ID/followups.json

liste des suivis commerciaux disponibles, par groupe de 30 résultats.

Paramètres optionnels

  • page : numéro de page
  • title : recherche partielle sur le libellé du suivi
  • status : rechercher par type de suivi (i.e. type d'affectation)

Remarques:

Il existe deux codes de suivis gérés par le système, qui sont non modifiables et non supprimables, et qui n'apparaissent donc pas dans la liste des suivis que vous avez défini. Il s'agit des codes suivants:

  • En cours (id: 0)
  • Terminé (id: -1)

Ces codes s'utilisent sur les devis et les factures comme n'importe lequel de vos suivis personnalisés, en utilisant l'id indiqué ci dessus dans le champs followup_id du devis ou de la facture.

Requête

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

Réponse

[{
  "id": 4866,
  "status": 1,
  "title": "A facturer"
}, {
  "id": 4867,
  "status": 0,
  "title": "A relancer"
}, {
  "id": 4857,
  "status": 2,
  "title": "Envoyer produits"
}]

Détail d'un suivi commercial

GET /firms/FIRM_ID/followups/ID.json

Affiche le détail du suivi n° ID

Requête

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

Réponse

{
  "id": 1,
  "status": 1,
  "title": En attente de facturation
}

Créer un suivi commercial

POST /firms/FIRM_ID/followups.json

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

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 '{"title":"En attente de réponse","status":"1"}' \
 https://www.facturation.pro/firms/FIRM_ID/followups.json

Réponse

Status: 201 Created
Location: /firms/FIRM_ID/followups/1234.json
...
{
  "id": 1234,
  "status": 1,
  "title": "En attente de réponse"
}

Modifier un suivi commercial

PATCH /firms/FIRM_ID/followups/ID.json

Mise à jour d'un suivi 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 '{"title":"Relancer le client","status":"2"}' \
 https://www.facturation.pro/firms/FIRM_ID/followups/1.json

Réponse

Status: 200 OK

Supprimer un suivi commercial

DELETE /firms/FIRM_ID/followups/ID.json

Supprime le suivi commercial identifié par son ID. Cette opération ne supprime pas les documents rattachés à ce suivi.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X DELETE \
 https://www.facturation.pro/firms/FIRM_ID/followups/1.json

Réponse

Status: 200 OK

Liste des champs

Champs Libellé Type Accès
id Identifiant int(11) lecture seule
title Libellé string(255) lecture/écriture
status Affectation int(11) lecture/écriture
created_at Créé le datetime(3) lecture seule
updated_at Modifié le datetime(3) lecture seule

Champs utilisant des valeurs spécifiques

status

0 : Devis/Factures
1 : Devis uniquement
2 : Factures uniquement