API Factures

API “FACTURES”

Préréquis

• La fonctionnalité “API” est activée sur votre Scolana
• Vous connaissez votre clé API (ci-dessous api_key).

Guide

https://<votre scolana>.scolana.com/api/invoices?key=api_key

La requête renvoie un objet en format JSON avec les deux clés suivantes :

• invoices : une liste de documents (factures et avoirs), maximum 50 par page
• meta : numéro de la page, nombre de pages total

Chaque élément de la liste invoices contient, entre autres, les clés suivantes :

• id : l’identifiant interne de la fiche
• invoice_number : numéro de la pièce, si émise
• billing_date : date de la pièce, si émise
• issued : date d’émission, si émise
• total : montant total
• total_remaining_due : montant dû
• type : “Invoice” correspond à «facture», “CreditNote” correspond à «avoir»
• download_link : lien pour télécharger le PDF
• client_id : identifiant interne du client
• client_type : “Contact” ou “Organisation” ou “Family”
• original_invoice_id : si c’est un avoir, identifiant de la facture concernée
• created_at : date et heure création fiche
• updated_at : date et heure dernière mise à jour
• invoice_elements : liste d’éléments de facturation (les lignes de la facture)

L’object meta fournit quelques informations concernant la liste, notamment le nombre d’éléments au total, le nombre de pages au total (avec 50 éléments par page), et le numéro de la page en cours

• page : le numéro de cette page
• total_pages : nombre de pages disponibles
• count : nombre d’éléments dans la base