Liste des catégories

GET /firms/FIRM_ID/categories.json

liste des catégories, par groupe de 30 résultats.

Paramètres optionnels

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

Requête

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

Réponse

[{
  "id": 4866,
  "status": 2,
  "title": "Affranchissement"
}, {
  "id": 4867,
  "status": 1,
  "title": "Publicite"
}, {
  "id": 4857,
  "status": 2,
  "title": "Banque"
}, {
  "id": 4848,
  "status": 1,
  "title": "Conseil"
}]

Détail d'une categorie

GET /firms/FIRM_ID/categories/ID.json

Affiche le détail de la catégorie n° ID

Requête

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

Réponse

{
  "id": 1,
  "status": 2,
  "title": "Affranchissement"
}

Créer une categorie

POST /firms/FIRM_ID/categories.json

Création d'une nouvelle catégorie. On obtient en retour le code JSON de la catégorie 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":"Prestation de services","status":"1"}' \
 https://www.facturation.pro/firms/FIRM_ID/categories.json

Réponse

Status: 201 Created
Location: /firms/FIRM_ID/categories/5010.json
...
{
  "id": 5010,
  "status": 1,
  "title": "Prestation de services"
}

Modifier une categorie

PATCH /firms/FIRM_ID/categories/ID.json

Mise à jour d'une catégorie existante.

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":"Affranchissement postal","status":"2"}' \
 https://www.facturation.pro/firms/FIRM_ID/categories/1.json

Réponse

Status: 200 OK

Supprimer une categorie

DELETE /firms/FIRM_ID/categories/ID.json

Supprime la catégorie identifiée par son ID. Cette opération ne supprime pas les documents rattachés à cette catégorie.

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/categories/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 tinyint(4) 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 : Achats/Ventes
2 : Achats uniquement
1 : Ventes uniquement