[{"data":1,"prerenderedAt":784},["ShallowReactive",2],{"\u002Fv5\u002Fdodock\u002Fdeveloppeurs\u002Fapi\u002Frest-api-v2":3,"section:\u002Fv5\u002Fdodock\u002Fdeveloppeurs\u002Fapi\u002Frest-api-v2":783},{"id":4,"title":5,"body":6,"description":770,"extension":771,"meta":772,"navigation":773,"path":779,"seo":780,"stem":781,"__hash__":782},"docs\u002F1.v5\u002F3.dodock\u002F10.developpeurs\u002F1.api\u002F3.rest-api-v2.md","API REST v2",{"type":7,"value":8,"toc":761},"minimark",[9,13,17,90,103,106,110,235,240,365,379,473,477,496,499,534,538,617,621,666,670,750,757],[10,11,5],"h1",{"id":12},"api-rest-v2",[14,15,16],"p",{},"Dodock sert deux versions de l'API REST sur le même site :",[18,19,20,39],"table",{},[21,22,23],"thead",{},[24,25,26,30,33,36],"tr",{},[27,28,29],"th",{},"Version",[27,31,32],{},"Préfixe",[27,34,35],{},"Documents",[27,37,38],{},"Réponse",[40,41,42,71],"tbody",{},[24,43,44,48,58,63],{},[45,46,47],"td",{},"v1",[45,49,50,54,55],{},[51,52,53],"code",{},"\u002Fapi\u002F"," ou ",[51,56,57],{},"\u002Fapi\u002Fv1\u002F",[45,59,60],{},[51,61,62],{},"\u002Fapi\u002Fresource\u002F\u003Cdoctype>",[45,64,65,54,68],{},[51,66,67],{},"{\"data\": ...}",[51,69,70],{},"{\"message\": ...}",[24,72,73,76,81,86],{},[45,74,75],{},"v2",[45,77,78],{},[51,79,80],{},"\u002Fapi\u002Fv2\u002F",[45,82,83],{},[51,84,85],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>",[45,87,88],{},[51,89,67],{},[14,91,92,93,98,99,102],{},"La v1 est décrite dans ",[94,95,97],"a",{"href":96},"\u002Fv5\u002Fdodock\u002Fdeveloppeurs\u002Fapi\u002Frest_api","API Rest",". La v2 utilise les mêmes méthodes d'authentification : session ou jeton ",[51,100,101],{},"Authorization: token api_key:api_secret",".",[14,104,105],{},"Chaque appel s'exécute avec les permissions de l'utilisateur authentifié.",[107,108,35],"h2",{"id":109},"documents",[18,111,112,125],{},[21,113,114],{},[24,115,116,119,122],{},[27,117,118],{},"Méthode",[27,120,121],{},"Chemin",[27,123,124],{},"Action",[40,126,127,141,155,169,191,205,219],{},[24,128,129,134,138],{},[45,130,131],{},[51,132,133],{},"GET",[45,135,136],{},[51,137,85],{},[45,139,140],{},"Liste des documents",[24,142,143,148,152],{},[45,144,145],{},[51,146,147],{},"POST",[45,149,150],{},[51,151,85],{},[45,153,154],{},"Création d'un document",[24,156,157,161,166],{},[45,158,159],{},[51,160,133],{},[45,162,163],{},[51,164,165],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>\u002F\u003Cname>",[45,167,168],{},"Lecture d'un document",[24,170,171,179,183],{},[45,172,173,54,176],{},[51,174,175],{},"PATCH",[51,177,178],{},"PUT",[45,180,181],{},[51,182,165],{},[45,184,185,186,190],{},"Modification d'un document. Demande l'autorisation ",[187,188,189],"strong",{},"Écriture"," sur le document.",[24,192,193,198,202],{},[45,194,195],{},[51,196,197],{},"DELETE",[45,199,200],{},[51,201,165],{},[45,203,204],{},"Suppression d'un document (statut HTTP 202)",[24,206,207,211,216],{},[45,208,209],{},[51,210,133],{},[45,212,213],{},[51,214,215],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>\u002F\u003Cname>\u002Fcopy",[45,217,218],{},"Copie d'un document, prête à être créée",[24,220,221,227,232],{},[45,222,223,54,225],{},[51,224,133],{},[51,226,147],{},[45,228,229],{},[51,230,231],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>\u002F\u003Cname>\u002Fmethod\u002F\u003Cmethod>",[45,233,234],{},"Appel d'une méthode whitelistée du document",[236,237,239],"h3",{"id":238},"paramètres-de-la-liste","Paramètres de la liste",[18,241,242,255],{},[21,243,244],{},[24,245,246,249,252],{},[27,247,248],{},"Paramètre",[27,250,251],{},"Défaut",[27,253,254],{},"Rôle",[40,256,257,273,289,305,320,335,347],{},[24,258,259,264,267],{},[45,260,261],{},[51,262,263],{},"fields",[45,265,266],{},"Champs par défaut",[45,268,269,270],{},"Liste JSON des champs, par exemple ",[51,271,272],{},"[\"name\",\"customer\",\"grand_total\"]",[24,274,275,280,283],{},[45,276,277],{},[51,278,279],{},"filters",[45,281,282],{},"Aucun",[45,284,285,286],{},"Filtres JSON, par exemple ",[51,287,288],{},"{\"status\":\"Draft\"}",[24,290,291,296,299],{},[45,292,293],{},[51,294,295],{},"order_by",[45,297,298],{},"Tri du type de document",[45,300,301,302],{},"Tri, par exemple ",[51,303,304],{},"posting_date desc",[24,306,307,312,317],{},[45,308,309],{},[51,310,311],{},"start",[45,313,314],{},[51,315,316],{},"0",[45,318,319],{},"Décalage pour la pagination",[24,321,322,327,332],{},[45,323,324],{},[51,325,326],{},"limit",[45,328,329],{},[51,330,331],{},"20",[45,333,334],{},"Nombre maximal de lignes",[24,336,337,342,344],{},[45,338,339],{},[51,340,341],{},"group_by",[45,343,282],{},[45,345,346],{},"Regroupement",[24,348,349,354,359],{},[45,350,351],{},[51,352,353],{},"as_dict",[45,355,356],{},[51,357,358],{},"true",[45,360,361,362],{},"Lignes en objets, ou en listes si ",[51,363,364],{},"false",[14,366,367,368,371,372,375,376,378],{},"La réponse contient ",[51,369,370],{},"data",", la liste des lignes, et ",[51,373,374],{},"has_next_page",", à ",[51,377,358],{}," s'il reste des lignes après la page.",[380,381,386],"pre",{"className":382,"code":383,"language":384,"meta":385,"style":385},"language-sh shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl -G \"https:\u002F\u002Fvotre-site\u002Fapi\u002Fv2\u002Fdocument\u002FSales%20Invoice\" \\\n  -H \"Authorization: token api_key:api_secret\" \\\n  --data-urlencode 'fields=[\"name\",\"customer\",\"grand_total\"]' \\\n  --data-urlencode 'filters={\"docstatus\":1}' \\\n  --data-urlencode 'limit=5'\n","sh","",[51,387,388,415,429,446,460],{"__ignoreMap":385},[389,390,393,397,401,405,408,411],"span",{"class":391,"line":392},"line",1,[389,394,396],{"class":395},"sBMFI","curl",[389,398,400],{"class":399},"sfazB"," -G",[389,402,404],{"class":403},"sMK4o"," \"",[389,406,407],{"class":399},"https:\u002F\u002Fvotre-site\u002Fapi\u002Fv2\u002Fdocument\u002FSales%20Invoice",[389,409,410],{"class":403},"\"",[389,412,414],{"class":413},"sTEyZ"," \\\n",[389,416,418,421,423,425,427],{"class":391,"line":417},2,[389,419,420],{"class":399},"  -H",[389,422,404],{"class":403},[389,424,101],{"class":399},[389,426,410],{"class":403},[389,428,414],{"class":413},[389,430,432,435,438,441,444],{"class":391,"line":431},3,[389,433,434],{"class":399},"  --data-urlencode",[389,436,437],{"class":403}," '",[389,439,440],{"class":399},"fields=[\"name\",\"customer\",\"grand_total\"]",[389,442,443],{"class":403},"'",[389,445,414],{"class":413},[389,447,449,451,453,456,458],{"class":391,"line":448},4,[389,450,434],{"class":399},[389,452,437],{"class":403},[389,454,455],{"class":399},"filters={\"docstatus\":1}",[389,457,443],{"class":403},[389,459,414],{"class":413},[389,461,463,465,467,470],{"class":391,"line":462},5,[389,464,434],{"class":399},[389,466,437],{"class":403},[389,468,469],{"class":399},"limit=5",[389,471,472],{"class":403},"'\n",[236,474,476],{"id":475},"appeler-une-méthode-dun-document","Appeler une méthode d'un document",[14,478,479,480,483,484,486,487,489,490,492,493,102],{},"Le chemin ",[51,481,482],{},"\u002Fmethod\u002F\u003Cmethod>"," charge le document et appelle la méthode si elle est whitelistée. ",[51,485,133],{}," demande le droit de lecture, ",[51,488,147],{}," le droit d'écriture. La réponse contient le résultat dans ",[51,491,370],{},", et le document à jour dans ",[51,494,495],{},"docs",[14,497,498],{},"Exemple : valider une facture brouillon.",[380,500,502],{"className":382,"code":501,"language":384,"meta":385,"style":385},"curl -X POST \"https:\u002F\u002Fvotre-site\u002Fapi\u002Fv2\u002Fdocument\u002FSales%20Invoice\u002FACC-SINV-2026-00012\u002Fmethod\u002Fsubmit\" \\\n  -H \"Authorization: token api_key:api_secret\"\n",[51,503,504,523],{"__ignoreMap":385},[389,505,506,508,511,514,516,519,521],{"class":391,"line":392},[389,507,396],{"class":395},[389,509,510],{"class":399}," -X",[389,512,513],{"class":399}," POST",[389,515,404],{"class":403},[389,517,518],{"class":399},"https:\u002F\u002Fvotre-site\u002Fapi\u002Fv2\u002Fdocument\u002FSales%20Invoice\u002FACC-SINV-2026-00012\u002Fmethod\u002Fsubmit",[389,520,410],{"class":403},[389,522,414],{"class":413},[389,524,525,527,529,531],{"class":391,"line":417},[389,526,420],{"class":399},[389,528,404],{"class":403},[389,530,101],{"class":399},[389,532,533],{"class":403},"\"\n",[107,535,537],{"id":536},"méthodes","Méthodes",[18,539,540,550],{},[21,541,542],{},[24,543,544,546,548],{},[27,545,118],{},[27,547,121],{},[27,549,124],{},[40,551,552,565,577,591,605],{},[24,553,554,557,562],{},[45,555,556],{},"Toutes",[45,558,559],{},[51,560,561],{},"\u002Fapi\u002Fv2\u002Fmethod\u002F\u003Cchemin.de.la.methode>",[45,563,564],{},"Appel d'une méthode whitelistée, ou d'un script serveur de type API",[24,566,567,569,574],{},[45,568,556],{},[45,570,571],{},[51,572,573],{},"\u002Fapi\u002Fv2\u002Fmethod\u002F\u003Cdoctype>\u002F\u003Cmethod>",[45,575,576],{},"Appel d'une méthode whitelistée du module du type de document",[24,578,579,583,588],{},[45,580,581],{},[51,582,147],{},[45,584,585],{},[51,586,587],{},"\u002Fapi\u002Fv2\u002Fmethod\u002Fupload_file",[45,589,590],{},"Envoi d'un fichier",[24,592,593,597,602],{},[45,594,595],{},[51,596,147],{},[45,598,599],{},[51,600,601],{},"\u002Fapi\u002Fv2\u002Fmethod\u002Flogout",[45,603,604],{},"Déconnexion",[24,606,607,609,614],{},[45,608,556],{},[45,610,611],{},[51,612,613],{},"\u002Fapi\u002Fv2\u002Fmethod\u002Fping",[45,615,616],{},"Test de disponibilité",[107,618,620],{"id":619},"types-de-documents","Types de documents",[18,622,623,633],{},[21,624,625],{},[24,626,627,629,631],{},[27,628,118],{},[27,630,121],{},[27,632,124],{},[40,634,635,649],{},[24,636,637,641,646],{},[45,638,639],{},[51,640,133],{},[45,642,643],{},[51,644,645],{},"\u002Fapi\u002Fv2\u002Fdoctype\u002F\u003Cdoctype>\u002Fmeta",[45,647,648],{},"Métadonnées du type de document : champs, propriétés",[24,650,651,655,660],{},[45,652,653],{},[51,654,133],{},[45,656,657],{},[51,658,659],{},"\u002Fapi\u002Fv2\u002Fdoctype\u002F\u003Cdoctype>\u002Fcount",[45,661,662,663,665],{},"Nombre de documents, avec les mêmes ",[51,664,279],{}," que la liste",[107,667,669],{"id":668},"opérations-en-masse","Opérations en masse",[18,671,672,683],{},[21,673,674],{},[24,675,676,678,680],{},[27,677,118],{},[27,679,121],{},[27,681,682],{},"Corps",[40,684,685,701,717,734],{},[24,686,687,691,696],{},[45,688,689],{},[51,690,147],{},[45,692,693],{},[51,694,695],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>\u002Fbulk_delete",[45,697,698],{},[51,699,700],{},"{\"names\": [...]}",[24,702,703,707,712],{},[45,704,705],{},[51,706,147],{},[45,708,709],{},[51,710,711],{},"\u002Fapi\u002Fv2\u002Fdocument\u002F\u003Cdoctype>\u002Fbulk_update",[45,713,714],{},[51,715,716],{},"{\"docs\": [{\"name\": ..., \"champ\": ...}]}",[24,718,719,723,728],{},[45,720,721],{},[51,722,147],{},[45,724,725],{},[51,726,727],{},"\u002Fapi\u002Fv2\u002Fmethod\u002Fbulk_delete",[45,729,730,733],{},[51,731,732],{},"{\"docs\": [{\"doctype\": ..., \"name\": ...}]}",", sur plusieurs types de documents",[24,735,736,740,745],{},[45,737,738],{},[51,739,147],{},[45,741,742],{},[51,743,744],{},"\u002Fapi\u002Fv2\u002Fmethod\u002Fbulk_update",[45,746,747,733],{},[51,748,749],{},"{\"docs\": [{\"doctype\": ..., \"name\": ..., \"champ\": ...}]}",[14,751,752,753,756],{},"Au-delà de 20 documents, l'opération passe en tâche de fond et la réponse a le statut HTTP 202. La clé ",[51,754,755],{},"bulk_operation_async_threshold"," de la configuration du site change ce seuil, globalement ou par type de document.",[758,759,760],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":385,"searchDepth":392,"depth":417,"links":762},[763,767,768,769],{"id":109,"depth":417,"text":35,"children":764},[765,766],{"id":238,"depth":431,"text":239},{"id":475,"depth":431,"text":476},{"id":536,"depth":417,"text":537},{"id":619,"depth":417,"text":620},{"id":668,"depth":417,"text":669},"Référence des points d'accès \u002Fapi\u002Fv2 : documents, méthodes, métadonnées, comptage et opérations en masse, avec le format des réponses.","md",{"reviewed":773,"last_verified":774,"sources":775},true,"2026-11-03",[776,777,778],"dodock@v5:frappe\u002Fapi\u002F__init__.py","dodock@v5:frappe\u002Fapi\u002Fv2.py","dodock@v5:frappe\u002Fapi\u002Fv1.py","\u002Fv5\u002Fdodock\u002Fdeveloppeurs\u002Fapi\u002Frest-api-v2",{"title":5,"description":770},"1.v5\u002F3.dodock\u002F10.developpeurs\u002F1.api\u002F3.rest-api-v2","c_M30_I3V0iS_7BFqSj7dvC8evwTANTIUdCzV3G6epg",{},1793871959570]