Liste des champs
Certains champs peuvent avoir des valeurs spécifiques
| Champs | libellé | Type | Accès |
|---|---|---|---|
| id | Identifiant | int(11) | lecture |
| customer_id | Client | int(11) | modifiable |
| customer_identity | Nom de la société ou du client | string(255) | lecture |
| title | Objet | string(255) | modifiable |
| language | Langue du PDF | string(2) | modifiable |
| category_id | Catégorie | int(11) | modifiable |
| followup_id | Suivi commercial | int(11) | modifiable |
| invoiced_on | Date facture | date | modifiable |
| term_on | Date d’échéance | date | modifiable |
| draft | Brouillon | boolean | lecture |
| total | Montant total HT | decimal(15,3) | lecture |
| total_with_vat | Montant total TTC | decimal(15,3) | lecture |
| currency | Devise | string(3) | modifiable |
| rebate_percentage | Réduction globale | decimal(8,3) | modifiable |
| exchange_rate | Taux de change | lecture | |
| estimated_rate | Taux de change estimé? | lecture | |
| vat_exemption | Motif d’exonération de TVA | string(255) | modifiable |
| vat_country | Code pays des taux TVA à appliquer | string(2) | modifiable |
| tax_title | Intitulé de la taxe additionnelle sur le total HT | string(255) | modifiable |
| tax_percent | Pourcentage de la taxe additionnelle sur le total HT | decimal(5,2) | modifiable |
| penalty | Pénalités de retard | decimal(8,3) | modifiable |
| pay_before | Délai de paiement | string(16) | modifiable |
| discount | Taux d’escompte | decimal(8,3) | modifiable |
| precompte | Précompte des cotisations | boolean | modifiable |
| activity_title | Nature de l’activité | string(255) | modifiable |
| service_personne | Service à la personne | boolean | modifiable |
| accounting_entry | Compte d’imputation | string(8) | modifiable |
| information | Informations complémentaires | text | modifiable |
| internal_note | Note interne | text | modifiable |
| purchase_number | Bon de commande | string(100) | modifiable |
| created_at | Créé le | datetime(3) | lecture |
| updated_at | Modifié le | datetime(3) | lecture |
| user_id | Géré par | int(11) | modifiable |
| public_download_url | Url de téléchargement publique | string(255) | lecture |
| items | Lignes de facturation | array | modifiable |
| files | Fichiers joints | array | lecture |
| api_id | API - Référence numérique libre | bigint(20) | modifiable |
| api_custom | API - Texte libre | string(255) | modifiable |
| soft_deleted | Enregistrement marqué comme à supprimer | boolean | lecture |
| hard_delete_on | Date définitive de la suppression | date | lecture |
| delivery_on | Livré/Réalisé le | date | modifiable |
| quote_id | ID Devis associé | int(11) | lecture |
| invoice_ref | N° de facture | string(128) | lecture |
| external_ref | N° de facture externe | string(255) | modifiable |
| full_invoice_ref | N° de facture intégral (incluant le prefixe) | string(140) | lecture |
| payment_mode | Mode de règlement | int(11) | modifiable |
| paid_on | Payé le | date | modifiable |
| payment_ref | Référence du paiement | string(255) | modifiable |
| paid_in_main_currency | Equivalent du total TTC en euros | decimal | modifiable |
| estimated_total_in_main_currency | Total TTC estimé en euro | decimal | lecture |
| refund_id | Avoir sur la facture n°ID Si la facture est un avoir généré via notre système automatisé, ce champ contient l’ID de la facture annulée | int(11) | lecture |
| pay_url | Url de paiement en ligne (option GOLD requise) | lecture | |
| balance | Montant restant dû | lecture | |
| external | Facture externe | boolean | lecture |
| overdue_at | Dernière relance | datetime | modifiable |
| settlements | Liste des règlements | array | lecture |
| recurring_invoice_id | ID de la facture récurrente associée | int(11) | lecture |
Ligne de facturation
Les lignes de facturations sont transmises sous forme d’un tableau de lignes, dans le champ items de la facture
Certains champs peuvent avoir des valeurs spécifiques
| Champs | libellé | Type | Accès |
|---|---|---|---|
| id | Identifiant | int(11) | modifiable |
| quantity | Quantité | decimal(12,4) | modifiable |
| measure | Unité de mesure | string(32) | modifiable |
| title | Libellé | text | modifiable |
| unit_price | Prix unitaire HT | decimal(15,3) | modifiable |
| vat | Taux de TVA | decimal(5,3) | modifiable |
| product_id | Identifiant du produit | int(11) | modifiable |
| position | Ligne n° | int(11) | modifiable |
| total | Total HT | decimal(15,3) | lecture |
| optional | En option Ce champ n’est utilisé que pour les devis. Lorsque la valeur de ce champ est ‘true’, la ligne est considérée comme une option, elle n’est donc pas prise en compte dans le calcul du total, et toutes les lignes optionnelles sont regroupées en fin de devis dans un bloc spécifique. | boolean | modifiable |
| style | Style de formattage Par défaut (ie valeur vide), ce champ indique une ligne de facturation standard. La valeur ‘comment’ permet d’indiquer qu’il s’agit d’une ligne de commentaire, la valeur ‘title’ permet d’indiquer une ligne de titre (mise en gras automatiquement), la value ‘subtotal’ permet d’indiquer une ligne de sous-total et la valeur ‘new_page’ permet d’indiquer un saut de page. | string(20) | modifiable |
| nature | Type la nature de la prestation n’est à préciser que pour les auto-entrepreneurs et les micro-entrepreneurs, afin de calculer correctement les cotisations sociales. | int(11) | modifiable |
| sap_nature | Code activité Le code d’activité d’une prestation de service à la personne ne doit être précisé que s’il s’agit d’une facture de service à la personne | modifiable |