Compartir a través de

GoFileRoom

GoFileRoom es una solución de flujo de trabajo y administración de documentos basada en la nube. Con el conector GoFileRoom, puede realizar acciones de documento, administración de usuarios y FirmFlow.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Estándar Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Estándar Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Estándar Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con GoFileRoom
URL https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
Correo Electrónico CS.Support@ThomsonReuters.com
Metadatos del conector
Publicador Thompson Reuters
Sitio web https://www.gofileroom.com/
Directiva de privacidad https://www.thomsonreuters.com/en/privacy-statement.html
Categorías Datos; Gestión empresarial

El conector GoFileRoom proporciona una manera sencilla de que los clientes de Thompson Reuters usen las API para GoFileRoom y FirmFlow. Los usuarios pueden crear automatización e integración relacionadas con la administración de usuarios, documentos o FirmFlow.

Prerrequisitos

Los usuarios deben tener una clave de API de GoFileRoom para poder usar el conector.

¿Cómo obtener credenciales?

La clave de API se puede obtener registrando para una cuenta en https://developerportal.thomsonreuters.com/. Además, deberá tener una cuenta activa de GoFileRoom. Si está interesado en GoFileRoom póngase en contacto con nosotros aquí: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
X-TR-API:APP-ID securestring ElAPP-ID X-TR-API para esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Agregar entrega maestra

Agregar entrega maestra
Búsqueda de documentos

Carga todos los documentos a los que el usuario tiene acceso en el cajón especificado.
Cerrar sesión

Cierre de sesión de la aplicación
Combinar PDF

Combinar archivos PDF
Copiar documento

Copia los documentos
Crear documento

Crea un registro de documento con índices
Crear flujo de trabajo

Crear flujo de trabajo
Crear grupo

Crea un grupo de permisos.
Crear usuarios

Crea usuarios de GoFileRoom y ClientFlow en el sistema
Documento de taxsort

Documento PDF de taxsort
Editar entrega maestra

Editar entrega maestra
Editar flujo de trabajo

Editar flujo de trabajo
Eliminar documento

Elimina un documento
Eliminar entrega maestra

Eliminar entrega maestra
Eliminar flujos de trabajo

Eliminar flujos de trabajo
Eliminar usuario

Eliminar usuarios de GoFileRoom y ClientFlow del sistema
Establecer permisos de grupo

Asigna permiso al grupo
Establecer permisos de usuario

Asigna permiso al usuario
Establecer seguridad de documentos de grupo

Asigna seguridad de documentos a un grupo
Establecer seguridad de documentos de usuario

Asigna permisos de seguridad de documentos de usuario
Flujo de trabajo de ruta V2

Flujo de trabajo de ruta V2
Index LookupList Find

Este método está diseñado para su uso con campos de autocompletar.
Iniciar sesión

Registra un usuario en la aplicación
Modificar grupo

Modificación de permisos de grupo
Modificar usuario

Modificación de permisos de usuario
Obtención de datos de FirmFlow por entrega

Obtiene el informe de seguimiento por datos de entrega.
Obtención de la entrega maestra

Obtención de la entrega maestra
Obtención de reglas dinámicas para el índice

Obtiene la lista de reglas dinámicas configuradas para el índice especificado.
Obtención de seguridad de documentos de usuario

Captura la seguridad del documento de usuario por inicio de sesión
Obtener cajones

Captura los cajones accesibles para el usuario que ha iniciado sesión
Obtener directiva de contraseñas

Captura la directiva de contraseñas para la empresa
Obtener documento

Descarga el documento
Obtener el estado del documento

Obtener el estado de los documentos
Obtener grupos

Captura los grupos disponibles para la administración de grupos y usuarios
Obtener historial de documentos

Obtiene el historial del documento.
Obtener información de usuario

Captura la información del usuario de GFR
Obtener información de usuario V2

Obtiene la infromation del usuario.
Obtener licencias

Recupera recuentos de licencias
Obtener lista de informes

Captura los informes disponibles para la administración de usuarios
Obtener lista de valores de índice

Obtiene todas las entradas de un índice de tipo de lista.
Obtener permisos de grupo

Obtiene los permisos de los grupos.
Obtener permisos de usuario

Obtiene los permisos del usuario.
Obtener seguridad de documentos de grupo

Recuperación de la seguridad del documento de grupo
Obtener ubicaciones de carga

Captura las ubicaciones de carga del usuario
Obtener usuarios

Captura los usuarios de GFR para el usuario que ha iniciado sesión
Obtener valores lookupList

Captura los valores de LookupList
Obtener índices de cajón

Recupera una lista de índices de documento configurados para el cajón.
Obtener índices de documentos

Recupera los índices del documento
Obtener índices secundarios

Obtiene una lista de valores de índice secundarios basados en el identificador de lista, que se proporciona cuando se selecciona el valor de lista primario.
Publicar estado del documento

Publicar o cancelar la publicación de documentos de ClientFlow.
Reindexación de documentos

Vuelve a indexar los documentos
Seguimiento del informe por entrega V2

Informe de seguimiento por DeliverableV2
Seguimiento del informe por flujo de trabajo

Seguimiento del informe por flujo de trabajo
Validar token

Validar el estado del token
Validar índices

Comprueba si los índices proporcionados son válidos.

Agregar entrega maestra

Id. de la operación:
AddMasterDeliverable

Agregar entrega maestra

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Nombre de la entrega
 deliverableName string

Nombre de la entrega
Fecha límite
 dueDate string

Fecha límite
Primera extensión
 firstExtension string

Primera extensión
Segunda extensión
 secondExtension string

Segunda extensión
Tercera extensión
 thirdExtension string

Tercera extensión
Calendario o fiscal
 calenderOrFiscal string

Calendario o fiscal
Extension
 extension integer

Extension
Tipo de servicio
 ServiceType string

Tipo de servicio
Nombre del cajón
 DrawerName string

Nombre del cajón

Devoluciones

Nombre Ruta de acceso Tipo Description
Se guarda
 isSaved boolean

Se guarda
Mensaje de respuesta
 responseMessage string

Mensaje de respuesta

Búsqueda de documentos

Id. de la operación:
DocumentSearch

Carga todos los documentos a los que el usuario tiene acceso en el cajón especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
DrawerId
 DrawerId string

Escriba el identificador del cajón.
IndexId
 IndexId string

Escriba id. de índice
IndexValue
 IndexValue string

Escriba el valor del índice.
NumberOfRows
 NumberOfRows integer

Escriba el número de filas.
PageNumber
 PageNumber integer

Escriba el número de página.
SortField
 SortField string

Escribir campo de ordenación
SortOrder
 SortOrder string

Escribir criterio de ordenación

Devoluciones

Nombre Ruta de acceso Tipo Description
documentIds
 documentIds array of string

documentIds
documentSearchCount
 documentSearchCount integer

recuento de búsqueda de documentos

Cerrar sesión

Id. de la operación:
Logout

Cierre de sesión de la aplicación

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
isLogoutSuccess
 isLogoutSuccess boolean

¿Se realizó correctamente el cierre de sesión?

Combinar PDF

Id. de la operación:
MergePDF

Combinar archivos PDF

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
body
 body array of string

Devoluciones

response
string

Copiar documento

Id. de la operación:
CopyDocument

Copia los documentos

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
DocumentIds
 DocumentIds array of string

DocumentIds
IndexId
 IndexId string

Escriba id. de índice
IndexValue
 IndexValue string

Escriba el valor del índice.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
copyDocumentException
 copyDocumentException string

copiar excepción de documento
documentId
 documentId string

valor de id. de documento
is Copiado
 isCopied boolean

¿Se copió el documento?
newDocumentId
 newDocumentId string

nuevo id. de documento

Crear documento

Id. de la operación:
CreateDocument

Crea un registro de documento con índices

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
DrawerId
 DrawerId string

Escriba el identificador del cajón.
IndexId
 IndexId string

Escriba id. de índice
IndexValue
 IndexValue string

Escriba el valor del índice.

Devoluciones

Nombre Ruta de acceso Tipo Description
documentId
 documentCreate.documentId string

valor de id. de documento
errorMessage
 documentCreate.errorMessage string

mensaje de error
errorMessage
 indexValidation.errorMessage string

mensaje de error
Errores
 indexValidation.errors array of

Errores
isValid
 indexValidation.isValid boolean

es el documento válido

Crear flujo de trabajo

Id. de la operación:
CreateWorkflow

Crear flujo de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Nombre del cajón
 Drawer string

Nombre del cajón
Tipo de servicio
 ServiceType string

