Liste des fournisseurs
GET /firms/FIRM_ID/suppliers.json
liste des fournisseurs, 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é
- 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.
Tri
Par défaut, les fournisseurs 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
- 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/suppliers.json"
Réponse
[{
"account_code": "401AMAZON",
"category_id": 4855,
"city": "",
"civility": null,
"company_name": "amazon",
"country": null,
"email": null,
"fax": "",
"first_name": "",
"id": 49091,
"last_name": "",
"mobile": "",
"notes": "",
"phone": "",
"short_name": "amazon",
"siret": null,
"street": "",
"vat_number": null,
"website": null,
"zip_code": ""
}, {
"account_code": "401APPLE",
"category_id": 4857,
"city": "",
"civility": null,
"company_name": "apple",
"country": null,
"email": null,
"fax": "",
"first_name": "",
"id": 49090,
"last_name": "",
"mobile": "",
"notes": "",
"phone": "",
"short_name": "apple",
"siret": null,
"street": "",
"vat_number": null,
"website": null,
"zip_code": ""
}]
Détail d'un fournisseur
GET /firms/FIRM_ID/suppliers/ID.json
Affiche le détail du fournisseur 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/suppliers/ID.json"
Réponse
{
"account_code": "401APPLE",
"category_id": 4857,
"city": "",
"civility": null,
"company_name": "apple",
"country": null,
"email": null,
"fax": "",
"first_name": "",
"id": 49090,
"last_name": "",
"mobile": "",
"notes": "",
"phone": "",
"short_name": "apple",
"siret": null,
"street": "",
"vat_number": null,
"website": null,
"zip_code": ""
}
Créer un fournisseur
POST /firms/FIRM_ID/suppliers.json
Création d'un nouveau fournisseur. On obtient en retour le code JSON du fournisseur 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 '{"company_name":"Office Depot"}' \
"https://www.facturation.pro/firms/FIRM_ID/suppliers.json"
Réponse
Status: 201 Created
Location: /firms/FIRM_ID/suppliers/49097.json
{
"account_code": "401OFFICEDE",
"category_id": null,
"city": null,
"civility": null,
"company_name": "Office Depot",
"country": null,
"email": null,
"fax": null,
"first_name": null,
"id": 49097,
"last_name": null,
"mobile": null,
"notes": null,
"phone": null,
"short_name": "Office Depot",
"siret": null,
"street": null,
"vat_number": null,
"website": null,
"zip_code": null
}
Modifier un fournisseur
PATCH /firms/FIRM_ID/suppliers/ID.json
Mise à jour d'un fournisseur.
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 '{"city":"Palo Alto","country":"US","street": "1 infinite loop"}' \
"https://www.facturation.pro/firms/FIRM_ID/suppliers/ID.json"
Réponse
Status: 200 OK
Supprimer un fournisseur
DELETE /firms/FIRM_ID/suppliers/ID.json
Supprime le fournisseur identifié par son ID, ainsi que tous les achats associés à ce fournisseur.
Remarque
certains fournisseurs sont gérés automatiquement par l'application (RSI, URSSAF, Facturation.pro, ...) et ne peuvent pas être supprimé dès lors que des achats ont été enregistrés pour ce fournisseur. Ces fournisseurs sont créés (ou recréés en cas de suppression) par le système quand c'est nécessaire.
Requête
curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
-X DELETE \
"https://www.facturation.pro/firms/FIRM_ID/suppliers/ID.json"
Réponse
Status: 200 OK
Liste des champs
Champs | Libellé | Type | Accès |
---|---|---|---|
id | Identifiant | int(11) | lecture seule |
company_name | Société | string(255) | lecture/écriture |
civility | Civilité | string(255) | lecture/écriture |
first_name | Prénom | string(255) | lecture/écriture |
last_name | Nom | string(255) | lecture/écriture |
short_name | Nom mnémotechnique | string(255) | lecture/écriture |
street | Adresse de facturation | string(255) | lecture/écriture |
city | Ville | string(255) | lecture/écriture |
zip_code | Code postal | string(20) | lecture/écriture |
country |
Pays
Code ISO à 2 lettres du pays, en majuscules |
string(2) | lecture/écriture |
phone | Téléphone | string(255) | lecture/écriture |
fax | Fax | string(255) | lecture/écriture |
text | lecture/écriture | ||
mobile | Mobile | string(255) | lecture/écriture |
website | Site web | string(255) | lecture/écriture |
notes | Notes internes | text | lecture/écriture |
vat_number | N° TVA | string(30) | lecture/écriture |
siret | Siret | string(100) | lecture/écriture |
category_id | Catégorie | int(11) | lecture/écriture |
account_code | Compte fournisseur | string(11) | lecture/écriture |
accounting_entry | Compte d'imputation | string(8) | lecture/écriture |
created_at | Créé le | datetime(3) | lecture seule |
updated_at | Modifié le | datetime(3) | lecture seule |
sepa_iban |
IBAN
Lecture autorisée uniquement avec la clé API de l'administrateur de l'entreprise |
string(34) | lecture/écriture |
sepa_bic |
BIC
Lecture autorisée uniquement avec la clé API de l'administrateur de l'entreprise |
string(11) | lecture/écriture |
sepa_rum |
RUM
Lecture autorisée uniquement avec la clé API de l'administrateur de l'entreprise |
lecture/écriture | |
sepa_signature_on |
Date de signature du mandat SEPA
Lecture autorisée uniquement avec la clé API de l'administrateur de l'entreprise |
lecture/écriture | |
api_id | API - Référence numérique libre | bigint(20) | lecture/écriture |
api_custom | API - Texte libre | string(255) | lecture/écriture |
reverse_charge | Auto-liquidation | boolean | lecture/écriture |
soft_deleted | Enregistrement marqué comme à supprimer | boolean | lecture seule |
hard_delete_on | Date définitive de la suppression | date | lecture seule |