<p><style>
.apitd tr, td {
border: 1px solid #DDDDDD;
}
</style>
<ul uk-accordion="">
<li>
<a class="uk-accordion-title"><b>document_category_path</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
PaperOffice target folder
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Specifies the target folder in PaperOffice using an internal path. <br>
The entire folder structure is created automatically if the path does not already exist. <br>
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>YES (One of the rootdir paths)</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>
String<br><small>UTF-8 text with characters valid for Windows file names. <br> <b> Internal names must be used as the root folder</b></small>
</td>
<td xss=removed>
rootdir_documents_personal
</td>
<td xss=removed>
"My documents" of the currently logged in user
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>
String<br><small>UTF-8 text with characters valid for Windows file names. <br> <b> Internal names must be used as the root folder</b></small>
</td>
<td xss=removed>
rootdir_incoming_personal
</td>
<td xss=removed>
"My inbox" of the currently logged in user
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>
String<br><small>UTF-8 text with characters valid for Windows file names. <br> <b> Internal names must be used as the root folder</b></small>
</td>
<td xss=removed>
rootdir_documents_public
</td>
<td xss=removed>
"Common documents"
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>
String<br><small>UTF-8 text with characters valid for Windows file names. <br> <b> Internal names must be used as the root folder</b></small>
</td>
<td xss=removed>
rootdir_incoming_public
</td>
<td xss=removed>
"Gemeinsamer inbox"
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic. <br>Use of variables in the folder path</small></td>
<td xss=removed>
__YYYY__
</td>
<td xss=removed>
Aktuelles Jahr wie z.B. 2018, 2019, 2020
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic. <br>Use of variables in the folder path</small></td>
<td xss=removed>
__MMMM__
</td>
<td xss=removed>
Current month name such as October, November, December
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic. <br>Use of variables in the folder path</small></td>
<td xss=removed>
__MM__
</td>
<td xss=removed>
Current month with a leading zero such as 09, 10, 11
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic. <br>Use of variables in the folder path</small></td>
<td xss=removed>
__DD__
</td>
<td xss=removed>
Current day of the month with a leading zero such as 10, 20, 30
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic. <br>Use of variables in the folder path</small></td>
<td xss=removed>
__WW__
</td>
<td xss=removed>
Current calendar week of the year with a leading zero such as 09, 10
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
<b>"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",</b>
"document_name":"Mein erstes PaperOffice POJOB-Dokument",
"document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage",
"document_state":
{
"name":"Dringend!",
"bgcolor":"#FF0000",
"fgcolor":"#FFFFFF"
},
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_name</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document name
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Defines the name of the new document.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>YES (one of the parameters)</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
Any name <br> <small>UTF-8 text with characters valid for Windows file names.</small>
</td>
<td xss=removed>
Names the new document
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Dynamic</td>
<td xss=removed>
DOCUMENT_FILEPATH_BASENAME
</td>
<td xss=removed>
Automatically generates the document name from the file name specified in the document_filepath <u>without</u> file extension
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Dynamic</td>
<td xss=removed>
DOCUMENT_FILEPATH_FILENAME
</td>
<td xss=removed>
Automatically generates the document name from the file name specified in the document_filepath <u>with</u> file extension
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
<b>"document_name":"DOCUMENT_FILEPATH_BASENAME",</b>
"document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage",
"document_state":
{
"name":"urgent!",
"bgcolor":"#FF0000",
"fgcolor":"#FFFFFF"
},
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_description</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Defines the description of the new document
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Is used to assign the later callback to a unique ID. <br>
In this way the callback_id is connected to the callback_X so that each callback also receives the correct result. <br>
It is recommended to use Microtime or something similar to make the ID unique.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters - JSON-String</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
description
</td>
<td xss=removed>
Any text without special characters. The description text can optionally be displayed as a post-it. #Document properties
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Boolean</td>
<td xss=removed>
showpostit
</td>
<td xss=removed>
true || false, true shows a Post-It
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage",
<b>"document_description":
{
"description":"Unbedingt auf Wiedervorlage setzen!",
"showpostit":"true"
}, </b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_keywords</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document-keywords
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Assigns these keywords to the new document and optionally creates them if they are not available.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
Unique keyword ID from PaperOffice
</td>
<td xss=removed>
Multiple entries separated with ";"
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic</small></td>
<td xss=removed>
Any text
</td>
<td xss=removed>
Text in UTF-8 format with characters valid for Windows file names. <br>
The keyword is created automatically, if it does not yet exist, multiple entries separated by ";"
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
<b>"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",</b>
"document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage",
"document_description":
{
"description":"Unbedingt auf Wiedervorlage setzen!",
"showpostit":"true"
},
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_type</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document-Type
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Assigns this document type to the new document and optionally creates it if it does not exist.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
Unique document type ID from PaperOffice,
</td>
<td xss=removed>
Multiple entries separated with ";"
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String<br><small>Dynamic</small></td>
<td xss=removed>
Any text
</td>
<td xss=removed>
Text in UTF-8 format with characters valid for Windows file names. <br>
The document type is created automatically if it does not yet exist, multiple entries separated by ";"
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
<b>"document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage;9",</b>
"document_description":
{
"description":"Unbedingt auf Wiedervorlage setzen!",
"showpostit":"true"
},
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_state</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document-Status
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Assigns this document status to the new document and optionally creates it if it does not exist. In addition, the background color and the font color are specified.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters - JSON-String</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
name
</td>
<td xss=removed>
Unique status ID from PaperOffice. <br>
State name: UTF-8 text with characters valid for Windows file names <br>
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
bgcolor
</td>
<td xss=removed>
HEX-Color value for the background color
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
fgcolor
</td>
<td xss=removed>
HEX-Color value for the font color
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
<b>"document_state":
{
"name":"Dringend!",
"bgcolor":"#FF0000",
"fgcolor":"#FFFFFF"
},</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_contacts</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Contacts associated with the document
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Assigns these contact links to the new document and optionally creates them if they do not exist.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters - JSON-String</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
name
</td>
<td xss=removed>
Status name: UTF-8 text with characters valid for Windows file names
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
firstname
</td>
<td xss=removed>
Firstname
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
lastname
</td>
<td xss=removed>
Lastname
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
company
</td>
<td xss=removed>
Company
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
department
</td>
<td xss=removed>
Department
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
position
</td>
<td xss=removed>
Position
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
custom_field1_name
</td>
<td xss=removed>
Add custom_field1 value
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
custom_field2_name
</td>
<td xss=removed>
Add custom_field2 value
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
custom_field5_name
</td>
<td xss=removed>
Add custom_field5 value
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
<b>"document_contacts":
[
{
"name":"Genossenschaft Bauen",
"firstname":"Hans",
"lastname":"Huber"
},
{
"name":"Name",
"firstname":"Firstname",
"lastname":"Lastname",
"company":"Company-name",
"department":"Department",
"position":"Position",
"fieldName":"value"
}
], </b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>callback_id</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Unique ID for the callback file (required for all callback functions)
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Is used to assign the later callback to a unique ID. <br>
In this way the callback_id is connected to the callback_X so that each callback also receives the correct result. <br>
It is recommended to use Microtime or something similar to make the ID unique.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_id
</td>
<td xss=removed>
Any text without special characters
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
<b>"callback_id":"archiving_invoice_number_IV123456 at 16593933105469",</b>
"callback_filepath": "c:/PaperOffice Callbacks/16593933105469.callback.pojob.json",
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>callback_filepath</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
File path to the callback file
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Specifies the full path to the callback file in UNIX format. <br>
The callback file is created automatically after the new document is saved and contains information in JSON format. The file extension must be "callback.pojob.json". <br>
It is recommended to use Microtime or something similar as the file name, otherwise the file will be overwritten. The directory must exist.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_id
</td>
<td xss=removed>
Absolute file path in UTF-8 and UNIX format
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<b>Return</b>
<table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_id
</td>
<td xss=removed>
The self-set callback_id when creating the POJOB
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
document_id
</td>
<td xss=removed>
Dokument-ID from new document
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
"callback_id":"archiving_invoice_number_IV123456 at 16593933105469",
<b>"callback_filepath": "c:/PaperOffice Callbacks/16593933105469.callback.pojob.json",</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>callback_exepush</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Push callback to an EXE file
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Starts the specified EXE file and passes the callback as a parameter. <br>
The EXE should terminate automatically after the start, otherwise the timeout is 10 seconds.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_exepush
</td>
<td xss=removed>
Absolute path to the EXE file
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<b>Return</b>
<table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_id
</td>
<td xss=removed>
The self-set callback_id when creating the POJOB
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
document_id
</td>
<td xss=removed>
Document ID of the new document
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
"callback_id":"archiving_invoice_number_IV123456 at 16593933105469",
"callback_filepath": "c:/PaperOffice Callbacks/16593933105469.callback.pojob.json",
<b>"callback_exepush":"c:/Helper/com.paperoffice.push2database.exe",</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>callback_urlpush</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Push callback to a URL
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Pushes the callback to the specified URL with the GET method. <br>
The callback is appended to the end of the URL address.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_urlpush
</td>
<td xss=removed>
URL to which the push should be sent
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<b>Return</b>
<table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
callback_id
</td>
<td xss=removed>
The self-set callback_id when creating the POJOB
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
document_id
</td>
<td xss=removed>
Document ID of the new document
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
"callback_id":"archiving_invoice_number_IV123456 at 16593933105469",
"callback_filepath": "c:/PaperOffice Callbacks/16593933105469.callback.pojob.json",
<b>"callback_urlpush":"https://api.paperoffice.com/?command=save_document",</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_importance_level</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document importance level
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Sets the importance level of the document.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
document_importance_level
</td>
<td xss=removed>
Values from 1 - 14
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
<b>"document_importance_level":10,</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_classification_level</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document classification level
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Sets the classification level of the document.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>Integer</td>
<td xss=removed>
document_classification_level
</td>
<td xss=removed>
Values from 1 - 10
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
<b>"document_classification_level":10,</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>document_voucher fields</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Document voucher flields
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Sets the value of each individual voucher field.<br>
<b>Currency format needs to match the settings from current user!</b>
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_number
</td>
<td xss=removed>
The desired Invoice number e.g.: IN123456
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>float</td>
<td xss=removed>
document_voucher_net
</td>
<td xss=removed>
Invoice net e.g.: 100.00
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>float</td>
<td xss=removed>
document_voucher_gross
</td>
<td xss=removed>
Invoice gross e.g.: 110.00
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>float</td>
<td xss=removed>
document_voucher_vat
</td>
<td xss=removed>
Invoice VAT %, e.g.: 10.00
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_debitaccount
</td>
<td xss=removed>
Debit account number e.g.: DE77 1234 5678 9012 0130 00
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_creditaccount
</td>
<td xss=removed>
Credit account number e.g.: DE88 1234 5678 9012 0130 00
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_costcenter1
</td>
<td xss=removed>
Costcenter1 name
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_costcenter2
</td>
<td xss=removed>
Costcenter2 name
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_bookingtext
</td>
<td xss=removed>
The desired booking text
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_comment
</td>
<td xss=removed>
The desired comment
</td>
<td xss=removed>NO</td>
</tr>
<tr>
<td xss=removed>String</td>
<td xss=removed>
document_voucher_vatnumber
</td>
<td xss=removed>
The desired VAT number number e.g.: LU26375245
</td>
<td xss=removed>NO</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
<b>"document_voucher_number":"IN123456",</b>
<b>"document_voucher_wkz":"EUR",</b>
<b>"document_voucher_net":"100.00",</b>
<b>"document_voucher_gross":"110.00",</b>
<b>"document_voucher_vat":"10.00",</b>
<b>"document_voucher_vatsum":"10.00",</b>
<b>"document_voucher_debitaccount":"DE77 1234 5678 9012 0130 00",</b>
<b>"document_voucher_creditaccount":"DE88 1234 5678 9012 0130 00",</b>
<b>"document_voucher_costcenter1":"Production",</b>
<b>"document_voucher_costcenter2":"Service",</b>
<b>"document_voucher_bookingtext":"AMAZON",</b>
<b>"document_voucher_comment":"Amazon payment",</b>
<b>"document_voucher_vatnumber":"LU26375245",</b>
"oncomplete_open_document":"true"
}
</pre>
</div>
<hr>
</li>
<li>
<a class="uk-accordion-title"><b>oncomplete_open_document</b></a>
<div class="uk-accordion-content">
<p>
<b>Function</b>
</p><div xss=removed>
Open document after saving
</div>
<p>
<b>Description</b>
</p><div xss=removed>
Opens the newly added document in PaperOffice after it has been saved.
</div>
<p>
<b>Mandatory</b>
</p><div xss=removed>NO</div>
<p>
<b>Parameters</b>
</p><table class="uk-table uk-table-striped apitd" xss=removed>
<tbody><tr>
<th>Type
</th><th>Parameter</th>
<th>Description</th>
<th>Mandatory</th>
</tr>
<tr>
<td xss=removed>Boolean</td>
<td xss=removed>
oncomplete_open_document
</td>
<td xss=removed>
true || false
</td>
<td xss=removed>YES</td>
</tr>
</tbody></table>
<p>
<b>Example</b></p><pre xss=removed>{
"document_category_path":"rootdir_documents_personal/Automatische Dokumente/YYYY/MM",
"document_name":"DOCUMENT_FILEPATH_BASENAME",
"document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
"callback_id":"archiving_invoice_number_IV123456 at 16593933105469",
"callback_filepath": "c:/PaperOffice Callbacks/16593933105469.callback.pojob.json",
"callback_urlpush":"https://api.paperoffice.com/?command=save_document",
<b>"oncomplete_open_document":"true"</b>
}
</pre>
</div>
</li></ul></p>