Tipo de servicio
Id. de carpeta
 folderId string

Id. de carpeta
Nombre de cliente
 ClientName string

Nombre de cliente
Número de cliente
 ClientNumber string

Número de cliente
Tipo de compromiso
 EngagementType string

Tipo de compromiso
PIC
 PIC string

PIC
Año
 Year string

Año
Fin del período
 PeriodEnd string

Fin del período
Nombre del flujo de trabajo
 workflowName string

Nombre del flujo de trabajo
Description
 description True string

Description
Nombre del estado
 statusName string

Nombre del estado
Acción de entrega
 action string

Acción de entrega
Fecha de vencimiento actual
 currentduedate string

Fecha de vencimiento actual
Fecha de vencimiento original
 originalduedate string

Fecha de vencimiento original
Formulario de entrega
 form string

Formulario de entrega
Delivery (método)
 Delivery string

Delivery (método)
Destino
 Destination string

Destino
Documento de origen
 sourceDocument string

Documento de origen
Acción de nota
 action string

Acción de nota
Tipo de nota
 noteType string

Tipo de nota
Mensaje de nota
 note string

Mensaje de nota
Nombre del campo de información
 name string

Nombre del campo de información
Valor del campo de información
 value string

Valor del campo de información
Campo responsable
 ResponsibleField string

Campo responsable
Valor de campo responsable
 value string

Valor de campo responsable

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de presentación
 filingId integer

Id. de presentación
Comentario de error
 errorComment string

Comentario de error
Estado
 status boolean

Estado
errorMessage
 errorMessage array of string

errorMessage

Crear grupo

Id. de la operación:
CreateGroup

Crea un grupo de permisos.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
AccessToApproveDocsOnly
 AccessToApproveDocsOnly string

Especificar true o false
AllowAccessToReports
 AllowAccessToReports string

Especificar true o false
Comentarios
 Comments string

Escribir comentarios
EnableMfa
 EnableMfa string

Especificar true o false
EnforceMfaForUsers
 EnforceMfaForUsers string

Especificar true o false
FirmFlowRoutingNotification
 FirmFlowRoutingNotification string

Especificar true o false
FullAccessToDocTracking
 FullAccessToDocTracking string

Especificar true o false
GroupName
 GroupName string

Escriba el nombre del grupo.
MfaRequired
 MfaRequired string

Especificar true o false
PermissonToApproveDocs
 PermissonToApproveDocs string

Especificar true o false
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Especificar true o false
IsDenyAll
 IsDenyAll string

Especificar true o false
ReportType
 ReportType string

Especificar true o false
UploadLocation
 UploadLocation string

Escribir ubicación de carga
Users
 Users array of string

Users

Devoluciones

Nombre Ruta de acceso Tipo Description
createGroupException
 createGroupException string

crear excepción de grupo
groupId
 groupId string

valor de id. de grupo
isCreated
 isCreated boolean

¿Se creó el grupo?
mfaException
 mfaException string

Estado de mfa

Crear usuarios

Id. de la operación:
CreateUsers

Crea usuarios de GoFileRoom y ClientFlow en el sistema

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de Usuario
 userType string

Escriba el tipo de usuario.
Token
 X-Authorization string

Autenticación de tokens
AccountExpiresDate
 AccountExpiresDate string

Escribir la fecha de expiración de la cuenta
DisabledComments
 DisabledComments string

Escriba Comentarios deshabilitados.
Nombre completo
 FullName string

Nombre completo del usuario
Groups
 Groups array of string

Groups
IsAccountExpires
 IsAccountExpires string

Especificar true o false
IsAdvanceFlow
 IsAdvanceFlow string

Especificar true o false
IsAllowAccessToReports
 IsAllowAccessToReports string

Especificar true o false
IsAllowOffline
 IsAllowOffline string

Especificar true o false
EstáDesactivado
 IsDisabled string

Especificar true o false
IsFirmFlow
 IsFirmFlow string

Especificar true o false
IsFirmFlowNotificationGroup
 IsFirmFlowNotificationGroup string

Especificar true o false
IsFirmFlowNotificationUser
 IsFirmFlowNotificationUser string

Especificar true o false
IsMfa
 IsMfa string

Especificar true o false
IsUserAdministration
 IsUserAdministration string

Especificar true o false
IsWorkflowManagerUser
 IsWorkflowManagerUser string

Especificar true o false
LicenseType
 LicenseType string

Escriba el tipo de licencia.
NombreDeUsuario
 LoginName string

Escriba el nombre de inicio de sesión.
ManagerEmail
 ManagerEmail string

Escriba correo electrónico del administrador.
Contraseña
 Password string

Escribir contraseña
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Especificar true o false
IsDenyAll
 IsDenyAll string

Especificar true o false
ReportType
 ReportType string

Especificar true o false
UploadLocation
 UploadLocation string

Escribir ubicación de carga

Devoluciones

Nombre Ruta de acceso Tipo Description
createUserException
 createUserException string

crear excepción de usuario
isCreated
 isCreated boolean

¿Se creó el usuario?
mfaException
 mfaException string

Excepción mfa
userId
 userId string

valor de id. de usuario

Documento de taxsort

Id. de la operación:
TaxsortDocument

Documento PDF de taxsort

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
body
 body array of string

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
documentId
 documentId string

valor de id. de documento
isTaxSorted
 isTaxSorted boolean

Es el documento TaxSorted
taxsortDocumentException
 taxsortDocumentException string

taxsort Document Exception

Editar entrega maestra

Id. de la operación:
EditMasterDeliverable

Editar entrega maestra

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Nombre actual de la entrega
 currentdeliverableName string

Nombre actual de la entrega
Actualizar nombre de entrega
 updatedeliverableName string

Actualizar nombre de entrega
Fecha límite
 dueDate string

Fecha límite
Primera extensión
 firstExtension string

Primera extensión
Segunda extensión
 secondExtension string

Segunda extensión
Tercera extensión
 thirdExtension string

Tercera extensión
Calendario o fiscal
 calenderOrFiscal string

Calendario o fiscal
Extension
 extension integer

Extension
Tipo de servicio
 serviceType string

Tipo de servicio
Nombre del cajón
 drawerName string

Nombre del cajón

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado de actualización
 isUpdated boolean

Estado de actualización
Mensaje de respuesta
 responseMessage string

Mensaje de respuesta

Editar flujo de trabajo

Id. de la operación:
EditWorkflow

Editar flujo de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Id. de presentación
 filingId integer

Id. de presentación
Nombre de cliente
 ClientName string

Nombre de cliente
Número de cliente
 ClientNumber string

Número de cliente
Tipo de compromiso
 EngagementType string

Tipo de compromiso
PIC
 PIC string

PIC
Año
 Year string

Año
Fin del período
 PeriodEnd string

Fin del período
Nombre de la entrega
 action string

Nombre de la entrega
Fecha de vencimiento actual
 currentduedate string

Fecha de vencimiento actual
Fecha de vencimiento original
 originalduedate string

Fecha de vencimiento original
Datos adjuntos
 form string

Datos adjuntos
Acción de nota
 action string

Acción de nota
Tipo de nota
 noteType string

Tipo de nota
noteid
 noteid array of string

noteid
Mensaje de nota
 note string

Mensaje de nota
Nombre del campo de información
 name string

Nombre del campo de información
Valor del campo de información
 value string

Valor del campo de información
Delivery (método)
 Delivery string

Delivery (método)
Destino
 Destination string

Destino
Documento de origen
 sourceDocument string

Documento de origen
Campo responsable
 responsibleField string

Campo responsable
Asignado a
 value string

Asignado a
Volver a indexar documentos
 reindexDocs boolean

Volver a indexar documentos

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de presentación
 filingId integer

Id. de presentación
Comentario de error
 errorComment string

Comentario de error
Estado
 status boolean

Estado
errorMessage
 errorMessage array of object

errorMessage
Nombre
 errorMessage.name string

Nombre
Estado
 errorMessage.status boolean

Estado
Comentario de error
 errorMessage.errorComment string

Comentario de error

Eliminar documento

Id. de la operación:
DocumentDelete

Elimina un documento

Parámetros

Nombre Clave Requerido Tipo Description
DocumentId
 documentId True string

Escriba el identificador de documento.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
deleteDocumentException
 deleteDocumentException string

eliminar excepción de documento
documentId
 documentId string

valor de id. de documento
isDeleted
 isDeleted boolean

es el documento eliminado

Eliminar entrega maestra

Id. de la operación:
DeleteMasterDeliverable

