PaperOffice API JSON Parameter

Heiko Meyer

Erstellt: 12.08.2020 9:49 - Aktualisiert : 15.01.2021 5:31

Funktion

Zielordner in PaperOffice

Beschreibung

Legt den Zielordner in PaperOffice per interner Pfadangabe fest.
Die gesamte Ordnerstruktur wird automatisch erstellt, falls es den Pfad noch nicht gibt.

Mandatory

YES (One of the rootdir paths)

Parameters

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

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "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"
}

document_name

Funktion

Dokumentname

Beschreibung

Legt den Namen des neuen Dokumentes fest.

Mandatory

YES (one of the parameters)

Parameters

Type	Parameter	Beschreibung	Mandatory
String	Beliebiger Name UTF-8 Text mit für Windows-Dateinamen gültige Zeichen.	Benennt das neue Dokument.	NO
Dynamisch	DOCUMENT_FILEPATH_BASENAME	Erzeugt automatisch den Dokumentnamen aus dem im document_filepath angegebenen Dateinamen ohne Dateiendung	NO
Dynamisch	DOCUMENT_FILEPATH_FILENAME	Erzeugt automatisch den Dokumentnamen aus dem im document_filepath angegebenen Dateinamen mit Dateiendung	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage", 
    "document_state":
        {
            "name":"Dringend!", 
            "bgcolor":"#FF0000",
            "fgcolor":"#FFFFFF"
        },    
    "oncomplete_open_document":"true"
}

document_description

Funktion

Legt die Beschreibung des neuen Dokumentes fest

Beschreibung

Wird benutzt um das spätere Callback einer eindeutigen ID zuzuordnen.
So wird die callback_id mit dem callback_X verbunden, damit jeder Callback auch das korrekte Ergebnis erhält.
Es wird empfohlen Microtime oder ähnliches zu benutzen um die ID einzigartig zu machen.

Mandatory

Parameters - JSON-String

Type	Parameter	Beschreibung	Mandatory
String	description	Beliebiger Text ohne Sonderzeichen. Der Beschreibungstext kann optional als Post-It angezeigt werden. #Dokumenteigenschaften	NO
Boolean	showpostit	true \|\| false, true zeigt ein Post-It an	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage", 
    "document_description": 
		{
			"description":"Unbedingt auf Wiedervorlage setzen!",
			"showpostit":"true"
        },   
    "oncomplete_open_document":"true"
}

document_keywords

Funktion

Dokument-Schlüsselwörter

Beschreibung

Weist dem neuen Dokument diese Schlüsselwörter zu und legt diese optional an, insofern diese nicht vorhanden sind.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
Integer	Eindeutige Schlüsselwort-ID aus PaperOffice	Mehrfachangabe getrennt mit ;	NO
String Dynamisch	Beliebiger Text	Text im UTF-8 Format mit für Windows-Dateinamen gültigen Zeichen. Das Schlüsselwort wird automatisch angelegt, insofern dieses noch nicht vorhanden ist, Mehrfachangabe getrennt mit ;	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
    "document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage", 
    "document_description": 
		{
			"description":"Unbedingt auf Wiedervorlage setzen!",
			"showpostit":"true"
        },
    "oncomplete_open_document":"true"
}

document_type

Funktion

Dokument-Typ

Beschreibung

Weist dem neuen Dokument diesen Dokumenttyp zu und legt diesen optional an, insofern dieser nicht vorhanden ist.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
Integer	Eindeutige Dokumenttyp-ID aus PaperOffice,	Mehrfachangabe getrennt mit ;	NO
String Dynamisch	Beliebiger Text	Text im UTF-8 Format mit für Windows-Dateinamen gültigen Zeichen. Der Dokumentyp wird automatisch angelegt, insofern dieser noch nicht vorhanden ist, Mehrfachangabe getrennt mit ;	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
    "document_type":"Rechnung;Rechnung unbezahlt;Auto-Ablage;9",
    "document_description": 
		{
			"description":"Unbedingt auf Wiedervorlage setzen!",
			"showpostit":"true"
        },
    "oncomplete_open_document":"true"
}

