{"id":21242,"date":"2022-04-11T13:56:06","date_gmt":"2022-04-11T11:56:06","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/"},"modified":"2026-05-13T09:40:14","modified_gmt":"2026-05-13T07:40:14","slug":"objects","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/","title":{"rendered":"Objects"},"content":{"rendered":"\n<p>Open Bee\u2122 Scan Capture provides a number of variables in its scripts depending on the context in which they are used. These variables can be structured.<\/p>\n\n<p>In Open Bee\u2122 Scan Capture there is a special type: <a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/jse_result\/\" data-type=\"page\" data-id=\"8407\">JSE_Result <\/a>that allows you to return an object that is more complex than a simple string. Indeed, this object allows you, for example, to fill in the values of a drop-down list if your script is intended not only to return a value, but also to populate the drop-down list.<\/p>\n\n<h1 class=\"wp-block-heading\" id=\"Lesobjets-Lesvariablespr&#xE9;-int&#xE9;gr&#xE9;es\">Pre-integrated variables<\/h1>\n\n<p>Reminder of contexts: LABEL, INDEX, VALIDATION, ENTRIES<\/p>\n\n<p>Variables are made available for use within the script:<\/p>\n\n<ul class=\"wp-block-list\">\n<li>Local variables (accessible in the main body of the script):\n<ul class=\"wp-block-list\">\n<li><strong>pParameters<\/strong> \u2014An array containing all<a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/info-articlelineinfo\/\" data-type=\"page\" data-id=\"8402\"> Info and ArticleLineInfo<\/a><a href=\"Les-objets_273191877.html\"> <\/a>objects found for the current document LABEL, INDEX, VALIDATION, ENTRIES<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n<p>Global variables to the script:<\/p>\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><th>Name<\/th><th>Description<\/th><th>Type<\/th><th>Context<\/th><th>Version<\/th><\/tr><tr><td><strong>ID_INVOICE<\/strong> <\/td><td>Displays the document ID in Open Bee\u2122 Scan Capture<\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.3.1<\/td><\/tr><tr><td><strong>INTERNAL_DOCUMENT_ID<\/strong><\/td><td>Displays the internal ID of the document in Open Bee\u2122 Scan Capture<\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.8.0<\/td><\/tr><tr><td><strong>ID_DMS<\/strong><\/td><td>L&#8217;identifiant du document dans Open Bee\u2122 Portal quand celui a d\u00e9j\u00e0 \u00e9t\u00e9 archiv\u00e9 par Capture. <\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.5.0<\/td><\/tr><tr><td><strong>ID_DMS_LIST<\/strong><\/td><td>Identifiants des documents dans le ou les Open Bee Portal\u2122 quand le document a \u00e9t\u00e9 archiv\u00e9 par Capture. <\/td><td>Liste de Texte<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>4.3.0<\/td><\/tr><tr><td><strong>THIRDPART<\/strong><\/td><td>Third Party of the Document<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/thirdpart\/\" data-type=\"page\" data-id=\"8441\">ThirdPart<\/a><\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>\u00a0<\/td><\/tr><tr><td><strong>FOLDER<\/strong> <\/td><td>Document Folder<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/folder\/\" data-type=\"page\" data-id=\"8385\">Folder<\/a><\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.3.0<\/td><\/tr><tr><td><strong>DOCUMENT_STATE<\/strong> <\/td><td>Current status of the document. Possible values: &#8211; WORKFLOW_DONE &#8211; ENTRY_DONE &#8211; DOCUMENT_FINAL &#8211; VIDEOCODAGE_DONE &#8211; ANALYTICAL_BREAKDOWN_DONE<\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.4.0<\/td><\/tr><tr><td><strong>DOCUMENT_TEMPLATE<\/strong><\/td><td>The template used for the document (corresponding to its third party, its folder or generic to the application)<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/template\/\" data-type=\"page\" data-id=\"8440\">Template<\/a><\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.8.0<\/td><\/tr><tr><td><strong>DOCUMENT_TYPE<\/strong><\/td><td>The type of document in Open Bee\u2122 Portal<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/document-template\/\" data-type=\"page\" data-id=\"8377\">Document Template<\/a><\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.8.0<\/td><\/tr><tr><td><strong>Wear out<\/strong> <\/td><td>Current user: LIBELLE the user who generates the accounting entries INDEX the user who videocodes the document (or if the script is executed on the server side, the user &#8220;USER_SYSTEM&#8221;) VALIDATION the user who validates and exports the document WRITINGS the user who exports the entries<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/wear-out\/\" data-type=\"page\" data-id=\"8442\">Wear out<\/a><\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.4.0<\/td><\/tr><tr><td><strong>COMMENTS<\/strong><\/td><td>Open Bee\u2122 Portal<\/td><td>List of <a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/comment\/\" data-type=\"page\" data-id=\"8373\">Comments<\/a><\/td><td>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>3.7.0<\/td><\/tr><tr><td><strong>ACCOUNT_ENTRIES<\/strong><\/td><td>List of ledger entries associated with the document<\/td><td>List <a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/accounting-entry\/\" data-type=\"page\" data-id=\"8380\">of Ledger Entries<\/a><\/td><td>VALIDATION<br\/>SCRIPTURES<\/td><td>3.7.0<\/td><\/tr><tr><td><strong>ACCOUNT_ENTRY<\/strong><\/td><td>Writing in the process of being exported<\/td><td><a href=\"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/accounting-entry\/\" data-type=\"page\" data-id=\"8380\">Accounting Entry<\/a><\/td><td>SCRIPTURES<\/td><td>4.2.0<\/td><\/tr><tr><td><strong>ACCOUNT_ENTRY_NUMBER<\/strong><\/td><td>The number of the ledger entry in the export order. Starts at 1<\/td><td>Whole<\/td><td>SCRIPTURES<\/td><td>3.8.0<\/td><\/tr><tr><td><strong>DOCUMENT_WORKFLOW_STATUS<\/strong><\/td><td>Status of the document vs. its status in the workflow (see <a href=\"Les-objets_273191877.html\">accounting configuration<\/a>) Status: Validated Refused NotProcessed Waiting<\/td><td>Text<\/td><td>SCRIPTURES<\/td><td>3.8.0<\/td><\/tr><tr><td><strong>ID_UNIT<\/strong><\/td><td>Instance number of the Current Info object  <\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<\/td><td>\u00a0<\/td><\/tr><tr><td><strong>GROUPED_INDEX_ID<\/strong><\/td><td>Unique identifier of the parent index: <em>Populated only if the index belongs to an article group or row<\/em><\/td><td>Text<\/td><td>INDEX<\/td><td>\u00a0<\/td><\/tr><tr><td><strong>IS_ARTICLE  <\/strong><\/td><td>Specifies whether the line comes from an item line (In case an item line needs to generate a ledger entry)<\/td><td>Boolean<\/td><td>LIBEL<\/td><td>\u00a0<\/td><\/tr><tr><td><strong>IS_DISCOUNT_RATE_GENERATION  <\/strong><\/td><td>Indicates whether the line is the result of a discount generation<\/td><td>Boolean<\/td><td>LIBEL<\/td><td>3.3.0<\/td><\/tr><tr><td><strong>ID_CURRENT_INDEX  <\/strong><\/td><td>The identifier of the index that was used to generate the row. <em>Filled only in case of index -&gt; entry line link<\/em> (Ex: If I find the value foo on the index NOM_INDEX I debit the account 445600 with the amount excluding VAT) -&gt; The value would be NOM_INDEX<\/td><td>Text<\/td><td>LIBEL<\/td><td>\u00a0<\/td><\/tr><tr><td><strong>CAPTURE_WS_TOKEN<\/strong><\/td><td>Session capture token to call certain web services<\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>4.1.0<\/td><\/tr><tr><td><strong>FILENAME<\/strong><\/td><td>File Name<\/td><td>Text<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>4.3.0<\/td><\/tr><tr><td><strong>INTERPRETATION_MODE<\/strong><\/td><td>Where the script is executed<\/td><td>CLIENT, SERVER, or UNKNOWN<\/td><td>LIBEL<br\/>INDEX<br\/>VALIDATION<br\/>SCRIPTURES<\/td><td>4.5.0<\/td><\/tr><tr><td><strong>GENERATION_TEMPLATE_NAME<\/strong><\/td><td>Ledger Entry Model Name<\/td><td>Text<\/td><td>LIBEL<\/td><td>4.7.1<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Open Bee\u2122 Scan Capture provides a number of variables in its scripts depending on the context in which they are used. These variables can be structured. In Open Bee\u2122 Scan Capture there is a special type: JSE_Result that allows you to return an object that is more complex than a simple string. Indeed, this object [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":21211,"menu_order":6,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-21242","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21242","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=21242"}],"version-history":[{"count":2,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21242\/revisions"}],"predecessor-version":[{"id":29209,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21242\/revisions\/29209"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21211"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=21242"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}