Eliminar entrega maestra

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Tipo de servicio
 ServiceType string

Tipo de servicio
Nombre del cajón
 DrawerName string

Nombre del cajón
DeliverableNames
 DeliverableNames array of string

DeliverableNames

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Eliminar estado
 isDeleted boolean

Eliminar estado
Mensaje de respuesta
 responseMessage string

Mensaje de respuesta

Eliminar flujos de trabajo

Id. de la operación:
DeleteWorkflows

Eliminar flujos de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
filingId
 filingId array of integer

filingId

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado eliminado
 isDeleted boolean

Estado eliminado
Id. de presentación
 filingId string

Id. de presentación

Eliminar usuario

Id. de la operación:
DeleteUser

Eliminar usuarios de GoFileRoom y ClientFlow del sistema

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
LoginId
 LoginId string

Escriba el identificador de inicio de sesión del usuario.
Tipo de Usuario
 UserType string

Escriba el tipo de usuario.

Devoluciones

Nombre Ruta de acceso Tipo Description
deleteUserException
 deleteUserException string

eliminar excepción de usuario
isDeleted
 isDeleted boolean

¿Se eliminó el inicio de sesión?
loginId
 loginId string

valor de id. de inicio de sesión

Establecer permisos de grupo

Id. de la operación:
SetGroupPermissions

Asigna permiso al grupo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Gabinete
 Cabinet string

Escriba el nombre del gabinete.
Agregar
 Add string

Especificar true o false
Delete
 Delete string

Especificar true o false
Deny
 Deny string

Especificar true o false
Edit
 Edit string

Especificar true o false
LookUp
 LookUp string

Especificar true o false
Read
 Read string

Especificar true o false
Caja registradora
 Drawer string

Escriba el nombre del cajón.
Agregar
 Add string

Especificar true o false
Delete
 Delete string

Especificar true o false
Deny
 Deny string

Especificar true o false
Edit
 Edit string

Especificar true o false
LookUp
 LookUp string

Especificar true o false
Read
 Read string

Especificar true o false
GroupName
 GroupName string

Escriba el nombre del grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
groupId
 groupId string

valor de id. de grupo
groupPermissionException
 groupPermissionException string

excepción de permiso de grupo
isSet
 isSet boolean

¿Se aplicaron los permisos?

Establecer permisos de usuario

Id. de la operación:
SetUserPermissions

Asigna permiso al usuario

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Gabinete
 Cabinet string

Escriba el nombre del gabinete.
Agregar
 Add string

Especificar true o false
Delete
 Delete string

Especificar true o false
Deny
 Deny string

Especificar true o false
Edit
 Edit string

Especificar true o false
LookUp
 LookUp string

Especificar true o false
Read
 Read string

Especificar true o false
Caja registradora
 Drawer string

Escriba el nombre del cajón.
Agregar
 Add string

Especificar true o false
Delete
 Delete string

Especificar true o false
Deny
 Deny string

Especificar true o false
Edit
 Edit string

Especificar true o false
LookUp
 LookUp string

Especificar true o false
Read
 Read string

Especificar true o false
LoginId
 LoginId string

Escriba el identificador de inicio de sesión.

Devoluciones

Nombre Ruta de acceso Tipo Description
isSetUserPermission
 isSetUserPermission boolean

Actualización del permiso de usuario
loginId
 loginId string

valor de id. de inicio de sesión
setUserPermissionException
 setUserPermissionException string

establecer excepción de permiso de usuario

Establecer seguridad de documentos de grupo

Id. de la operación:
SetGroupDocSecurity

Asigna seguridad de documentos a un grupo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
CabinetName
 CabinetName string

Escriba el nombre del gabinete.
DocSecurityType
 DocSecurityType string

Escriba el tipo de seguridad del documento.
IndexName
 IndexName string

Escriba el nombre del índice.
Operation
 Operation string

Escriba el tipo de operación.
Valores
 Values array of string

Valores
DrawerName
 DrawerName string

Escriba el nombre del cajón.
GroupName
 GroupName string

Escriba el nombre del grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
groupName
 groupName string

Valor de nombre de grupo
isSetGroupDocSecurity
 isSetGroupDocSecurity boolean

¿Se estableció la seguridad del documento?
setGroupDocSecurityException
 setGroupDocSecurityException string

Excepción de seguridad de documento de grupo

Establecer seguridad de documentos de usuario

Id. de la operación:
SetUserDocSecurity

Asigna permisos de seguridad de documentos de usuario

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
CabinetName
 CabinetName string

Escriba el nombre del gabinete.
DocSecurityType
 DocSecurityType string

Escriba el tipo de seguridad del documento.
IndexName
 IndexName string

Escriba el nombre del índice.
Operation
 Operation string

Entrar operación
Valores
 Values array of string

Valores
DrawerName
 DrawerName string

Escriba el nombre del cajón.
LoginId
 LoginId string

Escriba el identificador de inicio de sesión.

Devoluciones

Nombre Ruta de acceso Tipo Description
isSetUserDocSecurity
 isSetUserDocSecurity boolean

¿Se aplicó la seguridad de documentos de usuario?
loginId
 loginId string

valor de id. de inicio de sesión
setUserDocSecurityException
 setUserDocSecurityException string

establecer excepción de seguridad de documento de usuario

Flujo de trabajo de ruta V2

Id. de la operación:
RouteWorkflowV2

Flujo de trabajo de ruta V2

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
filingId
 filingId array of integer

filingId
CurrentStep
 CurrentStep array of string

CurrentStep
Completo
 Complete boolean

Completo
Fecha de finalización
 CompletedDate string

Fecha de finalización
Paso siguiente
 NextStep string

Paso siguiente
Asignado a
 AssignedTo string

Asignado a
Fecha asignada
 AssignedDate string

Fecha asignada
Priority
 Priority string

Priority
Estado
 Status string

Estado
Nota de enrutamiento
 RoutingNote string

Nota de enrutamiento
Notificación por correo electrónico
 emailNotify boolean

Notificación por correo electrónico

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de presentación
 filingId string

Id. de presentación
Se enruta
 isRouted boolean

Se enruta

Index LookupList Find

Id. de la operación:
IndexLookupListFind

Este método está diseñado para su uso con campos de autocompletar.

Parámetros

Nombre Clave Requerido Tipo Description
IndexID
 indexId True string

Escriba el identificador de índice.
Token
 X-Authorization string

Autenticación de tokens
TipoDeAcción
 ActionType integer

Escribir tipo de acción
Contar
 Count integer

Escribir recuento
IndexValue
 IndexValue string

Escriba el valor del índice.
TipoDeBúsqueda
 SearchType integer

Escriba el tipo de búsqueda.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
indexId
 index.indexId string

valor de id. de índice
indexValue
 index.indexValue string

valor de índice
linkedIndexes
 linkedIndexes array of object

linkedIndexes
indexId
 linkedIndexes.indexId string

indexId
indexValue
 linkedIndexes.indexValue string

indexValue

Iniciar sesión

Id. de la operación:
Login

Registra un usuario en la aplicación

Parámetros

Nombre Clave Requerido Tipo Description
NombreDeUsuario
 LoginName True string

Escriba el nombre de inicio de sesión.
Contraseña
 Password True password

Escribir contraseña

Devoluciones

Nombre Ruta de acceso Tipo Description
authSuccess
 authSuccess boolean

la autenticación se realizó correctamente
authenticationResponse
 authenticationResponse string

valor de respuesta de autenticación
customerId
 customerId string

valor de id. de cliente
código de error
 errorCode string

valor de código de error
idleSessionTimeoutMinutes
 idleSessionTimeoutMinutes integer

minutos de tiempo de espera de sesión inactivos
loneStarFirmId
 loneStarFirmId string

id. de firma de estrella lone
loneStarValidated
 loneStarValidated boolean

lone Star Validated
token
 token string

valor de token
userId
 userId string

valor de id. de usuario
nombre de usuario
 userName string

valor de nombre de usuario

Modificar grupo

Id. de la operación:
ModifyGroup

Modificación de permisos de grupo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
AccessToApproveDocsOnly
 AccessToApproveDocsOnly string

Especificar true o false
AllowAccessToReports
 AllowAccessToReports string

Especificar true o false
Comentarios
 Comments string

Escribir comentarios
EnableMfa
 EnableMfa string

Especificar true o false
EnforceMfaForUsers
 EnforceMfaForUsers string

Especificar true o false
FirmFlowRoutingNotification
 FirmFlowRoutingNotification string

Especificar true o false
FullAccessToDocTracking
 FullAccessToDocTracking string

