Variables

Pour afficher les valeurs liées au document dans votre modèle, vous devez utiliser des variables. La section suivante répertorie toutes les variables disponibles dans votre document.

Pour afficher la valeur d'une variable, insérez simplement {{variable_name}} dans le code de votre thème.

Compte

Voici les variables disponibles sur l'objet account :

Nom
Type
Description

account.logo_url

String

L'URL du logo de votre compte

account.company_name

String

Le nom de votre compte

account.address_line_1

String

La 1ère ligne d'adresse de votre compte

account.address_line_2

String

La 2ème ligne d'adresse de votre compte

account.zip_code

String

Le code postal de l'adresse de votre compte

account.city

String

La ville de l'adresse de votre compte

account.country_name

String

Le pays de l'adresse de votre compte

account.vat_number

String

Le numérot de TVA de votre compte

account.phone_number

String

Le numéro de téléphone de votre compte

account.email

String

L'adresse email de votre compte

account.bank_account_number

String

Le numéro de compte bancaire de votre compte

account.bic

String

Le numéro BIC (Bank Identifier Code) de votre compte

Document

Voici les variables disponibles sur l'objet document :

Important

Certaines variables du document ne sont disponibles que pour certains types de documents. Le tableau suivant indique la disponibilité pour chaque type de document (facture, devis ou note de crédit).

Nom
Type
Facture
Devis
Note de crédit
Description

document.company

Object

Oui

Oui

Oui

La société du document. Voir la section société du document plus d'informations.

document.number

String

Oui

Oui

Oui

Le numéro du document

document.issue_date

Date

Oui

Oui

Oui

La date d'envoi du document

document.due_date

Date

Oui

La date d'échéance du document

document.expiration_date

Date

Oui

La date d'expiration du document

document.name

String

Oui

Oui

Oui

Le nom du document

document.top_text

Text

Oui

Oui

Oui

Le texte d'entête du document

document.lines

Array

Oui

Oui

Oui

Les lignes du document. Voir la section lignes du document pour plus d'informations

document.sub_total_without_vat

Decimal

Oui

Oui

Oui

Le sous total HTVA du document, sans la réduction appliquée

document.discount_total

Decimal

Oui

Oui

Oui

Le montant de la réduction

document.discount?

Boolean

Oui

Oui

True si le document a une réduction

document.total_without_vat

Decimal

Oui

Oui

Oui

Le montant total HTVA du document avec la réduction appliquée si il y en a une

document.vat_totals

Array

Oui

Oui

Oui

Les taux de TVA du document. Voir la section totaux de TVA du document pour plus d'informations

document.bottom_text

Text

Oui

Oui

Oui

Le texte de bas de page du document

document.permalink

Text

Oui

Oui

Oui

L'URL vers votre document. Seulement disponible dans les textes des emails

document.invoice?

Boolean

Oui

Oui

Oui

True si le document est une facture

document.estimate?

Boolean

Oui

Oui

Oui

True si le document est un devis

document.credit_note?

Boolean

Oui

Oui

Oui

True si le document est une note de crédit

La société du document

Voici les variables disponibles sur l'objet document.company :

Nom
Type
Description

document.company.name

String

Le nom de la société

document.company.number

String

Le numéro de la société

document.company.address_line_1

String

La 1ère ligne d'adresse de la société

document.company.address_line_2

String

Le 2ème ligne d'adresse de la société

document.company.zip_code

String

Le code postal de l'adresse de la société

document.company.city

String

La ville de l'adresse de la société

document.company.country_name

String

Le pays de l'adresse de la société

document.company.vat_number

String

Le numéro de TVA de la société

document.company.phone_number

String

Le numéro de téléphone de la société

Lignes du document

Voici les variables disponibles pour chaque objet du tableau document.lines :

Nom
Type
Description

line.quantity

String

La quantité de la ligne

line.unit_price

Decimal

Le prix unitaire de la ligne

line.vat_rate

Decimal

Le taux de TVA de la ligne

line.total_without_vat

Decimal

Le total HTVA de la ligne

line.total_with_vat

Decimal

Le total TVAC de la ligne

line.description

String

La description de la ligne

line.divider?

Boolean

True si la ligne est un séparateur

line.product?

Boolean

True si la ligne a un produit associé

line.product

Object

Le produit associé à la ligne

Produit d'une ligne du document

Voici les variables disponibles sur l'objet line.product :

Nom
Type
Description

line.product.name

String

Le nom du produit

line.product.reference

String

La référence du produit

Les totaux de TVA du document

Voici les variables disponibles pour chaque objet du tableau document.vat_totals :

Name
Type
Description

vat_total.percentage

String

Le pourcentage du total TVA

vat_total.base_amount

Decimal

Le montant de base du total TVA

vat_total.amount

Decimal

Le montant TVA du total TVA

Numérotation de page

Utilisez cette syntaxe spécifique pour afficher le numéro de page actuel et le numéro total de page. Notez qu'il ne s'agit pas de balisage Liquid.

<p>Page $[page] of $[total]</p>

Mis à jour