document_state

Funktion

Dokument-Status

Beschreibung

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.

Mandatory

Parameters - JSON-String

Type	Parameter	Beschreibung	Mandatory
String	name	Eindeutige Status-ID aus PaperOffice. Statusname: UTF-8 Text mit für Windows-Dateinamen gültigen Zeichen	NO
String	bgcolor	HEX-Farbwert für die Hintergrundsfarbe	NO
String	fgcolor	HEX-Farbwert für die Schriftfarbe	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
    "document_state":
        {
            "name":"Dringend!", 
            "bgcolor":"#FF0000",
            "fgcolor":"#FFFFFF"
        },
    "oncomplete_open_document":"true"
}

document_contacts

Funktion

Mit dem Dokument verbundene Kontakte

Beschreibung

Weist dem neuen Dokument diese Kontaktverbindungen zu und legt diese optional an, insofern diese nicht vorhanden sind.

Mandatory

Parameters - JSON-String

Type	Parameter	Beschreibung	Mandatory
String	name	Statusname: UTF-8 Text mit für Windows-Dateinamen gültigen Zeichen	NO
String	firstname	Vorname	NO
String	lastname	Nachname	NO
String	company	Unternehmen	NO
String	department	Abteilung	NO
String	position	Position	NO
String	position	Position	NO
String	custom_field1_name	Add custom_field1 value	NO
String	custom_field2_name	Add custom_field2 value	NO
String	custom_field5_name	Add custom_field5 value	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_keywords":"Projekt Bahnhof;Einkauf;Kulanz;15",
    "document_contacts":
		[
			{
				"name":"Genossenschaft Bauen",
				"firstname":"Hans",
				"lastname":"Huber"
			},
			{
				"name":"Name",
				"firstname":"Vorname",
				"lastname":"Nachname",
				"company":"Unternehmen",
				"department":"Abteilung",
				"position":"Position",
				"fieldName":"value"
			}
		], 
    "oncomplete_open_document":"true"
}

callback_id

Funktion

Eindeutige ID für die Callback-Datei (benötigt für alle Callback-Funktionen)

Beschreibung

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
String	callback_id	Beliebiger Text ohne Sonderzeichenen	NO

Beispiel

{    
    "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",
    "oncomplete_open_document":"true"
}

callback_filepath

Funktion

Dateipfad zur Callback-Datei

Beschreibung

Legt den vollen Pfad zu der Callback-Datei im UNIX Format fest.
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.
Es wird empfohlen als Dateinamen Microtime oder ähnliches zu benutzen, da die Datei ansonsten überschrieben wird. Das Verzeichnis muss vorhanden sein.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
String	callback_id	Absoluter Dateipfad im UTF-8- und UNIX Format	NO

Return

Type	Parameter	Beschreibung	Mandatory
String	callback_id	Die selbst gesetzte callback_id beim Erstellen des POJOB	NO
Integer	document_id	Dokument-ID des neuen Dokumentes	NO

Beispiel

{    
    "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",
    "oncomplete_open_document":"true"
}

callback_exepush

Funktion

Callback an eine EXE-Datei pushen

Beschreibung

Startet die angegebene EXE-Datei und übergibt den Callback als Parameter.
Die EXE sollte sich nach dem Start selbstständig beenden, ansonsten beträgt das Timeout 10sec.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
String	callback_exepush	Absoluter Pfad zur EXE-Datei	NO

Return

Type	Parameter	Beschreibung	Mandatory
String	callback_id	Die selbst gesetzte callback_id beim Erstellen des POJOB	NO
Integer	document_id	Dokument-ID des neuen Dokumentes	NO

Beispiel

{    
    "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_exepush":"c:/Helper/com.paperoffice.push2database.exe",
    "oncomplete_open_document":"true"
}

callback_urlpush

Funktion

Callback an eine URL pushen

Beschreibung