Especificar true o false
GroupName
 GroupName string

Escriba el nombre del grupo.
MfaRequired
 MfaRequired string

Especificar true o false
PermissonToApproveDocs
 PermissonToApproveDocs string

Especificar true o false
RenameGroup
 RenameGroup string

Escriba nuevo nombre de grupo.
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Especificar true o false
IsDenyAll
 IsDenyAll string

Especificar true o false
ReportType
 ReportType string

Especificar true o false
UploadLocation
 UploadLocation string

Escribir ubicación de carga
Users
 Users array of string

Users

Devoluciones

Nombre Ruta de acceso Tipo Description
groupId
 groupId string

valor de id. de grupo
isModified
 isModified boolean

¿Se modificó el grupo?
mfaException
 mfaException string

Excepción mfa
modifyGroupException
 modifyGroupException string

modificar excepción de grupo

Modificar usuario

Id. de la operación:
ModifyUser

Modificación de permisos de usuario

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de Usuario
 userType string

Escriba el tipo de usuario.
Token
 X-Authorization string

Autenticación de tokens
AccountExpiresDate
 AccountExpiresDate string

Fecha en que expirará la cuenta
DisabledComments
 DisabledComments string

Escribir comentarios
Nombre completo
 FullName string

Escriba el nombre completo.
Groups
 Groups array of string

Groups
IsAccountExpires
 IsAccountExpires string

Especificar true o false
IsAdvanceFlow
 IsAdvanceFlow string

Especificar true o false
IsAllowAccessToReports
 IsAllowAccessToReports string

Especificar true o false
IsAllowOffline
 IsAllowOffline string

Especificar true o false
IsChangeNextLogin
 IsChangeNextLogin string

Especificar true o false
EstáDesactivado
 IsDisabled string

Especificar true o false
IsFirmFlow
 IsFirmFlow string

Especificar true o false
IsFirmFlowNotificationGroup
 IsFirmFlowNotificationGroup string

Especificar true o false
IsFirmFlowNotificationUser
 IsFirmFlowNotificationUser string

Especificar true o false
IsMfa
 IsMfa string

Especificar true o false
IsUserAdministration
 IsUserAdministration string

Especificar true o false
IsWorkflowManagerUser
 IsWorkflowManagerUser string

Especificar true o false
LicenseType
 LicenseType string

Escriba el tipo de licencia.
NombreDeUsuario
 LoginName string

Escriba el nombre de inicio de sesión.
ManagerEmail
 ManagerEmail string

Escriba correo electrónico del administrador.
Contraseña
 Password string

Escribir contraseña
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Especificar true o false
IsDenyAll
 IsDenyAll string

Especificar true o false
ReportType
 ReportType string

Especificar true o false
UploadLocation
 UploadLocation string

Escribir ubicación de carga

Devoluciones

Nombre Ruta de acceso Tipo Description
isModified
 isModified boolean

¿Se modificó el usuario?
mfaException
 mfaException string

Excepción mfa
modifyUserException
 modifyUserException string

modificar excepción de usuario
userId
 userId string

valor de id. de usuario

Obtención de datos de FirmFlow por entrega

Id. de la operación:
GetFirmFlowDeliverableReport

Obtiene el informe de seguimiento por datos de entrega.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Responsable
 Accountable string

Escriba el valor responsable.
AssignedOn
 AssignedOn string

Escriba Assigned On Date (Especificar asignado en fecha)
AssignedTo
 AssignedTo string

Escriba el valor Asignado a.
AssignmentHistory
 AssignmentHistory string

Escriba historial de asignaciones.
CompletedBy
 CompletedBy string

Escriba Completed By value (Completado por valor)
CompletedOn
 CompletedOn string

Escriba Completed On Date (Completado en fecha)
CurrentDueDate
 CurrentDueDate string

Escriba Fecha de vencimiento actual.
CurrentStep
 CurrentStep string

Escriba el paso actual.
DateExtended
 DateExtended string

Escribir fecha extendida
DaysAtStep
 DaysAtStep string

Escribir días en el paso
DaysBetweenRoutings
 DaysBetweenRoutings string

Especificar días entre enrutamientos
DrawerId
 DrawerId string

Escriba el identificador del cajón.
EngagementType
 EngagementType string

Escriba el tipo de compromiso.
InProcessOnly
 InProcessOnly string

Escriba el valor Solo en proceso.
Indexes
 Indexes array of string

Indexes
InformationFields
 InformationFields array of string

InformationFields
OriginalDueDate
 OriginalDueDate string

Escriba la fecha de vencimiento original.
PIC
 PIC string

Escriba PIC.
PageNumber
 PageNumber string

Escriba el número de página.
Priority
 Priority string

Escriba Prioridad.
ReceivedFrom
 ReceivedFrom string

Escriba Received From value (Recibido del valor)
RecibidoEl
 ReceivedOn string

Escriba Received On Date (Recibido en fecha)
Responsable
 Responsible string

Escriba el valor responsable.
RoutingDetails
 RoutingDetails string

Escriba detalles de enrutamiento.
SentOn
 SentOn string

Escriba Sent On Date
SentTo
 SentTo string

Escriba el valor Enviado a.
ServiceType
 ServiceType string

Escriba el tipo de servicio.
Estado
 Status string

Escriba status (Estado)
TotalDaysAtStep
 TotalDaysAtStep string

Escriba El total de días en el paso
TotalDaysInProcess
 TotalDaysInProcess string

Escriba total de días en proceso.
Flujo de trabajo
 Workflow string

Escriba el nombre del flujo de trabajo.
WorkflowDescription
 WorkflowDescription string

Escriba la descripción del flujo de trabajo.

Devoluciones

Nombre Ruta de acceso Tipo Description
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
responsable
 firmFlowReportResponse.accountable string

valor responsable
assignedOn
 firmFlowReportResponse.assignedOn string

asignado en la fecha
assignedTo
 firmFlowReportResponse.assignedTo string

asignado Al valor
assignedToYesOrNo
 firmFlowReportResponse.assignedToYesOrNo string

¿Se asigna el flujo de trabajo?
assignmentHistory
 firmFlowReportResponse.assignmentHistory string

valor del historial de asignaciones
clientName
 firmFlowReportResponse.clientName string

valor de nombre de cliente
clientNumber
 firmFlowReportResponse.clientNumber string

valor de número de cliente
completedBy
 firmFlowReportResponse.completedBy string

completado por valor
completedOn
 firmFlowReportResponse.completedOn string

completado en la fecha
currentDueDate
 firmFlowReportResponse.currentDueDate string

fecha de vencimiento actual
currentStep
 firmFlowReportResponse.currentStep string

valor del paso actual
dateExtended
 firmFlowReportResponse.dateExtended string

fecha extendida
daysAtStep
 firmFlowReportResponse.daysAtStep string

días de flujo de trabajo en el paso
daysBetweenRoutings
 firmFlowReportResponse.daysBetweenRoutings string

días de flujo de trabajo entre enrutamientos
Entregas
 firmFlowReportResponse.deliverables string

valor de resultados
drawerId
 firmFlowReportResponse.drawerId string

valor de id. de cajón
eFileYesOrNo
 firmFlowReportResponse.eFileYesOrNo string

es el resultado que se va a enviar a eFiled
engagementType
 firmFlowReportResponse.engagementType string

valor de tipo de compromiso
extendedYesOrNo
 firmFlowReportResponse.extendedYesOrNo string

ha ampliado la entrega
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
nombre
 firmFlowReportResponse.informationFields.name string

nombre
value
 firmFlowReportResponse.informationFields.value string

value
originalDueDate
 firmFlowReportResponse.originalDueDate string

fecha de vencimiento original
periodEnd
 firmFlowReportResponse.periodEnd string

period Fin del flujo de trabajo
Pic
 firmFlowReportResponse.pic string

imagen del flujo de trabajo
picYesOrNo
 firmFlowReportResponse.picYesOrNo string

ha asignado la imagen
prioridad
 firmFlowReportResponse.priority string

valor de prioridad
progreso
 firmFlowReportResponse.progress string

valor de progreso
receivedFrom
 firmFlowReportResponse.receivedFrom string

recibido desde el valor
receivedOn
 firmFlowReportResponse.receivedOn string

recibido en la fecha
responsable
 firmFlowReportResponse.responsible string

valor responsable
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
routingNotes
 firmFlowReportResponse.routingNotes string

enrutamiento de notas del flujo de trabajo
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
sentOn
 firmFlowReportResponse.sentOn string

enviado en fecha
sentTo
 firmFlowReportResponse.sentTo string

