GoFileRoom
GoFileRoom ist eine cloudbasierte Dokumentverwaltung und Workflowlösung. Mit dem GoFileRoom-Connector können Sie Dokument-, Benutzerverwaltungs- und FirmFlow-Aktionen ausführen.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Norm | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Norm | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Norm | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | GoFileRoom-Unterstützung |
| URL | https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact |
| CS.Support@ThomsonReuters.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Thomson Reuters |
| Webseite | https://www.gofileroom.com/ |
| Datenschutzrichtlinie | https://www.thomsonreuters.com/en/privacy-statement.html |
| Kategorien | Daten; Unternehmensführung |
Der GoFileRoom Connector bietet den Kunden von Thomson Reuters eine einfache Möglichkeit, DIE API für GoFileRoom und FirmFlow zu nutzen. Benutzer können Automatisierung und Integration im Zusammenhang mit der Benutzerverwaltung, Dokumenten oder FirmFlow erstellen.
Voraussetzungen
Benutzer müssen über einen GoFileRoom-API-Schlüssel verfügen, um den Connector verwenden zu können.
Wie erhalten Sie Anmeldeinformationen?
Der API-Schlüssel kann abgerufen werden, indem er sich für ein Konto registriert https://developerportal.thomsonreuters.com/. Darüber hinaus müssen Sie über ein aktives GoFileRoom-Konto verfügen. Wenn Sie interesse an GoFileRoom haben, kontaktieren Sie uns hier: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| X-TR-API-APP-ID | securestring | Die X-TR-API-APP-ID für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abmelden |
Abmelden der Anwendung |
| Abrufen des Master-Lieferumfangs |
Abrufen des Master-Lieferumfangs |
| Abrufen untergeordneter Indizes |
Ruft eine Liste der untergeordneten Indexwerte basierend auf der Listen-ID ab, die angegeben wird, wenn der übergeordnete Listenwert ausgewählt wird. |
| Abrufen von Benutzerberechtigungen |
Ruft Berechtigungen des Benutzers ab. |
| Abrufen von Benutzerinformationen |
Ruft die GFR-Benutzerinformationen ab |
| Abrufen von Benutzerinformationen V2 |
Ruft die Benutzerinfromation ab. |
| Abrufen von Dokumentindizes |
Ruft die Indizes des Dokuments ab. |
|
Abrufen von Firm |
Ruft den Nachverfolgungsbericht nach Lieferumfangsdaten ab. |
| Abrufen von Schubladen |
Ruft die Schubladen, auf die für den angemeldeten Benutzer zugegriffen werden kann |
| Abrufen von Uploadspeicherorten |
Ruft die Uploadspeicherorte für den Benutzer ab. |
| Arbeitsfluss bearbeiten |
Arbeitsfluss bearbeiten |
| Benutzer abrufen |
Ruft die GFR-Benutzer für den angemeldeten Benutzer ab. |
| Benutzer erstellen |
Erstellt GoFileRoom- und ClientFlow-Benutzer im System |
| Benutzer löschen |
Löschen von GoFileRoom- und ClientFlow-Benutzern aus dem System |
| Benutzer ändern |
Ändern von Benutzerberechtigungen |
| Benutzerdokumentsicherheit abrufen |
Ruft die Sicherheit von Benutzerdokumenten pro Anmeldung ab. |
| Bericht nach Workflow nachverfolgen |
Bericht nach Workflow nachverfolgen |
| Dokument abrufen |
Lädt das Dokument herunter. |
| Dokument erstellen |
Erstellt einen Dokumentdatensatz mit Indizes |
| Dokument kopieren |
Kopiert die Dokumente |
| Dokument löschen |
Löscht ein Dokument. |
| Dokument neu indizieren |
Neuindiziert die Dokumente |
| Dokumentstatus abrufen |
Abrufen des Status von Dokumenten |
| Dokumentstatus veröffentlichen |
Veröffentlichen oder Aufheben der Veröffentlichung von Dokumenten aus ClientFlow. |
| Dokumentsuche |
Lädt alle Dokumente, auf die der Benutzer in der angegebenen Schublade zugreifen kann. |
| Dokumentverlauf abrufen |
Ruft den Verlauf des Dokuments ab. |
| Dynamische Regeln für Index abrufen |
Ruft die Liste der dynamischen Regeln ab, die für den angegebenen Index konfiguriert sind. |
| Einloggen |
Protokolliert einen Benutzer bei der Anwendung. |
| Erstellen einer Gruppe |
Erstellt Berechtigungsgruppe |
| Festlegen der Benutzerdokumentsicherheit |
Zuweisen von Benutzerdokumentsicherheitsberechtigungen |
| Festlegen von Benutzerberechtigungen |
Zuweisen von Berechtigungen für Den Benutzer |
| Gruppe ändern |
Ändern von Gruppenberechtigungen |
| Gruppen abrufen |
Ruft die für die Benutzer- und Gruppenverwaltung verfügbaren Gruppen ab. |
| Gruppenberechtigungen abrufen |
Ruft Berechtigungen von Gruppen ab |
| Gruppenberechtigungen festlegen |
Zuweisen der Berechtigung zur Gruppe |
| Gruppendokumentsicherheit abrufen |
Abrufen der Gruppendokumentsicherheit |
| Gruppendokumentsicherheit festlegen |
Zuweisen der Dokumentsicherheit zu einer Gruppe |
| Hinzufügen eines Master-Lieferumfangs |
Hinzufügen eines Master-Lieferumfangs |
| Index-Nachschlageliste suchen |
Diese Methode wurde für die Verwendung mit AutoVervollständigen-Feldern entwickelt. |
| Kennwortrichtlinie abrufen |
Ruft die Kennwortrichtlinie für die Firma ab. |
| Liste der Berichte abrufen |
Ruft die Berichte ab, die für die Benutzerverwaltung verfügbar sind. |
| Liste der Indexwerte abrufen |
Ruft alle Einträge für einen Listentypindex ab. |
| Lizenzen abrufen |
Ruft die Anzahl der Lizenzen ab. |
|
Lookup |
Ruft die Werte aus der LookupList ab. |
| Master-Lieferumfang bearbeiten |
Master-Lieferumfang bearbeiten |
| Master-Lieferumfang löschen |
Master-Lieferumfang löschen |
| PDF-Dateien zusammenführen |
Zusammenführen von PDF-Dateien |
| Routingworkflow V2 |
Routingworkflow V2 |
| Schubladeindizes abrufen |
Ruft eine Liste von Dokumentindizes ab, die für die Schublade eingerichtet sind. |
| Steuersortdokument |
PDF-Dokument für Steuersort |
| Token überprüfen |
Überprüfen des Tokenstatus |
| Tracking-Bericht nach Lieferumfang V2 |
Nachverfolgungsbericht nach DeliverableV2 |
| Workflow erstellen |
Workflow erstellen |
| Workflows löschen |
Workflows löschen |
| Überprüfen von Indizes |
Überprüft, ob die bereitgestellten Indizes gültig sind. |
Abmelden
Abmelden der Anwendung
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
isLogoutSuccess
|
isLogoutSuccess | boolean |
War die Abmeldung erfolgreich |
Abrufen des Master-Lieferumfangs
Abrufen des Master-Lieferumfangs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Seitennummer
|
PageNumber | integer |
Seitennummer |
|
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Name der Schublade
|
DrawerName | string |
Name der Schublade |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
deliverableList
|
deliverableList | array of object |
deliverableList |
|
Lieferumfangsname
|
deliverableList.deliverableName | string |
Lieferumfangsname |
|
Art der Erweiterung
|
deliverableList.extensionType | string |
Art der Erweiterung |
|
Fälligkeitsdatum
|
deliverableList.dueDate | string |
Fälligkeitsdatum |
|
Erste Erweiterung
|
deliverableList.firstExtension | string |
Erste Erweiterung |
|
Zweite Erweiterung
|
deliverableList.secondExtension | string |
Zweite Erweiterung |
|
Dritte Erweiterung
|
deliverableList.thirdExtension | string |
Dritte Erweiterung |
|
Extension
|
deliverableList.extension | string |
Extension |
|
Maßnahme
|
deliverableList.action | string |
Maßnahme |
|
Verpflichtungs-ID
|
deliverableList.obligationId | string |
Verpflichtungs-ID |
|
Unternehmensverwaltete Option
|
deliverableList.firmManagedOption | string |
Unternehmensverwaltete Option |
|
Datensätze insgesamt
|
totalRecords | string |
Datensätze insgesamt |
|
Antwortnachricht
|
responseMessage | string |
Antwortnachricht |
Abrufen untergeordneter Indizes
Ruft eine Liste der untergeordneten Indexwerte basierend auf der Listen-ID ab, die angegeben wird, wenn der übergeordnete Listenwert ausgewählt wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Index-ID eingeben |
|
ListId
|
listId | True | string |
Listen-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
untergeordneter Index-ID-Wert |
|
childListId
|
childListId | integer |
untergeordneter Listen-ID-Wert |
|
hasChildren
|
hasChildren | boolean |
Hat der Index einen untergeordneten Index |
|
listEntryId
|
listEntryId | integer |
Listeneintrags-ID-Wert |
|
listId
|
listId | integer |
Listen-ID-Wert |
|
value
|
value | string |
value |
Abrufen von Benutzerberechtigungen
Ruft Berechtigungen des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Einloggen
|
login | True | string |
Anmeldung eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
cabinet
|
cabinet | string |
Cab-Name-Wert |
|
add
|
cabinetPermission.add | boolean |
Mehrwert hinzufügen |
|
delete
|
cabinetPermission.delete | boolean |
Löschwert |
|
leugnen
|
cabinetPermission.deny | boolean |
Verweigerungswert |
|
edit
|
cabinetPermission.edit | boolean |
Wert bearbeiten |
|
nachschlagen
|
cabinetPermission.lookUp | boolean |
LookUp-Wert |
|
read
|
cabinetPermission.read | boolean |
Wert lesen |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
Schublade
|
drawerPermissions.drawer | string |
Namewert der Schublade |
|
add
|
drawerPermissions.permission.add | boolean |
Mehrwert hinzufügen |
|
delete
|
drawerPermissions.permission.delete | boolean |
Löschwert |
|
leugnen
|
drawerPermissions.permission.deny | boolean |
Verweigerungswert |
|
edit
|
drawerPermissions.permission.edit | boolean |
Wert bearbeiten |
|
nachschlagen
|
drawerPermissions.permission.lookUp | boolean |
LookUp-Wert |
|
read
|
drawerPermissions.permission.read | boolean |
Wert lesen |
|
getUserPermissionException
|
getUserPermissionException | string |
Ausnahme für Benutzerberechtigungen |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
Abrufen von Benutzerinformationen
Ruft die GFR-Benutzerinformationen ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Anmeldename
|
LoginName | True | string |
LoginName eingeben |
|
Benutzertyp
|
UserType | True | string |
UserType auswählen |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
createDate (Datum)
|
createDate | string |
createDate (Datum) |
|
createdBy
|
createdBy | string |
createdBy |
|
Beschreibung
|
description | string |
Beschreibung |
|
disabled
|
disabled | integer |
disabled |
|
disabledByAdmin
|
disabledByAdmin | boolean |
disabledByAdmin |
|
emailNotify
|
emailNotify | boolean |
emailNotify |
|
emailNotifyEventMgmtGroups
|
emailNotifyEventMgmtGroups | boolean |
emailNotifyEventMgmtGroups |
|
emailNotifyEventMgmtUsers
|
emailNotifyEventMgmtUsers | boolean |
emailNotifyEventMgmtUsers |
|
emailNotifyGroup
|
emailNotifyGroup | boolean |
emailNotifyGroup |
|
forcePasswordChange
|
forcePasswordChange | boolean |
forcePasswordChange |
|
fullName
|
fullName | string |
fullName |
|
hasDrawerSetupRights
|
hasDrawerSetupRights | string |
hasDrawerSetupRights |
|
isAdmin
|
isAdmin | integer |
isAdmin |
|
isManager
|
isManager | integer |
isManager |
|
licenseType
|
licenseType | string |
licenseType |
|
locationID
|
locationID | string |
locationID |
|
loginID
|
loginID | string |
loginID |
|
managerFullName
|
managerFullName | string |
managerFullName |
|
managerId
|
managerId | string |
managerId |
|
managerLoginId
|
managerLoginId | string |
managerLoginId |
|
oberonUser
|
oberonUser | integer |
oberonUser |
|
offline
|
offline | boolean |
offline |
|
passwordChangeDate
|
passwordChangeDate | string |
passwordChangeDate |
|
passwordChangeInterval
|
passwordChangeInterval | integer |
passwordChangeInterval |
|
passwordExpireDate
|
passwordExpireDate | string |
passwordExpireDate |
|
reports
|
reports | boolean |
reports |
|
Signatur
|
signature | string |
Signatur |
|
systemAdmin
|
systemAdmin | boolean |
systemAdmin |
|
taxFlow
|
taxFlow | boolean |
taxFlow |
|
userAdministration
|
userAdministration | integer |
userAdministration |
|
userID
|
userID | string |
userID |
|
workflowManagerUser
|
workflowManagerUser | boolean |
workflowManagerUser |
Abrufen von Benutzerinformationen V2
Ruft die Benutzerinfromation ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Benutzername
|
LoginName | string |
Benutzername |
|
|
Benutzertyp
|
UserType | string |
Benutzertyp |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer-ID
|
userID | string |
Benutzer-ID |
|
Anmelde-ID
|
loginID | string |
Anmelde-ID |
|
Vollständiger Name
|
fullName | string |
Vollständiger Name |
|
Erstellungsdatum
|
createDate | string |
Erstellungsdatum |
|
Erstellt von
|
createdBy | string |
Erstellt von |
|
Description
|
description | string |
Description |
|
Disabled
|
disabled | integer |
Disabled |
|
Vom Administrator deaktiviert
|
disabledByAdmin | boolean |
Vom Administrator deaktiviert |
|
Ablaufdatum des Kennworts
|
passwordExpireDate | string |
Ablaufdatum des Kennworts |
|
Kennwortänderung erzwingen
|
forcePasswordChange | boolean |
Kennwortänderung erzwingen |
|
Datum der Kennwortänderung
|
passwordChangeDate | string |
Datum der Kennwortänderung |
|
Kennwortänderungsintervall
|
passwordChangeInterval | integer |
Kennwortänderungsintervall |
|
Lizenztyp
|
licenseType | string |
Lizenztyp |
|
Offline
|
offline | boolean |
Offline |
|
Berichte
|
reports | boolean |
Berichte |
|
Systemadministrator
|
systemAdmin | boolean |
Systemadministrator |
|
Signature
|
signature | string |
Signature |
|
Speicherort-ID
|
locationID | string |
Speicherort-ID |
|
Verfügt über Einrichtungsrechte für Schublade
|
hasDrawerSetupRights | string |
Verfügt über Einrichtungsrechte für Schublade |
|
Steuerfluss
|
taxFlow | boolean |
Steuerfluss |
|
E-Mail-Benachrichtigung
|
emailNotify | boolean |
E-Mail-Benachrichtigung |
|
E-Mail-Benachrichtigungsgruppe
|
emailNotifyGroup | boolean |
E-Mail-Benachrichtigungsgruppe |
|
E-Mail-Benachrichtigungsereignis Mgmt-Benutzer
|
emailNotifyEventMgmtUsers | boolean |
E-Mail-Benachrichtigungsereignis Mgmt-Benutzer |
|
E-Mail-Benachrichtigungsereignis Mgmt-Gruppen
|
emailNotifyEventMgmtGroups | boolean |
E-Mail-Benachrichtigungsereignis Mgmt-Gruppen |
|
Portalbenutzerverwaltung
|
portalUserAdministration | boolean |
Portalbenutzerverwaltung |
|
Interne Benutzerverwaltung
|
internalUserAdministration | boolean |
Interne Benutzerverwaltung |
|
Workflow-Manager-Benutzer
|
workflowManagerUser | boolean |
Workflow-Manager-Benutzer |
|
Manager-ID
|
managerId | string |
Manager-ID |
|
Manager-Anmelde-ID
|
managerLoginId | string |
Manager-Anmelde-ID |
|
Vollständiger Name des Managers
|
managerFullName | string |
Vollständiger Name des Managers |
|
Ist Manager
|
isManager | integer |
Ist Manager |
|
Oberon-Benutzer
|
oberonUser | integer |
Oberon-Benutzer |
|
Ist Administrator
|
isAdmin | integer |
Ist Administrator |
|
Letzte Anmeldung
|
lastLogin | string |
Letzte Anmeldung |
|
Gruppen
|
groups | array of string |
Gruppen |
Abrufen von Dokumentindizes
Ruft die Indizes des Dokuments ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DokumentID
|
documentId | True | string |
Dokument-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
indexId | string |
Index-ID-Wert |
|
indexValue
|
indexValue | string |
Sollwert |
Abrufen von FirmFlow-Daten nach Lieferumfang
Ruft den Nachverfolgungsbericht nach Lieferumfangsdaten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Verantwortlich
|
Accountable | string |
Accountable-Wert eingeben |
|
|
AssignedOn
|
AssignedOn | string |
Zugewiesen am Datum eingeben |
|
|
AssignedTo
|
AssignedTo | string |
Geben Sie den Wert "Zugewiesen an" ein. |
|
|
AssignmentHistory
|
AssignmentHistory | string |
Zuordnungsverlauf eingeben |
|
|
CompletedBy
|
CompletedBy | string |
Eingeben des Werts "Abgeschlossen nach" |
|
|
CompletedOn
|
CompletedOn | string |
Eingabe abgeschlossen am Datum |
|
|
CurrentDueDate
|
CurrentDueDate | string |
Aktuelles Fälligkeitsdatum eingeben |
|
|
CurrentStep
|
CurrentStep | string |
Aktuellen Schritt eingeben |
|
|
DateExtended
|
DateExtended | string |
Datum erweitert eingeben |
|
|
DaysAtStep
|
DaysAtStep | string |
Tage bei Schritt eingeben |
|
|
DaysBetweenRoutings
|
DaysBetweenRoutings | string |
Tage zwischen Routing eingeben |
|
|
DrawerId
|
DrawerId | string |
Schublade-ID eingeben |
|
|
EngagementType
|
EngagementType | string |
Einsatztyp eingeben |
|
|
InProcessOnly
|
InProcessOnly | string |
Nur Wert für "In Prozess eingeben" |
|
|
Indizes
|
Indexes | array of string |
Indizes |
|
|
InformationFields
|
InformationFields | array of string |
InformationFields |
|
|
OriginalDueDate
|
OriginalDueDate | string |
Ursprüngliches Fälligkeitsdatum eingeben |
|
|
PIC
|
PIC | string |
PIC eingeben |
|
|
PageNumber
|
PageNumber | string |
Seitenzahl eingeben |
|
|
Priority
|
Priority | string |
Priorität eingeben |
|
|
ReceivedFrom
|
ReceivedFrom | string |
Eingeben des Werts "Empfangen von" |
|
|
Empfangen am
|
ReceivedOn | string |
Eingeben des Empfangsdatums |
|
|
Verantwortlich
|
Responsible | string |
Verantwortungsvoller Wert eingeben |
|
|
RoutingDetails
|
RoutingDetails | string |
Routingdetails eingeben |
|
|
SentOn
|
SentOn | string |
Übermittlungsdatum eingeben |
|
|
SentTo
|
SentTo | string |
Geben Sie den Wert "Gesendet an" ein. |
|
|
ServiceType
|
ServiceType | string |
Diensttyp eingeben |
|
|
Der Status
|
Status | string |
Status eingeben |
|
|
TotalDaysAtStep
|
TotalDaysAtStep | string |
Gesamtanzahl der Tage in Schritt eingeben |
|
|
TotalDaysInProcess
|
TotalDaysInProcess | string |
Gesamtzahl der verarbeiteten Tage eingeben |
|
|
Arbeitsablauf
|
Workflow | string |
Workflownamen eingeben |
|
|
WorkflowDescription
|
WorkflowDescription | string |
Workflowbeschreibung eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
verantwortlich
|
firmFlowReportResponse.accountable | string |
Verantwortlicher Wert |
|
assignedOn
|
firmFlowReportResponse.assignedOn | string |
zugewiesen am Datum |
|
assignedTo
|
firmFlowReportResponse.assignedTo | string |
zugewiesener Wert |
|
assignedToYesOrNo
|
firmFlowReportResponse.assignedToYesOrNo | string |
Ist der Workflow zugewiesen |
|
assignmentHistory
|
firmFlowReportResponse.assignmentHistory | string |
Zuordnungsverlaufswert |
|
clientName
|
firmFlowReportResponse.clientName | string |
Clientnamewert |
|
clientNumber
|
firmFlowReportResponse.clientNumber | string |
Clientnummerwert |
|
completedBy
|
firmFlowReportResponse.completedBy | string |
abgeschlossen nach Wert |
|
completedOn
|
firmFlowReportResponse.completedOn | string |
abgeschlossen am Datum |
|
currentDueDate
|
firmFlowReportResponse.currentDueDate | string |
aktuelles Fälligkeitsdatum |
|
currentStep
|
firmFlowReportResponse.currentStep | string |
aktueller Schrittwert |
|
dateExtended
|
firmFlowReportResponse.dateExtended | string |
Datum erweitert |
|
daysAtStep
|
firmFlowReportResponse.daysAtStep | string |
Workflowtage in Step |
|
daysBetweenRoutings
|
firmFlowReportResponse.daysBetweenRoutings | string |
Workflowtage zwischen Routings |
|
Lieferumfang
|
firmFlowReportResponse.deliverables | string |
Lieferumfangswert |
|
DrawerId
|
firmFlowReportResponse.drawerId | string |
Drawer ID-Wert |
|
eFileYesOrNo
|
firmFlowReportResponse.eFileYesOrNo | string |
ist der Lieferumfang, der eFiled sein soll |
|
engagementType
|
firmFlowReportResponse.engagementType | string |
Wert des Einsatztyps |
|
extendedYesOrNo
|
firmFlowReportResponse.extendedYesOrNo | string |
hat den Lieferumfang erweitert |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
name
|
firmFlowReportResponse.informationFields.name | string |
name |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
originalDueDate
|
firmFlowReportResponse.originalDueDate | string |
ursprüngliches Fälligkeitsdatum |
|
periodEnd
|
firmFlowReportResponse.periodEnd | string |
Ablauf des Workflows |
|
pic
|
firmFlowReportResponse.pic | string |
Bild des Workflows |
|
picYesOrNo
|
firmFlowReportResponse.picYesOrNo | string |
wurde das Bild zugewiesen. |
|
priority
|
firmFlowReportResponse.priority | string |
Prioritätswert |
|
Fortschritt
|
firmFlowReportResponse.progress | string |
Statuswert |
|
receivedFrom
|
firmFlowReportResponse.receivedFrom | string |
Received From-Wert |
|
receivedOn
|
firmFlowReportResponse.receivedOn | string |
empfangen am Datum |
|
verantwortlich
|
firmFlowReportResponse.responsible | string |
Verantwortungsvoller Wert |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
routingNotes
|
firmFlowReportResponse.routingNotes | string |
Routingnotizen des Workflows |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
sentOn
|
firmFlowReportResponse.sentOn | string |
gesendet am Datum |
|
sentTo
|
firmFlowReportResponse.sentTo | string |
sent To-Wert |
|
serviceType (englisch)
|
firmFlowReportResponse.serviceType | string |
Diensttyp des Workflows |
|
status
|
firmFlowReportResponse.status | string |
Status des Workflows |
|
totalDaysAtStep
|
firmFlowReportResponse.totalDaysAtStep | string |
Workflow-Gesamtanzahl der Tage in Schritt |
|
totalDaysInProcess
|
firmFlowReportResponse.totalDaysInProcess | string |
Workflow insgesamt Tage im Prozess |
|
Arbeitsablauf
|
firmFlowReportResponse.workflow | string |
Workflowtyp |
|
workflowDescription
|
firmFlowReportResponse.workflowDescription | string |
Workflowbeschreibung |
|
Jahr
|
firmFlowReportResponse.year | string |
Jahr des Workflows |
|
getFirmFlowException
|
getFirmFlowException | string |
Get FirmFlow Exception |
|
pageNumber
|
pageNumber | string |
Seitenanzahl der Anforderung |
|
pageSize
|
pageSize | integer |
Seitengröße der Anforderung |
|
totalPages
|
totalPages | integer |
Gesamtanzahl der Seiten der Anforderung |
|
totalRecords
|
totalRecords | integer |
Gesamtanzahl der Datensätze der Anforderung |
Abrufen von Schubladen
Ruft die Schubladen, auf die für den angemeldeten Benutzer zugegriffen werden kann
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
DrawerID
|
drawerID | string |
Drawer ID-Wert |
|
drawerName
|
drawerName | string |
Drawer Name-Wert |
|
add
|
permissions.add | boolean |
Mehrwert hinzufügen |
|
delete
|
permissions.delete | boolean |
Löschwert |
|
edit
|
permissions.edit | boolean |
Wert bearbeiten |
|
LookupManagement
|
permissions.lookupManagement | boolean |
LookupManagement-Wert |
|
Ansicht
|
permissions.view | boolean |
Ansichtswert |
Abrufen von Uploadspeicherorten
Ruft die Uploadspeicherorte für den Benutzer ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
uploadLocations
|
uploadLocations | array of object |
uploadLocations |
|
locationName
|
uploadLocations.locationName | string |
Location Name-Wert |
|
locationPath
|
uploadLocations.locationPath | string |
Location Path-Wert |
|
uploadLocationsException
|
uploadLocationsException | string |
Ausnahme für Uploadspeicherorte |
Arbeitsfluss bearbeiten
Arbeitsfluss bearbeiten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Ablage-ID
|
filingId | integer |
Ablage-ID |
|
|
Clientname
|
ClientName | string |
Clientname |
|
|
Clientnummer
|
ClientNumber | string |
Clientnummer |
|
|
Einsatztyp
|
EngagementType | string |
Einsatztyp |
|
|
PIC
|
PIC | string |
PIC |
|
|
Jahr
|
Year | string |
Jahr |
|
|
Ende des Zeitraums
|
PeriodEnd | string |
Ende des Zeitraums |
|
|
Lieferumfangsname
|
action | string |
Lieferumfangsname |
|
|
Aktuelles Fälligkeitsdatum
|
currentduedate | string |
Aktuelles Fälligkeitsdatum |
|
|
Ursprüngliches Fälligkeitsdatum
|
originalduedate | string |
Ursprüngliches Fälligkeitsdatum |
|
|
Attachment
|
form | string |
Attachment |
|
|
Hinweisaktion
|
action | string |
Hinweisaktion |
|
|
Notiztyp
|
noteType | string |
Notiztyp |
|
|
noteid
|
noteid | array of string |
noteid |
|
|
Notiznachricht
|
note | string |
Notiznachricht |
|
|
Name des Informationsfelds
|
name | string |
Name des Informationsfelds |
|
|
Wert des Informationsfelds
|
value | string |
Wert des Informationsfelds |
|
|
Übermittlungsmethode
|
Delivery | string |
Übermittlungsmethode |
|
|
Bestimmungsort
|
Destination | string |
Bestimmungsort |
|
|
Originalbeleg
|
sourceDocument | string |
Originalbeleg |
|
|
Verantwortungsvolles Feld
|
responsibleField | string |
Verantwortungsvolles Feld |
|
|
Zugeordnet
|
value | string |
Zugeordnet |
|
|
Erneutes Indizieren von Dokumenten
|
reindexDocs | boolean |
Erneutes Indizieren von Dokumenten |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ablage-ID
|
filingId | integer |
Ablage-ID |
|
Fehlerkommentar
|
errorComment | string |
Fehlerkommentar |
|
Der Status
|
status | boolean |
Der Status |
|
errorMessage
|
errorMessage | array of object |
errorMessage |
|
Name
|
errorMessage.name | string |
Name |
|
Der Status
|
errorMessage.status | boolean |
Der Status |
|
Fehlerkommentar
|
errorMessage.errorComment | string |
Fehlerkommentar |
Benutzer abrufen
Ruft die GFR-Benutzer für den angemeldeten Benutzer ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzertyp
|
userType | string |
Benutzertyp eingeben |
|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
isActive
|
isActive | boolean |
Ist der Benutzer aktiv |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
Benutzer erstellen
Erstellt GoFileRoom- und ClientFlow-Benutzer im System
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzertyp
|
userType | string |
Benutzertyp eingeben |
|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Kontoablaufdatum eingeben |
|
|
DisabledComments
|
DisabledComments | string |
Deaktivierte Kommentare eingeben |
|
|
FullName
|
FullName | string |
Vollständiger Benutzername |
|
|
Gruppen
|
Groups | array of string |
Gruppen |
|
|
IsAccountExpires
|
IsAccountExpires | string |
True oder False angeben |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
True oder False angeben |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
True oder False angeben |
|
|
IsAllowOffline
|
IsAllowOffline | string |
True oder False angeben |
|
|
IstDeaktiviert
|
IsDisabled | string |
True oder False angeben |
|
|
IsFirmFlow
|
IsFirmFlow | string |
True oder False angeben |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
True oder False angeben |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
True oder False angeben |
|
|
IsMfa
|
IsMfa | string |
True oder False angeben |
|
|
IsUserAdministration
|
IsUserAdministration | string |
True oder False angeben |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
True oder False angeben |
|
|
LicenseType
|
LicenseType | string |
Lizenztyp eingeben |
|
|
Anmeldename
|
LoginName | string |
Anmeldename eingeben |
|
|
ManagerEmail
|
ManagerEmail | string |
E-Mail-Adresse des Vorgesetzten eingeben |
|
|
Kennwort
|
Password | string |
Kennwort eingeben |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
True oder False angeben |
|
|
IsDenyAll
|
IsDenyAll | string |
True oder False angeben |
|
|
ReportType
|
ReportType | string |
True oder False angeben |
|
|
UploadLocation
|
UploadLocation | string |
Uploadspeicherort eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
createUserException
|
createUserException | string |
Erstellen einer Benutzer exception |
|
isCreated
|
isCreated | boolean |
Hat der Benutzer erstellt |
|
mfaException
|
mfaException | string |
mfa-Ausnahme |
|
userId
|
userId | string |
Benutzer-ID-Wert |
Benutzer löschen
Löschen von GoFileRoom- und ClientFlow-Benutzern aus dem System
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
LoginId
|
LoginId | string |
Geben Sie die Anmelde-ID des Benutzers ein. |
|
|
Benutzertyp
|
UserType | string |
Geben Sie den Benutzertyp ein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
deleteUserException
|
deleteUserException | string |
Benutzer exception löschen |
|
isDeleted
|
isDeleted | boolean |
Wurde die Anmeldung gelöscht |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
Benutzer ändern
Ändern von Benutzerberechtigungen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzertyp
|
userType | string |
Benutzertyp eingeben |
|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Datum, an dem das Konto abläuft |
|
|
DisabledComments
|
DisabledComments | string |
Kommentare eingeben |
|
|
FullName
|
FullName | string |
Vollständigen Namen eingeben |
|
|
Gruppen
|
Groups | array of string |
Gruppen |
|
|
IsAccountExpires
|
IsAccountExpires | string |
True oder False angeben |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
True oder False angeben |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
True oder False angeben |
|
|
IsAllowOffline
|
IsAllowOffline | string |
True oder False angeben |
|
|
IsChangeNextLogin
|
IsChangeNextLogin | string |
True oder False angeben |
|
|
IstDeaktiviert
|
IsDisabled | string |
True oder False angeben |
|
|
IsFirmFlow
|
IsFirmFlow | string |
True oder False angeben |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
True oder False angeben |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
True oder False angeben |
|
|
IsMfa
|
IsMfa | string |
True oder False angeben |
|
|
IsUserAdministration
|
IsUserAdministration | string |
True oder False angeben |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
True oder False angeben |
|
|
LicenseType
|
LicenseType | string |
Lizenztyp eingeben |
|
|
Anmeldename
|
LoginName | string |
Anmeldename eingeben |
|
|
ManagerEmail
|
ManagerEmail | string |
E-Mail-Adresse des Vorgesetzten eingeben |
|
|
Kennwort
|
Password | string |
Kennwort eingeben |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
True oder False angeben |
|
|
IsDenyAll
|
IsDenyAll | string |
True oder False angeben |
|
|
ReportType
|
ReportType | string |
True oder False angeben |
|
|
UploadLocation
|
UploadLocation | string |
Uploadspeicherort eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
isModified
|
isModified | boolean |
Wurde der Benutzer geändert |
|
mfaException
|
mfaException | string |
mfa-Ausnahme |
|
modifyUserException
|
modifyUserException | string |
Ändern der Benutzer exception |
|
userId
|
userId | string |
Benutzer-ID-Wert |
Benutzerdokumentsicherheit abrufen
Ruft die Sicherheit von Benutzerdokumenten pro Anmeldung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
LoginId
|
loginId | True | string |
Anmelde-ID eingeben |
|
CabinetName
|
cabinetName | True | string |
Cab-Name eingeben |
|
DrawerName
|
drawerName | True | string |
Namen der Schublade eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
cabinetName
|
cabinetName | string |
Cab-Name |
|
documentSecurity
|
documentSecurity | string |
Dokumentsicherheitswert |
|
drawerName
|
drawerName | string |
Namewert der Schublade |
|
getUserDocSecurityException
|
getUserDocSecurityException | string |
Ausnahme der Benutzerdokumentsicherheit |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
Bericht nach Workflow nachverfolgen
Bericht nach Workflow nachverfolgen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Schublade-ID
|
DrawerId | string |
Schublade-ID |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Einsatztyp
|
EngagementType | string |
Einsatztyp |
|
|
Arbeitsablauf
|
Workflow | string |
Arbeitsablauf |
|
|
Aktueller Schritt
|
CurrentStep | string |
Aktueller Schritt |
|
|
PIC
|
PIC | string |
PIC |
|
|
Zugeordnet
|
AssignedTo | string |
Zugeordnet |
|
|
Zugewiesen am
|
AssignedOn | string |
Zugewiesen am |
|
|
Workflowbeschreibung
|
WorkflowDescription | string |
Workflowbeschreibung |
|
|
Nur in Bearbeitung
|
InProcessOnly | string |
Nur in Bearbeitung |
|
|
Der Status
|
Status | string |
Der Status |
|
|
Priority
|
Priority | string |
Priority |
|
|
Verantwortlich
|
Responsible | string |
Verantwortlich |
|
|
Zuordnungsverlauf
|
AssignmentHistory | string |
Zuordnungsverlauf |
|
|
Empfangen von
|
ReceivedFrom | string |
Empfangen von |
|
|
Empfangen am
|
ReceivedOn | string |
Empfangen am |
|
|
Gesendet an
|
SentTo | string |
Gesendet an |
|
|
Nachgeschickt
|
SentOn | string |
Nachgeschickt |
|
|
Abgeschlossen von
|
CompletedBy | string |
Abgeschlossen von |
|
|
Abgeschlossen am
|
CompletedOn | string |
Abgeschlossen am |
|
|
Aktuelles Fälligkeitsdatum
|
CurrentDueDate | string |
Aktuelles Fälligkeitsdatum |
|
|
Tage im Schritt
|
DaysAtStep | string |
Tage im Schritt |
|
|
Gesamtanzahl der Tage in Schritt
|
TotalDaysAtStep | string |
Gesamtanzahl der Tage in Schritt |
|
|
Tage zwischen Routings
|
DaysBetweenRoutings | string |
Tage zwischen Routings |
|
|
Gesamtzahl der verarbeiteten Tage
|
TotalDaysInProcess | string |
Gesamtzahl der verarbeiteten Tage |
|
|
Verantwortlich
|
Accountable | string |
Verantwortlich |
|
|
Routingdetails
|
RoutingDetails | string |
Routingdetails |
|
|
Zuletzt aktualisiert
|
LastUpdated | string |
Zuletzt aktualisiert |
|
|
InformationFields
|
InformationFields | array of string |
InformationFields |
|
|
Indizes
|
Indexes | array of string |
Indizes |
|
|
Seitennummer
|
PageNumber | string |
Seitennummer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensätze insgesamt
|
totalRecords | integer |
Datensätze insgesamt |
|
Seitennummer
|
pageNumber | string |
Seitennummer |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
Seiten insgesamt
|
totalPages | integer |
Seiten insgesamt |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Clientname
|
firmFlowReportResponse.clientName | string |
Clientname |
|
Clientnummer
|
firmFlowReportResponse.clientNumber | string |
Clientnummer |
|
Schublade-ID
|
firmFlowReportResponse.drawerId | string |
Schublade-ID |
|
Diensttyp
|
firmFlowReportResponse.serviceType | string |
Diensttyp |
|
Einsatztyp
|
firmFlowReportResponse.engagementType | string |
Einsatztyp |
|
Arbeitsablauf
|
firmFlowReportResponse.workflow | string |
Arbeitsablauf |
|
Aktueller Schritt
|
firmFlowReportResponse.currentStep | string |
Aktueller Schritt |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Zugeordnet
|
firmFlowReportResponse.assignedTo | string |
Zugeordnet |
|
Zugewiesen am
|
firmFlowReportResponse.assignedOn | string |
Zugewiesen am |
|
Jahr
|
firmFlowReportResponse.year | string |
Jahr |
|
Ende des Zeitraums
|
firmFlowReportResponse.periodEnd | string |
Ende des Zeitraums |
|
Workflowbeschreibung
|
firmFlowReportResponse.workflowDescription | string |
Workflowbeschreibung |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Der Status
|
firmFlowReportResponse.status | string |
Der Status |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Ja oder Nein
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Ja oder Nein |
|
Erweitert ja oder nein
|
firmFlowReportResponse.extendedYesOrNo | string |
Erweitert ja oder nein |
|
Empfangen am
|
firmFlowReportResponse.receivedOn | string |
Empfangen am |
|
Abgeschlossen am
|
firmFlowReportResponse.completedOn | string |
Abgeschlossen am |
|
Nachgeschickt
|
firmFlowReportResponse.sentOn | string |
Nachgeschickt |
|
Ergebnisse
|
firmFlowReportResponse.deliverables | string |
Ergebnisse |
|
Verantwortlich
|
firmFlowReportResponse.responsible | string |
Verantwortlich |
|
Zuordnungsverlauf
|
firmFlowReportResponse.assignmentHistory | string |
Zuordnungsverlauf |
|
Empfangen von
|
firmFlowReportResponse.receivedFrom | string |
Empfangen von |
|
Gesendet an
|
firmFlowReportResponse.sentTo | string |
Gesendet an |
|
Abgeschlossen von
|
firmFlowReportResponse.completedBy | string |
Abgeschlossen von |
|
Verantwortlich
|
firmFlowReportResponse.accountable | string |
Verantwortlich |
|
Aktuelles Fälligkeitsdatum
|
firmFlowReportResponse.currentDueDate | string |
Aktuelles Fälligkeitsdatum |
|
Ursprüngliches Fälligkeitsdatum
|
firmFlowReportResponse.originalDueDate | string |
Ursprüngliches Fälligkeitsdatum |
|
Routingnotizen
|
firmFlowReportResponse.routingNotes | string |
Routingnotizen |
|
PIC Ja oder Nein
|
firmFlowReportResponse.picYesOrNo | string |
PIC Ja oder Nein |
|
"Ja" oder "Nein" zugewiesen
|
firmFlowReportResponse.assignedToYesOrNo | string |
"Ja" oder "Nein" zugewiesen |
|
Datum erweitert
|
firmFlowReportResponse.dateExtended | string |
Datum erweitert |
|
Tage im Schritt
|
firmFlowReportResponse.daysAtStep | string |
Tage im Schritt |
|
Gesamtanzahl der Tage in Schritt
|
firmFlowReportResponse.totalDaysAtStep | string |
Gesamtanzahl der Tage in Schritt |
|
Tage zwischen Routings
|
firmFlowReportResponse.daysBetweenRoutings | string |
Tage zwischen Routings |
|
Gesamtzahl der verarbeiteten Tage
|
firmFlowReportResponse.totalDaysInProcess | string |
Gesamtzahl der verarbeiteten Tage |
|
Ordner-ID
|
firmFlowReportResponse.folderID | string |
Ordner-ID |
|
Ablage-ID
|
firmFlowReportResponse.filingID | string |
Ablage-ID |
|
Letzte Aktualisierung des Workflows
|
firmFlowReportResponse.workflowLastUpdated | string |
Letzte Aktualisierung des Workflows |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
name
|
firmFlowReportResponse.informationFields.name | string |
name |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
FirmFlow-Ausnahme abrufen
|
getFirmFlowException | string |
FirmFlow-Ausnahme abrufen |
Dokument abrufen
Lädt das Dokument herunter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DokumentID
|
documentId | True | string |
Dokument-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Dokument erstellen
Erstellt einen Dokumentdatensatz mit Indizes
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
DrawerId
|
DrawerId | string |
Schublade-ID eingeben |
|
|
IndexId
|
IndexId | string |
Index-ID eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
documentId
|
documentCreate.documentId | string |
Dokument-ID-Wert |
|
errorMessage
|
documentCreate.errorMessage | string |
Fehlermeldung |
|
errorMessage
|
indexValidation.errorMessage | string |
Fehlermeldung |
|
Irrtümer
|
indexValidation.errors | array of |
Irrtümer |
|
isValid
|
indexValidation.isValid | boolean |
ist dokument gültig |
Dokument kopieren
Kopiert die Dokumente
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Index-ID eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
copyDocumentException
|
copyDocumentException | string |
Dokument ausnahme kopieren |
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
isCopied
|
isCopied | boolean |
Wurde das Dokument kopiert |
|
newDocumentId
|
newDocumentId | string |
neue Dokument-ID |
Dokument löschen
Löscht ein Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DokumentID
|
documentId | True | string |
Dokument-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
deleteDocumentException
|
deleteDocumentException | string |
Dokument exception löschen |
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
isDeleted
|
isDeleted | boolean |
ist das Dokument gelöscht. |
Dokument neu indizieren
Neuindiziert die Dokumente
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Index-ID eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
isReIndexed
|
isReIndexed | boolean |
ist das Dokument neu indiziert |
|
reIndexDocumentException
|
reIndexDocumentException | string |
ReIndex-Dokument exception |
Dokumentstatus abrufen
Abrufen des Status von Dokumenten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
body
|
body | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
documentStatusException
|
documentStatusException | string |
Dokumentstatus-Ausnahme |
|
DrawerId
|
drawerId | string |
Drawer ID-Wert |
|
Dateigröße
|
fileSize | string |
Dateigrößewert |
|
isArchived
|
isArchived | boolean |
ist das dokument archiviert |
|
isCheckedOut
|
isCheckedOut | boolean |
ist das Dokument ausgecheckt |
|
istVerschlüsselt
|
isEncrypted | boolean |
ist das Dokument verschlüsselt |
|
isFiled
|
isFiled | boolean |
ist das Dokument abgelegt |
|
isInRedactionQueue
|
isInRedactionQueue | boolean |
ist das Dokument in der Redaction-Warteschlange |
|
isInTaxsortQueue
|
isInTaxsortQueue | boolean |
ist das Dokument in der Steuersortwarteschlange |
|
isLocked
|
isLocked | boolean |
ist das Dokument gesperrt. |
|
isOfficeDocument
|
isOfficeDocument | boolean |
ist das Dokument eines Office-Dokuments. |
|
IsPublished
|
isPublished | boolean |
ist das Dokument veröffentlicht |
|
isUndergoingMerging
|
isUndergoingMerging | boolean |
ist das Dokument, das zusammenführen wird |
|
localFile
|
localFile | string |
ist das Dokument eine lokale Datei. |
|
noEdit
|
noEdit | boolean |
kein Bearbeitungswert |
|
pages
|
pages | integer |
Seiten im Dokument |
|
reviewed
|
reviewed | boolean |
Überprüfter Status |
|
taxSort
|
taxSort | boolean |
ist das Dokument taxSorted |
|
type
|
type | string |
Dateityp |
|
Ausgabe
|
version | integer |
Version des Dokuments |
Dokumentstatus veröffentlichen
Veröffentlichen oder Aufheben der Veröffentlichung von Dokumenten aus ClientFlow.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DokumentID
|
documentId | True | string |
Dokument-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
IsPublished
|
IsPublished | True | string |
True oder False angeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
documentException
|
documentException | string |
Dokument exception |
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
IsPublished
|
isPublished | boolean |
ist das Dokument veröffentlicht |
Dokumentsuche
Lädt alle Dokumente, auf die der Benutzer in der angegebenen Schublade zugreifen kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
DrawerId
|
DrawerId | string |
Schublade-ID eingeben |
|
|
IndexId
|
IndexId | string |
Index-ID eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
|
|
NumberOfRows
|
NumberOfRows | integer |
Geben Sie die Anzahl der Zeilen ein. |
|
|
PageNumber
|
PageNumber | integer |
Seitenzahl eingeben |
|
|
SortField
|
SortField | string |
Sortierfeld eingeben |
|
|
SortOrder
|
SortOrder | string |
Sortierreihenfolge eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
documentIds
|
documentIds | array of string |
documentIds |
|
documentSearchCount
|
documentSearchCount | integer |
Anzahl der Dokumentsuchen |
Dokumentverlauf abrufen
Ruft den Verlauf des Dokuments ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DokumentID
|
documentId | True | string |
Dokument-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
documentAudit
|
documentAudit | array of |
documentAudit |
|
documentHistoryException
|
documentHistoryException | string |
Ausnahme des Dokumentverlaufs |
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
mergeDocHistory
|
mergeDocHistory | array of |
mergeDocHistory |
Dynamische Regeln für Index abrufen
Ruft die Liste der dynamischen Regeln ab, die für den angegebenen Index konfiguriert sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Index-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
condition
|
condition | string |
Bedingungswert |
|
dependentIndexId
|
dependentIndexId | string |
Abhängiger Index-ID-Wert |
|
dynamicRuleId
|
dynamicRuleId | string |
dynamischer Regel-ID-Wert |
|
value
|
value | string |
value |
Einloggen
Protokolliert einen Benutzer bei der Anwendung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anmeldename
|
LoginName | True | string |
Anmeldename eingeben |
|
Kennwort
|
Password | True | password |
Kennwort eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
authSuccess
|
authSuccess | boolean |
war Authentifizierung erfolgreich |
|
authenticationResponse
|
authenticationResponse | string |
Authentifizierungsantwortwert |
|
customerId
|
customerId | string |
Kunden-ID-Wert |
|
Fehlercode
|
errorCode | string |
Fehlercodewert |
|
idleSessionTimeoutMinutes
|
idleSessionTimeoutMinutes | integer |
Leerlauf-Sitzungstimeoutminuten |
|
loneStarFirmId
|
loneStarFirmId | string |
Einzelstern-Firmen-ID |
|
loneStarValidated
|
loneStarValidated | boolean |
Einsamer Stern überprüft |
|
token
|
token | string |
Tokenwert |
|
userId
|
userId | string |
Benutzer-ID-Wert |
|
Nutzername
|
userName | string |
Benutzernameswert |
Erstellen einer Gruppe
Erstellt Berechtigungsgruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
True oder False angeben |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
True oder False angeben |
|
|
Kommentare
|
Comments | string |
Kommentare eingeben |
|
|
EnableMfa
|
EnableMfa | string |
True oder False angeben |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
True oder False angeben |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
True oder False angeben |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
True oder False angeben |
|
|
GroupName
|
GroupName | string |
Gruppenname eingeben |
|
|
MfaRequired
|
MfaRequired | string |
True oder False angeben |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
True oder False angeben |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
True oder False angeben |
|
|
IsDenyAll
|
IsDenyAll | string |
True oder False angeben |
|
|
ReportType
|
ReportType | string |
True oder False angeben |
|
|
UploadLocation
|
UploadLocation | string |
Uploadspeicherort eingeben |
|
|
Benutzer
|
Users | array of string |
Benutzer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
createGroupException
|
createGroupException | string |
Gruppen exception erstellen |
|
groupId
|
groupId | string |
Gruppen-ID-Wert |
|
isCreated
|
isCreated | boolean |
Wurde die Gruppe erstellt |
|
mfaException
|
mfaException | string |
mfa-Status |
Festlegen der Benutzerdokumentsicherheit
Zuweisen von Benutzerdokumentsicherheitsberechtigungen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
CabinetName
|
CabinetName | string |
Cab-Name eingeben |
|
|
DocSecurityType
|
DocSecurityType | string |
Dokumentsicherheitstyp eingeben |
|
|
IndexName
|
IndexName | string |
Indexname eingeben |
|
|
Operation
|
Operation | string |
Eingabevorgang |
|
|
Werte
|
Values | array of string |
Werte |
|
|
DrawerName
|
DrawerName | string |
Namen der Schublade eingeben |
|
|
LoginId
|
LoginId | string |
Anmelde-ID eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
isSetUserDocSecurity
|
isSetUserDocSecurity | boolean |
Benutzerdokumentsicherheit wurde angewendet |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
|
setUserDocSecurityException
|
setUserDocSecurityException | string |
Benutzerdokumentsicherheits-Ausnahme festlegen |
Festlegen von Benutzerberechtigungen
Zuweisen von Berechtigungen für Den Benutzer
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Schrank
|
Cabinet | string |
Cab-Name eingeben |
|
|
Add (Hinzufügen)
|
Add | string |
True oder False angeben |
|
|
Löschen
|
Delete | string |
True oder False angeben |
|
|
Deny
|
Deny | string |
True oder False angeben |
|
|
Bearbeiten
|
Edit | string |
True oder False angeben |
|
|
LookUp
|
LookUp | string |
True oder False angeben |
|
|
Lesen Sie
|
Read | string |
True oder False angeben |
|
|
Kassenlade
|
Drawer | string |
Namen der Schublade eingeben |
|
|
Add (Hinzufügen)
|
Add | string |
True oder False angeben |
|
|
Löschen
|
Delete | string |
True oder False angeben |
|
|
Deny
|
Deny | string |
True oder False angeben |
|
|
Bearbeiten
|
Edit | string |
True oder False angeben |
|
|
LookUp
|
LookUp | string |
True oder False angeben |
|
|
Lesen Sie
|
Read | string |
True oder False angeben |
|
|
LoginId
|
LoginId | string |
Anmelde-ID eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
isSetUserPermission
|
isSetUserPermission | boolean |
Aktualisierung der Benutzerberechtigung |
|
loginId
|
loginId | string |
Anmelde-ID-Wert |
|
setUserPermissionException
|
setUserPermissionException | string |
Benutzerberechtigungs-Ausnahme festlegen |
Gruppe ändern
Ändern von Gruppenberechtigungen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
True oder False angeben |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
True oder False angeben |
|
|
Kommentare
|
Comments | string |
Kommentare eingeben |
|
|
EnableMfa
|
EnableMfa | string |
True oder False angeben |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
True oder False angeben |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
True oder False angeben |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
True oder False angeben |
|
|
GroupName
|
GroupName | string |
Gruppenname eingeben |
|
|
MfaRequired
|
MfaRequired | string |
True oder False angeben |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
True oder False angeben |
|
|
RenameGroup
|
RenameGroup | string |
Neuen Gruppennamen eingeben |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
True oder False angeben |
|
|
IsDenyAll
|
IsDenyAll | string |
True oder False angeben |
|
|
ReportType
|
ReportType | string |
True oder False angeben |
|
|
UploadLocation
|
UploadLocation | string |
Uploadspeicherort eingeben |
|
|
Benutzer
|
Users | array of string |
Benutzer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
groupId
|
groupId | string |
Gruppen-ID-Wert |
|
isModified
|
isModified | boolean |
Hat die Gruppe geändert |
|
mfaException
|
mfaException | string |
mfa-Ausnahme |
|
modifyGroupException
|
modifyGroupException | string |
Gruppen exception ändern |
Gruppen abrufen
Ruft die für die Benutzer- und Gruppenverwaltung verfügbaren Gruppen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Gruppen-ID-Wert |
|
Mfa
|
mfa | integer |
mfa-Wert |
|
mfaRequired
|
mfaRequired | integer |
mfa Erforderlicher Wert |
|
name
|
name | string |
Gruppennamewert |
Gruppenberechtigungen abrufen
Ruft Berechtigungen von Gruppen ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
GroupName
|
groupName | string |
Gruppenname eingeben |
|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
cabinet
|
cabinet | string |
Cab-Name |
|
add
|
cabinetPermissions.add | boolean |
Berechtigungen hinzufügen |
|
delete
|
cabinetPermissions.delete | boolean |
Berechtigungen löschen |
|
leugnen
|
cabinetPermissions.deny | boolean |
Berechtigungen verweigern |
|
edit
|
cabinetPermissions.edit | boolean |
Berechtigungen bearbeiten |
|
nachschlagen
|
cabinetPermissions.lookUp | boolean |
Nachschlageberechtigungen |
|
read
|
cabinetPermissions.read | boolean |
Leseberechtigungen |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
Schublade
|
drawerPermissions.drawer | string |
Name der Schublade |
|
add
|
drawerPermissions.permission.add | boolean |
Berechtigungen hinzufügen |
|
delete
|
drawerPermissions.permission.delete | boolean |
Berechtigungen löschen |
|
leugnen
|
drawerPermissions.permission.deny | boolean |
Berechtigungen verweigern |
|
edit
|
drawerPermissions.permission.edit | boolean |
Berechtigungen bearbeiten |
|
nachschlagen
|
drawerPermissions.permission.lookUp | boolean |
Nachschlageberechtigungen |
|
read
|
drawerPermissions.permission.read | boolean |
Leseberechtigungen |
|
groupName
|
groupName | string |
Gruppenname |
|
groupPermissionException
|
groupPermissionException | string |
Gruppenberechtigungs ausnahme |
Gruppenberechtigungen festlegen
Zuweisen der Berechtigung zur Gruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Schrank
|
Cabinet | string |
Cab-Name eingeben |
|
|
Add (Hinzufügen)
|
Add | string |
True oder False angeben |
|
|
Löschen
|
Delete | string |
True oder False angeben |
|
|
Deny
|
Deny | string |
True oder False angeben |
|
|
Bearbeiten
|
Edit | string |
True oder False angeben |
|
|
LookUp
|
LookUp | string |
True oder False angeben |
|
|
Lesen Sie
|
Read | string |
True oder False angeben |
|
|
Kassenlade
|
Drawer | string |
Namen der Schublade eingeben |
|
|
Add (Hinzufügen)
|
Add | string |
True oder False angeben |
|
|
Löschen
|
Delete | string |
True oder False angeben |
|
|
Deny
|
Deny | string |
True oder False angeben |
|
|
Bearbeiten
|
Edit | string |
True oder False angeben |
|
|
LookUp
|
LookUp | string |
True oder False angeben |
|
|
Lesen Sie
|
Read | string |
True oder False angeben |
|
|
GroupName
|
GroupName | string |
Gruppenname eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
groupId
|
groupId | string |
Gruppen-ID-Wert |
|
groupPermissionException
|
groupPermissionException | string |
Gruppenberechtigungs ausnahme |
|
isSet
|
isSet | boolean |
Wurden Berechtigungen angewendet |
Gruppendokumentsicherheit abrufen
Abrufen der Gruppendokumentsicherheit
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
GroupName
|
groupName | True | string |
Gruppenname eingeben |
|
CabinetName
|
cabinetName | True | string |
Cab-Name eingeben |
|
DrawerName
|
drawerName | True | string |
Namen der Schublade eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gruppenname
|
groupName | string |
Gruppenname |
|
Cab-Name
|
cabinetName | string |
Cab-Name |
|
Name der Schublade
|
drawerName | string |
Name der Schublade |
|
documentSecurity
|
documentSecurity | array of object |
documentSecurity |
|
Indexname
|
documentSecurity.indexName | string |
Indexname |
|
Dokumentsicherheitstyp
|
documentSecurity.docSecurityType | string |
Dokumentsicherheitstyp |
|
values
|
documentSecurity.values | array of string |
values |
|
Gruppendokumentsicherheits-Ausnahme
|
getGroupDocSecurityException | string |
Gruppendokumentsicherheits-Ausnahme |
Gruppendokumentsicherheit festlegen
Zuweisen der Dokumentsicherheit zu einer Gruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
CabinetName
|
CabinetName | string |
Geben Sie den Cab-Namen ein. |
|
|
DocSecurityType
|
DocSecurityType | string |
Dokumentsicherheitstyp eingeben |
|
|
IndexName
|
IndexName | string |
Geben Sie den Indexnamen ein. |
|
|
Operation
|
Operation | string |
Geben Sie den Vorgangstyp ein. |
|
|
Werte
|
Values | array of string |
Werte |
|
|
DrawerName
|
DrawerName | string |
Geben Sie den Namen der Schublade ein. |
|
|
GroupName
|
GroupName | string |
Geben Sie den Gruppennamen ein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
groupName
|
groupName | string |
Gruppennamewert |
|
isSetGroupDocSecurity
|
isSetGroupDocSecurity | boolean |
Dokumentensicherheit wurde festgelegt |
|
setGroupDocSecurityException
|
setGroupDocSecurityException | string |
Gruppendokumentsicherheits-Ausnahme |
Hinzufügen eines Master-Lieferumfangs
Hinzufügen eines Master-Lieferumfangs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Lieferumfangsname
|
deliverableName | string |
Lieferumfangsname |
|
|
Fälligkeitsdatum
|
dueDate | string |
Fälligkeitsdatum |
|
|
Erste Erweiterung
|
firstExtension | string |
Erste Erweiterung |
|
|
Zweite Erweiterung
|
secondExtension | string |
Zweite Erweiterung |
|
|
Dritte Erweiterung
|
thirdExtension | string |
Dritte Erweiterung |
|
|
Kalender oder Geschäftsdaten
|
calenderOrFiscal | string |
Kalender oder Geschäftsdaten |
|
|
Extension
|
extension | integer |
Extension |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Name der Schublade
|
DrawerName | string |
Name der Schublade |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wird gespeichert
|
isSaved | boolean |
Wird gespeichert |
|
Antwortnachricht
|
responseMessage | string |
Antwortnachricht |
Index-Nachschlageliste suchen
Diese Methode wurde für die Verwendung mit AutoVervollständigen-Feldern entwickelt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
IndexID
|
indexId | True | string |
Index-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Aktionstyp
|
ActionType | integer |
Aktionstyp eingeben |
|
|
Anzahl
|
Count | integer |
Anzahl eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
|
|
Suchtyp
|
SearchType | integer |
Suchtyp eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
index.indexId | string |
Index-ID-Wert |
|
indexValue
|
index.indexValue | string |
Sollwert |
|
linkedIndexes
|
linkedIndexes | array of object |
linkedIndexes |
|
indexId
|
linkedIndexes.indexId | string |
indexId |
|
indexValue
|
linkedIndexes.indexValue | string |
indexValue |
Kennwortrichtlinie abrufen
Ruft die Kennwortrichtlinie für die Firma ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kunden-ID
|
passwordPolicy.clientId | string |
Client-ID-Wert |
|
forbidden_pwd_words
|
passwordPolicy.forbidden_pwd_words | array of string |
forbidden_pwd_words |
|
lockout_threshold
|
passwordPolicy.lockout_threshold | integer |
Sperrschwellenwert |
|
max_length
|
passwordPolicy.max_length | integer |
maximale Länge des Kennworts |
|
max_login_similarity
|
passwordPolicy.max_login_similarity | string |
maximale Anmeldungsähnlichkeit |
|
max_pwd_age
|
passwordPolicy.max_pwd_age | integer |
max pwd Alter des Kennworts |
|
max_repeat_chars
|
passwordPolicy.max_repeat_chars | string |
maximale Wiederholungszeichen im Kennwort |
|
max_sequential_chars
|
passwordPolicy.max_sequential_chars | string |
Maximale Sequenzzeichen |
|
Mfa
|
passwordPolicy.mfa | integer |
mfa-Wert |
|
min_length
|
passwordPolicy.min_length | integer |
Mindestlänge des Kennworts |
|
pwd_req_alpha
|
passwordPolicy.pwd_req_alpha | integer |
Alpha-Kennwortanforderung |
|
pwd_req_lower
|
passwordPolicy.pwd_req_lower | integer |
Niedrigere Kennwortanforderung |
|
pwd_req_number
|
passwordPolicy.pwd_req_number | integer |
Kennwortnummernanforderung |
|
pwd_req_symbol
|
passwordPolicy.pwd_req_symbol | integer |
Symbolkennwortanforderung |
|
pwd_req_upper
|
passwordPolicy.pwd_req_upper | integer |
Anforderung für das obere Kennwort |
|
passwordPolicyException
|
passwordPolicyException | string |
passwordPolicyException |
Liste der Berichte abrufen
Ruft die Berichte ab, die für die Benutzerverwaltung verfügbar sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
reports
|
reports | array of object |
reports |
|
reportName
|
reports.reportName | array of string |
reportName |
|
Berichtstyp
|
reports.reportType | string |
Berichtstypwert |
|
reportsException
|
reportsException | string |
Berichtsausnahmewert |
Liste der Indexwerte abrufen
Ruft alle Einträge für einen Listentypindex ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Index-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
untergeordneter Index-ID-Wert |
|
childListId
|
childListId | integer |
untergeordneter Listen-ID-Wert |
|
hasChildren
|
hasChildren | boolean |
Hat der Index einen untergeordneten Index |
|
listEntryId
|
listEntryId | integer |
Listeneintrags-ID-Wert |
|
listId
|
listId | integer |
Listen-ID-Wert |
|
value
|
value | string |
value |
Lizenzen abrufen
Ruft die Anzahl der Lizenzen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
LicenseType
|
license | string |
Lizenztyp eingeben |
|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
assignedLicenses
|
assignedLicenses | string |
Zugewiesene Lizenzanzahl |
|
getLicenseException
|
getLicenseException | string |
Lizenz exception abrufen |
|
license
|
license | string |
Lizenzname |
|
message
|
message | string |
message |
|
totalLicenses
|
totalLicenses | string |
Gesamtanzahl der Lizenzen |
LookupList-Werte abrufen
Ruft die Werte aus der LookupList ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Drawer-ID. Beispielclient-Drawer: "0000000001"
|
drawerId | True | string |
Schublade-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
clientName
|
clientName | string |
Clientnamewert |
|
clientNumber
|
clientNumber | string |
Clientnummernwert |
Master-Lieferumfang bearbeiten
Master-Lieferumfang bearbeiten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Aktueller Lieferumfangsname
|
currentdeliverableName | string |
Aktueller Lieferumfangsname |
|
|
Name des Lieferumfangs aktualisieren
|
updatedeliverableName | string |
Name des Lieferumfangs aktualisieren |
|
|
Fälligkeitsdatum
|
dueDate | string |
Fälligkeitsdatum |
|
|
Erste Erweiterung
|
firstExtension | string |
Erste Erweiterung |
|
|
Zweite Erweiterung
|
secondExtension | string |
Zweite Erweiterung |
|
|
Dritte Erweiterung
|
thirdExtension | string |
Dritte Erweiterung |
|
|
Kalender oder Geschäftsdaten
|
calenderOrFiscal | string |
Kalender oder Geschäftsdaten |
|
|
Extension
|
extension | integer |
Extension |
|
|
Diensttyp
|
serviceType | string |
Diensttyp |
|
|
Name der Schublade
|
drawerName | string |
Name der Schublade |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Status aktualisieren
|
isUpdated | boolean |
Status aktualisieren |
|
Antwortnachricht
|
responseMessage | string |
Antwortnachricht |
Master-Lieferumfang löschen
Master-Lieferumfang löschen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Name der Schublade
|
DrawerName | string |
Name der Schublade |
|
|
DeliverableNames
|
DeliverableNames | array of string |
DeliverableNames |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
Status löschen
|
isDeleted | boolean |
Status löschen |
|
Antwortnachricht
|
responseMessage | string |
Antwortnachricht |
PDF-Dateien zusammenführen
Zusammenführen von PDF-Dateien
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
body
|
body | array of string |
Gibt zurück
- response
- string
Routingworkflow V2
Routingworkflow V2
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
filingId
|
filingId | array of integer |
filingId |
|
|
CurrentStep
|
CurrentStep | array of string |
CurrentStep |
|
|
Vollständig
|
Complete | boolean |
Vollständig |
|
|
Abgeschlossen am
|
CompletedDate | string |
Abgeschlossen am |
|
|
Nächster Schritt
|
NextStep | string |
Nächster Schritt |
|
|
Zugeordnet
|
AssignedTo | string |
Zugeordnet |
|
|
Zugewiesenes Datum
|
AssignedDate | string |
Zugewiesenes Datum |
|
|
Priority
|
Priority | string |
Priority |
|
|
Der Status
|
Status | string |
Der Status |
|
|
Routinghinweis
|
RoutingNote | string |
Routinghinweis |
|
|
E-Mail-Benachrichtigung
|
emailNotify | boolean |
E-Mail-Benachrichtigung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ablage-ID
|
filingId | string |
Ablage-ID |
|
Wird weitergeleitet
|
isRouted | boolean |
Wird weitergeleitet |
Schubladeindizes abrufen
Ruft eine Liste von Dokumentindizes ab, die für die Schublade eingerichtet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
DrawerId
|
drawerId | True | string |
Schublade-ID eingeben |
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
untergeordneter Index-ID-Wert |
|
indexId
|
indexId | string |
Index-ID-Wert |
|
indexName
|
indexName | string |
Indexname-Wert |
|
indexType
|
indexType | string |
Indextypwert |
|
length
|
length | integer |
Länge des Schubladeindexes |
|
listId
|
listId | integer |
Listen-ID-Wert |
|
lookupAutoUpdate
|
lookupAutoUpdate | boolean |
Automatisches Nachschlagen |
|
required
|
required | boolean |
Ist der Index erforderlich |
Steuersortdokument
PDF-Dokument für Steuersort
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
body
|
body | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
Dokument-ID-Wert |
|
isTaxSorted
|
isTaxSorted | boolean |
Ist das Dokument TaxSorted |
|
taxsortDocumentException
|
taxsortDocumentException | string |
Steuersort-Dokument-Ausnahme |
Token überprüfen
Überprüfen des Tokenstatus
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
Gibt zurück
- response
- boolean
Tracking-Bericht nach Lieferumfang V2
Nachverfolgungsbericht nach DeliverableV2
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Schublade-ID
|
DrawerId | string |
Schublade-ID |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Einsatztyp
|
EngagementType | string |
Einsatztyp |
|
|
Arbeitsablauf
|
Workflow | string |
Arbeitsablauf |
|
|
Aktueller Schritt
|
CurrentStep | string |
Aktueller Schritt |
|
|
PIC
|
PIC | string |
PIC |
|
|
Zugeordnet
|
AssignedTo | string |
Zugeordnet |
|
|
Zugewiesen am
|
AssignedOn | string |
Zugewiesen am |
|
|
Workflowbeschreibung
|
WorkflowDescription | string |
Workflowbeschreibung |
|
|
Nur in Bearbeitung
|
InProcessOnly | string |
Nur in Bearbeitung |
|
|
Der Status
|
Status | string |
Der Status |
|
|
Priority
|
Priority | string |
Priority |
|
|
Empfangen am
|
ReceivedOn | string |
Empfangen am |
|
|
Abgeschlossen am
|
CompletedOn | string |
Abgeschlossen am |
|
|
Nachgeschickt
|
SentOn | string |
Nachgeschickt |
|
|
Verantwortlich
|
Responsible | string |
Verantwortlich |
|
|
Zuordnungsverlauf
|
AssignmentHistory | string |
Zuordnungsverlauf |
|
|
Empfangen von
|
ReceivedFrom | string |
Empfangen von |
|
|
Gesendet an
|
SentTo | string |
Gesendet an |
|
|
Abgeschlossen von
|
CompletedBy | string |
Abgeschlossen von |
|
|
Verantwortlich
|
Accountable | string |
Verantwortlich |
|
|
Aktuelles Fälligkeitsdatum
|
CurrentDueDate | string |
Aktuelles Fälligkeitsdatum |
|
|
Ursprüngliches Fälligkeitsdatum
|
OriginalDueDate | string |
Ursprüngliches Fälligkeitsdatum |
|
|
Datum erweitert
|
DateExtended | string |
Datum erweitert |
|
|
Tage im Schritt
|
DaysAtStep | string |
Tage im Schritt |
|
|
Gesamtanzahl der Tage in Schritt
|
TotalDaysAtStep | string |
Gesamtanzahl der Tage in Schritt |
|
|
Tage zwischen Routings
|
DaysBetweenRoutings | string |
Tage zwischen Routings |
|
|
Gesamtzahl der verarbeiteten Tage
|
TotalDaysInProcess | string |
Gesamtzahl der verarbeiteten Tage |
|
|
Routingdetails
|
RoutingDetails | string |
Routingdetails |
|
|
Zuletzt aktualisiert
|
LastUpdated | string |
Zuletzt aktualisiert |
|
|
InformationFields
|
InformationFields | array of string |
InformationFields |
|
|
Indizes
|
Indexes | array of string |
Indizes |
|
|
Seitennummer
|
PageNumber | string |
Seitennummer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensätze insgesamt
|
totalRecords | integer |
Datensätze insgesamt |
|
Seitennummer
|
pageNumber | string |
Seitennummer |
|
Seitenformat
|
pageSize | integer |
Seitenformat |
|
Seiten insgesamt
|
totalPages | integer |
Seiten insgesamt |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Clientname
|
firmFlowReportResponse.clientName | string |
Clientname |
|
Clientnummer
|
firmFlowReportResponse.clientNumber | string |
Clientnummer |
|
Schublade-ID
|
firmFlowReportResponse.drawerId | string |
Schublade-ID |
|
Diensttyp
|
firmFlowReportResponse.serviceType | string |
Diensttyp |
|
Einsatztyp
|
firmFlowReportResponse.engagementType | string |
Einsatztyp |
|
Arbeitsablauf
|
firmFlowReportResponse.workflow | string |
Arbeitsablauf |
|
Aktueller Schritt
|
firmFlowReportResponse.currentStep | string |
Aktueller Schritt |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Zugeordnet
|
firmFlowReportResponse.assignedTo | string |
Zugeordnet |
|
Zugewiesen am
|
firmFlowReportResponse.assignedOn | string |
Zugewiesen am |
|
Jahr
|
firmFlowReportResponse.year | string |
Jahr |
|
Ende des Zeitraums
|
firmFlowReportResponse.periodEnd | string |
Ende des Zeitraums |
|
Workflowbeschreibung
|
firmFlowReportResponse.workflowDescription | string |
Workflowbeschreibung |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Der Status
|
firmFlowReportResponse.status | string |
Der Status |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Ja oder Nein
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Ja oder Nein |
|
Erweitert ja oder nein
|
firmFlowReportResponse.extendedYesOrNo | string |
Erweitert ja oder nein |
|
Empfangen am
|
firmFlowReportResponse.receivedOn | string |
Empfangen am |
|
Abgeschlossen am
|
firmFlowReportResponse.completedOn | string |
Abgeschlossen am |
|
Nachgeschickt
|
firmFlowReportResponse.sentOn | string |
Nachgeschickt |
|
Ergebnisse
|
firmFlowReportResponse.deliverables | string |
Ergebnisse |
|
Verantwortlich
|
firmFlowReportResponse.responsible | string |
Verantwortlich |
|
Zuordnungsverlauf
|
firmFlowReportResponse.assignmentHistory | string |
Zuordnungsverlauf |
|
Empfangen von
|
firmFlowReportResponse.receivedFrom | string |
Empfangen von |
|
Gesendet an
|
firmFlowReportResponse.sentTo | string |
Gesendet an |
|
Abgeschlossen von
|
firmFlowReportResponse.completedBy | string |
Abgeschlossen von |
|
Verantwortlich
|
firmFlowReportResponse.accountable | string |
Verantwortlich |
|
Aktuelles Fälligkeitsdatum
|
firmFlowReportResponse.currentDueDate | string |
Aktuelles Fälligkeitsdatum |
|
Ursprüngliches Fälligkeitsdatum
|
firmFlowReportResponse.originalDueDate | string |
Ursprüngliches Fälligkeitsdatum |
|
Routingnotizen
|
firmFlowReportResponse.routingNotes | string |
Routingnotizen |
|
PIC Ja oder Nein
|
firmFlowReportResponse.picYesOrNo | string |
PIC Ja oder Nein |
|
"Ja" oder "Nein" zugewiesen
|
firmFlowReportResponse.assignedToYesOrNo | string |
"Ja" oder "Nein" zugewiesen |
|
Datum erweitert
|
firmFlowReportResponse.dateExtended | string |
Datum erweitert |
|
Tage im Schritt
|
firmFlowReportResponse.daysAtStep | string |
Tage im Schritt |
|
Gesamtanzahl der Tage in Schritt
|
firmFlowReportResponse.totalDaysAtStep | string |
Gesamtanzahl der Tage in Schritt |
|
Tage zwischen Routings
|
firmFlowReportResponse.daysBetweenRoutings | string |
Tage zwischen Routings |
|
Gesamtzahl der verarbeiteten Tage
|
firmFlowReportResponse.totalDaysInProcess | string |
Gesamtzahl der verarbeiteten Tage |
|
Ordner-ID
|
firmFlowReportResponse.folderID | string |
Ordner-ID |
|
Ablage-ID
|
firmFlowReportResponse.filingID | string |
Ablage-ID |
|
Vorherige Ablage-ID
|
firmFlowReportResponse.priorFilingID | string |
Vorherige Ablage-ID |
|
Zuletzt aktualisiert
|
firmFlowReportResponse.lastUpdated | string |
Zuletzt aktualisiert |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
name
|
firmFlowReportResponse.informationFields.name | string |
name |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
FirmFlow-Ausnahme abrufen
|
getFirmFlowException | string |
FirmFlow-Ausnahme abrufen |
Workflow erstellen
Workflow erstellen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
Name der Schublade
|
Drawer | string |
Name der Schublade |
|
|
Diensttyp
|
ServiceType | string |
Diensttyp |
|
|
Ordner-ID
|
folderId | string |
Ordner-ID |
|
|
Clientname
|
ClientName | string |
Clientname |
|
|
Clientnummer
|
ClientNumber | string |
Clientnummer |
|
|
Einsatztyp
|
EngagementType | string |
Einsatztyp |
|
|
PIC
|
PIC | string |
PIC |
|
|
Jahr
|
Year | string |
Jahr |
|
|
Ende des Zeitraums
|
PeriodEnd | string |
Ende des Zeitraums |
|
|
Workflowname
|
workflowName | string |
Workflowname |
|
|
Description
|
description | True | string |
Description |
|
Statusname
|
statusName | string |
Statusname |
|
|
Lieferumfangsaktion
|
action | string |
Lieferumfangsaktion |
|
|
Aktuelles Fälligkeitsdatum
|
currentduedate | string |
Aktuelles Fälligkeitsdatum |
|
|
Ursprüngliches Fälligkeitsdatum
|
originalduedate | string |
Ursprüngliches Fälligkeitsdatum |
|
|
Lieferumfangsformular
|
form | string |
Lieferumfangsformular |
|
|
Übermittlungsmethode
|
Delivery | string |
Übermittlungsmethode |
|
|
Bestimmungsort
|
Destination | string |
Bestimmungsort |
|
|
Originalbeleg
|
sourceDocument | string |
Originalbeleg |
|
|
Hinweisaktion
|
action | string |
Hinweisaktion |
|
|
Notiztyp
|
noteType | string |
Notiztyp |
|
|
Notiznachricht
|
note | string |
Notiznachricht |
|
|
Name des Informationsfelds
|
name | string |
Name des Informationsfelds |
|
|
Wert des Informationsfelds
|
value | string |
Wert des Informationsfelds |
|
|
Verantwortungsvolles Feld
|
ResponsibleField | string |
Verantwortungsvolles Feld |
|
|
Wert des verantwortlichen Felds
|
value | string |
Wert des verantwortlichen Felds |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ablage-ID
|
filingId | integer |
Ablage-ID |
|
Fehlerkommentar
|
errorComment | string |
Fehlerkommentar |
|
Der Status
|
status | boolean |
Der Status |
|
errorMessage
|
errorMessage | array of string |
errorMessage |
Workflows löschen
Workflows löschen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
filingId
|
filingId | array of integer |
filingId |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gelöschter Status
|
isDeleted | boolean |
Gelöschter Status |
|
Ablage-ID
|
filingId | string |
Ablage-ID |
Überprüfen von Indizes
Überprüft, ob die bereitgestellten Indizes gültig sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
X-Authorization | string |
Tokenauthentifizierung |
|
|
DrawerId
|
DrawerId | string |
Schublade-ID eingeben |
|
|
IndexId
|
IndexId | string |
Index-ID eingeben |
|
|
IndexValue
|
IndexValue | string |
Indexwert eingeben |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
errorMessage
|
errorMessage | string |
Fehlermeldung |
|
Irrtümer
|
errors | array of |
Irrtümer |
|
isValid
|
isValid | boolean |
ist der index gültig. |
Definitionen
Schnur
Dies ist der grundlegende Datentyp "string".
boolean
Dies ist der grundlegende Datentyp "boolean".