GoFileRoom
O GoFileRoom é uma solução de fluxo de trabalho e gerenciamento de documentos baseada em nuvem. Com o conector GoFileRoom, você pode executar ações de documentos, gerenciamento de usuários e FirmFlow.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Standard | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte GoFileRoom |
| URL | https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact |
| CS.Support@ThomsonReuters.com |
| Metadados do conector | |
|---|---|
| Editora | Thomson Reuters |
| Sítio Web | https://www.gofileroom.com/ |
| Política de privacidade | https://www.thomsonreuters.com/en/privacy-statement.html |
| Categorias | Dados; Gestão Empresarial |
O GoFileRoom Connector fornece uma maneira fácil para os clientes da Thomson Reuters utilizarem APIs para GoFileRoom e FirmFlow. Os usuários podem criar automação e integração relacionada ao Gerenciamento de Usuários, Documentos ou FirmFlow.
Pré-requisitos
Os usuários devem ter uma chave de API do GoFileRoom para usar o conector.
Como obter credenciais?
A chave API pode ser obtida registrando-se para uma conta em https://developerportal.thomsonreuters.com/. Além disso, você precisará ter uma conta GoFileRoom ativa. Se você está interessado em GoFileRoom entre em contato conosco aqui: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| X-TR-API-APP-ID | securestring | O X-TR-API-APP-ID para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar Produto Principal |
Adicionar Produto Principal |
| Copiar documento |
Copia os documentos |
| Criar documento |
Cria um registro de documento com índices |
| Criar fluxo de trabalho |
Criar fluxo de trabalho |
| Criar Grupo |
Cria grupo de permissões |
| Criar usuários |
Cria usuários GoFileRoom e ClientFlow no sistema |
| Definir permissões de grupo |
Atribui permissão ao grupo |
| Definir permissões de usuário |
Atribui permissão ao usuário |
| Definir Segurança de Documentos de Grupo |
Atribui segurança de documentos a um grupo |
| Definir Segurança de Documentos do Usuário |
Atribui permissões de segurança de documentos do usuário |
| Documento Taxsort |
Documento PDF Taxsort |
| Editar fluxo de trabalho |
Editar fluxo de trabalho |
| Editar produto mestre |
Editar produto mestre |
| Excluir documento |
Exclui um documento |
| Excluir fluxos de trabalho |
Excluir fluxos de trabalho |
| Excluir Produto Mestre |
Excluir Produto Mestre |
| Excluir usuário |
Excluir usuários GoFileRoom e ClientFlow do sistema |
| Fim de Sessão |
Sair do aplicativo |
| Fluxo de trabalho de rota V2 |
Fluxo de trabalho de rota V2 |
| Iniciar sessão |
Registra um usuário no aplicativo |
| Mesclar PDFs |
Mesclar arquivos PDF juntos |
| Modificar grupo |
Modificar permissões de grupo |
| Modificar usuário |
Modificar permissões de usuário |
|
Obtenha dados do Firm |
Obtém o relatório de acompanhamento por dados de entrega |
| Obtenha o Master Deliverable |
Obtenha o Master Deliverable |
| Obter documento |
Descarrega o documento |
| Obter gavetas |
Busca as gavetas acessíveis para o usuário conectado |
| Obter grupos |
Busca os grupos disponíveis para gerenciamento de usuários e grupos |
| Obter Histórico de Documentos |
Obtém o histórico do documento |
| Obter informações do usuário |
Busca as informações do usuário do GFR |
| Obter informações do usuário V2 |
Obtém a infromação do usuário |
| Obter licenças |
Recupera contagens de licenciamento |
| Obter lista de relatórios |
Busca os relatórios disponíveis para gerenciamento de usuários |
| Obter lista de valores de índice |
Obtém todas as entradas para um índice de tipo de lista |
| Obter locais de carregamento |
Busca os locais de carregamento para o usuário |
| Obter permissões de grupo |
Obtém permissões de grupos |
| Obter permissões de usuário |
Obtém permissões de usuário |
| Obter Política de Palavra-passe |
Busca a política de senha para a empresa |
| Obter regras dinâmicas para índice |
Obtém a lista de regras dinâmicas configuradas para o índice especificado |
| Obter Segurança de Documentos de Grupo |
Recuperar segurança de documentos de grupo |
| Obter Segurança de Documentos do Usuário |
Busca segurança de documentos do usuário por login |
| Obter status do documento |
Obter o status dos documentos |
| Obter usuários |
Busca os usuários GFR para o usuário conectado |
|
Obter valores de Lookup |
Busca os valores da LookupList |
| Obter índices de documentos |
Recupera os índices do documento |
| Obter índices de gaveta |
Recupera uma lista de índices de documentos configurados para a gaveta |
| Obter índices filhos |
Obtém uma lista de valores de índice filho com base na ID da lista, que é fornecida quando o valor da lista pai é selecionado. |
| Pesquisa de Documentos |
Carrega todos os documentos aos quais o usuário tem acesso na gaveta especificada. |
| Publicar status do documento |
Publique ou cancele a publicação de documentos do ClientFlow. |
| Reindexação de documentos |
Reindexa os documentos |
| Relatório de acompanhamento por fluxo de trabalho |
Relatório de acompanhamento por fluxo de trabalho |
| Relatório de acompanhamento por produto V2 |
Relatório de acompanhamento por DeliverableV2 |
| Validar token |
Validar status do token |
| Validar índices |
Verifica se os índices fornecidos são válidos. |
|
Índice Lookup |
Este método foi projetado para uso com campos de preenchimento automático. |
Adicionar Produto Principal
Adicionar Produto Principal
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome do produto final
|
deliverableName | string |
Nome do produto final |
|
|
Data Para Conclusão
|
dueDate | string |
Data Para Conclusão |
|
|
Primeira Extensão
|
firstExtension | string |
Primeira Extensão |
|
|
Segunda prorrogação
|
secondExtension | string |
Segunda prorrogação |
|
|
Terceira Extensão
|
thirdExtension | string |
Terceira Extensão |
|
|
Calendário Ou Fiscal
|
calenderOrFiscal | string |
Calendário Ou Fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
Nome da gaveta
|
DrawerName | string |
Nome da gaveta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Está guardado
|
isSaved | boolean |
Está guardado |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Copiar documento
Copia os documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
IDs de documentos
|
DocumentIds | array of string |
IDs de documentos |
|
|
IndexId
|
IndexId | string |
Insira o ID do índice |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
copyDocumentException
|
copyDocumentException | string |
copiar exceção de documento |
|
documentId
|
documentId | string |
valor de ID do documento |
|
isCopiado
|
isCopied | boolean |
O documento foi copiado |
|
newDocumentId
|
newDocumentId | string |
novo ID do documento |
Criar documento
Cria um registro de documento com índices
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Insira o ID da gaveta |
|
|
IndexId
|
IndexId | string |
Insira o ID do índice |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentCreate.documentId | string |
valor de ID do documento |
|
errorMessage
|
documentCreate.errorMessage | string |
mensagem de erro |
|
errorMessage
|
indexValidation.errorMessage | string |
mensagem de erro |
|
erros
|
indexValidation.errors | array of |
erros |
|
isValid
|
indexValidation.isValid | boolean |
é um documento válido |
Criar fluxo de trabalho
Criar fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome da gaveta
|
Drawer | string |
Nome da gaveta |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
ID da pasta
|
folderId | string |
ID da pasta |
|
|
Nome do Cliente
|
ClientName | string |
Nome do Cliente |
|
|
Número do Cliente
|
ClientNumber | string |
Número do Cliente |
|
|
Tipo de Compromisso
|
EngagementType | string |
Tipo de Compromisso |
|
|
PIC
|
PIC | string |
PIC |
|
|
Ano
|
Year | string |
Ano |
|
|
Fim do Período
|
PeriodEnd | string |
Fim do Período |
|
|
Nome do fluxo de trabalho
|
workflowName | string |
Nome do fluxo de trabalho |
|
|
Description
|
description | True | string |
Description |
|
Nome do estado
|
statusName | string |
Nome do estado |
|
|
Ação de entrega
|
action | string |
Ação de entrega |
|
|
Data de Vencimento Atual
|
currentduedate | string |
Data de Vencimento Atual |
|
|
Data de vencimento original
|
originalduedate | string |
Data de vencimento original |
|
|
Formulário de entrega
|
form | string |
Formulário de entrega |
|
|
Método de Entrega
|
Delivery | string |
Método de Entrega |
|
|
Destino
|
Destination | string |
Destino |
|
|
Documento de origem
|
sourceDocument | string |
Documento de origem |
|
|
Ação de Observação
|
action | string |
Ação de Observação |
|
|
Tipo de Nota
|
noteType | string |
Tipo de Nota |
|
|
Nota Mensagem
|
note | string |
Nota Mensagem |
|
|
Nome do campo de informação
|
name | string |
Nome do campo de informação |
|
|
Valor do campo de informação
|
value | string |
Valor do campo de informação |
|
|
Campo Responsável
|
ResponsibleField | string |
Campo Responsável |
|
|
Valor de campo responsável
|
value | string |
Valor de campo responsável |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de depósito
|
filingId | integer |
ID de depósito |
|
Comentário de erro
|
errorComment | string |
Comentário de erro |
|
Situação
|
status | boolean |
Situação |
|
errorMessage
|
errorMessage | array of string |
errorMessage |
Criar Grupo
Cria grupo de permissões
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Especificar verdadeiro ou falso |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Especificar verdadeiro ou falso |
|
|
Comments
|
Comments | string |
Inserir comentários |
|
|
EnableMfa
|
EnableMfa | string |
Especificar verdadeiro ou falso |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Especificar verdadeiro ou falso |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Especificar verdadeiro ou falso |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Especificar verdadeiro ou falso |
|
|
Nome do Grupo
|
GroupName | string |
Insira o nome do grupo |
|
|
MfaObrigatório
|
MfaRequired | string |
Especificar verdadeiro ou falso |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Especificar verdadeiro ou falso |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar verdadeiro ou falso |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar verdadeiro ou falso |
|
|
Tipo de relatório
|
ReportType | string |
Especificar verdadeiro ou falso |
|
|
CarregarLocalização
|
UploadLocation | string |
Insira o local de carregamento |
|
|
Utilizadores
|
Users | array of string |
Utilizadores |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
createGroupException
|
createGroupException | string |
criar exceção de grupo |
|
groupId
|
groupId | string |
valor de Id do grupo |
|
isCreated
|
isCreated | boolean |
O grupo foi criado |
|
mfaExceção
|
mfaException | string |
Estado do MFA |
Criar usuários
Cria usuários GoFileRoom e ClientFlow no sistema
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de usuário
|
userType | string |
Insira o tipo de usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ContaExpira. Data de Validade
|
AccountExpiresDate | string |
Insira a data de expiração da conta |
|
|
DisabledComments
|
DisabledComments | string |
Inserir comentários desativados |
|
|
Nome Completo
|
FullName | string |
Nome completo do usuário |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpira
|
IsAccountExpires | string |
Especificar verdadeiro ou falso |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Especificar verdadeiro ou falso |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Especificar verdadeiro ou falso |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Especificar verdadeiro ou falso |
|
|
EstáDesativado
|
IsDisabled | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Especificar verdadeiro ou falso |
|
|
IsMfa
|
IsMfa | string |
Especificar verdadeiro ou falso |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Especificar verdadeiro ou falso |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Especificar verdadeiro ou falso |
|
|
Tipo de Licença
|
LicenseType | string |
Insira o tipo de licença |
|
|
Nome de login
|
LoginName | string |
Digite o nome de login |
|
|
ManagerEmail
|
ManagerEmail | string |
Digite o e-mail do gerente |
|
|
Palavra-passe
|
Password | string |
Introduza a palavra-passe |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar verdadeiro ou falso |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar verdadeiro ou falso |
|
|
Tipo de relatório
|
ReportType | string |
Especificar verdadeiro ou falso |
|
|
CarregarLocalização
|
UploadLocation | string |
Insira o local de carregamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
createUserException
|
createUserException | string |
criar exceção de usuário |
|
isCreated
|
isCreated | boolean |
O usuário foi criado |
|
mfaExceção
|
mfaException | string |
Exceção mfa |
|
userId
|
userId | string |
valor de ID do usuário |
Definir permissões de grupo
Atribui permissão ao grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Gabinete
|
Cabinet | string |
Insira o nome do gabinete |
|
|
Adicionar
|
Add | string |
Especificar verdadeiro ou falso |
|
|
Suprimir
|
Delete | string |
Especificar verdadeiro ou falso |
|
|
Deny
|
Deny | string |
Especificar verdadeiro ou falso |
|
|
Edit
|
Edit | string |
Especificar verdadeiro ou falso |
|
|
LookUp
|
LookUp | string |
Especificar verdadeiro ou falso |
|
|
Leitura
|
Read | string |
Especificar verdadeiro ou falso |
|
|
Gaveta
|
Drawer | string |
Insira o nome da gaveta |
|
|
Adicionar
|
Add | string |
Especificar verdadeiro ou falso |
|
|
Suprimir
|
Delete | string |
Especificar verdadeiro ou falso |
|
|
Deny
|
Deny | string |
Especificar verdadeiro ou falso |
|
|
Edit
|
Edit | string |
Especificar verdadeiro ou falso |
|
|
LookUp
|
LookUp | string |
Especificar verdadeiro ou falso |
|
|
Leitura
|
Read | string |
Especificar verdadeiro ou falso |
|
|
Nome do Grupo
|
GroupName | string |
Insira o nome do grupo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valor de Id do grupo |
|
groupPermissionException
|
groupPermissionException | string |
Exceção de permissão do grupo |
|
isSet
|
isSet | boolean |
As permissões foram aplicadas |
Definir permissões de usuário
Atribui permissão ao usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Gabinete
|
Cabinet | string |
Insira o nome do gabinete |
|
|
Adicionar
|
Add | string |
Especificar verdadeiro ou falso |
|
|
Suprimir
|
Delete | string |
Especificar verdadeiro ou falso |
|
|
Deny
|
Deny | string |
Especificar verdadeiro ou falso |
|
|
Edit
|
Edit | string |
Especificar verdadeiro ou falso |
|
|
LookUp
|
LookUp | string |
Especificar verdadeiro ou falso |
|
|
Leitura
|
Read | string |
Especificar verdadeiro ou falso |
|
|
Gaveta
|
Drawer | string |
Insira o nome da gaveta |
|
|
Adicionar
|
Add | string |
Especificar verdadeiro ou falso |
|
|
Suprimir
|
Delete | string |
Especificar verdadeiro ou falso |
|
|
Deny
|
Deny | string |
Especificar verdadeiro ou falso |
|
|
Edit
|
Edit | string |
Especificar verdadeiro ou falso |
|
|
LookUp
|
LookUp | string |
Especificar verdadeiro ou falso |
|
|
Leitura
|
Read | string |
Especificar verdadeiro ou falso |
|
|
LoginId
|
LoginId | string |
Insira o ID de login |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
isSetUserPermission
|
isSetUserPermission | boolean |
A Permissão do Usuário foi atualizada |
|
loginId
|
loginId | string |
valor de ID de login |
|
setUserPermissionException
|
setUserPermissionException | string |
definir exceção de permissão de usuário |
Definir Segurança de Documentos de Grupo
Atribui segurança de documentos a um grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome do gabinete
|
CabinetName | string |
Insira o nome do gabinete |
|
|
DocSecurityType
|
DocSecurityType | string |
Insira o tipo de segurança do documento |
|
|
IndexName
|
IndexName | string |
Insira o nome do índice |
|
|
Funcionamento
|
Operation | string |
Insira o tipo de operação |
|
|
Valores
|
Values | array of string |
Valores |
|
|
DrawerName
|
DrawerName | string |
Insira o nome da gaveta |
|
|
Nome do Grupo
|
GroupName | string |
Insira o nome do grupo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
groupName
|
groupName | string |
Valor Nome do Grupo |
|
isSetGroupDocSecurity
|
isSetGroupDocSecurity | boolean |
A Segurança de Documentos foi definida |
|
setGroupDocSecurityException
|
setGroupDocSecurityException | string |
Exceção de segurança de documento de grupo |
Definir Segurança de Documentos do Usuário
Atribui permissões de segurança de documentos do usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome do gabinete
|
CabinetName | string |
Insira o nome do gabinete |
|
|
DocSecurityType
|
DocSecurityType | string |
Insira o tipo de segurança do documento |
|
|
IndexName
|
IndexName | string |
Insira o nome do índice |
|
|
Funcionamento
|
Operation | string |
Entrar em operação |
|
|
Valores
|
Values | array of string |
Valores |
|
|
DrawerName
|
DrawerName | string |
Insira o nome da gaveta |
|
|
LoginId
|
LoginId | string |
Insira o ID de login |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
isSetUserDocSecurity
|
isSetUserDocSecurity | boolean |
A Segurança de Documentos do Usuário foi aplicada |
|
loginId
|
loginId | string |
valor de ID de login |
|
setUserDocSecurityException
|
setUserDocSecurityException | string |
definir exceção de segurança do documento do usuário |
Documento Taxsort
Documento PDF Taxsort
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor de ID do documento |
|
isTaxSorted
|
isTaxSorted | boolean |
É o documento TaxSorted |
|
taxsortDocumentException
|
taxsortDocumentException | string |
Exceção de documento taxsort |
Editar fluxo de trabalho
Editar fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ID de depósito
|
filingId | integer |
ID de depósito |
|
|
Nome do Cliente
|
ClientName | string |
Nome do Cliente |
|
|
Número do Cliente
|
ClientNumber | string |
Número do Cliente |
|
|
Tipo de Compromisso
|
EngagementType | string |
Tipo de Compromisso |
|
|
PIC
|
PIC | string |
PIC |
|
|
Ano
|
Year | string |
Ano |
|
|
Fim do Período
|
PeriodEnd | string |
Fim do Período |
|
|
Nome do produto final
|
action | string |
Nome do produto final |
|
|
Data de Vencimento Atual
|
currentduedate | string |
Data de Vencimento Atual |
|
|
Data de vencimento original
|
originalduedate | string |
Data de vencimento original |
|
|
Anexo
|
form | string |
Anexo |
|
|
Ação de Observação
|
action | string |
Ação de Observação |
|
|
Tipo de Nota
|
noteType | string |
Tipo de Nota |
|
|
noteid
|
noteid | array of string |
noteid |
|
|
Nota Mensagem
|
note | string |
Nota Mensagem |
|
|
Nome do campo de informação
|
name | string |
Nome do campo de informação |
|
|
Valor do campo de informação
|
value | string |
Valor do campo de informação |
|
|
Método de Entrega
|
Delivery | string |
Método de Entrega |
|
|
Destino
|
Destination | string |
Destino |
|
|
Documento de origem
|
sourceDocument | string |
Documento de origem |
|
|
Campo Responsável
|
responsibleField | string |
Campo Responsável |
|
|
Atribuído A
|
value | string |
Atribuído A |
|
|
Reindexar documentos
|
reindexDocs | boolean |
Reindexar documentos |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de depósito
|
filingId | integer |
ID de depósito |
|
Comentário de erro
|
errorComment | string |
Comentário de erro |
|
Situação
|
status | boolean |
Situação |
|
errorMessage
|
errorMessage | array of object |
errorMessage |
|
Nome
|
errorMessage.name | string |
Nome |
|
Situação
|
errorMessage.status | boolean |
Situação |
|
Comentário de erro
|
errorMessage.errorComment | string |
Comentário de erro |
Editar produto mestre
Editar produto mestre
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome atual do produto final
|
currentdeliverableName | string |
Nome atual do produto final |
|
|
Atualizar nome do produto final
|
updatedeliverableName | string |
Atualizar nome do produto final |
|
|
Data Para Conclusão
|
dueDate | string |
Data Para Conclusão |
|
|
Primeira Extensão
|
firstExtension | string |
Primeira Extensão |
|
|
Segunda prorrogação
|
secondExtension | string |
Segunda prorrogação |
|
|
Terceira Extensão
|
thirdExtension | string |
Terceira Extensão |
|
|
Calendário Ou Fiscal
|
calenderOrFiscal | string |
Calendário Ou Fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Tipo de Serviço:
|
serviceType | string |
Tipo de Serviço: |
|
|
Nome da gaveta
|
drawerName | string |
Nome da gaveta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da atualização
|
isUpdated | boolean |
Status da atualização |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Excluir documento
Exclui um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Insira o ID do documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
deleteDocumentException
|
deleteDocumentException | string |
excluir exceção de documento |
|
documentId
|
documentId | string |
valor de ID do documento |
|
isSuprimido
|
isDeleted | boolean |
é o documento suprimido |
Excluir fluxos de trabalho
Excluir fluxos de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
filingId
|
filingId | array of integer |
filingId |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Estado Eliminado
|
isDeleted | boolean |
Estado Eliminado |
|
ID de depósito
|
filingId | string |
ID de depósito |
Excluir Produto Mestre
Excluir Produto Mestre
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
Nome da gaveta
|
DrawerName | string |
Nome da gaveta |
|
|
DeliverableNames
|
DeliverableNames | array of string |
DeliverableNames |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Estado da Eliminação
|
isDeleted | boolean |
Estado da Eliminação |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Excluir usuário
Excluir usuários GoFileRoom e ClientFlow do sistema
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
LoginId
|
LoginId | string |
Insira o ID de login do usuário |
|
|
Tipo de usuário
|
UserType | string |
Insira o tipo de usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
deleteUserException
|
deleteUserException | string |
excluir exceção de usuário |
|
isSuprimido
|
isDeleted | boolean |
O login foi excluído |
|
loginId
|
loginId | string |
valor de ID de login |
Fim de Sessão
Sair do aplicativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
isLogoutSuccess
|
isLogoutSuccess | boolean |
O logout foi bem-sucedido |
Fluxo de trabalho de rota V2
Fluxo de trabalho de rota V2
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
filingId
|
filingId | array of integer |
filingId |
|
|
CurrentStep
|
CurrentStep | array of string |
CurrentStep |
|
|
Complete
|
Complete | boolean |
Complete |
|
|
Data de Conclusão
|
CompletedDate | string |
Data de Conclusão |
|
|
Próximo Passo
|
NextStep | string |
Próximo Passo |
|
|
Atribuído A
|
AssignedTo | string |
Atribuído A |
|
|
Data atribuída
|
AssignedDate | string |
Data atribuída |
|
|
Priority
|
Priority | string |
Priority |
|
|
Situação
|
Status | string |
Situação |
|
|
Nota de roteamento
|
RoutingNote | string |
Nota de roteamento |
|
|
Notificação por e-mail
|
emailNotify | boolean |
Notificação por e-mail |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de depósito
|
filingId | string |
ID de depósito |
|
É encaminhado
|
isRouted | boolean |
É encaminhado |
Iniciar sessão
Registra um usuário no aplicativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome de login
|
LoginName | True | string |
Digite o nome de login |
|
Palavra-passe
|
Password | True | password |
Introduza a palavra-passe |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
authSucesso
|
authSuccess | boolean |
foi autenticação bem-sucedida |
|
authenticationResponse
|
authenticationResponse | string |
valor de resposta de autenticação |
|
ID do cliente
|
customerId | string |
valor de ID do cliente |
|
código de erro
|
errorCode | string |
valor do código de erro |
|
idleSessionTimeoutMinutes
|
idleSessionTimeoutMinutes | integer |
Minutos de tempo limite de sessão ociosa |
|
loneStarFirmId
|
loneStarFirmId | string |
Id da empresa da estrela solitária |
|
loneStarValidado
|
loneStarValidated | boolean |
Estrela solitária validada |
|
token
|
token | string |
Valor do token |
|
userId
|
userId | string |
valor de ID do usuário |
|
nome de utilizador
|
userName | string |
valor de nome de usuário |
Mesclar PDFs
Mesclar arquivos PDF juntos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Devoluções
- response
- string
Modificar grupo
Modificar permissões de grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Especificar verdadeiro ou falso |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Especificar verdadeiro ou falso |
|
|
Comments
|
Comments | string |
Inserir comentários |
|
|
EnableMfa
|
EnableMfa | string |
Especificar verdadeiro ou falso |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Especificar verdadeiro ou falso |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Especificar verdadeiro ou falso |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Especificar verdadeiro ou falso |
|
|
Nome do Grupo
|
GroupName | string |
Insira o nome do grupo |
|
|
MfaObrigatório
|
MfaRequired | string |
Especificar verdadeiro ou falso |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Especificar verdadeiro ou falso |
|
|
RenomearGrupo
|
RenameGroup | string |
Insira o novo nome do grupo |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar verdadeiro ou falso |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar verdadeiro ou falso |
|
|
Tipo de relatório
|
ReportType | string |
Especificar verdadeiro ou falso |
|
|
CarregarLocalização
|
UploadLocation | string |
Insira o local de carregamento |
|
|
Utilizadores
|
Users | array of string |
Utilizadores |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valor de Id do grupo |
|
isModified
|
isModified | boolean |
O grupo foi modificado |
|
mfaExceção
|
mfaException | string |
Exceção mfa |
|
modificarGroupException
|
modifyGroupException | string |
modificar exceção de grupo |
Modificar usuário
Modificar permissões de usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de usuário
|
userType | string |
Insira o tipo de usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ContaExpira. Data de Validade
|
AccountExpiresDate | string |
Data de expiração da Conta |
|
|
DisabledComments
|
DisabledComments | string |
Inserir comentários |
|
|
Nome Completo
|
FullName | string |
Insira o nome completo |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpira
|
IsAccountExpires | string |
Especificar verdadeiro ou falso |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Especificar verdadeiro ou falso |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Especificar verdadeiro ou falso |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Especificar verdadeiro ou falso |
|
|
IsChangeNextLogin
|
IsChangeNextLogin | string |
Especificar verdadeiro ou falso |
|
|
EstáDesativado
|
IsDisabled | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Especificar verdadeiro ou falso |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Especificar verdadeiro ou falso |
|
|
IsMfa
|
IsMfa | string |
Especificar verdadeiro ou falso |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Especificar verdadeiro ou falso |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Especificar verdadeiro ou falso |
|
|
Tipo de Licença
|
LicenseType | string |
Insira o tipo de licença |
|
|
Nome de login
|
LoginName | string |
Digite o nome de login |
|
|
ManagerEmail
|
ManagerEmail | string |
Digite o e-mail do gerente |
|
|
Palavra-passe
|
Password | string |
Introduza a palavra-passe |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar verdadeiro ou falso |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar verdadeiro ou falso |
|
|
Tipo de relatório
|
ReportType | string |
Especificar verdadeiro ou falso |
|
|
CarregarLocalização
|
UploadLocation | string |
Insira o local de carregamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
isModified
|
isModified | boolean |
O usuário foi modificado |
|
mfaExceção
|
mfaException | string |
Exceção mfa |
|
modificarUserException
|
modifyUserException | string |
modificar exceção de usuário |
|
userId
|
userId | string |
valor de ID do usuário |
Obtenha dados do FirmFlow por entrega
Obtém o relatório de acompanhamento por dados de entrega
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Prestação de contas
|
Accountable | string |
Insira o valor responsável |
|
|
AtribuídoOn
|
AssignedOn | string |
Insira a data atribuída na data |
|
|
AtribuídoTo
|
AssignedTo | string |
Insira o valor Atribuído a |
|
|
Histórico de Atribuições
|
AssignmentHistory | string |
Insira o histórico de atribuições |
|
|
ConcluídoPor
|
CompletedBy | string |
Insira o valor Concluído por |
|
|
CompletedOn
|
CompletedOn | string |
Insira Concluído na Data |
|
|
CurrentDueDate
|
CurrentDueDate | string |
Insira a Data de Vencimento Atual |
|
|
CurrentStep
|
CurrentStep | string |
Insira a etapa atual |
|
|
DataEstendida
|
DateExtended | string |
Insira a data estendida |
|
|
DiasAtStep
|
DaysAtStep | string |
Insira os dias no passo |
|
|
DiasEntreRoteamentos
|
DaysBetweenRoutings | string |
Insira dias entre roteamentos |
|
|
DrawerId
|
DrawerId | string |
Insira o ID da gaveta |
|
|
Tipo de Compromisso
|
EngagementType | string |
Insira o tipo de compromisso |
|
|
InProcessOnly
|
InProcessOnly | string |
Insira o valor Somente processo |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Campos de Informação
|
InformationFields | array of string |
Campos de Informação |
|
|
OriginalDueDate
|
OriginalDueDate | string |
Insira a Data de Vencimento Original |
|
|
PIC
|
PIC | string |
Insira o PIC |
|
|
Número da página
|
PageNumber | string |
Insira o número da página |
|
|
Priority
|
Priority | string |
Insira a prioridade |
|
|
RecebidoDe
|
ReceivedFrom | string |
Insira o valor Recebido de |
|
|
ReceivedOn
|
ReceivedOn | string |
Insira o recebimento na data |
|
|
Responsável
|
Responsible | string |
Insira o valor responsável |
|
|
RoteamentoDetalhes
|
RoutingDetails | string |
Insira os detalhes de roteamento |
|
|
SentOn
|
SentOn | string |
Insira a data de envio |
|
|
Enviado para
|
SentTo | string |
Insira o valor Enviado para |
|
|
ServiceType
|
ServiceType | string |
Insira o tipo de serviço |
|
|
Situação
|
Status | string |
Insira o status |
|
|
TotalDaysAtStep
|
TotalDaysAtStep | string |
Insira o total de dias na etapa |
|
|
TotalDaysInProcess
|
TotalDaysInProcess | string |
Insira o total de dias em processo |
|
|
Workflow
|
Workflow | string |
Insira o nome do fluxo de trabalho |
|
|
Fluxo de trabalhoDescrição
|
WorkflowDescription | string |
Inserir descrição do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
responsável
|
firmFlowReportResponse.accountable | string |
Valor responsável |
|
atribuídoEm
|
firmFlowReportResponse.assignedOn | string |
atribuído Na data |
|
atribuído A
|
firmFlowReportResponse.assignedTo | string |
valor atribuído a |
|
atribuídoToYesOrNo
|
firmFlowReportResponse.assignedToYesOrNo | string |
O fluxo de trabalho é atribuído |
|
Histórico da atribuição
|
firmFlowReportResponse.assignmentHistory | string |
Valor do histórico da atribuição |
|
nome_do_cliente
|
firmFlowReportResponse.clientName | string |
valor Nome do cliente |
|
Número do Cliente
|
firmFlowReportResponse.clientNumber | string |
valor do número do cliente |
|
concluídoPor
|
firmFlowReportResponse.completedBy | string |
preenchido por valor |
|
concluídoEm
|
firmFlowReportResponse.completedOn | string |
concluída Na data |
|
currentDueDate
|
firmFlowReportResponse.currentDueDate | string |
Data de vencimento atual |
|
currentStep
|
firmFlowReportResponse.currentStep | string |
valor atual da etapa |
|
dateExtended
|
firmFlowReportResponse.dateExtended | string |
data prorrogada |
|
diasAtStep
|
firmFlowReportResponse.daysAtStep | string |
dias de fluxo de trabalho em passo |
|
diasEntreRoteamentos
|
firmFlowReportResponse.daysBetweenRoutings | string |
dias de fluxo de trabalho entre roteamentos |
|
Resultados tangíveis
|
firmFlowReportResponse.deliverables | string |
valor das entregas |
|
gavetaId
|
firmFlowReportResponse.drawerId | string |
valor de id da gaveta |
|
eFileSimOrNão
|
firmFlowReportResponse.eFileYesOrNo | string |
é o produto a ser eFiled |
|
tipo de compromisso
|
firmFlowReportResponse.engagementType | string |
Valor do tipo de contrato |
|
extendedYesOrNo
|
firmFlowReportResponse.extendedYesOrNo | string |
o resultado final foi prorrogado |
|
informaçãoCampos
|
firmFlowReportResponse.informationFields | array of object |
informaçãoCampos |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
valor
|
firmFlowReportResponse.informationFields.value | string |
valor |
|
originalDueDate
|
firmFlowReportResponse.originalDueDate | string |
Data de vencimento original |
|
periodFim do período
|
firmFlowReportResponse.periodEnd | string |
período Fim do fluxo de trabalho |
|
foto
|
firmFlowReportResponse.pic | string |
imagem do fluxo de trabalho |
|
picSimOrNão
|
firmFlowReportResponse.picYesOrNo | string |
A fotografia foi atribuída |
|
priority
|
firmFlowReportResponse.priority | string |
Valor de prioridade |
|
Progressos
|
firmFlowReportResponse.progress | string |
Valor do progresso |
|
recebidosDe
|
firmFlowReportResponse.receivedFrom | string |
recebido Do valor |
|
recebidosEm
|
firmFlowReportResponse.receivedOn | string |
recebido na data |
|
responsável
|
firmFlowReportResponse.responsible | string |
valor responsável |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
roteamentoNotas
|
firmFlowReportResponse.routingNotes | string |
roteamento Notas do fluxo de trabalho |
|
roteamentoResumo
|
firmFlowReportResponse.routingSummary | array of |
roteamentoResumo |
|
sentOn
|
firmFlowReportResponse.sentOn | string |
enviado na data |
|
enviadoTo
|
firmFlowReportResponse.sentTo | string |
enviado para o valor |
|
Tipo de serviço
|
firmFlowReportResponse.serviceType | string |
serviço Tipo de fluxo de trabalho |
|
estado
|
firmFlowReportResponse.status | string |
Status do fluxo de trabalho |
|
totalDaysAtStep
|
firmFlowReportResponse.totalDaysAtStep | string |
total de dias em passo do fluxo de trabalho |
|
totalDaysInProcess
|
firmFlowReportResponse.totalDaysInProcess | string |
total de dias em processo no fluxo de trabalho |
|
fluxo de trabalho
|
firmFlowReportResponse.workflow | string |
Tipo de fluxo de trabalho |
|
fluxo de trabalhoDescrição
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
ano
|
firmFlowReportResponse.year | string |
ano do fluxo de trabalho |
|
getFirmFlowException
|
getFirmFlowException | string |
obter exceção FirmFlow |
|
Número da página
|
pageNumber | string |
página Número do pedido |
|
pageSize
|
pageSize | integer |
página Tamanho do pedido |
|
totalPáginas
|
totalPages | integer |
total de páginas de pedido |
|
totalRegistos
|
totalRecords | integer |
Total de registos do pedido |
Obtenha o Master Deliverable
Obtenha o Master Deliverable
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Número da página
|
PageNumber | integer |
Número da página |
|
|
Tamanho da página
|
pageSize | integer |
Tamanho da página |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
Nome da gaveta
|
DrawerName | string |
Nome da gaveta |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
lista de resultados
|
deliverableList | array of object |
lista de resultados |
|
Nome do produto final
|
deliverableList.deliverableName | string |
Nome do produto final |
|
Tipo de extensão
|
deliverableList.extensionType | string |
Tipo de extensão |
|
Data Para Conclusão
|
deliverableList.dueDate | string |
Data Para Conclusão |
|
Primeira Extensão
|
deliverableList.firstExtension | string |
Primeira Extensão |
|
Segunda prorrogação
|
deliverableList.secondExtension | string |
Segunda prorrogação |
|
Terceira Extensão
|
deliverableList.thirdExtension | string |
Terceira Extensão |
|
Extension
|
deliverableList.extension | string |
Extension |
|
Ação
|
deliverableList.action | string |
Ação |
|
Id da obrigação
|
deliverableList.obligationId | string |
Id da obrigação |
|
Opção Gerida pela Empresa
|
deliverableList.firmManagedOption | string |
Opção Gerida pela Empresa |
|
Total de Registos
|
totalRecords | string |
Total de Registos |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Obter documento
Descarrega o documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Insira o ID do documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Obter gavetas
Busca as gavetas acessíveis para o usuário conectado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID do gavetador
|
drawerID | string |
valor do ID da gaveta |
|
drawerName
|
drawerName | string |
valor do nome da gaveta |
|
add
|
permissions.add | boolean |
Agregar valor |
|
eliminar
|
permissions.delete | boolean |
Excluir valor |
|
editar
|
permissions.edit | boolean |
Editar valor |
|
lookupManagement
|
permissions.lookupManagement | boolean |
valor lookupManagement |
|
vista
|
permissions.view | boolean |
Ver valor |
Obter grupos
Busca os grupos disponíveis para gerenciamento de usuários e grupos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Valor da ID de Grupo |
|
AFM
|
mfa | integer |
Valor MFA |
|
mfaObrigatório
|
mfaRequired | integer |
mfa Valor obrigatório |
|
nome
|
name | string |
Valor do nome do grupo |
Obter Histórico de Documentos
Obtém o histórico do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Insira o ID do documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
documentAuditoria
|
documentAudit | array of |
documentAuditoria |
|
documentHistoryException
|
documentHistoryException | string |
Exceção do histórico do documento |
|
documentId
|
documentId | string |
valor de ID do documento |
|
mesclarDocHistory
|
mergeDocHistory | array of |
mesclarDocHistory |
Obter informações do usuário
Busca as informações do usuário do GFR
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome de login
|
LoginName | True | string |
Digite LoginName |
|
Tipo de usuário
|
UserType | True | string |
Selecione UserType |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
createDate
|
createDate | string |
createDate |
|
criado por
|
createdBy | string |
criado por |
|
descrição
|
description | string |
descrição |
|
desactivado
|
disabled | integer |
desactivado |
|
desabilitadoByAdmin
|
disabledByAdmin | boolean |
desabilitadoByAdmin |
|
emailNotificar
|
emailNotify | boolean |
emailNotificar |
|
emailNotifyEventMgmtGroups
|
emailNotifyEventMgmtGroups | boolean |
emailNotifyEventMgmtGroups |
|
emailNotifyEventMgmtUsers
|
emailNotifyEventMgmtUsers | boolean |
emailNotifyEventMgmtUsers |
|
emailNotifyGroup
|
emailNotifyGroup | boolean |
emailNotifyGroup |
|
forcePasswordChange
|
forcePasswordChange | boolean |
forcePasswordChange |
|
Nome completo
|
fullName | string |
Nome completo |
|
hasDrawerSetupRights
|
hasDrawerSetupRights | string |
hasDrawerSetupRights |
|
isAdmin
|
isAdmin | integer |
isAdmin |
|
isManager
|
isManager | integer |
isManager |
|
licenseType
|
licenseType | string |
licenseType |
|
locationID
|
locationID | string |
locationID |
|
ID de login
|
loginID | string |
ID de login |
|
managerNome Completo
|
managerFullName | string |
managerNome Completo |
|
managerId
|
managerId | string |
managerId |
|
managerLoginId
|
managerLoginId | string |
managerLoginId |
|
oberonUsuário
|
oberonUser | integer |
oberonUsuário |
|
offline
|
offline | boolean |
offline |
|
passwordChangeDate
|
passwordChangeDate | string |
passwordChangeDate |
|
passwordChangeInterval
|
passwordChangeInterval | integer |
passwordChangeInterval |
|
passwordExpireDate
|
passwordExpireDate | string |
passwordExpireDate |
|
reports
|
reports | boolean |
reports |
|
assinatura
|
signature | string |
assinatura |
|
systemAdmin
|
systemAdmin | boolean |
systemAdmin |
|
taxFlow [en]
|
taxFlow | boolean |
taxFlow [en] |
|
userAdministration
|
userAdministration | integer |
userAdministration |
|
ID de utilizador
|
userID | string |
ID de utilizador |
|
workflowManagerUser
|
workflowManagerUser | boolean |
workflowManagerUser |
Obter informações do usuário V2
Obtém a infromação do usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome de login
|
LoginName | string |
Nome de login |
|
|
Tipo de Utilizador
|
UserType | string |
Tipo de Utilizador |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de utilizador
|
userID | string |
ID de utilizador |
|
Login ID
|
loginID | string |
Login ID |
|
Nome Completo
|
fullName | string |
Nome Completo |
|
Data de Criação
|
createDate | string |
Data de Criação |
|
Criado por
|
createdBy | string |
Criado por |
|
Description
|
description | string |
Description |
|
Disabled
|
disabled | integer |
Disabled |
|
Desativado por administrador
|
disabledByAdmin | boolean |
Desativado por administrador |
|
Data de expiração da palavra-passe
|
passwordExpireDate | string |
Data de expiração da palavra-passe |
|
Forçar alteração de senha
|
forcePasswordChange | boolean |
Forçar alteração de senha |
|
Data de alteração da palavra-passe
|
passwordChangeDate | string |
Data de alteração da palavra-passe |
|
Intervalo de alteração de senha
|
passwordChangeInterval | integer |
Intervalo de alteração de senha |
|
Tipo de Licença
|
licenseType | string |
Tipo de Licença |
|
Offline
|
offline | boolean |
Offline |
|
Relatórios
|
reports | boolean |
Relatórios |
|
Administrador de Sistema
|
systemAdmin | boolean |
Administrador de Sistema |
|
Signature
|
signature | string |
Signature |
|
ID da Localização
|
locationID | string |
ID da Localização |
|
Tem direitos de configuração de gaveta
|
hasDrawerSetupRights | string |
Tem direitos de configuração de gaveta |
|
Fluxo Fiscal
|
taxFlow | boolean |
Fluxo Fiscal |
|
Notificação por e-mail
|
emailNotify | boolean |
Notificação por e-mail |
|
Grupo de notificação por e-mail
|
emailNotifyGroup | boolean |
Grupo de notificação por e-mail |
|
Usuários de gerenciamento de eventos de notificação por e-mail
|
emailNotifyEventMgmtUsers | boolean |
Usuários de gerenciamento de eventos de notificação por e-mail |
|
Grupos de gerenciamento de eventos de notificação por e-mail
|
emailNotifyEventMgmtGroups | boolean |
Grupos de gerenciamento de eventos de notificação por e-mail |
|
Administração de Usuários do Portal
|
portalUserAdministration | boolean |
Administração de Usuários do Portal |
|
Administração de Utilizadores Internos
|
internalUserAdministration | boolean |
Administração de Utilizadores Internos |
|
Usuário do Workflow Manager
|
workflowManagerUser | boolean |
Usuário do Workflow Manager |
|
ID do Gerente
|
managerId | string |
ID do Gerente |
|
ID de login do gerente
|
managerLoginId | string |
ID de login do gerente |
|
Nome Completo do Gerente
|
managerFullName | string |
Nome Completo do Gerente |
|
É Gestor
|
isManager | integer |
É Gestor |
|
Usuário Oberon
|
oberonUser | integer |
Usuário Oberon |
|
É administrador
|
isAdmin | integer |
É administrador |
|
Último Login
|
lastLogin | string |
Último Login |
|
groups
|
groups | array of string |
groups |
Obter licenças
Recupera contagens de licenciamento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Licença
|
license | string |
Insira o tipo de licença |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
assignedLicenses
|
assignedLicenses | string |
contagem de licenças atribuídas |
|
getLicenseException
|
getLicenseException | string |
obter exceção de licença |
|
licença
|
license | string |
nome da licença |
|
mensagem
|
message | string |
mensagem |
|
totalLicenças
|
totalLicenses | string |
Contagem total de licenças |
Obter lista de relatórios
Busca os relatórios disponíveis para gerenciamento de usuários
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
reports
|
reports | array of object |
reports |
|
nome_do-relatório
|
reports.reportName | array of string |
nome_do-relatório |
|
tipo de relatório
|
reports.reportType | string |
valor do tipo de relatório |
|
relatóriosExceção
|
reportsException | string |
relatórios Valor de exceção |
Obter lista de valores de índice
Obtém todas as entradas para um índice de tipo de lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira o ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor de ID do índice filho |
|
childListId
|
childListId | integer |
valor de ID da lista filho |
|
temCrianças
|
hasChildren | boolean |
O índice tem um índice filho |
|
listEntryId
|
listEntryId | integer |
valor de ID de entrada da lista |
|
listId
|
listId | integer |
valor de id da lista |
|
valor
|
value | string |
valor |
Obter locais de carregamento
Busca os locais de carregamento para o usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
uploadLocalizações
|
uploadLocations | array of object |
uploadLocalizações |
|
localizaçãoNome
|
uploadLocations.locationName | string |
valor do nome do local |
|
localizaçãoCaminho
|
uploadLocations.locationPath | string |
localização Valor do caminho |
|
uploadLocationsException
|
uploadLocationsException | string |
Exceção de Locais de Upload |
Obter permissões de grupo
Obtém permissões de grupos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do Grupo
|
groupName | string |
Insira o nome do grupo |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
Nome do gabinete |
|
add
|
cabinetPermissions.add | boolean |
adicionar permissões |
|
eliminar
|
cabinetPermissions.delete | boolean |
Excluir permissões |
|
deny
|
cabinetPermissions.deny | boolean |
negar permissões |
|
editar
|
cabinetPermissions.edit | boolean |
editar permissões |
|
pesquisa
|
cabinetPermissions.lookUp | boolean |
permissões de pesquisa |
|
ler
|
cabinetPermissions.read | boolean |
permissões de leitura |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
gaveta
|
drawerPermissions.drawer | string |
Nome da gaveta |
|
add
|
drawerPermissions.permission.add | boolean |
adicionar permissões |
|
eliminar
|
drawerPermissions.permission.delete | boolean |
Excluir permissões |
|
deny
|
drawerPermissions.permission.deny | boolean |
negar permissões |
|
editar
|
drawerPermissions.permission.edit | boolean |
editar permissões |
|
pesquisa
|
drawerPermissions.permission.lookUp | boolean |
permissões de pesquisa |
|
ler
|
drawerPermissions.permission.read | boolean |
permissões de leitura |
|
groupName
|
groupName | string |
Nome do Grupo |
|
groupPermissionException
|
groupPermissionException | string |
Exceção de permissão de grupo |
Obter permissões de usuário
Obtém permissões de usuário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Iniciar sessão
|
login | True | string |
Digite Login |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
valor do nome do gabinete |
|
add
|
cabinetPermission.add | boolean |
Agregar valor |
|
eliminar
|
cabinetPermission.delete | boolean |
Excluir valor |
|
deny
|
cabinetPermission.deny | boolean |
negar valor |
|
editar
|
cabinetPermission.edit | boolean |
Editar valor |
|
pesquisa
|
cabinetPermission.lookUp | boolean |
valor de pesquisa |
|
ler
|
cabinetPermission.read | boolean |
valor de leitura |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
gaveta
|
drawerPermissions.drawer | string |
valor do nome da gaveta |
|
add
|
drawerPermissions.permission.add | boolean |
Agregar valor |
|
eliminar
|
drawerPermissions.permission.delete | boolean |
Excluir valor |
|
deny
|
drawerPermissions.permission.deny | boolean |
negar valor |
|
editar
|
drawerPermissions.permission.edit | boolean |
Editar valor |
|
pesquisa
|
drawerPermissions.permission.lookUp | boolean |
valor de pesquisa |
|
ler
|
drawerPermissions.permission.read | boolean |
valor de leitura |
|
getUserPermissionException
|
getUserPermissionException | string |
Exceção de permissão do usuário |
|
loginId
|
loginId | string |
valor de ID de login |
Obter Política de Palavra-passe
Busca a política de senha para a empresa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
clientId
|
passwordPolicy.clientId | string |
valor de ID do cliente |
|
forbidden_pwd_words
|
passwordPolicy.forbidden_pwd_words | array of string |
forbidden_pwd_words |
|
lockout_threshold
|
passwordPolicy.lockout_threshold | integer |
Limite de bloqueio |
|
max_length
|
passwordPolicy.max_length | integer |
Comprimento máximo da palavra-passe |
|
max_login_similarity
|
passwordPolicy.max_login_similarity | string |
semelhança máxima de login |
|
max_pwd_age
|
passwordPolicy.max_pwd_age | integer |
idade máxima da senha pwd |
|
max_repeat_chars
|
passwordPolicy.max_repeat_chars | string |
max repetir caracteres na senha |
|
max_sequential_chars
|
passwordPolicy.max_sequential_chars | string |
máximo de caracteres sequenciais |
|
AFM
|
passwordPolicy.mfa | integer |
Valor MFA |
|
min_length
|
passwordPolicy.min_length | integer |
comprimento mínimo da palavra-passe |
|
pwd_req_alpha
|
passwordPolicy.pwd_req_alpha | integer |
Requisito de senha alfa |
|
pwd_req_lower
|
passwordPolicy.pwd_req_lower | integer |
Requisito de senha mais baixo |
|
pwd_req_number
|
passwordPolicy.pwd_req_number | integer |
Requisito de número de senha |
|
pwd_req_symbol
|
passwordPolicy.pwd_req_symbol | integer |
Requisito de senha de símbolo |
|
pwd_req_upper
|
passwordPolicy.pwd_req_upper | integer |
Requisito de senha superior |
|
passwordPolicyException
|
passwordPolicyException | string |
passwordPolicyException |
Obter regras dinâmicas para índice
Obtém a lista de regras dinâmicas configuradas para o índice especificado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira o ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
condition
|
condition | string |
Valor da condição |
|
dependentIndexId
|
dependentIndexId | string |
valor de Id de índice dependente |
|
dynamicRuleId
|
dynamicRuleId | string |
valor dinâmico de Id da regra |
|
valor
|
value | string |
valor |
Obter Segurança de Documentos de Grupo
Recuperar segurança de documentos de grupo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do Grupo
|
groupName | True | string |
Insira o nome do grupo |
|
Nome do gabinete
|
cabinetName | True | string |
Insira o nome do gabinete |
|
DrawerName
|
drawerName | True | string |
Insira o nome da gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do Grupo
|
groupName | string |
Nome do Grupo |
|
Nome do gabinete
|
cabinetName | string |
Nome do gabinete |
|
Nome da gaveta
|
drawerName | string |
Nome da gaveta |
|
documentSegurança do documento
|
documentSecurity | array of object |
documentSegurança do documento |
|
Nome do índice
|
documentSecurity.indexName | string |
Nome do índice |
|
Tipo de Segurança do Documento
|
documentSecurity.docSecurityType | string |
Tipo de Segurança do Documento |
|
values
|
documentSecurity.values | array of string |
values |
|
Exceção de segurança do documento de grupo
|
getGroupDocSecurityException | string |
Exceção de segurança do documento de grupo |
Obter Segurança de Documentos do Usuário
Busca segurança de documentos do usuário por login
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
LoginId
|
loginId | True | string |
Introduza o ID de Login |
|
Nome do gabinete
|
cabinetName | True | string |
Insira o nome do gabinete |
|
DrawerName
|
drawerName | True | string |
Insira o nome da gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do gabinete
|
cabinetName | string |
Nome do gabinete |
|
documentSegurança do documento
|
documentSecurity | string |
valor de segurança do documento |
|
drawerName
|
drawerName | string |
valor do nome da gaveta |
|
getUserDocSecurityException
|
getUserDocSecurityException | string |
Exceção de segurança de documentos do usuário |
|
loginId
|
loginId | string |
valor de ID de login |
Obter status do documento
Obter o status dos documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor de ID do documento |
|
documentStatusException
|
documentStatusException | string |
Exceção de status do documento |
|
gavetaId
|
drawerId | string |
valor de id da gaveta |
|
tamanho do ficheiro
|
fileSize | string |
valor do tamanho do arquivo |
|
isArchived
|
isArchived | boolean |
é o documento arquivado |
|
isCheckedOut
|
isCheckedOut | boolean |
é o documento Check-out |
|
éEncriptado
|
isEncrypted | boolean |
é o documento criptografado |
|
isArquivado
|
isFiled | boolean |
é o documento arquivado |
|
isInRedactionQueue
|
isInRedactionQueue | boolean |
é o documento na fila de redação |
|
isInTaxsortQueue
|
isInTaxsortQueue | boolean |
é o documento na fila Taxsort |
|
isLocked
|
isLocked | boolean |
é o documento bloqueado |
|
isOfficeDocument
|
isOfficeDocument | boolean |
é o documento um documento do Office |
|
isPublicado
|
isPublished | boolean |
é o documento Publicado |
|
isUndergoingFusão
|
isUndergoingMerging | boolean |
é o documento em fase de fusão |
|
arquivo local
|
localFile | string |
é o documento um ficheiro local |
|
nãoEditar
|
noEdit | boolean |
sem valor de edição |
|
pages
|
pages | integer |
páginas no documento |
|
avaliou
|
reviewed | boolean |
estado revisto |
|
taxSort
|
taxSort | boolean |
é o documento taxSorted |
|
tipo
|
type | string |
Tipo de ficheiro |
|
versão
|
version | integer |
versão do documento |
Obter usuários
Busca os usuários GFR para o usuário conectado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de usuário
|
userType | string |
Insira o tipo de usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
isActive
|
isActive | boolean |
O usuário está ativo |
|
loginId
|
loginId | string |
valor de ID de login |
Obter valores de LookupList
Busca os valores da LookupList
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da gaveta. Exemplo de gaveta de clientes: "0000000001"
|
drawerId | True | string |
Insira o ID da gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
nome_do_cliente
|
clientName | string |
valor Nome do cliente |
|
Número do Cliente
|
clientNumber | string |
valor do número do cliente |
Obter índices de documentos
Recupera os índices do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Insira o ID do documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
indexId | string |
valor de ID do índice |
|
indexValue
|
indexValue | string |
Valor do índice |
Obter índices de gaveta
Recupera uma lista de índices de documentos configurados para a gaveta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
DrawerId
|
drawerId | True | string |
Insira o ID da gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor de ID do índice filho |
|
indexId
|
indexId | string |
valor de ID do índice |
|
indexName
|
indexName | string |
valor do nome do índice |
|
indexType
|
indexType | string |
valor do tipo de índice |
|
length
|
length | integer |
Comprimento do índice da gaveta |
|
listId
|
listId | integer |
valor de id da lista |
|
pesquisaAutoUpdate
|
lookupAutoUpdate | boolean |
pesquisa Atualização Automática |
|
required
|
required | boolean |
O índice é necessário |
Obter índices filhos
Obtém uma lista de valores de índice filho com base na ID da lista, que é fornecida quando o valor da lista pai é selecionado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira o ID do índice |
|
ListId
|
listId | True | string |
Insira o ID da lista |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor de ID do índice filho |
|
childListId
|
childListId | integer |
valor de ID da lista filho |
|
temCrianças
|
hasChildren | boolean |
O índice tem um índice filho |
|
listEntryId
|
listEntryId | integer |
valor de ID de entrada da lista |
|
listId
|
listId | integer |
valor de id da lista |
|
valor
|
value | string |
valor |
Pesquisa de Documentos
Carrega todos os documentos aos quais o usuário tem acesso na gaveta especificada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Insira o ID da gaveta |
|
|
IndexId
|
IndexId | string |
Insira o ID do índice |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
|
|
NúmerodeLinhas
|
NumberOfRows | integer |
Insira o número de linhas |
|
|
Número da página
|
PageNumber | integer |
Insira o número da página |
|
|
SortField
|
SortField | string |
Inserir campo de classificação |
|
|
SortOrder
|
SortOrder | string |
Inserir ordem de classificação |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
documentIds
|
documentIds | array of string |
documentIds |
|
documentSearchCount
|
documentSearchCount | integer |
Contagem de pesquisa de documentos |
Publicar status do documento
Publique ou cancele a publicação de documentos do ClientFlow.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Inserir ID do documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
IsPublished
|
IsPublished | True | string |
Especificar verdadeiro ou falso |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentException
|
documentException | string |
Exceção do documento |
|
documentId
|
documentId | string |
valor de ID do documento |
|
isPublicado
|
isPublished | boolean |
é o documento Publicado |
Reindexação de documentos
Reindexa os documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
IDs de documentos
|
DocumentIds | array of string |
IDs de documentos |
|
|
IndexId
|
IndexId | string |
Insira o ID do índice |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor de ID do documento |
|
isReIndexed
|
isReIndexed | boolean |
é o documento ReIndexed |
|
reIndexDocumentException
|
reIndexDocumentException | string |
Exceção de documento reIndex |
Relatório de acompanhamento por fluxo de trabalho
Relatório de acompanhamento por fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Id da gaveta
|
DrawerId | string |
Id da gaveta |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
Tipo de Compromisso
|
EngagementType | string |
Tipo de Compromisso |
|
|
Workflow
|
Workflow | string |
Workflow |
|
|
Etapa atual
|
CurrentStep | string |
Etapa atual |
|
|
PIC
|
PIC | string |
PIC |
|
|
Atribuído A
|
AssignedTo | string |
Atribuído A |
|
|
Atribuído em
|
AssignedOn | string |
Atribuído em |
|
|
Descrição do fluxo de trabalho
|
WorkflowDescription | string |
Descrição do fluxo de trabalho |
|
|
Apenas em processo
|
InProcessOnly | string |
Apenas em processo |
|
|
Situação
|
Status | string |
Situação |
|
|
Priority
|
Priority | string |
Priority |
|
|
Responsável
|
Responsible | string |
Responsável |
|
|
Histórico de Atribuições
|
AssignmentHistory | string |
Histórico de Atribuições |
|
|
Recebido de
|
ReceivedFrom | string |
Recebido de |
|
|
Recebido em
|
ReceivedOn | string |
Recebido em |
|
|
Enviado para
|
SentTo | string |
Enviado para |
|
|
Enviado em
|
SentOn | string |
Enviado em |
|
|
Completado por
|
CompletedBy | string |
Completado por |
|
|
Concluído em
|
CompletedOn | string |
Concluído em |
|
|
Data de Vencimento Atual
|
CurrentDueDate | string |
Data de Vencimento Atual |
|
|
Dias em passo
|
DaysAtStep | string |
Dias em passo |
|
|
Total de dias no passo
|
TotalDaysAtStep | string |
Total de dias no passo |
|
|
Dias entre roteamentos
|
DaysBetweenRoutings | string |
Dias entre roteamentos |
|
|
Total de dias em processo
|
TotalDaysInProcess | string |
Total de dias em processo |
|
|
Prestação de contas
|
Accountable | string |
Prestação de contas |
|
|
Detalhes de roteamento
|
RoutingDetails | string |
Detalhes de roteamento |
|
|
Última atualização
|
LastUpdated | string |
Última atualização |
|
|
Campos de Informação
|
InformationFields | array of string |
Campos de Informação |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Número da página
|
PageNumber | string |
Número da página |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Total de Registos
|
totalRecords | integer |
Total de Registos |
|
Número da página
|
pageNumber | string |
Número da página |
|
Tamanho da página
|
pageSize | integer |
Tamanho da página |
|
Total de Páginas
|
totalPages | integer |
Total de Páginas |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nome do Cliente
|
firmFlowReportResponse.clientName | string |
Nome do Cliente |
|
Número do Cliente
|
firmFlowReportResponse.clientNumber | string |
Número do Cliente |
|
Id da gaveta
|
firmFlowReportResponse.drawerId | string |
Id da gaveta |
|
Tipo de Serviço:
|
firmFlowReportResponse.serviceType | string |
Tipo de Serviço: |
|
Tipo de Compromisso
|
firmFlowReportResponse.engagementType | string |
Tipo de Compromisso |
|
Workflow
|
firmFlowReportResponse.workflow | string |
Workflow |
|
Etapa atual
|
firmFlowReportResponse.currentStep | string |
Etapa atual |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Atribuído A
|
firmFlowReportResponse.assignedTo | string |
Atribuído A |
|
Atribuído em
|
firmFlowReportResponse.assignedOn | string |
Atribuído em |
|
Ano
|
firmFlowReportResponse.year | string |
Ano |
|
Fim do Período
|
firmFlowReportResponse.periodEnd | string |
Fim do Período |
|
Descrição do fluxo de trabalho
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Situação
|
firmFlowReportResponse.status | string |
Situação |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Sim ou Não
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Sim ou Não |
|
Estendido Sim ou Não
|
firmFlowReportResponse.extendedYesOrNo | string |
Estendido Sim ou Não |
|
Recebido em
|
firmFlowReportResponse.receivedOn | string |
Recebido em |
|
Concluído em
|
firmFlowReportResponse.completedOn | string |
Concluído em |
|
Enviado em
|
firmFlowReportResponse.sentOn | string |
Enviado em |
|
Resultados
|
firmFlowReportResponse.deliverables | string |
Resultados |
|
Responsável
|
firmFlowReportResponse.responsible | string |
Responsável |
|
Histórico de Atribuições
|
firmFlowReportResponse.assignmentHistory | string |
Histórico de Atribuições |
|
Recebido de
|
firmFlowReportResponse.receivedFrom | string |
Recebido de |
|
Enviado para
|
firmFlowReportResponse.sentTo | string |
Enviado para |
|
Completado por
|
firmFlowReportResponse.completedBy | string |
Completado por |
|
Prestação de contas
|
firmFlowReportResponse.accountable | string |
Prestação de contas |
|
Data de Vencimento Atual
|
firmFlowReportResponse.currentDueDate | string |
Data de Vencimento Atual |
|
Data de vencimento original
|
firmFlowReportResponse.originalDueDate | string |
Data de vencimento original |
|
Notas de roteamento
|
firmFlowReportResponse.routingNotes | string |
Notas de roteamento |
|
PIC Sim ou Não
|
firmFlowReportResponse.picYesOrNo | string |
PIC Sim ou Não |
|
Atribuído a Sim ou Não
|
firmFlowReportResponse.assignedToYesOrNo | string |
Atribuído a Sim ou Não |
|
Data de prorrogação
|
firmFlowReportResponse.dateExtended | string |
Data de prorrogação |
|
Dias em passo
|
firmFlowReportResponse.daysAtStep | string |
Dias em passo |
|
Total de dias no passo
|
firmFlowReportResponse.totalDaysAtStep | string |
Total de dias no passo |
|
Dias entre roteamentos
|
firmFlowReportResponse.daysBetweenRoutings | string |
Dias entre roteamentos |
|
Total de dias em processo
|
firmFlowReportResponse.totalDaysInProcess | string |
Total de dias em processo |
|
ID da pasta
|
firmFlowReportResponse.folderID | string |
ID da pasta |
|
ID de depósito
|
firmFlowReportResponse.filingID | string |
ID de depósito |
|
Última atualização do fluxo de trabalho
|
firmFlowReportResponse.workflowLastUpdated | string |
Última atualização do fluxo de trabalho |
|
informaçãoCampos
|
firmFlowReportResponse.informationFields | array of object |
informaçãoCampos |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
valor
|
firmFlowReportResponse.informationFields.value | string |
valor |
|
roteamentoResumo
|
firmFlowReportResponse.routingSummary | array of |
roteamentoResumo |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obter exceção FirmFlow
|
getFirmFlowException | string |
Obter exceção FirmFlow |
Relatório de acompanhamento por produto V2
Relatório de acompanhamento por DeliverableV2
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Id da gaveta
|
DrawerId | string |
Id da gaveta |
|
|
Tipo de Serviço:
|
ServiceType | string |
Tipo de Serviço: |
|
|
Tipo de Compromisso
|
EngagementType | string |
Tipo de Compromisso |
|
|
Workflow
|
Workflow | string |
Workflow |
|
|
Etapa atual
|
CurrentStep | string |
Etapa atual |
|
|
PIC
|
PIC | string |
PIC |
|
|
Atribuído A
|
AssignedTo | string |
Atribuído A |
|
|
Atribuído em
|
AssignedOn | string |
Atribuído em |
|
|
Descrição do fluxo de trabalho
|
WorkflowDescription | string |
Descrição do fluxo de trabalho |
|
|
Apenas em processo
|
InProcessOnly | string |
Apenas em processo |
|
|
Situação
|
Status | string |
Situação |
|
|
Priority
|
Priority | string |
Priority |
|
|
Recebido em
|
ReceivedOn | string |
Recebido em |
|
|
Concluído em
|
CompletedOn | string |
Concluído em |
|
|
Enviado em
|
SentOn | string |
Enviado em |
|
|
Responsável
|
Responsible | string |
Responsável |
|
|
Histórico de Atribuições
|
AssignmentHistory | string |
Histórico de Atribuições |
|
|
Recebido de
|
ReceivedFrom | string |
Recebido de |
|
|
Enviado para
|
SentTo | string |
Enviado para |
|
|
Completado por
|
CompletedBy | string |
Completado por |
|
|
Prestação de contas
|
Accountable | string |
Prestação de contas |
|
|
Data de Vencimento Atual
|
CurrentDueDate | string |
Data de Vencimento Atual |
|
|
Data de vencimento original
|
OriginalDueDate | string |
Data de vencimento original |
|
|
Data de prorrogação
|
DateExtended | string |
Data de prorrogação |
|
|
Dias em passo
|
DaysAtStep | string |
Dias em passo |
|
|
Total de dias no passo
|
TotalDaysAtStep | string |
Total de dias no passo |
|
|
Dias entre roteamentos
|
DaysBetweenRoutings | string |
Dias entre roteamentos |
|
|
Total de dias em processo
|
TotalDaysInProcess | string |
Total de dias em processo |
|
|
Detalhes de roteamento
|
RoutingDetails | string |
Detalhes de roteamento |
|
|
Última atualização
|
LastUpdated | string |
Última atualização |
|
|
Campos de Informação
|
InformationFields | array of string |
Campos de Informação |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Número da página
|
PageNumber | string |
Número da página |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Total de Registos
|
totalRecords | integer |
Total de Registos |
|
Número da página
|
pageNumber | string |
Número da página |
|
Tamanho da página
|
pageSize | integer |
Tamanho da página |
|
Total de Páginas
|
totalPages | integer |
Total de Páginas |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nome do Cliente
|
firmFlowReportResponse.clientName | string |
Nome do Cliente |
|
Número do Cliente
|
firmFlowReportResponse.clientNumber | string |
Número do Cliente |
|
Id da gaveta
|
firmFlowReportResponse.drawerId | string |
Id da gaveta |
|
Tipo de Serviço:
|
firmFlowReportResponse.serviceType | string |
Tipo de Serviço: |
|
Tipo de Compromisso
|
firmFlowReportResponse.engagementType | string |
Tipo de Compromisso |
|
Workflow
|
firmFlowReportResponse.workflow | string |
Workflow |
|
Etapa atual
|
firmFlowReportResponse.currentStep | string |
Etapa atual |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Atribuído A
|
firmFlowReportResponse.assignedTo | string |
Atribuído A |
|
Atribuído em
|
firmFlowReportResponse.assignedOn | string |
Atribuído em |
|
Ano
|
firmFlowReportResponse.year | string |
Ano |
|
Fim do Período
|
firmFlowReportResponse.periodEnd | string |
Fim do Período |
|
Descrição do fluxo de trabalho
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Situação
|
firmFlowReportResponse.status | string |
Situação |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Sim ou Não
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Sim ou Não |
|
Estendido Sim ou Não
|
firmFlowReportResponse.extendedYesOrNo | string |
Estendido Sim ou Não |
|
Recebido em
|
firmFlowReportResponse.receivedOn | string |
Recebido em |
|
Concluído em
|
firmFlowReportResponse.completedOn | string |
Concluído em |
|
Enviado em
|
firmFlowReportResponse.sentOn | string |
Enviado em |
|
Resultados
|
firmFlowReportResponse.deliverables | string |
Resultados |
|
Responsável
|
firmFlowReportResponse.responsible | string |
Responsável |
|
Histórico de Atribuições
|
firmFlowReportResponse.assignmentHistory | string |
Histórico de Atribuições |
|
Recebido de
|
firmFlowReportResponse.receivedFrom | string |
Recebido de |
|
Enviado para
|
firmFlowReportResponse.sentTo | string |
Enviado para |
|
Completado por
|
firmFlowReportResponse.completedBy | string |
Completado por |
|
Prestação de contas
|
firmFlowReportResponse.accountable | string |
Prestação de contas |
|
Data de Vencimento Atual
|
firmFlowReportResponse.currentDueDate | string |
Data de Vencimento Atual |
|
Data de vencimento original
|
firmFlowReportResponse.originalDueDate | string |
Data de vencimento original |
|
Notas de roteamento
|
firmFlowReportResponse.routingNotes | string |
Notas de roteamento |
|
PIC Sim ou Não
|
firmFlowReportResponse.picYesOrNo | string |
PIC Sim ou Não |
|
Atribuído a Sim ou Não
|
firmFlowReportResponse.assignedToYesOrNo | string |
Atribuído a Sim ou Não |
|
Data de prorrogação
|
firmFlowReportResponse.dateExtended | string |
Data de prorrogação |
|
Dias em passo
|
firmFlowReportResponse.daysAtStep | string |
Dias em passo |
|
Total de dias no passo
|
firmFlowReportResponse.totalDaysAtStep | string |
Total de dias no passo |
|
Dias entre roteamentos
|
firmFlowReportResponse.daysBetweenRoutings | string |
Dias entre roteamentos |
|
Total de dias em processo
|
firmFlowReportResponse.totalDaysInProcess | string |
Total de dias em processo |
|
ID da pasta
|
firmFlowReportResponse.folderID | string |
ID da pasta |
|
ID de depósito
|
firmFlowReportResponse.filingID | string |
ID de depósito |
|
ID de depósito prévio
|
firmFlowReportResponse.priorFilingID | string |
ID de depósito prévio |
|
Última atualização
|
firmFlowReportResponse.lastUpdated | string |
Última atualização |
|
informaçãoCampos
|
firmFlowReportResponse.informationFields | array of object |
informaçãoCampos |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
valor
|
firmFlowReportResponse.informationFields.value | string |
valor |
|
roteamentoResumo
|
firmFlowReportResponse.routingSummary | array of |
roteamentoResumo |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obter exceção FirmFlow
|
getFirmFlowException | string |
Obter exceção FirmFlow |
Validar token
Validar status do token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Devoluções
- response
- boolean
Validar índices
Verifica se os índices fornecidos são válidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Insira o ID da gaveta |
|
|
IndexId
|
IndexId | string |
Insira o ID do índice |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
errorMessage
|
errorMessage | string |
mensagem de erro |
|
erros
|
errors | array of |
erros |
|
isValid
|
isValid | boolean |
o índice é válido |
Índice LookupList Localizar
Este método foi projetado para uso com campos de preenchimento automático.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IndexID
|
indexId | True | string |
Insira o ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Tipo de ação
|
ActionType | integer |
Insira o tipo de ação |
|
|
Contar
|
Count | integer |
Insira a contagem |
|
|
ÍndiceValor
|
IndexValue | string |
Insira o valor do índice |
|
|
Tipo de pesquisa
|
SearchType | integer |
Insira o tipo de pesquisa |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
index.indexId | string |
valor de ID do índice |
|
indexValue
|
index.indexValue | string |
Valor do índice |
|
linkedIndexes
|
linkedIndexes | array of object |
linkedIndexes |
|
indexId
|
linkedIndexes.indexId | string |
indexId |
|
indexValue
|
linkedIndexes.indexValue | string |
indexValue |
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.
Booleano
Este é o tipo de dados básico 'booleano'.