sent To value
serviceType
 firmFlowReportResponse.serviceType string

tipo de servicio de flujo de trabajo
estado
 firmFlowReportResponse.status string

estado del flujo de trabajo
totalDaysAtStep
 firmFlowReportResponse.totalDaysAtStep string

total de días en el paso del flujo de trabajo
totalDaysInProcess
 firmFlowReportResponse.totalDaysInProcess string

total de días en proceso de flujo de trabajo
flujo de trabajo
 firmFlowReportResponse.workflow string

tipo de flujo de trabajo
workflowDescription
 firmFlowReportResponse.workflowDescription string

Descripción del flujo de trabajo
año
 firmFlowReportResponse.year string

año de flujo de trabajo
getFirmFlowException
 getFirmFlowException string

Obtener excepción de FirmFlow
pageNumber
 pageNumber string

page Número de solicitud
pageSize
 pageSize integer

tamaño de la página de solicitud
totalPages
 totalPages integer

total de páginas de solicitud
totalRecords
 totalRecords integer

total de registros de solicitud

Obtención de la entrega maestra

Id. de la operación:
GetMasterDeliverable

Obtención de la entrega maestra

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Número de página
 PageNumber integer

Número de página
Tamaño de página
 pageSize integer

Tamaño de página
Tipo de servicio
 ServiceType string

Tipo de servicio
Nombre del cajón
 DrawerName string

Nombre del cajón

Devoluciones

Nombre Ruta de acceso Tipo Description
deliverableList
 deliverableList array of object

deliverableList
Nombre de la entrega
 deliverableList.deliverableName string

Nombre de la entrega
Tipo de extensión
 deliverableList.extensionType string

Tipo de extensión
Fecha límite
 deliverableList.dueDate string

Fecha límite
Primera extensión
 deliverableList.firstExtension string

Primera extensión
Segunda extensión
 deliverableList.secondExtension string

Segunda extensión
Tercera extensión
 deliverableList.thirdExtension string

Tercera extensión
Extension
 deliverableList.extension string

Extension
Acción
 deliverableList.action string

Acción
Id. de obligación
 deliverableList.obligationId string

Id. de obligación
Opción administrada de firma
 deliverableList.firmManagedOption string

Opción administrada de firma
Total de registros
 totalRecords string

Total de registros
Mensaje de respuesta
 responseMessage string

Mensaje de respuesta

Obtención de reglas dinámicas para el índice

Id. de la operación:
GetDynamicRulesForIndex

Obtiene la lista de reglas dinámicas configuradas para el índice especificado.

Parámetros

Nombre Clave Requerido Tipo Description
IndexId
 indexId True string

Escriba el identificador de índice.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
condition
 condition string

valor de condición
dependentIndexId
 dependentIndexId string

valor de id. de índice dependiente
dynamicRuleId
 dynamicRuleId string

valor de id. de regla dinámico
value
 value string

value

Obtención de seguridad de documentos de usuario

Id. de la operación:
GetUserDocumentSecurity

Captura la seguridad del documento de usuario por inicio de sesión

Parámetros

Nombre Clave Requerido Tipo Description
LoginId
 loginId True string

Escriba el identificador de inicio de sesión.
CabinetName
 cabinetName True string

Escriba el nombre del gabinete.
DrawerName
 drawerName True string

Escriba el nombre del cajón.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
cabinetName
 cabinetName string

nombre del gabinete
documentSecurity
 documentSecurity string

valor de seguridad del documento
drawerName
 drawerName string

valor del nombre del cajón
getUserDocSecurityException
 getUserDocSecurityException string

Excepción de seguridad del documento de usuario
loginId
 loginId string

valor de id. de inicio de sesión

Obtener cajones

Id. de la operación:
GetDrawers

Captura los cajones accesibles para el usuario que ha iniciado sesión

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
drawerID
 drawerID string

valor de id. de cajón
drawerName
 drawerName string

valor del nombre del cajón
add
 permissions.add boolean

agregar valor
delete
 permissions.delete boolean

eliminar valor
edit
 permissions.edit boolean

editar valor
lookupManagement
 permissions.lookupManagement boolean

valor lookupManagement
view
 permissions.view boolean

valor de vista

Obtener directiva de contraseñas

Id. de la operación:
GetPasswordPolicy

Captura la directiva de contraseñas para la empresa

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
clientId
 passwordPolicy.clientId string

valor de id. de cliente
forbidden_pwd_words
 passwordPolicy.forbidden_pwd_words array of string

forbidden_pwd_words
lockout_threshold
 passwordPolicy.lockout_threshold integer

umbral de bloqueo
max_length
 passwordPolicy.max_length integer

longitud máxima de la contraseña
max_login_similarity
 passwordPolicy.max_login_similarity string

similitud máxima de inicio de sesión
max_pwd_age
 passwordPolicy.max_pwd_age integer

max pwd age of password
max_repeat_chars
 passwordPolicy.max_repeat_chars string

max repeat chars in password (número máximo de caracteres de repetición en la contraseña)
max_sequential_chars
 passwordPolicy.max_sequential_chars string

caracteres secuenciales máximos
Amf
 passwordPolicy.mfa integer

Valor mfa
min_length
 passwordPolicy.min_length integer

longitud mínima de la contraseña
pwd_req_alpha
 passwordPolicy.pwd_req_alpha integer

Requisito de contraseña alfa
pwd_req_lower
 passwordPolicy.pwd_req_lower integer

Requisito de contraseña inferior
pwd_req_number
 passwordPolicy.pwd_req_number integer

Requisito de número de contraseña
pwd_req_symbol
 passwordPolicy.pwd_req_symbol integer

Requisito de contraseña de símbolos
pwd_req_upper
 passwordPolicy.pwd_req_upper integer

Requisito superior de contraseña
passwordPolicyException
 passwordPolicyException string

passwordPolicyException

Obtener documento

Id. de la operación:
GetDocument

Descarga el documento

Parámetros

Nombre Clave Requerido Tipo Description
DocumentId
 documentId True string

Escriba el identificador de documento.
Token
 X-Authorization string

Autenticación de tokens

Obtener el estado del documento

Id. de la operación:
GetDocumentStatus

Obtener el estado de los documentos

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
body
 body array of string

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
documentId
 documentId string

valor de id. de documento
documentStatusException
 documentStatusException string

excepción de estado del documento
drawerId
 drawerId string

valor de id. de cajón
tamaño de archivo
 fileSize string

valor de tamaño de archivo
isArchived
 isArchived boolean

es el documento archivado
isCheckedOut
 isCheckedOut boolean

es el documento desprotegido
Está cifrado
 isEncrypted boolean

es el documento cifrado
isFiled
 isFiled boolean

es el documento archivado
isInRedactionQueue
 isInRedactionQueue boolean

es el documento En la cola de reacciones
isInTaxsortQueue
 isInTaxsortQueue boolean

es el documento en la cola taxsort.
isLocked
 isLocked boolean

es el documento bloqueado
isOfficeDocument
 isOfficeDocument boolean

es el documento un documento de Office
isPublished
 isPublished boolean

es el documento publicado
isUndergoing Combine
 isUndergoingMerging boolean

es el documento En proceso de combinación
localFile
 localFile string

es el documento un archivo local.
noEdit
 noEdit boolean

no hay ningún valor de edición
pages
 pages integer

páginas del documento
reviewed
 reviewed boolean

estado revisado
taxSort
 taxSort boolean

es el documento taxSorted
type
 type string

tipo de archivo
version
 version integer

versión del documento

Obtener grupos

Id. de la operación:
GetGroups

Captura los grupos disponibles para la administración de grupos y usuarios

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
id
 id string

Valor de id. de grupo
Amf
 mfa integer

Valor mfa
mfaRequired
 mfaRequired integer

Valor requerido de mfa
nombre
 name string

Valor de nombre de grupo

Obtener historial de documentos

Id. de la operación:
GetDocumentHistory

Obtiene el historial del documento.

Parámetros

Nombre Clave Requerido Tipo Description
DocumentId
 documentId True string

Escriba el identificador de documento.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
documentAudit
 documentAudit array of

documentAudit
documentHistoryException
 documentHistoryException string

Excepción del historial de documentos
documentId
 documentId string

valor de id. de documento
mergeDocHistory
 mergeDocHistory array of

mergeDocHistory

Obtener información de usuario

Id. de la operación:
GetUserInfo

Captura la información del usuario de GFR

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
NombreDeUsuario
 LoginName True string

Escriba LoginName.
Tipo de Usuario
 UserType True string