Pusht mit der GET-Methode den Callback an die angegebene URL.
Der Callback wird am Ende der URL-Adresse angehängt.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
String	callback_urlpush	URL an welche der Push geschickt werden soll	NO

Return

Type	Parameter	Beschreibung	Mandatory
String	callback_id	Die selbst gesetzte callback_id beim Erstellen des POJOB	NO
Integer	document_id	Dokument-ID des neuen Dokumentes	NO

Beispiel

{    
    "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",
    "oncomplete_open_document":"true"
}

document_importance_level

Funktion

Document importance level

Beschreibung

Sets the importance level of the document.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
Integer	document_importance_level	Values from 1 - 14	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_importance_level":10,
    "oncomplete_open_document":"true"
}

document_classification_level

Funktion

Document classification level

Beschreibung

Sets the classification level of the document.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
Integer	document_classification_level	Values from 1 - 10	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_classification_level":10,
    "oncomplete_open_document":"true"
}

document_voucher fields

Funktion

Document voucher flields

Beschreibung

Sets the value of each individual voucher field.
Currency format needs to match the settings from current user!

Mandatory

Parameters

Type	Parameter	Description	Mandatory
String	document_voucher_number	The desired Invoice number e.g.: IN123456	NO
float	document_voucher_net	Invoice net e.g.: 100.00	NO
float	document_voucher_gross	Invoice gross e.g.: 110.00	NO
float	document_voucher_vat	Invoice VAT %, e.g.: 10.00	NO
String	document_voucher_debitaccount	Debit account number e.g.: DE77 1234 5678 9012 0130 00	NO
String	document_voucher_creditaccount	Credit account number e.g.: DE88 1234 5678 9012 0130 00	NO
String	document_voucher_costcenter1	Costcenter1 name	NO
String	document_voucher_costcenter2	Costcenter2 name	NO
String	document_voucher_bookingtext	The desired booking text	NO
String	document_voucher_comment	The desired comment	NO
String	document_voucher_vatnumber	The desired VAT number number e.g.: LU26375245	NO

Beispiel

{    
    "document_category_path":"rootdir_documents_personal/Automatische Dokumente/__YYYY__/__MM__",
    "document_name":"DOCUMENT_FILEPATH_BASENAME",
    "document_voucher_number":"IN123456",
    "document_voucher_wkz":"EUR",
    "document_voucher_net":"100.00",
    "document_voucher_gross":"110.00",
    "document_voucher_vat":"10.00",
    "document_voucher_vatsum":"10.00",
    "document_voucher_debitaccount":"DE77 1234 5678 9012 0130 00",
    "document_voucher_creditaccount":"DE88 1234 5678 9012 0130 00",
    "document_voucher_costcenter1":"Production",
    "document_voucher_costcenter2":"Service",
    "document_voucher_bookingtext":"AMAZON",
    "document_voucher_comment":"Amazon payment",
    "document_voucher_vatnumber":"LU26375245",
    "oncomplete_open_document":"true"
}

oncomplete_open_document

Funktion

Dokument öffnen nach Speicherung

Beschreibung

Öffnet das neue hinzugefügte Dokument in PaperOffice nachdem dieses gespeichert wurde.

Mandatory

Parameters

Type	Parameter	Beschreibung	Mandatory
Boolean	oncomplete_open_document	true \|\| false	YES

Beispiel

{    
    "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",
    "oncomplete_open_document":"true"
}

PaperOffice API JSON Parameter

Heiko Meyer

War dieser Artikel hilfreich?

Aktuelle Artikel

DropMail empfängt keine Anhänge – Fehlerbehebungsanleitung

Wie man eine langsame Suche oder langsames Laden von Inhalten in PaperOffice behebt, indem man FULLTEXT-Indizes neu erstellt

PIA Zeigt Vorheriges Dokumentenbild oder Flackert

Behebung von Problemen bei der Erstellung der PaperOffice-Datenbank auf Synology NAS-Geräten

PaperOffice zeigt beim Start nur das Fenster Status - Letzte Rechnung an

Kategorien