PaperOffice API JSON Parameter

<ul uk-accordion> <li> <a class="uk-accordion-title"><b>document_category_path</b></a> <div class="uk-accordion-content">
<p> <b>Funktion</b> <div> Zielordner in PaperOffice </div>
</p> <p> <b>Beschreibung</b> <div> Legt den Zielordner in PaperOffice per interner Pfadangabe fest.<br>
Die gesamte Ordnerstruktur wird automatisch erstellt, falls es den Pfad noch nicht gibt.<br> </div>
</p> <p> <b>Mandatory</b> <div>YES (One of the rootdir paths)</div> </p>
<p>
<b>Parameters</b>
<table class="uk-table uk-table-striped apitd"> <tr> <th>Type</thd> <th>Parameter</th> <th>Beschreibung</th> <th>Mandatory</th> </tr>

                <tr>
                    <td>
                        String<br><small>UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.<br><b>Interne Namen müssen als Root-Ordner benutzt werden</b></small>
                    </td>
                    <td>
                        rootdir_documents_personal
                    </td>
                    <td>
                        "Meine Dokumente" des aktuell angemeldeten Benutzers
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>
                        String<br><small>UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.<br><b>Interne Namen müssen als Root-Ordner benutzt werden</b></small>
                    </td>
                    <td>
                        rootdir_incoming_personal
                    </td>
                    <td>
                        "Mein Eingang" des aktuell angemeldeten Benutzers
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>
                        String<br><small>UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.<br><b>Interne Namen müssen als Root-Ordner benutzt werden</b></small>
                    </td>
                    <td>
                        rootdir_documents_public
                    </td>
                    <td>
                        "Gemeinsame Dokumente"
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>
                        String<br><small>UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.<br><b>Interne Namen müssen als Root-Ordner benutzt werden</b></small>
                    </td>
                    <td>
                        rootdir_incoming_public
                    </td>
                    <td>
                        "Gemeinsamer Eingang"
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch.<br>Verwendung von Variablen im Ordner-Pfad</small></td>
                    <td>
                        __YYYY__
                    </td>
                    <td>
                        Aktuelles Jahr wie z.B. 2018, 2019, 2020
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch.<br>Verwendung von Variablen im Ordner-Pfad</small></td>
                    <td>
                        __MMMM__
                    </td>
                    <td>
                        Aktueller Monatsname wie z.B. Oktober, November, Dezember
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch.<br>Verwendung von Variablen im Ordner-Pfad</small></td>
                    <td>
                        __MM__
                    </td>
                    <td>
                        Aktueller Monat mit führender Null wie z.B. 09, 10, 11
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch.<br>Verwendung von Variablen im Ordner-Pfad</small></td>
                    <td>
                        __DD__
                    </td>
                    <td>
                        Aktueller Monatstag mit führender Null wie z.B. 10, 20, 30
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch.<br>Verwendung von Variablen im Ordner-Pfad</small></td>
                    <td>
                        __WW__
                    </td>
                    <td>
                        Aktuelle Kalenderwoche des Jahres mit führender Null wie z.B. 09, 10
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
<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> </p>

    </div>
    <hr>
</li>

<li>
    <a class="uk-accordion-title"><b>document_name</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dokumentname
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Legt den Namen des neuen Dokumentes fest.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>YES (one of the parameters)</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        Beliebiger Name<br><small>UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.</small>
                    </td>
                    <td>
                        Benennt das neue Dokument.
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Dynamisch</td>
                    <td>
                        DOCUMENT_FILEPATH_BASENAME
                    </td>
                    <td>
                        Erzeugt automatisch den Dokumentnamen aus dem im document_filepath angegebenen Dateinamen <u>ohne</u> Dateiendung
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Dynamisch</td>
                    <td>
                        DOCUMENT_FILEPATH_FILENAME
                    </td>
                    <td>
                        Erzeugt automatisch den Dokumentnamen aus dem im document_filepath angegebenen Dateinamen <u>mit</u> Dateiendung
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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":"Dringend!", "bgcolor":"#FF0000", "fgcolor":"#FFFFFF" },
"oncomplete_open_document":"true" } </pre> </p>

    </div>
    <hr>
</li>

