PDF Templates

PDF templates control the design and layout of generated documents (invoices, orders, estimates, etc.).

Available fields

PdfTemplate

Field	Type	Description
`id`	Int	Unique identifier.
`label`	String	Template name.
`document_type`	PdfTemplateType	Target document type.
`pdf_settings`	JSON	PDF configuration settings.
`active`	Boolean	Whether this template is active.
`default`	Boolean	Whether this is the default template for its type.
`logo`	File	Template logo.

Enums

PdfTemplateType

Value	Description
`estimate`	Estimate template.
`order`	Sales order template.
`shipping_order`	Shipping order template.
`invoice`	Invoice template.
`product_return`	Product return template.
`credit_note`	Credit note template.
`refund`	Refund template.
`purchase`	Purchase order template.
`purchase_receipt`	Purchase receipt template.
`stock_adjustment`	Stock adjustment template.
`stock_entry`	Stock entry template.
`stock_removal`	Stock removal template.
`stock_transfer`	Stock transfer template.
`picking_list`	Picking list template.

PdfTemplate

Returns a single PDF template by id.

query GetPdfTemplate($id: ID!) {
  PdfTemplate(id: $id) {
    id
    label
    document_type
    pdf_settings
    active
    default
    logo {
      id
      label
      public_path
    }
  }
}

PdfTemplates

Returns a paginated list of PDF templates with sorting and filters.

query PdfTemplates(
  $active: Boolean
  $orderBy: [QueryPdfTemplatesOrderByOrderByClause!]
  $where: QueryPdfTemplatesWhereWhereConditions
  $search: String
) {
  PdfTemplates(
    active: $active
    orderBy: $orderBy
    where: $where
    search: $search
  ) {
    id
    label
    document_type
    active
    default
  }
}

Filters

The following fields can be used in the where parameter:

id, label, document_type, active, company_id, created_at, updated_at.

Sorting

You can sort results using the orderBy parameter:

id
label
document_type

PDF Settings

Le champ pdf_settings contient la configuration du template PDF. Voici toutes les options disponibles.

Affichage des produits

Option	Type	Défaut	Description
`displaySKU`	Boolean	`true`	Afficher le SKU
`displaySkuInSeparateColumn`	Boolean	`false`	SKU dans une colonne séparée
`displayProductDescription`	Boolean	`false`	Afficher la description produit
`displayProductWeight`	Boolean	`false`	Afficher le poids
`displayTotalWeight`	Boolean	`false`	Afficher le poids total
`displayProductPicture`	Boolean	`false`	Afficher l'image produit
`displayProductLargePicture`	Boolean	`false`	Image en grande taille
`productPictureSize`	String	`small`	Taille de l'image (small, medium, large)
`displayProductTags`	Boolean	`false`	Afficher les tags
`displayProductBrand`	Boolean	`false`	Afficher la marque
`displayProductCountryOfOrigin`	Boolean	`false`	Afficher le pays d'origine
`displayProductSubtotal`	Boolean	`false`	Afficher le sous-total produit

Affichage des kits/composants

Option	Type	Défaut	Description
`displayKitComponents`	Boolean	`true`	Afficher les composants du kit
`displayKitComponentsSku`	Boolean	`false`	Afficher le SKU des composants
`displayKitComponentDetails`	Boolean	`false`	Détails des composants
`displayKitComponentDetails.document`	Array	[estimate, order, invoice, credit_note, refund, purchase, purchase_receipt]	Types de documents concernés

Codes-barres et emplacements

Option	Type	Défaut	Description
`displayBarcode`	Boolean	`false`	Afficher le code-barres
`displayBarcodePicture`	Boolean	`false`	Afficher l'image du code-barres
`displayBinLocation`	Boolean	`false`	Afficher l'emplacement bin
`displayBinLocation.document`	Array	[purchase_receipt]	Types de documents concernés

Mise en page

Option	Type	Défaut	Description
`paperSize`	String	`A4`	Taille du papier (A4, Letter, etc.)
`topMargin`	Number	`1`	Marge supérieure
`layout`	String	`classic`	Mise en page
`primaryColor`	String	`rgb(106, 106, 106)`	Couleur principale
`borderRadius`	String	`light`	Arrondi des bordures

Étiquettes multilingues

Les étiquettes sont des objets avec des clés pour chaque langue : EN, FR, NL, DE, IT, ES, SV.

Option	Type	Description
`label`	Object	Étiquettes custom
`subtotalLabel`	Object	Étiquette sous-total
`totalLabel`	Object	Étiquette total
`discountLabel`	Object	Étiquette remise
`creditLabel`	Object	Étiquette crédit
`draftInvoiceLabel`	Object	Étiquette facture proforma
`totalUnitsLabel`	Object	Étiquette unités totales
`taxNumberLabel`	Object	Étiquette numéro TVA
`companyRegistrationNumberLabel`	Object	Étiquette numéro registration
`externalReferenceLabel`	Object	Étiquette référence externe
`language`	String	Langue du template