Seleccionar UserType

Devoluciones

Nombre Ruta de acceso Tipo Description
createDate
 createDate string

createDate
createdBy
 createdBy string

createdBy
descripción
 description string

descripción
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
firma
 signature string

firma
systemAdmin
 systemAdmin boolean

systemAdmin
taxFlow
 taxFlow boolean

taxFlow
userAdministration
 userAdministration integer

userAdministration
userID
 userID string

userID
workflowManagerUser
 workflowManagerUser boolean

workflowManagerUser

Obtener información de usuario V2

Id. de la operación:
GetUserInfoV2

Obtiene la infromation del usuario.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Nombre de inicio de sesión
 LoginName string

Nombre de inicio de sesión
Tipo de usuario
 UserType string

Tipo de usuario

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 userID string

Id. de usuario
Id. de inicio de sesión
 loginID string

Id. de inicio de sesión
Nombre completo
 fullName string

Nombre completo
Fecha de creación
 createDate string

Fecha de creación
Autor
 createdBy string

Autor
Description
 description string

Description
Disabled
 disabled integer

Disabled
Deshabilitado por administrador
 disabledByAdmin boolean

Deshabilitado por administrador
Fecha de expiración de contraseña
 passwordExpireDate string

Fecha de expiración de contraseña
Forzar el cambio de contraseña
 forcePasswordChange boolean

Forzar el cambio de contraseña
Fecha de cambio de contraseña
 passwordChangeDate string

Fecha de cambio de contraseña
Intervalo de cambio de contraseña
 passwordChangeInterval integer

Intervalo de cambio de contraseña
Tipo de licencia
 licenseType string

Tipo de licencia
Desconectado
 offline boolean

Desconectado
Informes
 reports boolean

Informes
Administrador del sistema
 systemAdmin boolean

Administrador del sistema
Signature
 signature string

Signature
Id. de ubicación
 locationID string

Id. de ubicación
Tiene derechos de configuración del cajón
 hasDrawerSetupRights string

Tiene derechos de configuración del cajón
Flujo fiscal
 taxFlow boolean

Flujo fiscal
Notificación por correo electrónico
 emailNotify boolean

Notificación por correo electrónico
Grupo de notificaciones por correo electrónico
 emailNotifyGroup boolean

Grupo de notificaciones por correo electrónico
Enviar notificación por correo electrónico a usuarios de mgmt de eventos
 emailNotifyEventMgmtUsers boolean

Enviar notificación por correo electrónico a usuarios de mgmt de eventos
Grupos de mgmt de notificación de correo electrónico
 emailNotifyEventMgmtGroups boolean

Grupos de mgmt de notificación de correo electrónico
Administración de usuarios del portal
 portalUserAdministration boolean

Administración de usuarios del portal
Administración interna de usuarios
 internalUserAdministration boolean

Administración interna de usuarios
Usuario del Administrador de flujos de trabajo
 workflowManagerUser boolean

Usuario del Administrador de flujos de trabajo
Identificador del administrador
 managerId string

Identificador del administrador
Identificador de inicio de sesión del administrador
 managerLoginId string

Identificador de inicio de sesión del administrador
Nombre completo del administrador
 managerFullName string

Nombre completo del administrador
Is Manager
 isManager integer

Is Manager
Usuario de Oberon
 oberonUser integer

Usuario de Oberon
Es administrador
 isAdmin integer

Es administrador
Último inicio de sesión
 lastLogin string

Último inicio de sesión
groups
 groups array of string

groups

Obtener licencias

Id. de la operación:
GetLicenses

Recupera recuentos de licencias

Parámetros

Nombre Clave Requerido Tipo Description
LicenseType
 license string

Escriba el tipo de licencia.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
assignedLicenses
 assignedLicenses string

recuento de licencias asignadas
getLicenseException
 getLicenseException string

Obtener excepción de licencia
license
 license string

nombre de licencia
Mensaje
 message string

Mensaje
totalLicenses
 totalLicenses string

recuento total de licencias

Obtener lista de informes

Id. de la operación:
GetListOfReports

Captura los informes disponibles para la administración de usuarios

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
reports
 reports array of object

reports
reportName
 reports.reportName array of string

reportName
tipoDeInforme
 reports.reportType string

valor de tipo de informe
reportsException
 reportsException string

notifica el valor de excepción

Obtener lista de valores de índice

Id. de la operación:
GetListTypeIndexData

Obtiene todas las entradas de un índice de tipo de lista.

Parámetros

Nombre Clave Requerido Tipo Description
IndexId
 indexId True string

Escriba el identificador de índice.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
childIndexId
 childIndexId string

valor de id. de índice secundario
childListId
 childListId integer

valor de id. de lista secundario
hasChildren
 hasChildren boolean

¿Tiene el índice un índice secundario?
listEntryId
 listEntryId integer

valor de id. de entrada de lista
listId
 listId integer

valor de id. de lista
value
 value string

value

Obtener permisos de grupo

Id. de la operación:
GetGroupPermissions

Obtiene los permisos de los grupos.

Parámetros

Nombre Clave Requerido Tipo Description
GroupName
 groupName string

Escriba el nombre del grupo.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
cabinet
 cabinet string

Nombre del gabinete
add
 cabinetPermissions.add boolean

agregar permisos
delete
 cabinetPermissions.delete boolean

eliminar permisos
negar
 cabinetPermissions.deny boolean

permisos de denegación
edit
 cabinetPermissions.edit boolean

editar permisos
Búsqueda
 cabinetPermissions.lookUp boolean

permisos de búsqueda
read
 cabinetPermissions.read boolean

permisos de lectura
drawerPermissions
 drawerPermissions array of object

drawerPermissions
cajón
 drawerPermissions.drawer string

Nombre del cajón
add
 drawerPermissions.permission.add boolean

agregar permisos
delete
 drawerPermissions.permission.delete boolean

eliminar permisos
negar
 drawerPermissions.permission.deny boolean

permisos de denegación
edit
 drawerPermissions.permission.edit boolean

editar permisos
Búsqueda
 drawerPermissions.permission.lookUp boolean

permisos de búsqueda
read
 drawerPermissions.permission.read boolean

permisos de lectura
groupName
 groupName string

Nombre de grupo
groupPermissionException
 groupPermissionException string

Excepción de permiso de grupo

Obtener permisos de usuario

Id. de la operación:
GetUserPermission

Obtiene los permisos del usuario.

Parámetros

Nombre Clave Requerido Tipo Description
Iniciar sesión
 login True string

Escribir inicio de sesión
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
cabinet
 cabinet string

valor de nombre del gabinete
add
 cabinetPermission.add boolean

agregar valor
delete
 cabinetPermission.delete boolean

eliminar valor
negar
 cabinetPermission.deny boolean

valor deny
edit
 cabinetPermission.edit boolean

editar valor
Búsqueda
 cabinetPermission.lookUp boolean

valor lookUp
read
 cabinetPermission.read boolean

valor de lectura
drawerPermissions
 drawerPermissions array of object

drawerPermissions
cajón
 drawerPermissions.drawer string

valor del nombre del cajón
add
 drawerPermissions.permission.add boolean

agregar valor
delete
 drawerPermissions.permission.delete boolean

eliminar valor
negar
 drawerPermissions.permission.deny boolean

valor deny
edit
 drawerPermissions.permission.edit boolean

editar valor
Búsqueda
 drawerPermissions.permission.lookUp boolean

valor lookUp
read
 drawerPermissions.permission.read boolean

valor de lectura
getUserPermissionException
 getUserPermissionException string

Excepción de permiso de usuario
loginId
 loginId string

valor de id. de inicio de sesión

Obtener seguridad de documentos de grupo

Id. de la operación:
GetGroupDocumentSecurity

Recuperación de la seguridad del documento de grupo

Parámetros

Nombre Clave Requerido Tipo Description
GroupName
 groupName True string

Escriba el nombre del grupo.
CabinetName
 cabinetName True string

Escriba el nombre del gabinete.
DrawerName
 drawerName True string

Escriba el nombre del cajón.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre de grupo
 groupName string

Nombre de grupo
Nombre del gabinete
 cabinetName string

Nombre del gabinete
Nombre del cajón
 drawerName string

Nombre del cajón
documentSecurity
 documentSecurity array of object

documentSecurity
Nombre del índice
 documentSecurity.indexName string

Nombre del índice
Tipo de seguridad de documento
 documentSecurity.docSecurityType string

Tipo de seguridad de documento
values
 documentSecurity.values array of string

values
Excepción de seguridad de documento de grupo
 getGroupDocSecurityException string