<li>
    <a class="uk-accordion-title"><b>document_description</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Legt die Beschreibung des neuen Dokumentes fest
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Wird benutzt um das spätere Callback einer eindeutigen ID zuzuordnen.<br>
                So wird die callback_id mit dem callback_X verbunden, damit jeder Callback auch das korrekte Ergebnis erhält.<br>
                Es wird empfohlen Microtime oder ähnliches zu benutzen um die ID einzigartig zu machen.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters - JSON-String</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        description
                    </td>
                    <td>
                        Beliebiger Text ohne Sonderzeichen. Der Beschreibungstext kann optional als Post-It angezeigt werden. #Dokumenteigenschaften
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Boolean</td>
                    <td>
                        showpostit
                    </td>
                    <td>
                        true || false, true zeigt ein Post-It an
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>
    <a class="uk-accordion-title"><b>document_keywords</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dokument-Schlüsselwörter
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Weist dem neuen Dokument diese Schlüsselwörter zu und legt diese optional an, insofern diese nicht vorhanden sind.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        Eindeutige Schlüsselwort-ID aus PaperOffice
                    </td>
                    <td>
                        Mehrfachangabe getrennt mit ;
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch</small></td>
                    <td>
                        Beliebiger Text
                    </td>
                    <td>
                        Text im UTF-8 Format mit für Windows-Dateinamen gültigen Zeichen.<br>
                        Das Schlüsselwort wird automatisch angelegt, insofern dieses noch nicht vorhanden ist, Mehrfachangabe getrennt mit ;
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>
    <a class="uk-accordion-title"><b>document_type</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dokument-Typ
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Weist dem neuen Dokument diesen Dokumenttyp zu und legt diesen optional an, insofern dieser nicht vorhanden ist.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        Eindeutige Dokumenttyp-ID aus PaperOffice,
                    </td>
                    <td>
                        Mehrfachangabe getrennt mit ;
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String<br><small>Dynamisch</small></td>
                    <td>
                        Beliebiger Text
                    </td>
                    <td>
                        Text im UTF-8 Format mit für Windows-Dateinamen gültigen Zeichen.<br>
                        Der Dokumentyp wird automatisch angelegt, insofern dieser noch nicht vorhanden ist, Mehrfachangabe getrennt mit ;
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>document_state</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dokument-Status
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Weist dem neuen Dokument diesen Dokumentstatus zu und legt diesen optional an, insofern dieser nicht vorhanden ist. Zusätzlich wird die Hintergrundsfarbe sowie Schriftfarbe festgelegt.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters - JSON-String</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        name
                    </td>
                    <td>
                        Eindeutige Status-ID aus PaperOffice.<br>
                        Statusname: UTF-8 Text mit für Windows-Dateinamen gültigen Zeichen<br>
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        bgcolor
                    </td>
                    <td>
                        HEX-Farbwert für die Hintergrundsfarbe
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        fgcolor
                    </td>
                    <td>
                        HEX-Farbwert für die Schriftfarbe
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>document_contacts</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Mit dem Dokument verbundene Kontakte
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Weist dem neuen Dokument diese Kontaktverbindungen zu und legt diese optional an, insofern diese nicht vorhanden sind.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters - JSON-String</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        name
                    </td>
                    <td>
                        Statusname: UTF-8 Text mit für Windows-Dateinamen gültigen Zeichen
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        firstname
                    </td>
                    <td>
                        Vorname
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        lastname
                    </td>
                    <td>
                        Nachname
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        company
                    </td>
                    <td>
                        Unternehmen
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        department
                    </td>
                    <td>
                        Abteilung
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        position
                    </td>
                    <td>
                        Position
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        position
                    </td>
                    <td>
                        Position
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        custom_field1_name
                    </td>
                    <td>
                        Add custom_field1 value
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        custom_field2_name
                    </td>
                    <td>
                        Add custom_field2 value
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        custom_field5_name
                    </td>
                    <td>
                        Add custom_field5 value
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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":"Vorname", "lastname":"Nachname", "company":"Unternehmen", "department":"Abteilung", "position":"Position", "fieldName":"value" } ], </b> "oncomplete_open_document":"true" } </pre> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>callback_id</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Eindeutige ID für die Callback-Datei (benötigt für alle Callback-Funktionen)
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Wird benutzt um das spätere Callback einer eindeutigen ID zuzuordnen.<br>
                So wird die callback_id mit dem callback_X verbunden, damit jeder Callback auch das korrekte Ergebnis erhält.<br>
                Es wird empfohlen Microtime oder ähnliches zu benutzen, um die ID einzigartig zu machen.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_id
                    </td>
                    <td>
                        Beliebiger Text ohne Sonderzeichenen
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>callback_filepath</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dateipfad zur Callback-Datei
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Legt den vollen Pfad zu der Callback-Datei im UNIX Format fest.<br>
                Die Callback-Datei wird automatisch nach Speicherung des neuen Dokumentes erstellt und enthält Informationen im JSON-Format. Die Dateiendung muss "callback.pojob.json" lauten.<br>
                Es wird empfohlen als Dateinamen Microtime oder ähnliches zu benutzen, da die Datei ansonsten überschrieben wird. Das Verzeichnis muss vorhanden sein.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_id
                    </td>
                    <td>
                        Absoluter Dateipfad im UTF-8- und UNIX Format
                    </td>
                    <td>NO</td>
                </tr>
            </table>
            <b>Return</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_id
                    </td>
                    <td>
                        Die selbst gesetzte callback_id beim Erstellen des POJOB
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        document_id
                    </td>
                    <td>
                        Dokument-ID des neuen Dokumentes
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>callback_exepush</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Callback an eine EXE-Datei pushen
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Startet die angegebene EXE-Datei und übergibt den Callback als Parameter.<br>
                Die EXE sollte sich nach dem Start selbstständig beenden, ansonsten beträgt das Timeout 10sec.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_exepush
                    </td>
                    <td>
                        Absoluter Pfad zur EXE-Datei
                    </td>
                    <td>NO</td>
                </tr>
            </table>
            <b>Return</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_id
                    </td>
                    <td>
                        Die selbst gesetzte callback_id beim Erstellen des POJOB
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        document_id
                    </td>
                    <td>
                        Dokument-ID des neuen Dokumentes
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>callback_urlpush</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Callback an eine URL pushen
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Pusht mit der GET-Methode den Callback an die angegebene URL.<br>
                Der Callback wird am Ende der URL-Adresse angehängt.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_urlpush
                    </td>
                    <td>
                        URL an welche der Push geschickt werden soll
                    </td>
                    <td>NO</td>
                </tr>
            </table>
            <b>Return</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        callback_id
                    </td>
                    <td>
                        Die selbst gesetzte callback_id beim Erstellen des POJOB
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        document_id
                    </td>
                    <td>
                        Dokument-ID des neuen Dokumentes
                    </td>
                    <td>NO</td>
                </tr>
            </table>
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>document_importance_level</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Document importance level
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Sets the importance level of the document.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        document_importance_level
                    </td>
                    <td>
                        Values from 1 - 14
                    </td>
                    <td>NO</td>
                </tr>
            </table>                
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>document_classification_level</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Document classification level
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Sets the classification level of the document.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>Integer</td>
                    <td>
                        document_classification_level
                    </td>
                    <td>
                        Values from 1 - 10
                    </td>
                    <td>NO</td>
                </tr>
            </table>                
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>

