Liste des pièces jointes aux devis

GET /firms/FIRM_ID/assets/quotes.json

Liste de toutes les pièces jointes aux devis, par groupe de 30 résultats.

Paramètres optionnels

  • page : numéro de page
  • quote_id : ID du devis, cela permet de récupérer la liste des pièces jointes d'un devis spécifique, sachant que cette liste est aussi renvoyée dans la requête permettant d'obtenir le détail d'un devis.

Tri

Par défaut, les pièces jointes sont triées par ordre décroissant de création.
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
    • title: tri par nom de fichier
    • size: tri par taille de fichier
    • updated: tri par date de mise à jour
    • created: tri par date de création

Requête

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

Réponse

[{
  "id": 1,
  "quote_id": 1,
  "document_content_type": "application/pdf",
  "document_file_name": "contrat prestation.pdf",
  "document_file_size": 18884,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/1/download",
  "title": "Devis n°1"
},
{
  "id": 2,
  "quote_id": 2,
  "document_content_type": "application/pdf",
  "document_file_name": "contrat vente.pdf",
  "document_file_size": 33442,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/2/download",
  "title": "Devis n°2"
}]

Liste des pièces jointes aux facture

GET /firms/FIRM_ID/assets/invoices.json

Liste de toutes les pièces jointes aux factures, par groupe de 30 résultats.

Paramètres optionnels

  • page : numéro de page
  • invoice_id : ID de de la facture, cela permet de récupérer la liste des pièces jointes d'une facture spécifique, sachant que cette liste est aussi renvoyée dans la requête permettant d'obtenir le détail d'une facture.

Tri

Par défaut, les pièces jointes sont triées par ordre décroissant de création.
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
    • title: tri par nom de fichier
    • size: tri par taille de fichier
    • updated: tri par date de mise à jour
    • created: tri par date de création

Requête

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

Réponse

[{
  "id": 1,
  "invoice_id": 1,
  "document_content_type": "application/pdf",
  "document_file_name": "contrat prestation.pdf",
  "document_file_size": 18884,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/1/download",
  "title": "Facture n°1"
},
{
  "id": 2,
  "invoice_id": 2,
  "document_content_type": "application/pdf",
  "document_file_name": "contrat vente.pdf",
  "document_file_size": 33442,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/2/download",
  "title": "Facture n°2"
}]

Liste des pièces jointes aux achats

GET /firms/FIRM_ID/assets/purchases.json

Liste de toutes les pièces jointes aux achats, par groupe de 30 résultats.

Paramètres optionnels

  • page : numéro de page
  • purchase_id : ID de l'achat, cela permet de récupérer la liste des pièces jointes d'un achat spécifique, sachant que cette liste est aussi renvoyée dans la requête permettant d'obtenir le détail d'un achat.

Tri

Par défaut, les pièces jointes sont triées par ordre décroissant de création.
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
    • title: tri par nom de fichier
    • size: tri par taille de fichier
    • updated: tri par date de mise à jour
    • created: tri par date de création

Requête

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

Réponse

[{
  "id": 1,
  "purchase_id": 1,
  "document_content_type": "application/pdf",
  "document_file_name": "facture_123.pdf",
  "document_file_size": 18884,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/1/download",
  "title": "Location serveur dédié"
},
{
  "id": 2,
  "purchase_id": 2,
  "document_content_type": "application/pdf",
  "document_file_name": "bill_321.pdf",
  "document_file_size": 33442,
  "download_url": "https://www.facturation.pro/firms/FIRM_ID/assets/2/download",
  "title": "Comptabilité 05/2014"
}]

Ajouter une pièce jointe

Pour ajouter une pièce jointe, consultez la documentation de la fonction upload pour chaque type de document (ie devis, facture et achat).

Supprimer une pièce jointe

DELETE /firms/FIRM_ID/assets/ID.json

Supprime la pièce jointe identifiée par son ID.

Requête

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

Réponse

Status: 200 OK