Référentiel des variables disponibles (personnalisation des documents 2/2)

Publication : 05 Feb 2010. Dernière mise à jour : 09 Sep 2011.

iScriba reconnait 4 types de gabarit de document : facture, devis, bon de commande et bon de livraison. Selon le type de gabarit, différentes variables contenant les données du document sont accessibles avec la syntaxe Liquid.

Certaines de ces variables sont des collections dans lesquels vous pouvez boucler avec la syntaxe suivante :


{% for element in collection %}{% endfor %}

Les collections sont noté ici sous forme d’éléments de liste imbriqués. En supposant que vous souhaitez accéder à un élément imbriqué (comme le nom de l’entreprise pour votre compte), vous utilisez le code suivant :


{{ account.company.name }}

Variables

Language

Contient la langue du document selon le contexte ("english" ou "french").

Account

company
- name
- tax_id
- address1
- address2
- address3
- address4
- city
- state
- postalcode
- country
- webaddress
- phone
- fax
- email
logo
- full_path
- image_height
- image_width
- full_path_thumb
- image_height_thumb
- image_width_thumb
tax_name
alt_tax_name
tax_id_name

Client

name
tax_id
address1
address2
address3
address4
city
state
postalcode
country

Document

Dans le cas d’une facture :

kind
(“invoice”)
date
number
status
summary
line_items_colspan
line_items
(collection des articles de la facture)
- kind
- description
- qty
- tax_percentage
- alt_tax_percentage
- unit_price
- reduction_percentage
- total
line_items_count
footer
global_discount_total
global_discount_percentage
sub_total
tax_total
tax_name
tax_percentage
alt_tax_total
alt_tax_name
alt_tax_percentage
total
grand_total
due_total
currency
currency_name
has_reduction
has_tax
terms
custom_terms
payments
- line_items
  (collection des paiements de la facture)
  - delete_action
  - date
  - method
  - reference
  - notes
  - amount
- line_items_count
payments_total
type
(“standard” ou “refund” dans le cas d’un avoir)
due_date
notes
related_invoice_number
related_purchaseorder_number
related_estimate_number

Dans le cas d’un devis :

kind
(“estimate”)
date
number
status
summary
line_items_colspan
line_items
(collection des articles du devis)
- kind
- description
- qty
- tax_percentage
- alt_tax_percentage
- unit_price
- reduction_percentage
- total
line_items_count
footer
global_discount_total
global_discount_percentage
sub_total
tax_total
tax_name
tax_percentage
alt_tax_total
alt_tax_name
alt_tax_percentage
total
grand_total
due_total
currency
currency_name
has_reduction
has_tax
terms
custom_terms
expiry_date
introduction
terms_of_agreement

Dans le cas d’un bon de commande :

kind
(“purchaseorder”)
date
number
status
summary
line_items_colspan
line_items
(collection des articles du bon de commande)
- kind
- description
- qty
- tax_percentage
- alt_tax_percentage
- unit_price
- reduction_percentage
- total
line_items_count
footer
global_discount_total
global_discount_percentage
sub_total
tax_total
tax_name
tax_percentage
alt_tax_total
alt_tax_name
alt_tax_percentage
total
grand_total
due_total
currency
currency_name
has_reduction
has_tax
has_alt_tax
terms
custom_terms
related_estimate_number
terms_of_agreement

Dans le cas d’un bon de livraison :

kind
(“packinglist”)
date
number
status
summary
line_items_colspan
line_items
(collection des articles du bon de livraison)
- kind
- description
- weight
- qty_shipped
line_items_count
footer
has_weight
mass_unit
shipped_total
packages_total
weight_total
related_invoice_number
related_purchaseorder_number
carrier_name
tracking_number
tracking_url