Informations entreprise

Option	Type	Défaut	Description
`overrideCompanyName`	Boolean	`false`	Override le nom entreprise
`companyName`	String	`''`	Nom entreprise personnalisé
`overrideCompanyAddress`	Boolean	`false`	Override l'adresse
`companyAddress`	Array	`[]`	Adresse personnalisée
`overrideCompanyLogo`	Boolean	`false`	Override le logo
`companyLogoId`	String	`''`	ID du logo
`overrideCompanyTermsAndConditions`	Boolean	`false`	Override les CGV
`termsAndConditions`	String	`''`	CGV personnalisées
`additionalCompanyInformation`	String	`''`	Infos supplémentaires
`hideTermsAndConditions`	Boolean	`false`	Masquer les CGV

Custom fields

Option	Type	Défaut	Description
`customFieldsHeader`	Array	`[]`	Custom fields dans l'en-tête
`customFieldsFooter`	Array	`[]`	Custom fields dans le pied
`customFieldsProduct`	Array	`[]`	Custom fields produit
`customFieldsVariant`	Array	`[]`	Custom fields variante
`customFieldsCustomer`	Array	`[]`	Custom fields client
`customFieldsSupplier`	Array	`[]`	Custom fields fournisseur

Taxes et remises

Option	Type	Défaut	Description
`hideDiscount`	Boolean	`false`	Masquer la remise
`hideTaxAmount`	Boolean	`false`	Masquer le montant des taxes
`displayTaxSummary`	Boolean	`false`	Afficher le résumé des taxes
`displayTaxCodesInTotal`	Boolean	`false`	Afficher les codes TVA
`displayTaxRate`	Boolean	`false`	Afficher le taux de TVA
`displaySubtotalBeforeDiscount`	Boolean	`false`	Sous-total avant remise
`displayProductUnitPriceWithoutTaxes`	Boolean	`false`	Prix unitaire HT
`addUpTaxesAndLineItemTotal`	Boolean	`false`	Additionner taxes et total ligne
`displayEcotax`	Boolean	`false`	Afficher l'écotaxe
`displayRecommendedRetailPrice`	Boolean	`false`	Afficher le prix de revente conseillé
`recommendedRetailPrice`	Array	`[]`	Prix de revente conseillé

Informations client/fournisseur

Option	Type	Défaut	Description
`displayCustomerEmailAddress`	Boolean	`false`	Afficher l'email client
`displayCustomerNumber`	Boolean	`false`	Afficher le numéro client
`displayCustomerTaxNumber`	Boolean	`false`	Afficher le numéro TVA client
`displayCustomerCompanyRegistrationNumber`	Boolean	`false`	Afficher le numéro registration
`displayCustomerName`	Boolean	`false`	Afficher le nom client
`displayShipToAddress`	Boolean	`false`	Afficher l'adresse de livraison
`displayBillToAddress`	Boolean	`false`	Afficher l'adresse de facturation

Documents liés

Option	Type	Défaut	Description
`displayOrderNumber`	Boolean	`false`	Afficher le numéro de commande
`displayShippingOrderNumber`	Boolean	`false`	Afficher le numéro de shipping
`displayEstimateNumber`	Boolean	`false`	Afficher le numéro de devis
`displayParentDocument`	Boolean	`false`	Afficher le document parent
`displayParentExternalReference`	Boolean	`false`	Référence externe du parent
`displayRemainingUnitsToShip`	Boolean	`false`	Unités restantes à expédier
`displayHSCodes`	Boolean	`false`	Afficher les codes SH
`displayAccountRepresentative`	Boolean	`false`	Afficher le représentant
`displayDocumentSeason`	Boolean	`false`	Afficher la saison
`displayExternalReference`	Boolean	`false`	Afficher la référence externe

Unités et quantités

Option	Type	Défaut	Description
`hideTotalUnits`	Boolean	`false`	Masquer les unités totales
`removeServiceFromTotalUnits`	Boolean	`false`	Exclure les services des unités
`sortLineItemsBy`	String	`weight`	Tri des lignes (weight, etc.)

Batch numbers

Option	Type	Défaut	Description
`displayBatchNumbers`	Boolean	`true`	Afficher les numéros de lot
`displayRemainingUnitsToShip`	Boolean	`false`	Unités restantes à expédier

Options générales

Option	Type	Défaut	Description
`hideDocumentStatus`	Boolean	`false`	Masquer le statut du document
`pageFooter`	String	`''`	Pied de page
`trueFooter`	Boolean	`false`	Vrai pied de page