Excepción de seguridad de documento de grupo

Obtener ubicaciones de carga

Id. de la operación:
GetUploadLocation

Captura las ubicaciones de carga del usuario

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
uploadLocations
 uploadLocations array of object

uploadLocations
locationName
 uploadLocations.locationName string

valor de location Name
locationPath
 uploadLocations.locationPath string

valor de ruta de acceso de ubicación
uploadLocationsException
 uploadLocationsException string

Upload Locations Exception

Obtener usuarios

Id. de la operación:
GetUsers

Captura los usuarios de GFR para el usuario que ha iniciado sesión

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de Usuario
 userType string

Escriba el tipo de usuario.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
isActive
 isActive boolean

¿Es el usuario activo?
loginId
 loginId string

valor de id. de inicio de sesión

Obtener valores lookupList

Id. de la operación:
GetLookupList

Captura los valores de LookupList

Parámetros

Nombre Clave Requerido Tipo Description
Id. de cajón. Cajón de clientes de ejemplo: "0000000001"
 drawerId True string

Escriba el identificador del cajón.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
clientName
 clientName string

valor de nombre de cliente
clientNumber
 clientNumber string

valor de número de cliente

Obtener índices de cajón

Id. de la operación:
GetDrawerIndexes

Recupera una lista de índices de documento configurados para el cajón.

Parámetros

Nombre Clave Requerido Tipo Description
DrawerId
 drawerId True string

Escriba el identificador del cajón.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
childIndexId
 childIndexId string

valor de id. de índice secundario
indexId
 indexId string

valor de id. de índice
indexName
 indexName string

valor de nombre de índice
indexType
 indexType string

valor de tipo de índice
length
 length integer

Longitud del índice del cajón
listId
 listId integer

valor de id. de lista
lookupAutoUpdate
 lookupAutoUpdate boolean

búsqueda de actualización automática
required
 required boolean

¿Es necesario el índice?

Obtener índices de documentos

Id. de la operación:
GetDocumentIndexes

Recupera los índices del documento

Parámetros

Nombre Clave Requerido Tipo Description
DocumentId
 documentId True string

Escriba el identificador de documento.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
indexId
 indexId string

valor de id. de índice
indexValue
 indexValue string

valor de índice

Obtener índices secundarios

Id. de la operación:
GetChildIndexes

Obtiene una lista de valores de índice secundarios basados en el identificador de lista, que se proporciona cuando se selecciona el valor de lista primario.

Parámetros

Nombre Clave Requerido Tipo Description
IndexId
 indexId True string

Escriba el identificador de índice.
ListID
 listId True string

Escriba el identificador de lista.
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
childIndexId
 childIndexId string

valor de id. de índice secundario
childListId
 childListId integer

valor de id. de lista secundario
hasChildren
 hasChildren boolean

¿Tiene el índice un índice secundario?
listEntryId
 listEntryId integer

valor de id. de entrada de lista
listId
 listId integer

valor de id. de lista
value
 value string

value

Publicar estado del documento

Id. de la operación:
PublishDocumentStatus

Publicar o cancelar la publicación de documentos de ClientFlow.

Parámetros

Nombre Clave Requerido Tipo Description
DocumentId
 documentId True string

Escriba el identificador del documento.
Token
 X-Authorization string

Autenticación de tokens
IsPublished
 IsPublished True string

Especificar true o false

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
documentException
 documentException string

excepción de documento
documentId
 documentId string

valor de id. de documento
isPublished
 isPublished boolean

es el documento publicado

Reindexación de documentos

Id. de la operación:
DocumentReindex

Vuelve a indexar los documentos

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
DocumentIds
 DocumentIds array of string

DocumentIds
IndexId
 IndexId string

Escriba id. de índice
IndexValue
 IndexValue string

Escriba el valor del índice.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
documentId
 documentId string

valor de id. de documento
isReIndexed
 isReIndexed boolean

es el documento ReIndexed
reIndexDocumentException
 reIndexDocumentException string

Excepción de documento reIndex

Seguimiento del informe por entrega V2

Id. de la operación:
TrackingReportByDeliverableV2

Informe de seguimiento por DeliverableV2

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Id. del cajón
 DrawerId string

Id. del cajón
Tipo de servicio
 ServiceType string

Tipo de servicio
Tipo de compromiso
 EngagementType string

Tipo de compromiso
Flujo de trabajo
 Workflow string

Flujo de trabajo
Paso actual
 CurrentStep string

Paso actual
PIC
 PIC string

PIC
Asignado a
 AssignedTo string

Asignado a
Asignado en
 AssignedOn string

Asignado en
Descripción del flujo de trabajo
 WorkflowDescription string

Descripción del flujo de trabajo
Solo en proceso
 InProcessOnly string

Solo en proceso
Estado
 Status string

Estado
Priority
 Priority string

Priority
Recibido al
 ReceivedOn string

Recibido al
Fecha de finalización
 CompletedOn string

Fecha de finalización
Enviado al
 SentOn string

Enviado al
Responsable
 Responsible string

Responsable
Historial de asignaciones
 AssignmentHistory string

Historial de asignaciones
Recibido de
 ReceivedFrom string

Recibido de
Enviado a
 SentTo string

Enviado a
Completado por
 CompletedBy string

Completado por
Responsable
 Accountable string

Responsable
Fecha de vencimiento actual
 CurrentDueDate string

Fecha de vencimiento actual
Fecha de vencimiento original
 OriginalDueDate string

Fecha de vencimiento original
Fecha extendida
 DateExtended string

Fecha extendida
Días en el paso
 DaysAtStep string

Días en el paso
Total de días en el paso
 TotalDaysAtStep string

Total de días en el paso
Días entre enrutamientos
 DaysBetweenRoutings string

Días entre enrutamientos
Total de días en proceso
 TotalDaysInProcess string

Total de días en proceso
Detalles de enrutamiento
 RoutingDetails string

Detalles de enrutamiento
Última actualización
 LastUpdated string

Última actualización
InformationFields
 InformationFields array of string

InformationFields
Indexes
 Indexes array of string

Indexes
Número de página
 PageNumber string

Número de página

Devoluciones

Nombre Ruta de acceso Tipo Description
Total de registros
 totalRecords integer

Total de registros
Número de página
 pageNumber string

Número de página
Tamaño de página
 pageSize integer

Tamaño de página
Total de páginas
 totalPages integer

Total de páginas
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
Nombre de cliente
 firmFlowReportResponse.clientName string

Nombre de cliente
Número de cliente
 firmFlowReportResponse.clientNumber string

Número de cliente
Id. del cajón
 firmFlowReportResponse.drawerId string

Id. del cajón
Tipo de servicio
 firmFlowReportResponse.serviceType string

Tipo de servicio
Tipo de compromiso
 firmFlowReportResponse.engagementType string

Tipo de compromiso
Flujo de trabajo
 firmFlowReportResponse.workflow string

Flujo de trabajo
Paso actual
 firmFlowReportResponse.currentStep string

Paso actual
PIC
 firmFlowReportResponse.pic string

PIC
Asignado a
 firmFlowReportResponse.assignedTo string

Asignado a
Asignado en
 firmFlowReportResponse.assignedOn string

Asignado en
Año
 firmFlowReportResponse.year string

Año
Fin del período
 firmFlowReportResponse.periodEnd string

Fin del período
Descripción del flujo de trabajo
 firmFlowReportResponse.workflowDescription string

Descripción del flujo de trabajo
Progress
 firmFlowReportResponse.progress string

Progress
Estado
 firmFlowReportResponse.status string

Estado
Priority
 firmFlowReportResponse.priority string

Priority
eFile Sí o No
 firmFlowReportResponse.eFileYesOrNo string

eFile Sí o No
Sí extendido o no
 firmFlowReportResponse.extendedYesOrNo string

Sí extendido o no
Recibido al
 firmFlowReportResponse.receivedOn string

Recibido al
Fecha de finalización
 firmFlowReportResponse.completedOn string

Fecha de finalización
Enviado al
 firmFlowReportResponse.sentOn string

Enviado al
Resultados
 firmFlowReportResponse.deliverables string

Resultados
Responsable
 firmFlowReportResponse.responsible string

Responsable
Historial de asignaciones
 firmFlowReportResponse.assignmentHistory string

Historial de asignaciones
Recibido de
 firmFlowReportResponse.receivedFrom string

Recibido de
Enviado a
 firmFlowReportResponse.sentTo string

Enviado a
Completado por
 firmFlowReportResponse.completedBy string

