Documentation Frappe Framework

{
  "doctype": "DocType",
  "name": "Client",
  "module": "MonApp",
  "autoname": "field:nom_client",
  "fields": [
    {
      "fieldname": "nom_client",
      "fieldtype": "Data",
      "label": "Nom du Client",
      "reqd": 1
    },
    {
      "fieldname": "email",
      "fieldtype": "Data",
      "label": "Email",
      "options": "Email"
    },
    {
      "fieldname": "telephone",
      "fieldtype": "Phone",
      "label": "Téléphone"
    },
    {
      "fieldname": "actif",
      "fieldtype": "Check",
      "label": "Actif",
      "default": "1"
    }
  ],
  "permissions": [
    {
      "role": "System Manager",
      "read": 1, "write": 1, "create": 1, "delete": 1
    }
  ]
}

import frappe
from frappe.model.document import Document

class Client(Document):
    def before_save(self):
        # Appelé avant chaque sauvegarde
        self.nom_client = self.nom_client.strip().title()

    def after_insert(self):
        # Appelé après la création (INSERT)
        frappe.sendmail(
            recipients=[self.email],
            subject="Bienvenue",
            message=f"Bonjour {self.nom_client}!"
        )

    def validate(self):
        # Validation avant sauvegarde
        if not self.email and not self.telephone:
            frappe.throw("Email ou téléphone obligatoire")

app_name = "monapp"
app_title = "Mon Application"

# Injecter du CSS/JS dans toutes les pages
app_include_css = "/assets/monapp/css/monapp.css"
app_include_js  = "/assets/monapp/js/monapp.js"

# Scripts JS associés à des DocTypes
doctype_js = {
    "Facture de vente": "public/js/facture_vente.js",
    "Client":           "public/js/client.js",
}

# Tâches planifiées
scheduler_events = {
    "daily":   ["monapp.tasks.rapport_quotidien"],
    "hourly":  ["monapp.tasks.sync_externe"],
    "weekly":  ["monapp.tasks.nettoyage_logs"],
}

# Surcharger des permissions globales
permission_query_conditions = {
    "Client": "monapp.utils.get_client_conditions",
}

# Fixtures (données exportées avec l'app)
fixtures = ["Custom Field", "Property Setter"]

# Récupérer la liste des clients
curl -H "Authorization: token api_key:api_secret" \
  "https://monsite.erpsys.ovh/api/resource/Customer?limit=10"

# Créer un client
curl -X POST \
  -H "Authorization: token api_key:api_secret" \
  -H "Content-Type: application/json" \
  -d '{"customer_name": "ACME Corp", "customer_type": "Company"}' \
  "https://monsite.erpsys.ovh/api/resource/Customer"

# Appeler une méthode personnalisée
curl -X POST \
  -H "Authorization: token api_key:api_secret" \
  -H "Content-Type: application/json" \
  -d '{"post_name": "POST-001"}' \
  "https://monsite.erpsys.ovh/api/method/monapp.api.publish_post"

import frappe

# ── Lire / écrire des documents ──────────────────────────────────
doc = frappe.get_doc("Client", "ACME Corp")
doc.email = "[email protected]"
doc.save()

# Créer un nouveau document
new_doc = frappe.get_doc({
    "doctype": "Client",
    "nom_client": "Nouvelle Entreprise",
    "email": "[email protected]"
})
new_doc.insert()

# ── Requêtes base de données ──────────────────────────────────────
# Récupérer une valeur unique
email = frappe.db.get_value("Client", "ACME Corp", "email")

# Récupérer plusieurs documents
clients = frappe.db.get_all("Client",
    filters={"actif": 1},
    fields=["name", "nom_client", "email"],
    limit=50
)

# SQL brut (à éviter sauf nécessité)
results = frappe.db.sql("SELECT name FROM `tabClient` WHERE actif=1", as_dict=True)

# ── Utilitaires ────────────────────────────────────────────────────
frappe.throw("Message d'erreur — arrête l'exécution")
frappe.msgprint("Message informatif")
frappe.log_error("Détail erreur", title="Titre erreur")

# Vérifier la permission de l'utilisateur courant
frappe.only_for("System Manager")  # lève une exception si pas ce rôle

# Mettre en cache
frappe.cache().set_value("ma_cle", {"data": 123}, expires_in_sec=300)
val = frappe.cache().get_value("ma_cle")

frappe.ui.form.on('Client', {
    // Déclenché à l'ouverture du formulaire
    refresh(frm) {
        // Ajouter un bouton personnalisé
        if (!frm.is_new()) {
            frm.add_custom_button('Envoyer Email', () => {
                frappe.call({
                    method: 'monapp.api.envoyer_email_bienvenue',
                    args: { client_name: frm.doc.name },
                    callback(r) {
                        frappe.show_alert({ message: 'Email envoyé !', indicator: 'green' });
                    }
                });
            }, 'Actions');
        }
    },

    // Déclenché quand le champ "email" change
    email(frm) {
        if (frm.doc.email && !frm.doc.email.includes('@')) {
            frappe.msgprint('Email invalide');
            frm.set_value('email', '');
        }
    },

    // Avant sauvegarde (côté client)
    before_save(frm) {
        frm.set_value('nom_client', frm.doc.nom_client.toUpperCase());
    }
});

def execute(filters=None):
    columns = [
        {"label": "Client", "fieldname": "client", "fieldtype": "Link", "options": "Customer", "width": 200},
        {"label": "Montant Total", "fieldname": "total", "fieldtype": "Currency", "width": 150},
    ]
    data = frappe.db.sql("""
        SELECT customer_name as client, SUM(grand_total) as total
        FROM `tabSales Invoice`
        WHERE docstatus=1
        GROUP BY customer_name
        ORDER BY total DESC
    """, as_dict=True)
    return columns, data