<li>        
    <a class="uk-accordion-title"><b>document_voucher fields</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Document voucher flields
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Sets the value of each individual voucher field.<br>
                <b>Currency format needs to match the settings from current user!</b>
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Description</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_number
                    </td>
                    <td>
                        The desired Invoice number e.g.: IN123456
                    </td>
                    <td>NO</td>
                </tr>
                <!-- <tr>
                    <td>String</td>
                    <td>
                        document_voucher_wkz
                    </td>
                    <td>
                        The desired currency format e.g.: EUR
                    </td>
                    <td>NO</td>
                </tr> -->
                <tr>
                    <td>float</td>
                    <td>
                        document_voucher_net
                    </td>
                    <td>
                        Invoice net e.g.: 100.00
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>float</td>
                    <td>
                        document_voucher_gross
                    </td>
                    <td>
                        Invoice gross e.g.: 110.00
                    </td>
                    <td>NO</td>
                </tr>

                <tr>
                    <td>float</td>
                    <td>
                        document_voucher_vat
                    </td>
                    <td>
                        Invoice VAT %, e.g.: 10.00
                    </td>
                    <td>NO</td>
                </tr>
                <!-- <tr>
                    <td>float</td>
                    <td>
                        document_voucher_vatsum
                    </td>
                    <td>
                        Invoice VAT sum, e.g.: 10.00
                    </td>
                    <td>NO</td>
                </tr> -->
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_debitaccount
                    </td>
                    <td>
                        Debit account number e.g.: DE77 1234 5678 9012 0130 00
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_creditaccount
                    </td>
                    <td>
                        Credit account number e.g.: DE88 1234 5678 9012 0130 00
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_costcenter1
                    </td>
                    <td>
                        Costcenter1 name
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_costcenter2
                    </td>
                    <td>
                        Costcenter2 name
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_bookingtext
                    </td>
                    <td>
                        The desired booking text
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_comment
                    </td>
                    <td>
                        The desired comment
                    </td>
                    <td>NO</td>
                </tr>
                <tr>
                    <td>String</td>
                    <td>
                        document_voucher_vatnumber
                    </td>
                    <td>
                        The desired VAT number number e.g.: LU26375245
                    </td>
                    <td>NO</td>
                </tr>
            </table>                
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
    <hr>
</li>
<!-- oncomplete_open_document -->
<li>        
    <a class="uk-accordion-title"><b>oncomplete_open_document</b></a>
    <div class="uk-accordion-content">            
        <p>
            <b>Funktion</b>
            <div>
                Dokument öffnen nach Speicherung
            </div>                
        </p>
        <p>
            <b>Beschreibung</b>
            <div>
                Öffnet das neue hinzugefügte Dokument in PaperOffice nachdem dieses gespeichert wurde.
            </div>                
        </p> 
        <p>
            <b>Mandatory</b>
            <div>NO</div> 
        </p>            
        <p>  
            <b>Parameters</b>              
            <table class="uk-table uk-table-striped apitd">
                <tr>
                    <th>Type</thd>
                    <th>Parameter</th>
                    <th>Beschreibung</th>
                    <th>Mandatory</th>
                </tr>
                <tr>
                    <td>Boolean</td>
                    <td>
                        oncomplete_open_document
                    </td>
                    <td>
                        true || false
                    </td>
                    <td>YES</td>
                </tr>
            </table>                
        </p>
        <p>
            <b>Beispiel</b>

<pre> {
"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> </p>

    </div>
</li>

</ul>