Completado por
Responsable
 firmFlowReportResponse.accountable string

Responsable
Fecha de vencimiento actual
 firmFlowReportResponse.currentDueDate string

Fecha de vencimiento actual
Fecha de vencimiento original
 firmFlowReportResponse.originalDueDate string

Fecha de vencimiento original
Notas de enrutamiento
 firmFlowReportResponse.routingNotes string

Notas de enrutamiento
PIC Sí o no
 firmFlowReportResponse.picYesOrNo string

PIC Sí o no
Asignado a Sí o no
 firmFlowReportResponse.assignedToYesOrNo string

Asignado a Sí o no
Fecha extendida
 firmFlowReportResponse.dateExtended string

Fecha extendida
Días en el paso
 firmFlowReportResponse.daysAtStep string

Días en el paso
Total de días en el paso
 firmFlowReportResponse.totalDaysAtStep string

Total de días en el paso
Días entre enrutamientos
 firmFlowReportResponse.daysBetweenRoutings string

Días entre enrutamientos
Total de días en proceso
 firmFlowReportResponse.totalDaysInProcess string

Total de días en proceso
Id. de carpeta
 firmFlowReportResponse.folderID string

Id. de carpeta
Id. de presentación
 firmFlowReportResponse.filingID string

Id. de presentación
Id. de presentación anterior
 firmFlowReportResponse.priorFilingID string

Id. de presentación anterior
Última actualización
 firmFlowReportResponse.lastUpdated string

Última actualización
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
nombre
 firmFlowReportResponse.informationFields.name string

nombre
value
 firmFlowReportResponse.informationFields.value string

value
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
Obtención de la excepción FirmFlow
 getFirmFlowException string

Obtención de la excepción FirmFlow

Seguimiento del informe por flujo de trabajo

Id. de la operación:
TrackingReportByWorkflow

Seguimiento del informe por flujo de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
Id. del cajón
 DrawerId string

Id. del cajón
Tipo de servicio
 ServiceType string

Tipo de servicio
Tipo de compromiso
 EngagementType string

Tipo de compromiso
Flujo de trabajo
 Workflow string

Flujo de trabajo
Paso actual
 CurrentStep string

Paso actual
PIC
 PIC string

PIC
Asignado a
 AssignedTo string

Asignado a
Asignado en
 AssignedOn string

Asignado en
Descripción del flujo de trabajo
 WorkflowDescription string

Descripción del flujo de trabajo
Solo en proceso
 InProcessOnly string

Solo en proceso
Estado
 Status string

Estado
Priority
 Priority string

Priority
Responsable
 Responsible string

Responsable
Historial de asignaciones
 AssignmentHistory string

Historial de asignaciones
Recibido de
 ReceivedFrom string

Recibido de
Recibido al
 ReceivedOn string

Recibido al
Enviado a
 SentTo string

Enviado a
Enviado al
 SentOn string

Enviado al
Completado por
 CompletedBy string

Completado por
Fecha de finalización
 CompletedOn string

Fecha de finalización
Fecha de vencimiento actual
 CurrentDueDate string

Fecha de vencimiento actual
Días en el paso
 DaysAtStep string

Días en el paso
Total de días en el paso
 TotalDaysAtStep string

Total de días en el paso
Días entre enrutamientos
 DaysBetweenRoutings string

Días entre enrutamientos
Total de días en proceso
 TotalDaysInProcess string

Total de días en proceso
Responsable
 Accountable string

Responsable
Detalles de enrutamiento
 RoutingDetails string

Detalles de enrutamiento
Última actualización
 LastUpdated string

Última actualización
InformationFields
 InformationFields array of string

InformationFields
Indexes
 Indexes array of string

Indexes
Número de página
 PageNumber string

Número de página

Devoluciones

Nombre Ruta de acceso Tipo Description
Total de registros
 totalRecords integer

Total de registros
Número de página
 pageNumber string

Número de página
Tamaño de página
 pageSize integer

Tamaño de página
Total de páginas
 totalPages integer

Total de páginas
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
Nombre de cliente
 firmFlowReportResponse.clientName string

Nombre de cliente
Número de cliente
 firmFlowReportResponse.clientNumber string

Número de cliente
Id. del cajón
 firmFlowReportResponse.drawerId string

Id. del cajón
Tipo de servicio
 firmFlowReportResponse.serviceType string

Tipo de servicio
Tipo de compromiso
 firmFlowReportResponse.engagementType string

Tipo de compromiso
Flujo de trabajo
 firmFlowReportResponse.workflow string

Flujo de trabajo
Paso actual
 firmFlowReportResponse.currentStep string

Paso actual
PIC
 firmFlowReportResponse.pic string

PIC
Asignado a
 firmFlowReportResponse.assignedTo string

Asignado a
Asignado en
 firmFlowReportResponse.assignedOn string

Asignado en
Año
 firmFlowReportResponse.year string

Año
Fin del período
 firmFlowReportResponse.periodEnd string

Fin del período
Descripción del flujo de trabajo
 firmFlowReportResponse.workflowDescription string

Descripción del flujo de trabajo
Progress
 firmFlowReportResponse.progress string

Progress
Estado
 firmFlowReportResponse.status string

Estado
Priority
 firmFlowReportResponse.priority string

Priority
eFile Sí o No
 firmFlowReportResponse.eFileYesOrNo string

eFile Sí o No
Sí extendido o no
 firmFlowReportResponse.extendedYesOrNo string

Sí extendido o no
Recibido al
 firmFlowReportResponse.receivedOn string

Recibido al
Fecha de finalización
 firmFlowReportResponse.completedOn string

Fecha de finalización
Enviado al
 firmFlowReportResponse.sentOn string

Enviado al
Resultados
 firmFlowReportResponse.deliverables string

Resultados
Responsable
 firmFlowReportResponse.responsible string

Responsable
Historial de asignaciones
 firmFlowReportResponse.assignmentHistory string

Historial de asignaciones
Recibido de
 firmFlowReportResponse.receivedFrom string

Recibido de
Enviado a
 firmFlowReportResponse.sentTo string

Enviado a
Completado por
 firmFlowReportResponse.completedBy string

Completado por
Responsable
 firmFlowReportResponse.accountable string

Responsable
Fecha de vencimiento actual
 firmFlowReportResponse.currentDueDate string

Fecha de vencimiento actual
Fecha de vencimiento original
 firmFlowReportResponse.originalDueDate string

Fecha de vencimiento original
Notas de enrutamiento
 firmFlowReportResponse.routingNotes string

Notas de enrutamiento
PIC Sí o no
 firmFlowReportResponse.picYesOrNo string

PIC Sí o no
Asignado a Sí o no
 firmFlowReportResponse.assignedToYesOrNo string

Asignado a Sí o no
Fecha extendida
 firmFlowReportResponse.dateExtended string

Fecha extendida
Días en el paso
 firmFlowReportResponse.daysAtStep string

Días en el paso
Total de días en el paso
 firmFlowReportResponse.totalDaysAtStep string

Total de días en el paso
Días entre enrutamientos
 firmFlowReportResponse.daysBetweenRoutings string

Días entre enrutamientos
Total de días en proceso
 firmFlowReportResponse.totalDaysInProcess string

Total de días en proceso
Id. de carpeta
 firmFlowReportResponse.folderID string

Id. de carpeta
Id. de presentación
 firmFlowReportResponse.filingID string

Id. de presentación
Flujo de trabajo actualizado por última vez
 firmFlowReportResponse.workflowLastUpdated string

Flujo de trabajo actualizado por última vez
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
nombre
 firmFlowReportResponse.informationFields.name string

nombre
value
 firmFlowReportResponse.informationFields.value string

value
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
Obtención de la excepción FirmFlow
 getFirmFlowException string

Obtención de la excepción FirmFlow

Validar token

Id. de la operación:
ValidateToken

Validar el estado del token

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens

Devoluciones

response
boolean

Validar índices

Id. de la operación:
ValidateIndexes

Comprueba si los índices proporcionados son válidos.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 X-Authorization string

Autenticación de tokens
DrawerId
 DrawerId string

Escriba el identificador del cajón.
IndexId
 IndexId string

Escriba id. de índice
IndexValue
 IndexValue string

Escriba el valor del índice.

Devoluciones

Nombre Ruta de acceso Tipo Description
errorMessage
 errorMessage string

mensaje de error
Errores
 errors array of

Errores
isValid
 isValid boolean

es el índice válido

Definiciones

cuerda / cadena

Este es el tipo de datos básico "string".

boolean

Este es el tipo de datos básico "booleano".