Regras da migração dos dados para o sistema

Transcrição

Regras da migração dos dados para o
sistema Protocolo Fly
Histórico de revisões
Revisão
Data
Descrição da alteração
1.0
01/10/2015
Criação deste manual
1.1
13/11/2015
- Reestruturação do documento
- Inclusão dos tópicos 2 e 3
1.2
10/02/2016
Reestruturação do documento
_ Tópico 4 – Serviços e tabelas
1.3
02/03/2016
_Tópico 4 – Serviços e tabelas
1.4
31/05/2016
_Tópico 4 – Serviços e tabelas
1.5
07/06/2016
- Item 2.4 – Homologar dados migrados: Inclusão
do Exemplo 3.
- Tópico 4 – Serviços e tabelas conforme item 4.4 Migrando andamento por lote: Inserido no manual
exemplo de envio pelo método POST.
- Tópico 4 – Serviços e tabelas conforme item 4.7 Migrando opção do usuário. Inserido no manual
exemplo de envio pelo método POST.
- Tópico 4 – Serviços e tabelas conforme item 4.12 Migrando processos >>Tira Dúvidas: Inserido as
regras
do Formato do *número do processo
("nroProcesso") da tabela Processos* (Migrando
Processos).
- Alteração realizada no Tópico 4 – Serviços e tabelas
conforme item 4.28 - Migrando informação adicional
da solicitação. A informação em relação ao campo
“rotulo” passou a ser obrigatória, ou seja, Não permite
nulo.
1.6
28/06/2016
- Item: 4.12 - Migrando processos: Alteração em
relação ao formato do *número do processo
("nroProcesso") da tabela Processos* (Migrando
Processos) quando for Sequencial/Ano.
- Item: 4.31 - Migrando vínculo do documento:
Inclusão da Regra de envio. No manual, a localização
dela fica no item 4.31 - Migrando vínculo do
documento, abaixo do exemplo de envio pelo método
POST.
1.7
08/07/2016
- Item 4.12 - Migrando Processos: Foi removido do
Exemplo: Envio pelo método POST da tabela
Processos, a variável "tipoRequerente": "F" devido
ao fato de que a mesma não compõe a tabela
Migrando Processos.
Sumário
2 - Liberação e envio dos dados........................................................................................6
2.1 – Extrair e estruturar dados......................................................................................7
2.2 – Solicitar Token a Betha Sistemas (Base Teste).....................................................7
2.3 – Migrar dados na base teste....................................................................................8
2.4 – Homologar dados migrados..................................................................................9
2.5 – Solicitar Token a Betha Sistemas (Base Produção).............................................11
2.6 – Migrar dados na base de produção......................................................................11
3 – Suporte aos serviços de migração..............................................................................11
4 - Serviços e tabelas.......................................................................................................12
4.1 - Migrando indexador.............................................................................................12
4.2 - Migrando valor do indexador...............................................................................13
4.3 - Migrando etiqueta................................................................................................15
4.4 - Migrando andamento por lote..............................................................................19
Exemplo: envio pelo Método POST............................................................................21
4.5 - Migrando organograma........................................................................................21
4.6 - Migrando taxa......................................................................................................24
4.7 - Migrando opção do usuário.................................................................................25
4.8 - Migrando grupo da solicitação.............................................................................27
4.10 - Migrando solicitação do requerente...................................................................28
4.11 - Migrando protocolização...................................................................................32
4.12 - Migrando processos...........................................................................................34
4.13 - Migrando andamento do processo.....................................................................46
4.14 - Migrando arquivamento do processo.................................................................49
4.15 - Migrando ajuntamento de processo...................................................................51
4.16 - Migrando encerramento do processo.................................................................54
4.17 - Migrando movimentação do processo...............................................................56
4.18 - Migrando número do processo...........................................................................59
4.19 - Migrando parecer do processo...........................................................................60
4.20 - Migrando guias de pagamento...........................................................................63
4.21 - Migrando pagamento da taxa do processo.........................................................69
4.22 - Migrando configuração do campo da etiqueta...................................................74
4.23 - Migrando usuário do organograma....................................................................77
4.24 - Migrando valor da taxa......................................................................................78
4.25 - Migrando taxa da solicitação.............................................................................80
4.26 - Migrando roteiro de andamento.........................................................................82
4.27 - Migrando local de protocolização......................................................................84
4.28 - Migrando informação adicional da solicitação..................................................85
4.29 - Migrando item da informação adicional da solicitação.....................................89
4.30 - Migrando solicitação de abertura.......................................................................90
4.31 - Migrando vínculo do documento.......................................................................96
4.32 - Migrando taxa do processo..............................................................................100
4.33 – Migrando exclusão de andamento...................................................................102
4.34 - Migrando local de arquivamento do processo.................................................106
4.35 - Migrando processo ajuntado............................................................................109
4.36 - Migrando ajuntamento de processo excluído...................................................111
4.37 - Migrando documento retirado do processo......................................................114
4.38 - Migrando lote em andamento...........................................................................116
4.39 - Migrando permissão do parecer.......................................................................118
4.40 - Migrando anexo do parecer..............................................................................119
4.41 - Migrando solicitação de documento................................................................120
4.42 - Migrando informações adicionais da abertura de processo.............................122
4.43 - Migrando documento da solicitação................................................................124
4.44 - Migrando taxa da guia de pagamento..............................................................126
4.45 - Migrando guia de pagamento cancelada..........................................................128
1 - Introdução
Este documento visa orientar as Revendas e Filiais na forma como o
arquivo Json deverá ser estruturado para que seja realizada a migração de
preenchimentos para o banco Oracle do sistema Protocolo Fly.
2 - Liberação e envio dos dados
Antes de realizar os procedimentos do respectivo manual, devem ser
realizados os procedimentos de importação contidos no Manual do GLB
(tabelas globais).
Para que o fluxo do processo de migração de dados possa ser colocado
em prática é necessário seguir alguns procedimentos que envolvem liberação,
preparação de ambiente e homologação dos dados a serem migrados.
Importante: Para utilização dos recursos disponíveis na migração de dados, é
prudente que o responsável pela execução de todo o fluxo tenha o seguinte
perfil técnico:
Ser desenvolvedor de sistemas com conhecimento na arquitetura REST com
JSON (preferencialmente);
Ter conhecimento em linguagem de programação, como: Java, Delphi, Ruby,
ASP.NET, Python, PHP, entre outras;
No decorrer deste capítulo o documento descreve o ciclo de
procedimentos necessários para que possa dar início e término do processo de
migração. De início, exibimos um fluxograma macro que ilustra todas as fases,
desde a necessidade de converter os dados até seu término, ou seja, a
migração concluída na base de produção.
Ilustração 1 – Fluxograma do ciclo de migração de dados
O fluxo da migração de dados para o Protocolo Fly é dividido em seis
tarefas, sendo que abaixo, está descrito os procedimentos necessários para o
atendimento a cada uma delas.
2.1 – Extrair e estruturar dados
Esta tarefa é responsável pela extração e estruturação dos dados da
base o qual será migrada para o sistema Protocolo Fly. Todos os dados
precisam ser extraídos, manipulados e organizados de maneira que fiquem
compatíveis com os serviços indicados no capítulo “4 – Serviços e tabelas”.
Nota: As ferramentas e técnicas necessárias para realizar esta tarefa ficam a
critério do responsável pelo processo de migração.
2.2 – Solicitar Token a Betha Sistemas (Base Teste)
Uma vez que os dados já estejam na estrutura apropriada para
execução dos serviços, é necessário a aquisição de um Token juntamente ao
setor de senhas da Betha Sistemas.
O token é uma chave formada por 32 algarismos alfanuméricos,
organizados em grupos de 8, 4, 4, 4 e 12 dígitos. O token é uma informação
obrigatória para o ciclo de migração, pois tem como finalidade, identificar a
entidade na web que receberá os dados migrados. Neste caso, o token
liberado estará apontando os dados enviados pelos serviços para a base de
dados que foi liberada para os testes de conversão. Exemplo de token:
ga1499bb-bad8-4w63-9999-9aa000311g63.
2.3 – Migrar dados na base teste
Nesta tarefa, se inicia o processo propriamente dito da migração, pois é
o momento de utilizar todos os dados anteriormente extraídos. Antes de
realizar qualquer procedimento de migração, é necessário solicitar ao setor de
senhas da Betha Sistemas o serial para liberação da entidade na web, e
também possuir o token devidamente liberado. Com esta base montada é
realizado a execução dos serviços, e através do Json, a entidade de teste
liberada na web, recebe os dados convertidos.
Para realizar o envio, o responsável pelo processo de migração precisa
inicialmente definir qual a ferramenta vai ser utilizada para a execução dos
serviços. Na ferramenta, deverá ser informado o token, a URL do serviço e o
tipo de serviço a ser acionado conforme as requisições de serviço: POST
(realiza inserções de registro na base de dados), PUT (realiza alterações de
registro na base de dados) ou DELETE (realiza exclusões de registro na base
de dados).
Os dados serão enviados de forma agrupada, em forma de lote, o qual
será gerado um código para o mesmo e fornecido ao usuário para posterior
consulta através do serviço de lote.
O processo de migração dos dados para o Protocolo Fly deve seguir a
estrutura de cada tabela descrita no capítulo “4 – Serviços e tabelas”, onde os
itens da coluna “Protocolo Fly” devem ser alimentados com os dados migrados
do outro sistema, obedecendo às informações e condições descritas nas
colunas “Tipo de Dado” e “Regras/Observações”.
Em casos onde seja enviado um dado inválido, ou seja, não compatível
com o atributo do serviço executado, será exibida a mensagem: “O valor do
campo <nome do atributo> é inválido”.
É importante ressaltar, que todo o conteúdo do Json a ser importado por
qualquer dos serviços disponibilizados, não poderá exceder a quantidade de
100000 caracteres. Nestes casos onde ocorra este tipo de situação, as
importações precisam ser partilhadas para que o serviço possa ser executado
com sucesso. Uma vez que o tamanho limite de 100000 caracteres não seja
respeitado, será apresentada a mensagem “Conteúdo enviado da tabela
Registros de conversão está fora do tamanho permitido {0 - 100000}!”.
Nota: Fica a critério das Filiais, Revendas e Conversão, definir a ferramenta e
como será a montagem da estrutura do arquivo Json para importação das
informações.
2.4 – Homologar dados migrados
Esta tarefa é uma das principais do processo de migração, pois neste
momento é realizada a conferência e validação dos dados migrados para a
entidade web. A homologação poderá ser feita basicamente de duas formas,
fazendo a comparação das informações registradas em ambos os sistemas,
conferindo se todos os dados estruturados conforme tarefa “1 – Extrair e
estruturar dados” estão inseridos corretamente na base teste de conversão.
Porém, também é possível conferir via execução de serviço, se em
algum dos atributos ocorreu problemas na inserção, alteração ou exclusão do
dado. Todo conteúdo do Json que for enviado pelos métodos POST, PUT e
DELETE, é retornado um Hash de identificação do lote de dados. Para
confirmar que a execução foi realizada com sucesso, ou seja, não houve
nenhuma restrição, é possível fazer a consulta através do hash e com isso
garantir que o processamento dos dados esteja correto.
Para realizar a consulta, deverá ser informado a URL e o método de
serviço utilizado na ferramenta (método GET).
URL: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/consultas/registros
Exemplo do retorno de um Json enviado:
{
"data": {
"hash": "NDA4MXw2MTI3fDQzMDE=="
},
"success": true
}
Exemplo da consulta utilizando o hash:
http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/consultas/registros/NDA4MXw2MTI3fDQzMDE=
Caso a consulta não retorne nenhuma restrição no processamento, é
indicado que o processamento foi efetuado com sucesso.
Exemplo 1:
{
"success": true
}
Caso a consulta retorne indicando alguma restrição no processamento,
ou seja, algum dado não pode ser inserido, é apresentada a informação da
restrição.
Exemplo 2:
{
"code": "E001",
"data": [
{
"messages": [
"O valor do campo 'dtInicio' é inválido: O tamanho deve estar entre 10
e 10"
],
"token": {
"descricao": "MARÇO/2015",
"data_fim": "2015-03-21",
"data_inicio": "20150310",
"data_vencimento": "2015-04-16"
}
}
],
"message": "Processamento parcialmente realizado.",
"success": true
}
Exemplo 3:
Caso na consulta do registro seja demonstrada a mensagem { "code":
"E002", "message": "Registro de integração ainda não processado.",
"success": true } , significa que o processamento do (s) lote (s) enviado (s)
está (ão) sendo realizado (s), ou seja, o conversor está organizando e
processando as informações enviadas. No momento em que todas as
informações forem processadas no banco, a mensagem não será mais
demonstrada.
2.5 – Solicitar Token a Betha Sistemas (Base Produção)
Uma vez que os dados migrados já estejam homologados, é necessário
que os mesmos sejam enviados para a base de dados de produção. Conforme
informado na sessão “2.2 – Solicitar Token a Betha Sistemas (Base Teste)”, o
token direciona para qual entidade na web os dados serão migrados.
Diante disso, para migrar oficialmente as informações para a liberação e
base de produção do cliente, também é necessário à aquisição de um Token
juntamente ao setor de senhas da Betha Sistemas.
Nota: Na solicitação do token a Betha Sistemas, é importante que seja
informado e fique bem claro ao atendente, que a geração do token deve ser
feita para a migração dos dados para o banco de produção (banco oficial) do
cliente.
2.6 – Migrar dados na base de produção
Nesta tarefa é efetuado o processo final de todo o ciclo da migração de
dados, ou seja, é o momento de enviar os dados para a base de produção do
cliente, também identificada como “base oficial”.
Nesta fase, todos os devidos ajustes já foram realizados durante o
processo de homologação, e neste caso, a necessidade é que os dados
extraídos e devidamente preparados sejam migrados utilizando os serviços
disponíveis.
Importante ressaltar que migrar os dados para a base de produção, significa
fazer a execução de todos os arquivos Json utilizados anteriormente na
migração teste para o banco de produção, lembrando que, na ferramenta
utilizada para a migração de dados, deve ser informado o token que foi liberado
para base oficial, de acordo com o descrito na sessão “2.5 – Solicitar Token a
Betha Sistemas (Base Produção)”.
3 – Suporte aos serviços de migração
A Betha Sistemas está disponibilizando as Revendas e Filiais este
manual para que auxilie no processo de migração dos dados através do uso de
WebService.
Toda e qualquer dúvida relacionada a regra de negócio ou estrutura do
sistema de Protocolo Fly, deverá ser reportado pelos canais de comunicação
que a Betha disponibiliza, ou seja, deve-se seguir o fluxo de atendimento via
chamado.
Nota: Não será prestado nenhum tipo de suporte relacionado a dúvidas
sobre construção de Webservice, execução de serviços via Webservice, ou
qualquer outro assunto que não esteja relacionado ao conteúdo deste
documento, regras ou estrutura do Protocolo Fly.
4 - Serviços e tabelas
Neste tópico serão demonstrados os atributos a serem enviados para
cada serviço com base na composição da estrutura de tabelas do banco de
dados.
O usuário deverá seguir a ordem dos tópicos dos serviços a fim de evitar
que uma regra de vínculo entre tabelas não seja respeitada.
Ficarem atentos às informações de restrição, relacionamento assim
como as observações inseridas no final da tabela de cada serviço.
Procuramos apresentar uma alternativa de conferência de dados no
sistema para cada serviço enviado. Porém, lembrando, que isto é apenas uma
dica, e ficará a cargo do responsável pelo envio dos dados, estabelecer sua
metodologia de conferência.
4.1 - Migrando indexador
Neste tópico iremos abordar a forma com que os dados referente ao
registro de indexadores deverão ser enviados para preenchimento da tabela no
banco de dados.
Para conferir o envio das informações no sistema, acesse a tela de
Cadastro de Indexadores (Cadastros >> Financeiros >> Indexadores).
Protocolo Fly
descricao
Tipo de
dados
String
Regras/Observações
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Referente ao nome do
indexador
sigla
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 5
Referente a sigla do
Mensagem
indexador.
Restrição:
1 Não poderão ser enviadas, para uma mesma entidade, informações de
indexadores que possuam a mesma descrição (descricao).
Exemplo:
Temos um registro de indexador com a descrição “Teste”. Caso esta
informação seja enviada novamente, será retornada uma mensagem de
validação, vista pelo método Get, comunicando que este registro já é
existente.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/indexadores
Exemplo: Envio pelo método Post
[{ “descrição” : “R$ Teste”, “sigla” : ”R$”}]
4.2 - Migrando valor do indexador
Neste tópico iremos abordar a forma com os dados referente ao registro
de valores dos indexadores deverão ser enviados para preenchimento da
tabela no banco de dados.
Para conferir o envio das informações, acesse a tela de Cadastro de
Indexadores (Cadastros >> Financeiros >> Indexadores >> item Valores).
Protocolo Fly
Tipo de dados
DescriçãoIndexador String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informação referente ao nome do
indexador.
DataIndexador
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Mensage
m
formato : yyyy-mm-ddThh:mm:ss
Informação referente a data base
do indexador.
vlTaxa
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”XXXXXX.XXXXXXXXXX ”
valor mínimo : menor ou igual a 0.
Os valores poderão ser enviados
conforme os exemplos abaixo:
“vlTaxa”:”10”
“vlTaxa”:”10.00”
“vlTaxa”:”0,0000000001 ”
- - O formato do campo "VALOR"
(Cadastros>>Financeiros>>Index
adores), segue o padrão do
formato existente atualmente no
Tributos (Formato do campo:
XXXXXX.XXXXXXXXXX
- É permitido aa inserção de
indexadores com* Valor *menor
ou igual a 0;
- Informação referente ao valor da
taxa conforme a data base.
Restrição :
1 Não poderão ser enviadas, para uma mesma entidade e para um mesmo
indexador, informações com a mesma data base (dataIndexador).
Exemplo:
Temos um registro de indexador com a descrição “X” e data base 01/01/2000
01:00:00:00. Caso esta informação seja enviada novamente, será retornada
uma mensagem de validação, vista pelo método Get, comunicando que este
registro já é existente.
Relacionamento :
1 O atributo descricaoIndexador irá relacionar o valor do indexador com o
registro do indexador.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/indexadoresvalores
Exemplo:
[{
"descricaoIndexador" : "R$ Teste",
"dataIndexador" : "2099-10-29T08:58:00",
"vlTaxa" : "1234567.89011234"
}]
4.3 - Migrando etiqueta
Neste tópico iremos abordar a forma com que os dados referente aos
registro das etiquetas deverão ser enviados para preenchimento da tabela no
banco de dados.
Para conferir o envio das informações, acesse a tela de Cadastro de
Etiquetas (Cadastros >> Etiquetas).
Protocolo Fly
nome
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
Referente ao modelo da
etiqueta.
tipo
String
não permite nulo
aceita somente G|T
G - Gráfico
T - Texto
case insensitive
Referente ao tipo da etiqueta.
padrão
String
não permite nulo
Mensagem
aceita somente S|N
S - Sim
N - Não
case insensitive
Este atributo define se o registro
da etiqueta é padrão de uso do
sistema.
disponível
String
não permite nulo
aceita somente S|N
Sim
Não
case insensitive
Este atributo define se a etiqueta
está disponível para uso.
larguraForm
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
aceita somente algarismos
numéricos
Define a largura do formulário.
alturaForm
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos
Define a altura do formulário.
larguraEtiqueta
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos
Define a largura da etiqueta.
alturaEtiqueta
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos
Define a altura da etiqueta.
nroColunas
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 1
aceita somente algarismo numérico
Define o número de colunas a
ser apresentado.
espVertical
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos.
Define o espaçamento vertical.
espHorizontal
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos.
Define o espaçamento
horizontal.
nroRepeticoes
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 1
numéricos.
Define o número de repetições.
brasaoEmitir
String
aceita somente S|N
S - Sim
N - Não
tamanho mínimo : 1
Validação:"O
valor deve
corresponde
r à [S|N] ou
nulo"
tamanho máximo: 1
Define se será ou não exibido o
brasão.
brasaoAltura
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 5
numéricos.
Define a altura do brasão.
brasaoLargura
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 5
numéricos.
Define a largura do brasão.
brasaoPosicao
String
permite nulo
aceita somente E|D
E - Esquerda
D - Direita
case insensitive
Validação :
"O valor
deve
corresponde
r à [E|D] ou
nulo"
Define a posição do brasão.
Restrição :
1 Não poderão ser enviadas, para a mesma entidade, informações que
possuam o mesmo nome e tipo de etiqueta.
Exemplo:
Temos um registro de etiqueta com a descrição “Etiqueta Teste” e tipo “T”.
Caso estas informações sejam enviadas novamente, será retornada uma
mensagem de validação, vista pelo método Get, comunicando que este
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/etiquetas
Exemplo: Envio pelo método POST
[{
"nome" : "Etiqueta Teste",
"tipo" : "T",
"padrao" : "S",
"disponivel" : "S",
"larguraForm" : "200",
"alturaForm" : "200",
"larguraEtiqueta" : "100",
"alturaEtiqueta" : "50",
"nroColunas" : "1",
"espVertical" : "10",
"espHorizontal" : "2",
"nroRepeticoes" : "1",
"brasaoEmitir" : "N",
"brasaoAltura" : "12",
"brasaoLargura" : "12",
"brasaoPosicao" : "E"
}]
4.4 - Migrando andamento por lote
registro de andamentos realizados por lote deverão ser enviados para
preenchimento da tabela do banco de dados.
Os lotes enviados podem ser conferidos por meio do relatório de
acompanhamento
de
processos
(Relatórios
>>
Gerenciais
>>
Acompanhamento de processos). Desta forma, busque pelas informações
preenchendo os campos “lote” e “ano”.
Protocolo Fly
iLotes
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 10
numéricos
Identificação de registro do lote.
Exemplo : “iLotes”.”1”
iAnos
String
não permite nulo
tamanho mínimo: 4
tamanho máximo: 4
numéricos
Exemplo : “iAnos”:”2015”
Informa o ano em que foi
realizado o andamento por
organograma.
descricao
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 500
Informação referente a
observação do andamento.
dhAndamento
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Exemplo : “dhAndamento”:”999901-01T01:00:00”
Define a data/hora em que foi
“Data de
andamento
inválida ou
não
informada.
Uma data
deve ter o
formato
yyyy-MMddTHH:mm:
realizado o andamento por
organograma.
ss”
Restrição:
possuam o mesmo lote (iLotes) e ano (iAnos).
Exemplo:
Temos um registro de lote com o código de lote 1 e ano 2016. Caso estas
informações sejam enviadas novamente, será retornada uma mensagem de
existente.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/lotes
Exemplo: envio pelo Método POST
[{
"iLotes" : "1",
"iAnos" : "2016",
"descricao" : "testando",
"dhAndamento" : "2016-06-06T14:45:10"
}]
4.5 - Migrando organograma
Neste tópico iremos abordar a forma com os dados referente ao registro
de organogramas deverão ser enviados para preenchimento da tabela no
banco de dados.
Os atributos enviados podem ser conferidos por meio da Tela de
Cadastro de Organogramas (Cadastros >> Organogramas).
Protocolo Fly
mascara
Tipo de
dados
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 9
Informação que identifica a
Mensagem
máscara do organograma.
Exemplo : 001001001
nome
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Informação que identifica o
nome do organograma.
sigla
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 10
Informação que identifica a
sigla do organograma.
email
String
permite nulo
Informação que define o
email vinculado ao
organograma.
ativo
String
não permite nulo
aceita somente S|N
S - Sim
N - Não
case insensitive
Define se o organograma
está em atividade.
protocolizacao
String
não permite nulo
aceita somente S|N
S - Sim
N - Não
case insensitive
Esta opção define se o
organograma permite entrada
de processos.
tipo
String
não permite nulo
aceita somente A|S
A - Analítico
S - Sintético
Ficar atento ao migrar esta
informação
já
que
os
organogramas do tipo “S” não
podem receber andamentos
de processos.
atribuicaoProcessos
String
não permite nulo
aceita somente A|N|R
A - Automática
N - Ao analista
R - Ao responsável
Define a forma como os
processos serão distribuídos
dentro do organograma.
iUsuarios
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Define o usuário responsável.
Restrição:
possuam a mesma máscara (mascara).
Exemplo:
Temos um registro de organograma com a máscara “004000000”. Caso esta
existente.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/organogramas
Exemplo : Envio pelo método POST
[{"mascara": "004000000",
"nome": "Organograma (conversor)",
"sigla": "CG",
"email": "[email protected]",
"ativo": "N",
"protocolizacao": "N",
"tipo": "A",
"atribuicaoProcessos": "R"}]
4.6 - Migrando taxa
registro de taxas deverão ser enviados para preenchimento da tabela no banco
de dados.
Cadastro de Taxas (Cadastros >> Financeiro >> Taxas).
Protocolo Fly
descricaoIndexador
Tipo de
dados
String
Mensagem
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Referente ao nome do
indexador.
descricao
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Referente ao nome da taxa
Restrição :
1 Não poderão ser enviadas, para uma mesma entidade, informações de
taxas que possuam a mesma descrição (descricao).
Exemplo:
Temos um registro de taxa com a descrição “Teste de conversão”. Caso
esta informação seja enviada novamente, será retornada uma mensagem
de validação, vista pelo método Get, comunicando que este registro já é
existente.
Relacionamento :
1 O atributo descricaoIndexador irá relacionar a taxa com o registro do
indexador.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/taxas
[{"descricaoIndexador": null,
"descricao": "Teste de conversão"}]
4.7 - Migrando opção do usuário
registro de opções de usuários deverão ser enviados para preenchimento da
Cadastro de Organogramas (Cadastros >> Configurações >> Usuários).
Protocolo Fly
iUsuarios
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Referente o nome do usuário
que possui permissões no
organograma.
permProcOrgan
String
permite nulo
aceita somente S|N
S - Sim
N – Não
Configuração que define se é
"O valor deve
corresponder à
[S|N] ou nulo"
permitida a tramitação e
encerramento dos processos
do organograma.
procOrganResumo
String
permite nulo
aceita somente S|N
S - Sim
"O valor deve
corresponder à
[S|N] ou nulo"
N – Não
Define se será demonstrado
todos
os
processos
do
organograma nos resumos da
página inicial.
tipoPermUsuario
String
permite nulo
aceita somente E|O|U
E - Todos processos da
entidade
O - Apenas processos
do organograma
U - Apenas processos
do usuário
"O valor deve
corresponder à
E|O|U ou nulo"
Restrição :
1 Não poderão ser enviadas, para uma mesma entidade, informações que
possuam o mesmo nome de usuário (iUsuarios).
Exemplo:
Temos um registro de usuário com o nome de “teste”. Caso esta informação
seja enviada novamente, será retornada uma mensagem de validação, vista
pelo método Get, comunicando que este registro já é existente.
Path:http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/conversao/usuariosopcoes
[{
"iUsuarios" : "julianafm",
"permProcOrgan" : "S",
"procOrganResumo" : "S",
"tipoPermUsuario" : "U"
}]
4.8 - Migrando grupo da solicitação
registro de grupos de solicitação deverão ser enviados para preenchimento da
Cadastro de Grupos de Solicitações (Cadastros >> Grupos de Solicitações).
Protocolo Fly
descricao
Tipo de dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informação
referente
descrição do grupo
solicitação.
a
de
Restrição :
possuam o mesmo nome de grupo de solicitação (descricao).
Exemplo:
Temos um registro de grupo de solicitação com a descrição “Teste”. Caso esta
validação, vista pelo método Get, comunicando que este registro já é existente.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/grupossolicitacoes
4.9 - Migrando documento
registro de documentos deverão ser enviados para preenchimento da tabela no
banco de dados.
Cadastro de Documentos (Cadastros >> Documentos).
Protocolo Fly
descricao
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
documento.
Restrição :
possuam o mesmo nome de documento (descricão).
Exemplo:
Temos um registro de documento com a descrição “Teste”. Caso esta
existente.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/documentos
4.10 - Migrando solicitação do requerente
registro de solicitação do requerente deverão ser enviados para preenchimento
da tabela no banco de dados.
Cadastro de Solicitações (Cadastro >> Solicitações).
Protocolo Fly
grupoDescricao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Mensagem
Informação referente ao
nome do grupo da
solicitação.
descricao
String
não permite nulo
tamanho mínimo: 1
descrição de solicitação.
numeracao
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 1
aceita somente 1|2|3|4|5|6|7:
3 Entidade
6 - Entidade/Ano
2 - Grupo
5 - Grupo/Ano
1 - Solicitação
4 - Solicitação/Ano
7 - Sequencial/Ano
Este atributo define a forma
como os protocolos terão sua
estrutura de codificação.
Todos as opções possuem no
final o código sequencial.
Ex: Item 3 - Grupo, formado 1.1
(Grupo 1, sequencial 1).
tramitavel
String
não permite nulo
aceita somente S|N
S - Sim
N – Não
Opção que define
se a solicitação é tramitável.
disponivel
String
não permite nulo
aceita somente S|N
S - Sim
N – Não
Define se a solicitação está
disponível para abertura de
novos processos.
aberturaExterna
String
não permite nulo
aceita somente S|N
S - Sim
N – Não
Define se a
solicitação possibilita a
abertura externa de
processos.
volumes
String
permite nulo
aceita somente S|N
S - Sim
N – Não
Define se possibilita a
abertura e volumes.
vencimento
String
aceita somente C|U
C - Corrido
U - Úteis
Obs : Este atributo recebe a
informação da forma como
será contado os dias
informados no atributo
diasVencto.
diasVencto
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos
Este atributo recebe a
informação da quantidade de
dias de vencimento caso não
seja seja possível alterar a
data manualmente.
Este
atributo
só
será
preenchido caso o atributo
venctoManual esteja setado
como “S”.
venctoManual
String
aceita somente S|N
S - Sim
N – Não
Define
no
registro
de
solicitações, referente as
guias de pagamento, se é
possível alterar a data
manualmente.
nroConvenio
String
permite nulo
tamanho mínimo: 1
tamanho máximo:10
Informa qual o convênio será
base para geração do código
de barras da taxa.
sumula
String
permite nulo
tamanho mínimo: 1
tamanho máximo:
100000
Restrição :
possuam a mesma descrição de solicitação.
Exemplo:
Temos um registro de solicitação com a descrição “Teste”. Caso esta
existente.
Relacionamento:
1
O atributo grupoDescricao irá relacionar a solicitação com o registro do grupo
de solicitações.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/solicitacoes
4.11 - Migrando protocolização
registro de protocolos deverão ser enviados para preenchimento da tabela no
banco de dados.
Os atributos enviados do tipo “A” podem ser conferidos por meio da Tela
de Solicitação de Abertura (Processos >> Abertura >> Dados da
protocolização).
Os atributos enviados do tipo “E” podem ser conferidos por meio da Tela
de Solicitação de Abertura (Processos >> Abertura >> Aba Documentos >>
Clique na opção “Ver dados da protocolização” da coluna Ações).
Protocolo Fly
dhProtocolizacao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
formato : yyyy-mmddThh:mm:ss
Informa a data/hora em que
a solicitação foi protocolada.
iProtocolos
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 10
numéricos
Informa o número
sequencial do protocolo.
iUsuarios
String
não permite nulo
Mensagem
tamanho mínimo: 1
tamanho máximo: 16
Informa o usuário que
protocolou o processo.
mascara
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 9
Informa a máscara do
organograma onde o
processo foi protocolado.
tipo
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 1
aceita somente A|E
A – Deverá ser preenchida
esta opção quando o
registro for referente a
abertura de processo.
E – Deverá ser preenchida
esta opção quando o
registro for referente a
inserção de documentos da
tela
de
Entrega
de
Documentos.
Observação : Para cada documento inserido na tela de Entrega de documentos
(Processos >> Entrega de Documentos), aba Documentos, é feito um registro na
tabela de protocolos para este documento com o tipo “E”.
Restrição :
possuam o mesmo número sequencial de protocolo.
Exemplo:
Temos o registro do número sequencial do protocolo 1. Caso esta
existente.
Relacionamento:
1 O vínculo do número do processo (nroProcesso) com a o número do
protocolo (iProtocolos) será feito pelo serviço de processos e não pelo
serviço de protocolos.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/protocolos
4.12 - Migrando processos
registro dos processos deverão ser enviados para preenchimento da tabela do
banco de dados.
Abertura de Protocolo (Processos >> Abertura de Protocolo).
Protocolo Fly
arquivado
Tipo de
dados
String
Mensagem
aceita somente S|N:
Validação:
"O valor
deve
corresponde
r à [S|N] ou
nulo"
S - Sim
N - Não
case insensitive
Define se o processo está ou
não arquivado.
pessoa
Objeto array
tipo
cpfCnpj
Não nulo
Aceita somente
F|J|O:
F - Fixo
J – Jurídico
O - Outros
1 permite
nulo
tam.
mínimo: 1
tam.
máximo:
14
Este atributo
recebe a
informação do
CPF/CNPJ e
portanto deverá
ser preenchido
com 11 ou 14
caracteres
numéricos.
nome
tam. mínimo : 1
tam. máximo: 155
codIBGE
tam. mínimo : 1
tam. máximo: 10
logradour Permite nulo
o
tam. mínimo : 1
tam. máximo: 100
bairro
Permite nulo
tam. mínimo : 1
tam. máximo: 100
cep
Permite nulo
tam. mínimo : 1
tam. máximo: 8
numero
Permite nulo
tam. mínimo : 1
tam. máximo: 8
telefone
Permite nulo
tam. mínimo : 1
tam. máximo: 11
celular
Permite nulo
tam. mínimo : 1
tam. máximo: 11
email
Permite nulo
tam. mínimo : 1
tam. máximo: 80
Será feita a busca da pessoa
requerente
conforme
as
informações
acima.
dos
atributos
Caso a opção do tipo da
pessoa seja “O” então deverá
ser preenchido os atributos
nome e codIBGE. Os demais
atributos servem para distinguir
melhor
os
requerentes
homônimos que são da mesma
cidade.
pessoa seja “F” ou “J” então
deverá ser preenchido o
atributo cpfCNPJ.
Importante! Este objeto é de
preenchimento obrigatório.
Caso exista na base de dados
do cliente mais de uma pessoa
com as mesmas informações
dos
atributos
aqui
especificados, estes deverão
ser unificados via banco de
dados.
Informação
referente
requerente do processo.
beneficiaria
Objeto array
tipo
cpfCnpj
ao
_ Não nulo
_
Aceita
somente : F|J|O
F - Fixo
J – Jurídico
O - Outros
1 permite
nulo
tam.
mínimo: 1
tam.
máximo:
14
Este atributo
recebe a
informação do
CPF/CNPJ e
portanto deverá
ser preenchido
com 11 ou 14
caracteres
numéricos.
nome
tam. mínimo : 1
tam. máximo: 155
codIBGE
tam. mínimo : 1
tam. máximo: 10
logradour Permite nulo
o
tam. mínimo : 1
tam. máximo: 100
bairro
Permite nulo
tam. mínimo : 1
tam. máximo: 100
cep
Permite nulo
tam. mínimo : 1
tam. máximo: 8
numero
Permite nulo
tam. mínimo : 1
tam. máximo: 8
telefone
Permite nulo
tam. mínimo : 1
tam. máximo: 11
celular
Permite nulo
tam. mínimo : 1
tam. máximo: 11
email
Permite nulo
tam. mínimo : 1
tam. máximo: 80
Será feita a busca da pessoa
beneficiária
conforme
as
informações
acima.
dos
atributos
Este
objeto
não
é
de
preenchimento
obrigatório,
porém caso seja utilizado
deverá
seguir
as regras
abaixo :
>>Caso a opção do tipo da
pessoa seja
“O” então
deverá ser preenchido os
atributos nome e codIBGE.
Os demais atributos servem
para distinguir melhor os
beneficiários homônimos de
mesma cidade.
pessoa seja “F” ou “J” então
deverá ser preenchido o
atributo cpfCNPJ.
Importante! Caso exista na
base de dados do cliente mais
de uma pessoa com as
mesmas
informações
dos
atributos aqui especificados,
estes deverão ser unificados
via banco de dados.
Informação
referente
beneficiário do processo.
descricaoGrupo
String
ao
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informar a descrição (nome) do
grupo pelo qual a solicitação
está vinculada (Abertura do
Protocolo).
descricaoGrupoAbert String
ura
tamanho mínimo: 1
tamanho máximo: 50
Informa a descrição (nome) do
grupo pelo qual a solicitação de
abertura
está
vinculada
(Solicitações de Abertura).
descricaoSolicAbertu String
ra
tamanho mínimo: 1
tamanho máximo: 50
Informa
a
descrição
da
solicitação pelo qual está
vinculado a solicitação de
abertura
(Solicitações
de
Abertura).
descricaoSolicitacao
String
não permite nulo
tamanho mínimo: 1
Informa
a
descrição
da
solicitação vinculada a abertura
do processo (Abertura do
protocolo).
Irá ser feita a validação se
existe o registro da descrição
da solicitação.
dhAberturaVol
String
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
formato : yyy-mm-ddThh:mm:ss
Informa a data/hora de abertura
do volume.
dhPrevista
String
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Informa a data/hora prevista para
conclusão do processo.
iProcessosPrinc
String
permite nulo
tamanho mínimo : 1
tamanho máximo : 10
aceita somente algarismos numéricos
Quando o processo for parte de
um volume informar a origem do
processo.
iProtocolos
String
não permite nulo
tamanho mínimo : 1
Informa o número do protocolo.
iSolicitacoesAbertura String
s
permite nulo
tamanho mínimo : 1
tamanho máximo : 5
Código sequencial da solicitação de
abertura (Solicitações de abertura)
iUsuariosAtual
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 16
Informa com qual usuário está
atualmente o processo.
mascaraOrgAtual
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 9
Informa em qual máscara de
organograma está atualmente o
processo.
mascaraOrgDest
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 9
Informa
a
máscara
do
organograma onde foi feito o
andamento do processo.
notificacao
String
1
aceita somente E|C|T|F|S|L|N : Validação :
"O valor
E - Email
deve
C -Carta
corresponde
r à [E|C|T|F|
T -Telefone
S|L|N] ou
F -Fax
nulo"
S - SMS
L - No local
N - Não notificar
case insensitive
Define a forma como será feita
a notificação dos trâmites ao
requerente.
nroDocumento
String
tamanho mínimo : 1
tamanho máximo: 70
Informa o número do
documento (Abertura do
Protocolo).
nroPaginasVol
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 5
numéricos
Informa o número de páginas
que possui o volume.
nroProcesso
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 24
Informa o número do processo
do protocolo.
nroProcessoPrinc
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 24
Informa o número do processo
principal do volume.
observacao
Clob
permite nulo
tamanho mínimo: 1
Informa o texto de observação
do protocolo.
observacaoOld
String
permite nulo
tamanho mínimo : 1
observacaoVol
String
permite nulo
tamanho mínimo : 1
Informa o texto de observação
do volume.
prioridade
String
aceita somente A|N|B:
A - Alta
N - Normal
B - Baixa
case insensitive
Define
a
informação
prioridade do processo.
de
procedencia
String
aceita somente I|E:
I - Interna
E - Externa
case insensitive
situacao
String
"O valor
deve
corresponde
r à [I|E] ou
nulo"
aceita somente N|A|D|I|C|P|E|F|
U|H|L|O :
N - Não Analisado
A - Em análise
D -Deferido
I -Indeferido
C - Cancelado
P - Parado
E - Em análise ent. externa
F - Confirmado
U - Anulado
H - Conhecimento
L - Parcial
O - Outros
case insensitive
sumula
Blob
permite nulo
tamanho mínimo : 1
Informa a súmula do processo.
tramitando
String
aceita somente S|N
S - Sim
N - Não
case insensitive
"O valor
deve
corresponde
r à [S|N] ou
nulo"
Restrição:
possuam o mesmo número de processo.
Exemplo:
Temos o registro do número de protocolo “201661419999990000007”. Caso
esta informação seja enviada novamente, será retornada uma mensagem de
existente.
Tira Dúvidas: A chave do processo é o número do processo. Ela é única,
sendo assim, não existirá outra idêntica.
Segue uma explicação das regras do Formato do *número do processo
("nroProcesso") da tabela Processos* (Migrando Processos):
- O formato seria esse, AAAAEEEEGGGTTTNNNNNNN onde:
AAAA - Ano do processo
EEEE - Código da entidade
GGG - Código do Grupo
TTT - Código da solicitação
NNNNNNN - Sequencial numérico do processos
Exemplos:
Solicitação: 999900010010010000001
Grupo: 999900010019990000001
Entidade: 999900019999990000001
Solicitação/Ano: 201600010010010000001
Grupo/Ano: 201600010019990000001
Entidade/Ano: 201600019999990000001
Sequencial/Ano: 201600009999990000001
- Segue abaixo outro exemplo mais detalhado de número do processo para a
seguinte mascará:
Sequencial+Ano:
201600009999990000007( AAAA0000999999NNNNNNN )
A = 2016 (com 4 carácter)
0 = Preencher com 0000 (quatro zeros)
9 = 999999 ( completar com 9 - tamanho de 6 carácteres)
N = 0000007 (Código do sequencial processo)
No caso o número do processo ficaria assim: 199800009999990000792.
Relacionamento:
1 O atributo iProtocolos irá relacionar o código do protocolo do registro do
processo com o código do protocolo do registro de protocolos.
O array pessoa irá buscar a informação do registro do requerente do
processo.
O array beneficiária irá buscar a informação de registro do beneficiário do
processo.
Os atributos descricaoGrupo e descricaoSolicitacao irão buscar a informação
do registro de solicitação do processo vinculado a Solicitação de Abertura.
Os atributos descricaoGrupoAbertura e descricaoSolicitacaoAbertura irão
buscar a informação do registro de solicitação do processo vinculado a
Abertura de Processo.
O atributo iSolicitacoesAberturas irá relacionar o processo com o registro da
solicitação de abertura.
Os atributos mascaraOrgAtual e mascaraOrgDet buscam a informação do
registro de organograma.
Observação :
É por meio deste serviço que será feito o vínculo do protocolo com o número do
processo.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/processos
Exemplo : Envio pelo método POST.
[{
"pessoa": { "tipo": "O", "nome": "John Snow", "codIbge":"4204608",
"telefone":"4834365086", "bairro":"centro", "cep":"88865000", "numero":"666",
"email":"[email protected]", "celular":"4899664455", "logradouro":"rua
ararangua" },
"beneficiaria": { "tipo": "O", "nome": "John Snow", "codIbge":"4204608",
"telefone":"4834365087", "bairro":"centro", "cep":"88864000",
"numero":"666","email":"[email protected]", "celular":"4899999999",
"logradouro":"rua ararangua"},
"arquivado": "N",
"descricaoGrupo": "GRUPO CENTRAL",
"descricaoSolicitacao": "Solicitação",
"iProtocolos": "33",
"iUsuariosAtual": "juliocps",
"mascaraOrgAtual": "001000000",
"notificacao": "N",
"nroDocumento": "123456",
"nroProcesso": "201661419999990000009",
"observacao": "Testando",
"prioridade": "A",
"sumula": "Testando Testnado",
"situacao" : "N"
}]
4.13 - Migrando andamento do processo
registro de andamento dos processos deverão ser enviados para
Os atributos enviados podem ser conferidos por meio do Relatório de
Acompanhamento
de
Processos
(Relatórios
>>
Gerenciais
>>
Acompanhamento de Processos).
Protocolo Fly
cpfCnpjOrig
Tipo de
dados
String
permite nulo
Caso haja informação, este atributo
recebe a informação do CPF/CNPJ e
portanto deverá ser preenchido com
11 ou 14 caracteres numéricos. Ex:
“01234567890”.
cpfCnpjDest
String
permite nulo
Caso haja informação, este atributo
recebe a informação do CPF/CNPJ e
11 ou 14 caracteres numéricos Ex:
“01234567890”.
dhAndamento
Timestam
p
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
dhConfirmacao
Timestam
p
permite nulo
tamanho mínimo: 19
Mensagem
tamanho máximo: 19
iUsuariosDest
String
permite nulo
tamanho mínimo : 1
Nome do usuário recebedor do
processo.
iUsuariosOrig
String
permite nulo
tamanho mínimo : 1
Nome do usuário que enviou o
processo.
mascaraDest
String
permite nulo
tamanho mínimo : 1
tamanho máximo : 9
Referente
a
informação
do
organograma (máscara) onde foi
enviado o processo.
mascaraOrig
String
permite nulo
tamanho mínimo : 1
tamanho máximo : 9
Referente
a
informação
do
organograma (máscara) que enviou
o processo.
nroProcesso
String
não permite nulo
tamanho mínimo : 1
Referente ao número do processo.
observacao
String
permite nulo
tamanho mínimo : 1
transferencia
String
permite nulo
aceita somente S|N
S - Sim
N - Não
Validação :
"O valor
deve
corresponde
r à [S|N] ou
nulo"
Restrição:
possuam a mesma data e hora de andamento para um mesmo número de
processo.
Exemplo:
Temos para o registro do andamento do processo de número do processo
201561419999990000013 e data e hora de andamento 2015-1103T13:12:00 . Caso esta informação seja enviada novamente, será
retornada uma mensagem de validação, vista pelo método Get,
comunicando que este registro já é existente.
Relacionamento:
1 O atributo nroProcesso busca a informação do número do processo do
registro de processo.
O atributo mascaraOrig relaciona o organograma de origem com o registro
de organograma.
O atributo mascaraDest relaciona o organograma de destino com o registro
de organograma.
Path: http:e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/andamentos
[{
"cpfCnpjDest" :"00000000001",
"cpfCnpjOrig" :"00000000002",
"dhAndamento" :"9999-11-03T13:12:00",
"dhConfirmacao" :"9999-11-03T13:13:00",
"iUsuariosDest" :"juliocps",
"iUsuariosOrig" :"juliocps",
"mascaraDest" :"002000000",
"mascaraOrig" :"001000000",
"nroProcesso" :"201561419999990000013",
"observacao" :"Teste",
"transferencia" :"N"
}]
Observação : Os documentos informados nos atributos "cpfCnpjDest" e
"cpfCnpjOrig",do exemplo acima, são inválidos e servem apenas para ilustrar a
forma como a informação deverá ser atribuída.
4.14 - Migrando arquivamento do processo
registro dos arquivamentos deverão ser enviados para preenchimento da
Os atributos enviados poderão ser conferidos por meio da Tela de
Movimentação de arquivamento (Processos >> Arquivamento).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Informação referente ao número do
processo
iUsuarios
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
1 Informação referente ao nome do
usuário.
mascara
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 9
Informação referente a máscara do
organograma.
tipo
String
não permite nulo
aceita somente A|R|D|E|M|X|I :
Mensagem
A - Arquivamento do processo
R - Retirar do arquivo
D - Devolução ao arquivo
E - Estorno de arquivamento
M - Movimentação entre
arquivo
X- Extravio do processo
I - Inutilização do processo
Informação referente ao tipo de
movimentação do processo ao
realizar o registro de arquivamento.
dhMovimentacao
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
formato yyyy-mm-ddThh:mm:ss
Exemplo: “dhMovimentacao”:”999901-01T01:00:00”
observacao
String
“Data de
movimentaç
ão inválida
ou não
informada.
Uma data
deve ter o
formato
yyyy-MMddTHH:mm:
ss”
não permite nulo
tamanho mínimo: 1
Restrição:
possuam o mesmo tipo e data e hora da movimentação para o mesmo
processo.
Exemplo:
Temos para o registro do número do processo 201561419999990000013 e
data de movimentação 2015-11-03T13:12:00 o tipo “A” . Caso esta
existente.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo arquivado com
o registro do processo
Path:http//e-gov.betha.com.br/arrecdacao-conversao-services/rest/conversao/arquivamentos
[{
"nroProcesso" : "201561419999990000009",
"iUsuarios" : "juliocps",
"mascara" : "001000000",
"tipo" : "A",
"dhMovimentacao" : "9999-10-29T09:43:00",
"observacao" : "Teste"
}]
4.15 - Migrando ajuntamento de processo
registro de ajuntamento de processos deverão ser enviados para
Ajuntamentos de Processos (Processos >> Ajuntamento de Processos).
Protocolo Fly
dhAjuntamento
Tipo de
dados
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora em que foi
realizado o ajuntamento.
dhDesentranhamen String
to
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do desentranhamento
de processo (cancelamento do
ajuntamento).
iUsuariosAjuntamen String
to
não permite nulo
Mensagem
tamanho mínimo: 1
tamanho máximo: 16
Usuário responsável pelo
ajuntamento do processo.
iUsuariosDesentran String
hamento
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Usuário
responsável
desentranhamento
processo.
nroProcesso
String
pelo
do
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Exemplo
:
“nroProcesso”:“999900010099
990000001”
Informação refente ao número
do processo.
tipoAjuntamento
String
permite nulo
aceita somente X|P
X - Anexação
P - Apensamento
case insensitive
Tipo de ajuntamento.
Observação :
1 Este serviço será responsável por preencher as informações do processo
principal, referente aos campos “Número do processo”, “Tipo de
Ajuntamento” e “Ajuntado em”.
Restrição:
1 Não poderão ser enviadas, para a mesma entidade, informações de
número do processo que possuam o mesmo tipo de ajuntamento e data e
hora do ajuntamento.
Exemplo:
Temos o registro de ajuntamento, número do processo principal
201561419999990000013, data de ajuntamento 2015-11-03T13:12:00 e tipo
de ajuntamento “X” .
Caso esta informação seja enviada novamente, será retornada uma
Só poderá haver um tipo de ajuntamento não desentranhado por processo.
Exemplo :
Nro Processo
201561419999990000
005
201561419999990000
005
201561419999990000
005
Tipo de
Ajuntamento
X
P
Dh Desentranhamento
9999-10-29T17:50:00
9999-10-29T18:00:00
X
Caso no exemplo acima houvesse mais de um processo sem
desentranhamento, ao acessar as informações do processo
201561419999990000005 na Tela de Consulta Geral iria ocasionar em erro
de consulta SQL, pois na aba Ajuntamento iria retornar mais de uma
informação.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo principal com o
registro de processo.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/ajuntamentos
Exemplo : Envio pelo método POST de um mesmo processo com tipos de
ajuntamentos diferentes.
[{
"dhAjuntamento" : "9999-10-29T17:40:00",
"iUsuariosAjuntamento" : "juliocps",
"nroProcesso" : "201561419999990000005",
"tipoAjuntamento" : "X",
"iUsuariosDesentranhamento" : "juliocps",
"dhDesentranhamento" : "9999-10-29T17:50:00"
},
{
"dhAjuntamento" : "9999-10-29T17:45:00",
"nroProcesso" : "201561419999990000005",
"tipoAjuntamento" : "P",
}]
4.16 - Migrando encerramento do processo
encerramento de processos deverão ser enviados para preenchimento da
tabela do banco de dados.
Os atributos enviados podem ser conferidos por meio da Tela de Consulta
Geral de Processo (Consultas >> Consulta Geral >> aba Enc./Arq >> Guia
Encerramentos/Estorno de encerramento).
Protocolo Fly
nroProcesso
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Exemplo
:
“nroProcesso”:
“999900010099990000001” .
O processo enviado por este atributo já
deverá existir no registro de processos.
mascara
String
não permite nulo
tamanho mínimo:1
tamanho máximo: 9
Informação referente ao organograma
responsável pelo encerramento do
processo.
dhEncerramento
String
não permite nulo
tamanho mínimo: 19
“Data de
encerrament
o inválida ou
não
informada.
Exemplo : "dhEncerramento":" 999901-01T01:00:00",
resultado
String
não permite nulo
aceita somente D|I|F|H|U|L|O
D - Deferido
I - Indeferido
F - Confirmado
U - Anulado
H - Conhecimento
O - Outros
dhEstorno
String
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Exemplo : “dhEstorno”:”9999-0101T01:00:00”
observacao
String
permite nulo
tamanho mínimo: 1
motivoEstorno
String
permite nulo
tamanho mínimo: 1
Referente ao motivo do estorno do
encerramento.
numeroFolhas
String
permite nulo
formato: aceita somente algarismos
numéricos.
Exemplo : “numeroFolhas” : “10”
iUsuarios
String
não permite nulo
Uma data
deve ter o
formato
yyyy-MMddTHH:mm:
ss”
tamanho mínimo: 1
tamanho máximo: 16
iUsuariosEstorno
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Restrição:
1 Não poderão ser enviadas, para a mesma entidade, informações de número
do processo que possuam a mesma data e hora de encerramento.
Exemplo:
data e hora de encerramento 2015-11-03T13:12:00 . Caso esta informação
seja enviada novamente, será retornada uma mensagem de validação, vista
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo encerrado com
o registro de processo.
O atributo mascara relaciona a informação do organograma de
encerramento com o registro de organograma.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/encerramentos
[{
"nroProcesso" : "201561419999990000008",
"mascara" : "001000000",
"dhEncerramento" : "2015-10-29T10:20:00",
"resultado" : "D",
"observacao" : "Testando",
"numeroFolhas" : "123456789",
"iUsuarios" : "juliocps",
"iUsuariosEstorno" : "juliocps",
"dhEstorno" : "9999-09-28T10:28:00",
"motivoEstorno" : "teste"
}]
4.17 - Migrando movimentação do processo
Neste tópico iremos abordar a forma com que os dados referente a
movimentação de cancelamento e parada dos processos deverão ser enviados
para preenchimento da tabela do banco de dados.
As movimentações de cancelamento poderão ser conferidas por meio da
tela de Cancelar Processos (Processos >> Movimentações >> Cancelar
processos).
As movimentações de parada poderão ser conferidas por meio da tela
de Parar Processos (Processos >> Movimentações >> Parar processos).
Protocolo Fly
nroProcesso
Tipo de dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Exemplo : “nroProcesso”:
“999900010099990000001” .
Informação referente ao número
do processo.
tipo
String
não permite nulo
aceita somente P|C
P - Parada
C - Cancelamento
case insensitive
Tipo de movimentação.
motivo
String
não permite nulo
tamanho mínimo: 1
Motivo da movimentação
(parada/cancelamento).
dhMovimentacao
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
“Data de
movimentaç
ão inválida
ou não
informada.
Uma data
deve ter o
formato
Data e hora da movimentação.
iUsuarios
String
yyyy-MMddTHH:mm:
ss”
não permite nulo
tamanho mínimo: 1
Requerente da movimentação.
mascara
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 9
Organograma
atual).
dhCancelamento
String
(localização
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do cancelamento.
iUsuariosCanc
String
tamanho mínimo: 1
tamanho máximo: 16
Usuário
responsável
movimentação
cancelamento.
pela
de
Restrição:
do processo que possuam o mesmo tipo e data e hora de movimentação.
Exemplo:
data e hora de movimentação 2015-11-03T13:12:00 e tipo “C”.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo movimentado
(parada/cancelamento) com o registro de processo.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/movimentacoes
4.18 - Migrando número do processo
Neste tópico iremos abordar a forma com que serão estruturadas as
informações referente ao registro de números únicos vinculados ao número do
processo para preenchimento da tabela do banco de dados. No Protocolo Fly o
número único é utilizado para que os requerentes possam consultar os
processos abertos no site do produto.
Os atributos enviados podem ser conferidos por meio da Tela de Consulta
Geral de Processo (Consultas >> Consulta Geral >> aba Processos >>Campo
Número único).
Protocolo Fly
iNroUnicos
Tipo de dados
String
tamanho mínimo: 1
tamanho máximo: 11
Informação que identifica o
número único do processo.
Exemplo:
“iNroUnicos”:”P124429F271”
nroProcesso
String
não permite nulo
tamanho mínimo: 1
tamamho máximo: 24
Exemplo
:
“nroProcesso”:
“999900010099990000001” .
O processo enviado por este
atributo já deverá existir no
registro de processos.
Restrição:
Mensagem
1 Não poderá ser enviado mais de uma número único.
Importante:
1 Caso o número único não seja preenchido no envio, então o sistema irá
preencher de forma automática.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo encerrado com
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/numerosprocessos
4.19 - Migrando parecer do processo
informações referente ao registro de pareceres dos processos para
Consulta Geral de Processos (Consultas >> Consulta Geral >> aba Pareceres).
Protocolo Fly
nroProcesso
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo : 1
Exemplo
:
“nroProcesso”:
“999900010099990000001” .
dhAndamento
String
permite nulo
“Data de
andamento
tamanho mínimo: 19
inválida ou
tamanho máximo: 19
não
informada.
Uma data
deve ter o
Exemplo : “dhAndamento”:”9999-01formato
01T01:00:00”
yyyy-MMddTHH:mm:
Informação que identifica a data e a ss”
hora em que foi realizado o
andamento do processo.
dhEncerramento
String
conclusivo
String
permite nulo
“Data de
encerrament
tamanho mínimo: 19
o inválida ou
tamanho máximo: 19
não
informada.
Uma data
deve ter o
Exemplo : “dhEncerramento”:”9999formato
01-01T01:00:00”
yyyy-MMddTHH:mm:
Informação que identifica a data e
ss”
hora de encerramento do processo.
não permite nulo
aceita somente S|N
S - Sim
N – Não
Identifica se o parecer foi conclusivo.
Exemplo: “conclusivo”:”S”
resultado
String
aceita somente D|I|O|F|U|H|L
D - Deferido
I - Indeferido
O - Outros
F - Confirmado
U - Anulado
H - Conhecimento
L – Parcial
Identifica o resultado do parecer.
Exemplo: “resultado”:”D”
dhParecer
String
não permite nulo
tamanho mínimo: 19
“Data do
parecer
tamanho máximo: 19
Informa a data e hora em que foi
concedido o parecer.
Exemplo: “dhParecer”:”9999-0101T01:00:00”
parecer
String
inválida ou
não
informada.
Uma data
deve ter o
formato
yyyy-MMddTHH:mm:
ss”
não permite nulo
tamanho mínimo : 1
Descrição do parecer.
dhEstorno
String
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Informa a data e hora em que foi
realizado o estorno.
Exemplo: “dhEstorno”:”9999-0101T01:00:00”
tipoAjuntamento
String
permite nulo
aceita somente X|P
X - Por anexação
P - Por apensação
dhAjuntamento
String
permite nulo
“Data de
ajuntamento
tamanho mínimo: 19
inválida ou
tamanho máximo: 19
não
informada.
formato: yyyy-mm-ddThh:mm:ss
Uma data
deve ter o
Exemplo: “dhAjuntamento”:”9999-01formato
01T01:00:00”
yyyy-MMddTHH:mm:
ss”
mascara
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 9
Informação da máscara do
organograma.
iUsuarios
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Usuário responsável pelo parecer.
Restrição:
do processo que possuam a mesma data e hora de parecer.
Exemplo:
data e hora de parecer 2015-11-03T13:12:00. Caso esta informação seja
enviada novamente, será retornada uma mensagem de validação, vista pelo
método Get, comunicando que este registro já é existente.
Relacionamento:
1 O atributo nroProcesso relaciona o número do processo com o registro de
processo.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/pareceres
4.20 - Migrando guias de pagamento
informações referente ao registro de guias geradas para os processos para
Os atributos enviados podem ser conferidos por meio do Relatório da
Situação de Guias de Pagamento (Relatórios >> Gerenciais >> Situação das
guias de pagamento).
Protocolo Fly
Tipo de
dados
Mensagem
nroProcesso
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Exemplo
:
“nroProcesso”:
“999900010099990000001”
cpfCnpjPessoa
String
não permite nulo
Obs: Este atributo recebe a
informação
do
CPF/CNPJ
e
11 ou 14 caracteres numéricos. Ex:
“01234567890”.
dhLancto
String
dtVencto
String
não permite nulo
“Data de
lançamento
tamanho mínimo : 19
inválida ou
tamanho máximo: 19
não
informada.
Uma data
deve ter o
Exemplo:
“dhLancto”:”9999-01formato
01T01:00:00”
yyyy-MMddTHH:mm:
Data e hora do lançamento da guia
ss”
de pagamento.
não permite nulo
tamanho mínimo: 10
tamanho máximo: 10
formato: yyyy-mm-dd
Data e hora do vencimento.
numeroBaixa
String
Validação do
CPF/CNPJ:
"O valor
'número do
documento’
não é um
CPF ou
CNPJ
válido"
não permite nulo
tamanho mínimo: 1
tamanho máximo: 10
aceita somente algarismos numéricos.
valor mínimo: 1
Número que identifica a guia de
pagamento.
vlGuia
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
Podem ser enviados conforme os
exemplos abaixo:
“vlGuia”:”10”
“vlGuia”:”10.00”
“vlGuia”:”10.0000”
vlDesconto
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
exemplos abaixo:
“vlDesconto”:”10”
“vlDesconto”:”10.00”
“vlDesconto”:”10.0000”
vlMulta
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
exemplos abaixo:
“vlMulta”:”10”
“vlMulta”:”10.00”
“vlMulta”:”10.0000”
vlJuro
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
exemplos abaixo:
“vlJuro”:”10”
“vlJuro”::”10.00”
“vlJuro”::”10.0000”
vlCorrecao
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
exemplos abaixo:
“vlCorrecao”:”10”
“vlCorrecao”:”10.00”
situacao
String
aceita somente A|C|P
A - Aberta
C - Cancelada
P - Paga
case insensitive
Situação da guia de pagamento.
integrado
String
permite nulo
aceita somente S|N|E :
S – Sim
N - Não
E – Erro de integração
case insensitive
A opção “S” define que a guia já foi
integrada.
A opção “N” define que a guia ainda
não foi integrada.
A opção “E” define que ao enviar a
guia por meio da ferramenta de
Validação :
“O valor
deve
corresponde
r à [S|N|E]
ou nulo”
integração houve um erro,
integrar
String
não permite nulo
aceita somente S|N:
S - Sim
N - Não
case insensitive
Obs: Este atributo define se a guia
será integrada (“S” ou não (“N”) pela
ferramenta de integração.
Importante: Este atributo só poderá
ser setado como “S” caso a guia
esteja com a situação em aberta e
não tenha sido gerado o lançamento
no sistema de arrecadação.
msgRetorno
String
permite nulo
tamanho mínimo: 1
Informação de retorno da integração
caso o atributo “integrado” receba a
opção “E”.
Exemplo: “O número de baixa
reservado para essa guia já está
sendo utilizado no Betha Tributos.”
nroProcessoGuia String
permite nulo
tamanho mínimo: 1
tamanho máximo: 30
Restrição:
possuam o mesmo número de baixa.
Exemplo :
Temos o registro de número de baixa código 1.
Não enviar uma guia de pagamento que esteja na situação diferente de
aberto com a opção do atributo integrar como “S”.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do número de processo com
Importante:
1
Para que uma guia na situação aberta seja enviada pela ferramenta de
integração, ao sistema de arrecadação, será necessário que o atributo
integrado esteja setado como “N” e o atributo integrar esteja como “S”.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/guiasprotocolo
4.21 - Migrando pagamento da taxa do processo
Neste tópico iremos abordar a forma com que deverão ser estruturadas
as informações referente ao registro de pagamentos das guias para
Os atributos enviados podem ser conferidos por meio do Relatório da
Situação de Guias de Pagamento (Relatórios >> Gerenciais >> Situação das
guias de pagamento >> Deixe somente selecionada a opção “Pagas”).
Protocolo Fly
dhEstorno
Tipo de dados
String
Mensagem
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do estorno de
pagamento.
dhPgto
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora de pagamento.
“Data de
pagamento
inválida ou
não
informada.
Uma data
deve ter o
formato
Exemplo : “dhPgto”:”9999-0101T01:00:00”
iPagamentos
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 10
numéricos
Código sequencial do
pagamento realizado no
sistema de arrecadação.
iUsuariosEst
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 24
estorno do pagamento.
iUsuariosPag
String
permiten nulo
tamanho mínimo : 1
tamanho máximo: 24
pagamento.
motivoDifer
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Informação referente ao motivo
da diferença de pagamento.
motivoEstorno
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Descrição do motivo do estorno
de pagamento.
yyyy-MMddTHH:mm:
ss”
nroBaixa
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 10
numéricos
valor mínimo: 1
Identifica a guia de pagamento
(número de baixa)
nroProcesso
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 24
“999900010099990000001” .
tipoPgto
String
não permite nulo
aceita somente N|I
N - Normal
I – Indevido
Identifica o tipo de pagamento.
vlCorrecao
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
Podem ser enviados conforme
os exemplos abaixo:
Valor de correção monetária.
vlDiferenca
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlDiferenca”:”10”
“vlDiferenca”:”10.00”
“vlDiferenca”:”10.0000”
Valor que informa a diferença de
pagamento.
vlJuro
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlJuro”:”10.00”
“vlJuro”:”10.0000”
Valor de juros.
vlMulta
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlMulta”:”10.0000”
Valor de multa.
vlPago
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlPago”:”10”
“vlPago”:”10.00”
“vlPago”:”10.0000”
Valor de pagamento.
Restrição:
possuam o mesmo código de pagamento.
Exemplo :
Temos o registro de número de pagamento código 1.
Relacionamento:
1 O atributo nroProcesso relaciona a informação do processo com o registro
de processo.
O atributo nroBaixa relaciona a informação da guia de pagamento com o
registro de números baixas (informação que define o número de baixa para
pagamento da guia no sistema de Arrecadação).
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/pagamentosprotocolo
[{
"dhPgto" : "9999-11-03T09:40:00",
"iPagamentos" : "1",
"iUsuariosPag" : "juliocps",
"motivoDifer" : "teste",
"nroBaixa" : "1234567894",
"nroProcesso" : "201561419999990000008",
"tipoPgto" : "I",
"vlPago" : "250",
"vlCorrecao" : "12345678901.1234",
"vlDiferenca" : "12345678901.1234",
"vlJuro" : "12345678901.1234",
"vlMulta" : "12345678901.1234",
"dhEstorno" : "9999-11-03T09:55:00",
"iUsuariosEst" : "juliocps",
"motivoEstorno" : "Testando"
}]
4.22 - Migrando configuração do campo da etiqueta
as informações referente ao registro de etiquetas para preenchimento da tabela
do banco de dados .
Os atributos enviados podem ser conferidos por meio da tela de
Cadastro de Etiquetas (Cadastros >> Etiquetas >> aba Campos das etiquetas).
Protocolo Fly
nomeEtiqueta
Tipo de dados
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 20
tipoEtiqueta
String
não permite nulo
aceita somente G|T
G - Gráfico
T - Texto
tamanho mínimo : 1
tamanho máximo : 1
Obs: Este atributo define se a
etiqueta será impressa em
pdf (“G”) ou em forma txt
(“T”).
posY
String
não permite nulo
tamanho mínimo : 1
Mensagem
tamanho máximo: 3
permite apenas algarismos
numéricos
posX
String
não permite nulo
tamanho mínimo: 1
tamanho máximo : 3
numéricos
tipoCampo
String
não permite nulo
aceita somente C|T|L
C - Coluna
T - Texto
L - Linha
tamanhoCampo
String
não permite nulo
tamanho mínimo: 1
tamanho máximo : 3
numéricos
estiloFonte
String
não permite nulo
aceita somente N|I|B|X
N - Normal
I - Itálico
B - Negrito
X - Negrito e Itálico
valorCampo
String
não permite nulo
tamanho mínimo : 1
Importante ! Quando o
atributo tipoCampo estiver
setado com a opção “C”
então este atributo deverá
obrigatoriamente estar
preenchido com um dos
nomes das colunas abaixo :
VW_PROCESSOS.I_PROCE
SSOS
VW_PROCESSOS.I_PROTO
COLOS
VW_PROCESSOS.I_SOLICI
TACOES
VW_PROCESSOS.NRO_PR
OCESSO
VW_PROCESSOS.DH_PRE
VISTA
VW_PROCESSOS.SUMULA
VW_PROTOCOLOS.DH_PR
OTOCOLIZACAO
NUMEROS_PROCESSO.I_N
RO_UNICOS
VW_ORGANOGRAMAS.MA
SCARA
VW_ORGANOGRAMAS.NO
ME
RESPONSAVEL
VW_SOLICITACOES.DESC
RICAO
VW_PESSOAS.NOME
VW_PESSOAS.TELEFONE
VW_PESSOAS.E_MAIL
CODIGOBARRAS
NOME_ORG
tamanhoFonte
String
não permite nulo
tamanho mínimo: 1
tamanho máximo : 2
Caso o atributo tipoCampo
estiver setado como “L” então
permitirá informar o algarismo
0.
Caso o atributo tipoCampo
estiver setado como “C” ou
“T” então permitirá informar
os algarismos: 6, 8, 10, 12,
14, 16, 20, 22.
Restrição
possuam a mesma informação de valor do campo.
Exemplo:
Temos para a etiqueta “X” tipo “G” a informação do valor do campo
VW_PROCESSOS.I_PROCESSOS.
Relacionamento
1 Os atributos nomeEtiqueta e tipoEtiqueta relacionam os campos das
etiquetas com o registro da etiqueta.
Exemplo :
Ao enviar o nome da Etiqueta “Etiqueta” e tipo da etiqueta “G” será feita a
busca pelo registro da etiqueta que possuírem estas características.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/etiquetascampos
[{
"nomeEtiqueta" : "Etiqueta Teste",
"tipoEtiqueta" : "T",
"posY" : "123",
"posX" : "123",
"tipoCampo" : "C",
"tamanhoCampo" : "12",
"estiloFonte" : "N",
"valorCampo" : "VW_PROCESSOS.SUMULA",
"tamanhoFonte" : "6"
}]
4.23 - Migrando usuário do organograma
as informações referente ao registro de usuários que podem estar
movimentando um processo que está pendente no organograma para
Cadastro de Organogramas (Cadastros >> Organogramas >> aba Usuários).
Protocolo Fly
mascara
Tipo de
dados
String
não permite nulo
Mensagem
tamanho mínimo: 1
tamanho máximo: 9
máscara do organograma.
Exemplo :
“mascara”:”001001001”
iUsuarios
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Nome do usuário que poderá
realizar a movimentação do
processo no organograma.
Exemplo: “iUsuarios”:”teste”
Restrição:
possuam a mesma informação de mascara e nome de usuário.
Exemplo:
Temos para o organograma máscara “001000000” o usuário “teste”. Caso
existente.
Relacionamento:
1 O atributo mascara irá relacionar o usuário do organograma com o registro
do organograma.
Path:http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/usuariosorganogramas
4.24 - Migrando valor da taxa
as informações referente ao registro de valores das taxas de acordo com a
moeda indexadora para preenchimento da tabela do banco de dados.
Cadastro de Taxas (Cadastros >>Financeiro >> Taxas).
Protocolo Fly
descricaoTaxa
Tipo de
dados
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Informação do nome da taxa.
dhTaxas
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data base do valor da taxa.
descricaoIndexador
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Descrição do nome do
indexador.
valor
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“valor”:”10”
“valor”:”10.00”
“valor”:”10.0000”
Valor da taxa conforme sua
Mensagem
data base.
Restrição:
possuam a mesma data base para uma mesma taxa.
Exemplo:
Temos o registro da taxa com a descrição “Taxa” e data base “01/01/2016
07:10:03” .
Relacionamento:
1 Os atributos descricaoTaxa e descricaoIndexador irão relacionar o valor da
taxa com o registro da taxa.
Exemplo :
Caso a taxa seja cobrada para a moeda Real, então poderá enviar :
“descricaoTaxa”:”Taxa”
Caso a taxa seja cobrada para a moeda Indexador, então poderá enviar:
“descricaoTaxa”:”Taxa”,
“descricaoIndexador”:”UMT”
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/taxasvalores
[{"descricaoTaxa": "Teste de conversão“,
"dhTaxas": "9999-10-30T17:39:00",
"descricaoIndexador": "indexador para conversão",
"valor": "12345678932.4321"}]
4.25 - Migrando taxa da solicitação
as informações referente ao registro do vínculo das taxas a solicitação para
Cadastro de Solicitações (Cadastros >> Solicitações >> aba Guia de
pagamento >> aba Taxas).
Protocolo Fly
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
descrição da solicitação.
descricaoTaxa
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Descrição da taxa.
descricaoGrupoSolicita
cao
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Descrição do grupo da
Solicitação.
taxaObrigatoria
String
aceita S|N
S - Sim
N - Não
tamanho mínimo : 1
tamanho máximo: 1
Informação que define a
obrigatoriedade da taxa.
permiteAlterar
String
aceita S|N
S - Sim
N - Não
tamanho mínimo : 1
tamanho máximo: 1
Mensagem
Informação que define se é
permitido alterar o valor da
taxa.
Relacionamento :
1 Os atributos descricaoSolicitacao e descricaoGrupoSolicitacao buscam a
informação do registro da solicitação.
O atributo descricaoTaxa busca a informação do registro da taxa.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/solicitacoestaxas
[{"descricaoSolicitacao": "Solicit. gonzaga",
"descricaoTaxa": "Taxa Teste",
"descricaoGrupoSolicitacao": "GRUPO CENTRAL",
"taxaObrigatoria": null,
"permiteAlterar": null}]
4.26 - Migrando roteiro de andamento
as informações referente ao registro dos locais onde as solicitações do
processo poderão percorrer para preenchimento da tabela do banco de dados.
Cadastro de Solicitações (Cadastros >> Solicitações >> aba Solicitações >>
Roteiro).
Protocolo Fly
Tipo de
dados
descricaoSolicitacao String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
Descrição da solicitação.
grupoDescricao
String
não permite nulo
tamanho mínimo: 1
Mensagem
tamanho máximo: 50
Descrição do grupo da
solicitação.
iSequencias
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 5
numéricos.
Informa a sequência do roteiro a
ser seguido.
mascara
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 9
Informação referente a máscara
do organograma.
unidadeTempo
String
aceita somente D|H|A|M
D - Dia
H - Hora
A - Ano
M – Mês
Informação referente a unidade
de tempo.
duracao
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 5
numéricos
Informação referente a duração.
Restrição :
1 A informação da sequência do roteiro (iSequencias) deverá seguir uma
ordem numérica pelo qual não poderá se repetir para uma mesma
solicitação de uma entidade.
Relacionamento :
1 Os atributos grupoDescricao e descricaoSolicitacao buscam a informação
do registro da solicitação.
O atributo mascara busca a informação do registro de organograma.
Path: http://e-gov.betha.com.br/arrecadao-conversao-services/rest/conversao/solicitacoesroteiros
4.27 - Migrando local de protocolização
informações referente aos locais de protocolização de uma determinada
solicitação de protocolo.
Cadastro de Solicitações (Cadastros >> Solicitações >> aba Locais de
Protocolização).
Protocolo Fly
descricao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
Informação da descrição da
solicitação.
mascara
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 9
Informação referente a máscara
do organograma.
descricaoGrupo
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Mensagem
Informação da descrição do
grupo da solicitação.
Restrição:
possuam a mesma máscara, descrição da solicitação e descrição do grupo
de solicitação.
Exemplo:
Temos o registro do local da protocolização máscara “001.000.000” e
descrição da solicitação “Serviço de Terraplanagem” e grupo de solicitação
“Serviços de Máquinas”.
Relacionamento:
1 Os atributos descricao e descricaoGrupo irão relacionar o organograma, por
meio da máscara, com o registro de solicitação.
Exemplo :
Ao enviar as seguintes informações abaixo :
[{“descricao”:” Serviço de Terraplanagem”,
“mascara”:”001000000”,
“descricaoGrupo”: “Serviços de Máquinas”}]
Será feita a busca pelo registro da solicitação que tiver a descrição “Serviço
de Terraplanagem” e vinculado ao grupo da solicitação “Serviços de
Máquinas”.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/solicitacoeslocalprot
4.28 - Migrando informação adicional da solicitação
informações dos campos adicionais para cada registro de solicitação.
Cadastro de Solicitações (Cadastros >> Solicitações >> Informações
adicionais).
Protocolo Fly
grupoDescricao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informação da descrição do
grupo da solicitação.
String
não permite nulo
tamanho mínimo: 1
Informação da descrição da
solicitação.
rotulo
String
Não permite nulo
tamanho mínimo: 1
nome do item.
tipoCampo
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 2
Permite informar apenas os
algarismos numéricos
1,2.3,4,5,6,7,8,9
1 - Campo de texto
2 - Múltipla escolha
3 - Caixa de texto
4 - Lista de opções
Mensagem
5 - Hora
6 - Data
7 - Número inteiro
8 - Número decimal
9 - Campo de seleção
obrigatorio
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 1
permite informar S|N
o S – Sim
N – Não
Define se será obrigatória a
informação do item
adicional.
tamanho
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 10
numéricos
tamanho do campo quando
o item for referente a texto.
sequencia
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 3
numéricos
Número sequencial de
registro do item para o item.
ativo
String
não permite nulo
aceita somente S|N
S - Sim
N - Não
tamanho mínimo: 1
tamanho máximo: 1
Define se o item está ativo
ou inativo.
Restrição:
possuam a mesma descrição de solicitação,descrição de grupo e mesma
sequência.
Exemplo:
Temos o registro do item adicional de descrição da solicitação “Serviço de
Terraplanagem” e grupo de solicitação “Serviços de Máquinas” e sequência
1.
Relacionamento:
1 Os atributos descricao e descricaoGrupo irão relacionar o item com o
registro de solicitação.
Exemplo :
“descricaoGrupo”: “Serviços de Máquinas”,
“rotulo”:”Texto”
“tipoCampo”:”1”,
“obrigatório”:”N”,
“tamanho”:”10”,
“sequencia”:”1”,
“ativo”:”S”}]
Será feita a busca pelo registro da solicitação que tiver a descrição “Serviço
de Terraplanagem” e vinculado ao grupo da solicitação “Serviços de
Máquinas”.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesadicionais
4.29 - Migrando item da informação adicional da solicitação
informações do registro de itens adicionais inseridos pelo usuário para
Consulta Geral (Consultas >> Consulta Geral >> aba Inf. adicionais).
Protocolo Fly
grupoDescricao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Nome do grupo da
solicitação.
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
Nome do registro da
solicitação.
sequencia
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 3
numéricos
Sequência do item.
iSolicitacoesAdicionaisIt String
não permite nulo
tamanho mínimo : 1
tamanho máximo : 3
Código sequencial de
registro.
Mensagem
item
String
não permite nulo
tamanho mínimo: 1
Informação do item
adicional.
Restrição:
possuam a mesma descrição de solicitação, mesma descrição de grupo,
mesma sequência e código de registro da solicitação adicional do item.
Exemplo:
Temos o registro do item adicional de descrição da solicitação “Serviço de
Terraplanagem” e grupo de solicitação “Serviços de Máquinas” , sequência
1e código de registro da solicitação adicional do item 1.
Relacionamento:
1 Os atributos grupoDescricao, descricaoSolicitacao,sequencia irão relacionar
o item com o registro da solicitação adicional.
Exemplo:
“descricaoGrupo”: “Serviços de Máquinas”,
“sequencia”:”1”,
“iSolicitacoesAdicionaisIt”:”1”,
“item”:”Teste”}]
Será feita a busca pelo registro da solicitação adicional que possua o
seguinte registro acima de descrição, descrição do grupo e sequência.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesadicionaisit
4.30 - Migrando solicitação de abertura
informações referente ao registro das solicitações de abertura de protocolo dos
requerentes para preenchimento da tabela do banco de dados.
Cadastro de Solicitações (Processos >> Solicitações de abertura).
Protocolo Fly
Tipo de
dados
descricaoSolicitaco
es
String
Não permite nulo
Mensagem
tamanho mínimo: 1
tamanho máximo: 20
Informação referente a descrição da
solicitação.
grupoDescricao
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informação referente ao grupo da
solicitação.
descricaoMunicipio
String
permite nulo
tamanho mínimo : 1
município.
descricaoBairro
String
permite nulo.
tamanho mínimo: 1
bairro.
descricaoLogradou
ro
String
permite nulo
tamanho mínimo : 1
Informação referente ao nome da
rua.
Validação :
"Não foi
localizado o
grupo de
solicitações
informado."
inscricao
String
nome
String
não permite nulo
Validação do
tamanho :
tamanho mínimo: 1
"O valor do
tamanho máximo: 14
campo
'Inscrição da
Este atributo recebe a informação pessoa' é
do CPF/CNPJ e portanto deverá ser inválido: O
preenchido com 11 ou 14 caracteres tamanho
deve estar
numéricos. Ex: “01234567890”.
entre 1 e 14"
não permite nulo
tamanho mínimo: 1
Este atributo é referente ao nome
do solicitante.
email
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 80
Obs: Quando informado, este
atributo
deverá
receber
a
informação de um email válido.
Exemplo: [email protected]
Importante: A coluna e-mail da
tabela de solicitacoes_aberturas irá
permitir nulo, mas quando cadastrar
a solicitação de abertura externa
pelo sistema, continuará obrigando
a informar o email.
logradouro
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Informação tipo de logradouro.
Exemplo: “Avenida”
numero
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 8
endereço do solicitante.
complemento
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Informação complementar referente
a localizalição do endereço do
solicitante.
cep
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 8
Informação referente ao cep do
endereço do solicitante.
telefone
String
tamanho mínimo : 1
tamanho máximo: 11
Importante: Este atributo deverá
receber a informação de um
telefone válido com no mínimo 10
algarismos.
Exemplo
:
(48)
34440000.
A validação do tamanho do telefone
é uma regra de negócio que tem
como intuito receber informações
corretas. A mesma validação ocorre
também nas telas de cadastro de
pessoas nos sistemas Fly. Dessa
forma, a remoção da mesma
resultaria na recepção de dados
inconsistentes.
dhSolicitacao
String
não permite nulo
“Data de
solicitação
tamanho mínimo: 19
inválida ou
tamanho máximo: 19
não
informada.
Uma data
deve ter o
Informação referente a data e a
formato
hora em que foi realizada a
yyyy-MMsolicitação pela pessoa solicitante.
Exemplo : “dhSolicitacao”:”" 999901-01T01:00:00"
situacao
String
ddTHH:mm:
ss”
não permite nulo.
permite apenas N|D|I
N - Não analisado
D - Deferido
I - Indeferido
aceita maiúsculo/minúsculo.
Parecer do usuário do sistema
quanto a aceitação do pedido de
protocolo.
resultado
String
permite nulo.
tamanho mínimo: 1
Informação descritiva do resultado
da análise, conforme parecer dado
pelo usuário responsável pela
protocolização.
dhResultado
String
permite nulo
tamanho mínimo: 19
Exemplo : “dhResultado”:”" 999901-01T01:00:00"
motivo
String
não permite nulo.
tamanho mínimo: 1
Motivo pelo qual foi gerada a
solicitação de abertura do protocolo.
prioridade
String
não permite nulo.
aceita somente A|N|B
A - Alta
N - Normal
"O valor do
campo
'Prioridade
do processo'
é inválido: O
valor deve
B - Baixa
corresponde
Informação referente a prioridade r à \"[A|N|
B]\""
do processo.
Restrição:
possuam a mesma descrição de solicitação, mesma descrição de grupo,
mesma inscrição e data e hora da solicitação.
Exemplo:
Temos o registro da solicitação de abertura descrição da solicitação “Serviço
de Terraplanagem” e grupo de solicitação “Serviços de Máquinas” , inscrição
“00000000000” e data e hora “2016-01-01T01:00:00”
Relacionamento:
1 Os atributos descricaoSolicitacoes e grupoDescricao irão relacionar a
solicitação de abertura com o registro de solicitação.
Os atributos descricaoMunicipio, descricaoBairro, descricaoLogradouro,
inscricao, nome, email, logradouro, numero, complemento, telefone
identificam o requerente.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesaberturas
Exemplo 1 : Envio de dados pelo serviço Post.
[{
"descricaoSolicitacoes":"Solicitação",
"grupoDescricao":"GRUPO CENTRAL",
"descricaoMunicipio" : "Criciúma",
"descricaoBairro":"Centro",
"descricaoLogradouro":"Mangueiras",
"inscricao":"9999999000191",
"nome":"Solicitação de Férias",
"email":"[email protected]",
"logradouro":"Rua",
"numero":"1",
"complemento":"Perto do praça central",
"cep":"88136515",
"telefone":"4896320330",
"dhSolicitacao":"9999-02-01T01:02:03",
"situacao":"N",
"resultado":"Pedido confirmado",
"dhResultado":"9999-02-11T11:02:03",
"motivo":"Forte motivo para análise",
"prioridade":"A"}]
4.31 - Migrando vínculo do documento
informações do registro de documentos que estão entregues e vinculados ao
processo para preenchimento do banco de dados.
IMPORTANTE:
Para que seja possível realizar o envio desse serviço, antes do envio, deverá
ser feito com o content-type "multipart/form-data". Em seguida, deverá ser
setado o parâmetro chamado "dto" que irá receber o JSON conforme
(Exemplo: “Envio pelo método POST”), e um campo "files" onde poderá ser
incluído uma imagem, PDF etc...
Na prática, ficaria da seguinte forma:
1. Para enviar os ProcessosDocumentos, se faz necessário enviar o
documento com descrição, informação essa descrita n o item 4.9 Migrando documento deste manual.
2. Após feita a inserção da informação no item 1, poderá ser dado
continuidade
e proceder ao item 4.31 - Migrando vínculo do
documento conforme informação descrita neste manual.
3. Para que os dados citados anteriormente sejam enviados, é necessário
realizar uma configuração diferenciada, segue abaixo:
Apenas como exemplo para melhor exemplificar o que está descrito no item
acima setado como (IMPORTANTE:),utilizamos o Postman abaixo para teste
conforme segue imagem de demonstração:
Figura: Postman apenas de demonstração
- Content-Type - - > Multipart/form-data
- No campo Headers deixar somente a informação do token:
Figura: Postman apenas de demonstração
O nome utilizado no item <4.9 - Migrando documento> é o mesmo que será
utilizado no item <4.31 - Migrando Vinculo do Documento> no atributo
<descricaoDocumento>, esse é o vinculo entre as tabelas.
Cadastro de Entrega de Documentos (Processos >> Entrega de documentos).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 24
“999900010099990000001” .
número do processo.
descricaoDocumento
String
não permite nulo
tamanho mínimo : 1
Nome do documento.
iProtocolos
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 10
numéricos
Código sequencial de registro
do protocolo.
nroDocumento
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 20
Número do documento.
Mensagem
dtEmissao
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 10
formato : yyyy-mm-dd
Data
de
documento.
dtVencimento
String
emissão
do
permite nulo
tamanho mínimo : 1
tamanho máximo: 10
formato : yyyy-mm-dd
Data de vencimento
documento.
observacao
String
do
permite nulo
tamanho mínimo : 1
tamanho máximo: 50
Observação.
Restrição :
possuam o mesmo número do processo, mesmo código de protocolo e
descrição do documento.
Exemplo:
Temos o registro de entrega de documento número do processo
“201561419999990000009”, protocolo “9” e descrição do documento “CNPJ”.
Relacionamento:
1 Os atributos nroProcesso e iProtocolos relacionam o documento do processo
com o registro de processos.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/processosdocumentos
[{"nroProcesso": "201561419999990000009",
"descricaoDocumento": "CNPJ",
"iProtocolos": "9",
"nroDocumento": "1",
"dtEmissao": "2099-10-29",
"dtVencimento": "2099-10-29",
"observacao": "Obs.: Teste gonzaga conversão"
}]
Regra de envio: Para a tabela processosdocumentos não é possível
realizar o envio de documentos em forma de array devido a uma limitação
técnica. Os serviços que possibilitam anexar arquivos, permitem o envio
apenas de um registro por vez, conforme exemplo acima.
Por mais que o responsável pela migração de dados realize o envio em forma
de array, ou seja, envie mais de um registro, na consulta do GET, será
demonstrada a mensagem conforme { "success": true}, ou seja, o true é
referente ao primeiro registro, o serviço de conversão irá inserir o primeiro
registro e os outros registros enviados em formato de array serão descartados.
Observação: O envio do arquivo dependerá da ferramenta a ser utilizada para
migração dos dados. Não será possível atualizar os dados do arquivo, portanto
só será permitido remover (DELETE) e inserir (POST) novamente.
4.32 - Migrando taxa do processo
informações referente ao registro de taxas geradas para os processos para
Consulta Geral (Consultas >> Consulta Geral >> aba Taxas).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 24
Exemplo
:
“nroProcesso”:
“999900010099990000001” .
processo.
Mensagem
descricaoTaxa
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Nome de registro da taxa.
valor
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 16
Informação correspondente aos
valores das taxas cobradas de
acordo com o processo. Seguir o
formato dos exemplos abaixo para
envio destas informações..
Exemplo 1 : “valor”:”5.00”
Exemplo 2 : “valor”:”10”
Exemplo 3 : “valor”:”150.5555”
Valor lançado para a taxa.
situacao
String
não permite nulo
aceita somente A|G
A - Não gerada
G – Gerada
Informa a situação da taxa.
quantidade
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 10
formato : aceita somente algarismos
numéricos.
Exemplo : “quantidade”:”10”
Restrição :
possuam o mesmo número do processo e descrição da taxa.
Exemplo:
“201561419999990000009” e descrição da taxa “Taxa”.
Relacionamento:
1 O atributo nroProcesso relaciona a taxa gerada com o registro do processo.
O atributo descricaoTaxa relaciona o valor da taxa com o registro da taxa.
Path: http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/processostaxas
[{
"nroProcesso" : "201561419999990000006",
"descricaoTaxa" : "Taxa Teste",
"valor" : "100.1234",
"situacao" : "A",
"quantidade" : "10"
}]
4.33 – Migrando exclusão de andamento
informações referente ao registro de andamentos dos processos que foram
excluídos por algum usuário para preenchimento da tabela do banco de dados.
Consulta Geral (Consultas >> Consulta Geral >> aba Andamentos).
Protocolo Fly
nroProcesso
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo : 1
“999900010099990000001” .
processo.
dhAndamento
String
não permite nulo
“Data de
andamento
inválida ou
não
informada.
Uma data
Exemplo : “dhAndamento”: “9999-03- deve ter o
formato
01T01:02:03”
yyyy-MMInformação que referencia ao registro ddTHH:mm:
ss”
do andamento do processo.
iDhAndamentos
String
mascaraOrig
String
não permite nulo
“Data de
cancelament
o inválida ou
não
informada.
Uma data
deve ter o
Exemplo : “iDhAndamentos”: “9999formato
03-01T01:02:03”
yyyy-MMddTHH:mm:
Informação referente a data e hora
ss”
de exclusão do andamento do
processo.
permite nulo
tamanho mínimo : 1
tamanho máximo : 9
iUsuariosOrig
String
Informação
referente
organograma de origem.
ao
Exemplo
“mascaraOrig”:”001001001”
:
permite nulo
tamanho mínimo : 1
Informação referente ao usuário de
origem,
responsável
pelo
andamento.
mascaraDest
String
permite nulo
tamanho mínimo : 1
tamanho máximo : 9
Informação
referente
ao
organograma destino do andamento.
Exemplo
“mascaraDest”:”002001001”
iUsuariosDest
String
:
permite nulo
tamanho mínimo : 1
usuário destino do andamento..
dhConfirmacao
String
permite nulo
Exemplo : “dhConfirmacao”: “999903-01T01:02:03”
observacao
String
permite nulo
tamanho mínimo : 1
cpfCnpjOrig
String
permite nulo
informação do CPF/CNPJ e portanto
deverá ser preenchido com 11 ou 14
caracteres numéricos caso haja
preenchimento. Ex: “01234567890”
cpfCnpjDest
String
permite nulo
informação do CPF/CNPJ e portanto
deverá ser preenchido com 11 ou 14
caracteres numéricos caso haja
preenchimento. Ex: “01234567890”
iUsuariosExclusa
o
String
não permite nulo
Validação do
CPF/CNPJ:
"O valor
'número do
documento’
não é um
CPF ou
CNPJ
válido"
Validação do
CPF/CNPJ:
"O valor
'número do
documento’
não é um
CPF ou
CNPJ
válido"
tamanho mínimo: 1
tamanho máximo: 16
Informação referente ao usuário
responsável pela exclusão do
andamento.
dhExclusao
String
não permite nulo
“Data de
exclusão
inválida ou
não
informada.
Uma data
deve ter o
Exemplo : “dhExclusao”: “9999-03formato
01T01:02:03”
yyyy-MMddTHH:mm:
Informação referente a data e a hora
ss”
em que o processo foi excluído.
Restrição:
possuam o mesmo número do processo, data e hora de andamento e data
e hora da exclusão do andamento.
Exemplo:
“201561419999990000009” e data e hora do andamento “2015-1029T10:55:39” e data e hora da exclusão do andamento “2015-1029T11:00:00”.
Relacionamento:
1 As informações dos atributos nroProcesso e dhAndamento irão identificar o
registro do andamento do processo.
Path:http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/andamentosexcluidos
Exemplo : Pelo método de envio POST
[{
"nroProcesso" : "201561419999990000010",
"dhAndamento" : "9999-10-29T10:55:39",
"iDhAndamentos" : "9999-10-29T11:00:00",
"mascaraOrig" : "001000000",
"iUsuariosOrig" : "juliocps",
"mascaraDest" : "002000000",
"iUsuariosDest" : "juliocps",
"dhConfirmacao" : "9999-10-29T10:56:45",
"iUsuariosExclusao" : "juliocps",
"dhExclusao" : "9999-10-29T11:00:47",
"observacao" : "Teste",
"cpfCnpjOrig" : "00000000000",
"cpfCnpjDest" : "00000000001"
}]
Observação : Os documentos "cpfCnpjOrig" e "cpfCnpjDest" ,do exemplo
acima, são inválidos e servem apenas para ilustrar a forma como a informação
deverá ser atribuída.
4.34 - Migrando local de arquivamento do processo
informações referente ao registro da localização do processo arquivado para
Consulta Geral (Consultas >> Consulta Geral >> aba Enc./Arq.).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
“999900010099990000001” .
processo.
tipo
String
não permite nulo
aceita somente A|R|D|E|M|X|I :
A - Arquivamento do processo
R - Retirar do arquivo
D - Devolução ao arquivo
Mensagem
E - Estorno de arquivamento
M - Movimentação entre arquivo
X- Extravio do processo
I - Inutilização do processo
Informação referente ao tipo de
movimentação realizada.
dhMovimentac
ao
String
arquivo
String
não permite nulo
“Data de
movimentaç
tamanho mínimo: 19
ão inválida
tamanho máximo: 19
ou não
informada.
Uma data
deve ter o
Exemplo : “dhMovimentacao”:”9999formato
01-01T01:00:00”
yyyy-MMddTHH:mm:
Informação referente a date e hora
ss”
da movimentação.
permite nulo
tamanho mínimo: 1
tamanho máximo: 20
gaveta
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 20
corredor
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 20
prateleira
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 20
pasta
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 20
qtdFolhas
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 5
numéricos
Exemplo : “qtdFolhas”:”2”
Informação referente a quantidade
de folhas do processo.
Restrição:
possuam o mesmo número do processo, tipo e data e hora da
movimentação.
Exemplo :
Temos o registro do arquivamento para o processo
“201561419999990000009” , tipo “A” e data e hora da movimentação “201510-29T10:55:39”.
Relacionamento:
1 O atributo nroProcesso relaciona o processo arquivado com o registro do
processo.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/arquivamentoslocais
[{"nroProcesso" : "201561419999990000001",
"tipo": "A",
"dhMovimentacao": "9999-10-29T08:22:26",
"arquivo": "10",
"gaveta": "10",
"corredor": "1",
"prateleira": "10",
"pasta": "1",
"qtdFolhas": "1" }]
4.35 - Migrando processo ajuntado
informações referente ao registro de processos ajuntados para preenchimento
da tabela do banco de dados.
Ajuntamentos de Processos (Processos >> Ajuntamento de Processos >> aba
Processos Ajuntados).
Protocolo Fly
dhAjuntamento
Tipo de
dados
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Este atributo é referente ao
registro do ajuntamento.
dhAjuntamentoProc
esso
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Este atributo é referente a data
e hora do vínculo do processo
com o ajuntamento.
iUsuariosAjuntament String
o
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Informa o campo “Ajuntado por
“
nroProcesso
String
não permite nulo
tamanho mínimo: 1
Mensagem
tamanho máximo: 24
“999900010099990000001” .
tipoAjuntamento
String
não permite nulo
aceita somente X|P
X - Anexação
P - Apensamento
case insensitive
Observação :
1 Este serviço irá ser responsável por preencher as informações da aba
Processos Ajuntados da Tela de Ajuntamento de Processos.
Quando um processo ajuntado é desentranhado, ou seja, excluído da lista
dos processos ajuntados da Tela de Ajuntamentos de Processos, o registro
do ajuntamento do processo é excluído.
Após a exclusão do registro do ajuntamento do processo, é realizada a
inclusão no registro de processos ajuntados excluídos.
Restrição :
possuam o mesma data e hora do ajuntamento principal, tipo de
ajuntamento , número do processo ajuntado e data e hora em que o
processo foi ajuntado.
Exemplo :
Temos o registro do ajuntamento do processo , número “9999-1030T13:56:00” e data e hora de ajuntamento “2015-10-30T13:56:00”
vinculados ao processo principal pelo qual possuem a data e hora do
ajuntamento em “2015-10-29T17:40:00” e tipo de ajuntamento “X”. Caso
existente.
Relacionamento:
1
Os atributos dhAjuntamento e tipoAjuntamento irão relacionar o ajuntamento
do processo com o ajuntamento principal.
O atributo nroProcesso relaciona o número do processo ajuntado com o
registro do processo.
Importante:
1 Só será realizado o envio do ajuntamento do processo por este serviço caso
o processo ajuntado não tenha sido desentranhado.
Path: http//e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/ajuntamentosprocessos
[{
"dhAjuntamento" : "2015-10-29T17:40:00",
"dhAjuntamentoProcesso" : "2015-10-30T13:56:00",
"nroProcesso" : "201561419999990000002",
"tipoAjuntamento" : "X"
}]
4.36 - Migrando ajuntamento de processo excluído
informações referente ao registro de processos desentranhados para
preenchimento do banco de dados.
Ajuntamentos de Processos (Processos >> Ajuntamento de Processos >> aba
Processos Ajuntados). Neste caso, deverá ser conferido se o processo não
está mais vinculado ao processo principal.
Protocolo Fly
dhAjuntamento
Tipo de
dados
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do ajuntamento
Mensagem
principal.
dhAjuntamentoProc
esso
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do processo
ajuntado.
dhDesentranhament String
o
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do
desentranhamento do
processo.
iDhAjuntamentos
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do
desentranhamento.
iUsuariosAjuntamen String
to
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
ajuntamento.
iUsuariosDesentran
hamento
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
desentranhamento.
nroProcesso
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Exemplo
:
“nroProcesso”:
“999900010099990000001” .
tipoAjuntamento
String
não permite nulo
aceita somente X|P
X - Anexação
P - Apensamento
case insensitive
Tipo
do
ajutamento
processo principal.
do
Observação :
1 Após a exclusão do registro do ajuntamento do processo, é realizada a
inclusão no registro de processos ajuntados excluídos.
Restrição :
possuam o mesma data e hora do ajuntamento principal, tipo de
ajuntamento , número do processo ajuntado e data e hora em que o
processo foi ajuntado.
Exemplo :
Temos o registro do ajuntamento do processo , número “9999-1030T13:56:00” e data e hora de ajuntamento “2015-10-30T13:56:00”
vinculados ao processo principal pelo qual possuem a data e hora do
ajuntamento em “2015-10-29T17:40:00” e tipo de ajuntamento “X”. Caso
existente.
Relacionamento:
1
Os atributos dhAjuntamento e tipoAjuntamento irão relacionar o ajuntamento
do processo excluído com o ajuntamento principal.
O atributo nroProcesso relaciona o número do processo ajuntado (excluído)
com o registro do processo.
Importante:
1 Só será realizado o envio do ajuntamento do processo por este serviço caso
o processo ajuntado não tenha sido desentranhado.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/ajuntamentosprocessosexcl
[{
"dhAjuntamento" : "9999-10-29T17:40:00",
"dhAjuntamentoProcesso" : "9999-10-29T17:40:00",
"dhDesentranhamento" : "9999-10-29T17:50:00",
"iDhAjuntamentos" : "9999-10-29T17:50:00",
"iUsuariosDesentranhamento" : "juliocps",
"nroProcesso" : "201561419999990000002",
"tipoAjuntamento" : "X"
}]
4.37 - Migrando documento retirado do processo
informações referente ao registro de controle de retirada e devolução de
documentos ao processo para preenchimento do banco de dados.
Ajuntamentos de Processos (Processos >> Entrega de documentos >> aba
Retiradas/Devoluções).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
“999900010099990000001” .
Mensagem
descricaoDocument
o
String
permite nulo
tamanho mínimo: 1
Nome do documento.
iProtocolos
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 10
numéricos
Registro do protocolo.
iUsuarios
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Usuário responsável.
dataRetirada
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data da retirada do document.
dataDevolucao
String
permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data da devolução do document.
observacaoRetirada String
permite nulo
tamanho mínimo : 1
Observação da retirada.
observacaoDevoluc
ao
String
permite nulo
tamanho mínimo: 1
Observação da devolução.
Restrição :
possuam o mesmo número do processo, descrição do documento e código
do protocolo.
Exemplo :
Temos o registro do processo número “9999-10-30T13:56:00” e descrição
do documento “CNPJ” e protocolo 32. Caso esta informação seja enviada
novamente, será retornada uma mensagem de validação, vista pelo método
Get, comunicando que este registro já é existente.
Relacionamento:
1 O atributo iProtocolos juntamente com os atributos nroProcesso e
descricaoDocumento identificam o registro do processo.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/documentosretirados
4.38 - Migrando lote em andamento
informações referente ao registro de migração dos andamentos realizados por
processos agrupados em lote para preenchimento da tabela do banco de
dados.
Os atributos enviados podem ser conferidos por meio do relatório de
acompanhamento
de
processo
(Relatórios
>>
Gerenciais
>>
Acompanhamentos de Processos>> Informar o lote e o ano).
Protocolo Fly
Tipo de dados
Mensagem
iLotes
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 10
numéricos
iAnos
String
não permite nulo
tamanho mínimo: 4
tamanho máximo: 4
numéricos
nroProcesso
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 24
dhAndamento
String
não permite nulo
“Data de
andamento
tamanho mínimo: 19
inválida ou
tamanho máximo: 19
não
formato : yyyy-mm-ddThh:mm:ss informada.
Uma data
deve ter o
Exemplo
:
formato
“dhAndamento”:”9999-01yyyy-MM01T01:00:00”
ddTHH:mm:
ss”
Atributos chaves : iLotes, iAnos, nroProcesso, dhAndamento
Restrição:
possuam o mesmo número do processo, código do lote, ano do lote e data
e hora do andamento.
Exemplo :
Temos o registro do processo número “2015-09-30T13:56:00” , código do
lote, código do ano e data e hora do andamento “2015-10-30T13:56:00”.
Relacionamento:
1 Os atributos iLotes e iAnos identificam o registro do lote.
O atributo nroProcesso juntamente com os atributos iLotes e iAnos
identificam o registro do lote.
O atributo dhAndamento juntamente com o atributo nroProcesso identificam
o registro de andamento.
Path:http: //e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/lotesandamentos
4.39 - Migrando permissão do parecer
informações referente ao registro das permissões dos usuários quanto a
interação com o parecer concedido para preenchimento da tabela do banco de
dados.
Pareceres (Processos >> Pareceres >> Aba Usuários).
Protocolo Fly
nroProcesso
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
processo.
dhParecer
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
Data e hora do parecer.
iUsuarios
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
Restrição :
Mensagem
possuam o mesmo número do processo, data e hora do parecer e nome do
usuário.
Exemplo:
Temos o registro do processo número “2015-09-30T13:56:00” , data e hora
do parecer “2015-10-30T13:56:00” e usuário “teste”.
Relacionamento:
1 O atributo nroProcesso identifica o registro do processo.
O atributo dhParecer juntamente com o atributo nroProcesso identificam o
processo no registro de parecer.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/parecerespermissoes
4.40 - Migrando anexo do parecer
informações referente ao registro de documentos entregues e vinculados ao
processo para preenchimento da tabela do banco de dados.
Consulta Geral (Consultas >> Consulta Geral >> Pareceres >> Coluna Anexo).
Protocolo Fly
nroProcesso
Tipo de dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 24
Informação referente ao número
do processo.
dhParecer
String
não permite nulo
tamanho mínimo: 19
tamanho máximo: 19
“Data de
parecer
inválido ou
não
formato : yyyy-mm-ddThh:mm:ss informada.
Uma data
Exemplo: “dhParecer”:”9999-01- deve ter o
formato
01T01:00:00”
yyyy-MMddTHH:mm:
ss”
Restrição:
possuam o mesmo número do processo e data e hora do parecer.
Relacionamento:
1 O atributo nroProcesso identifica o registro do processo.
1. Os atributos dhParecer e nroProcesso identificam o registro do parecer.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/pareceresanexos
[{
"nroProcesso" : "201561419999990000012",
"dhParecer" : "9999-10-30T08:28:38"
}]
4.41 - Migrando solicitação de documento
informações referente ao registro de documentos a serem solicitados conforme
a solicitação cadastrada para preenchimento da tabela do banco de dados.
Cadastro de Solicitações (Cadastros >> Solicitações >> Documentos).
Protocolo Fly
grupodescricao
Tipo de
dados
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Mensagem
Informação referente ao nome
do grupo da solicitação.
String
não permite nulo
tamanho mínimo : 1
tamanho máximo: 20
da solicitação.
descricaoDocumento
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 14
do documento.
tipoPessoa
String
não permite nulo
aceita somente J|F|A|O
J - Jurídica
F - Física
A -Física e Jurídica
O - Outras
Restrição:
possuam a mesma descrição de grupo, descrição da solicitação e
descrição do documento.
Exemplo:
Temos o registro da descrição do grupo “Teste” e descrição da solicitação
“Teste” e descrição do documento “CNPJ”. Caso estas informações sejam
enviadas novamente, será retornada uma mensagem de validação, vista
Relacionamento:
1 Os atrbutos grupoDescricao e descricaoSolicitacao identificam o registro
da solicitação.
O atributo de descricaoDocumento identifica o registro do documento.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesdocumentos
4.42 - Migrando informações adicionais da abertura de processo
informações referente ao registros das informações adicionais da solicitação de
abertura de processo.
Cadastro de Abertura de Protocolo (Processos >> Abertura >> Informações
adicionais).
Protocolo Fly
grupoDescricao
Tipo de
dados
String
1 não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Descrição do grupo da solicitação.
descricaoSolicita
cao
String
1 não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
Informação referente a descrição da
solicitação de processo.
sequencia
String
1 não permite nulo
tamanho mínimo : 1
tamanho máximo : 3
Utilizado
na
busca
de
uma
solicitação adicional juntamento com
a descrição da solicitação e o grupo.
texto
String
1 tamanho mínimo: 1
Informação de campo para texto
dh
String
1 permite nulo
Mensagem
Exemplo: “dh:9999-03-01T01:02:03”
Informação de campo para data e/ou
hora.
numero
String
1 permite nulo
tamanho mínimo : 1
Informação de campo para números.
nroProcesso
String
permite nulo.
tamanho mínimo: 1
tamanho máximo: 24
processo.
iProtocolos
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 10
numéricos.
Exemplo: “iProtocolos” : “12345”
protocolo.
inscricao
String
dhSolicitacao
String
não permite nulo
Validação do
CPF/CNPJ:
tamanho mínimo: 1
"O valor
tamanho máximo: 14
'número do
documento’
Este atributo recebe a informação do não é um
CPF/CNPJ e portanto deverá ser CPF ou
preenchido com 11 ou 14 caracteres CNPJ
válido"
numéricos.
não permite nulo
“Data de
solicitação
inválida ou
não
informada.
Uma data
deve ter o
Exemplo : “dhSolicitacao”: “9999-03- formato
yyyy-MM01T01:02:03”
ddTHH:mm:
ss”
Relacionamento:
1 O atributo grupoDescricao identifica o registro do documento.
1. Os atributos descricaoSolicitacao e grupoDescricao identificam o registro da
solicitação.
2. Os atributos sequencia e descricaoSolicitacao identificam o registro da
solicitação adicional.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesadicionaisab
[{
"grupoDescricao": "GRUPO CENTRAL",
"descricaoSolicitacao": "Solicitação Ferias",
"sequencia": "1",
"texto": "Teste",
"numero": "1",
"nroProcesso": "201561419999990000001",
"iProtocolos": "1",
"inscricao": "56829165229",
"dhSolicitacao": "9999-09-21T10:55:55"
}]
4.43 - Migrando documento da solicitação
informações referente ao registro de documentos vinculados as solicitações
para preenchimento da tabela do banco de dados.
Consulta Geral (Consultas >> Consulta Geral >> Inf. adicionais).
Protocolo Fly
descricaoSolicita
coes
Tipo de
dados
String
Mensagem
não permite nulo
tamanho mínimo: 1
tamanho máximo: 20
Pesquisa uma solicitação baseado
nessa descrição e e conforme a
informação da descrição do grupo.
grupoDescricao
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
Obs: Para inserir esta informação, o
grupo de solicitação já deverá estar
inserido na Tela de Cadastro de
Grupo de Solicitações.
Pesquisa um grupo de descrição.
inscricao
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 14
Este atributo recebe a informação do
CPF/CNPJ e portanto deverá ser
preenchido com 11 ou 14 caracteres
numéricos.
dhSolicitacao
String
descricaoDocum
ento
String
não permite nulo
“Data de
solicitação
inválida ou
não
informada.
Uma data
deve ter o
Informação referente a data e a hora
formato
em que foi realizada a solicitação
yyyy-MMpela pessoa solicitante.
ddTHH:mm:
ss”
Exemplo : “dhSolicitacao”:”" 9999-0101T01:00:00"
não permite nulo.
tamanho mínimo : 1
documento a serem adicionados no
registro de solicitações.
Restrição:
possuam a mesma descrição de grupo, descrição da solicitação e descrição
do documento, inscrição e data e hora da solicitação.
Relacionamento:
1 Os atributos descricaoSolicitacoes e grupoDescricao identificam o registro
da solicitação.
Os atributos inscricao, descricaoSolicitacoes e dhSolicitacao identificam o
registro de solicitação de abertura.
O atributo descricaoDocumento identifica o registro de documento.
Path:http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/solicitacoesaberturasdocs
Exemplo :
[{
"descricaoSolicitacoes":"Revisão de Cálculo",
"grupoDescricao":"Arrecadação",
"inscricao":"99999999000191",
"dhSolicitacao":"9999-03-01T01:02:03",
"descricaoDocumento":"RG"
}]
4.44 - Migrando taxa da guia de pagamento
informações referente ao registro das guias geradas com as taxas para
Protocolo Fly
nroBaixa
Tipo de dados
String
permite nulo
tamanho mínimo : 1
tamanho máximo: 10
Mensagem
numéricos
valor mínimo : 1
Código que identifica a guia de
pagamento.
descricaoTaxa
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 50
vlTaxa
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlTaxa”:”10”
“vlTaxa”:”10.00”
“vlTaxa”:”10.0000”
vlMulta
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlMulta”:”10.0000”
vlJuro
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
“vlJuro”:”10.00”
“vlJuro”:”10.0000”
vlCorrecao
String
permite nulo
tamanho mínimo: 1
tamanho máximo: 16
formato :”###########.####”
os exemplos abaixo:
Restrição:
possuam o mesmo número de baixa e descrição da taxa.
Relacionamento:
1 O atributo nroBaixa identifica o registro da guia de pagamento.
O atributo descricaoTaxa identifica o registro da taxa.
Path:http://e-gov.betha.com.br/arrecadacao-conversao-services/rest/conversao/guiastaxas
4.45 - Migrando guia de pagamento cancelada
Neste tópico iremos abordar a forma com que será estruturadas as
informações referente o registro das guias que tiveram sua situação alterada
para cancelada.
Situação das Guias de Pagamento (Relatórios >> Gerenciais >> Guias de
pagamento canceladas).
Protocolo Fly
nroBaixa
Tipo de
dados
String
não permite nulo
Mensagem
tamanho mínimo : 1
tamanho máximo: 10
valor mínimo: 1
Código que identifica a guia de
pagamento no arquivo bancário.
iUsuariosCanc
String
não permite nulo
tamanho mínimo: 1
tamanho máximo: 16
dhCancelamento
String
Motivo
String
não permite nulo
“Data de
cancelament
tamanho mínimo: 19
o inválida ou
tamanho máximo: 19
não
informada.
Uma data
deve ter o
Exemplo : “dhCancelamento”:”9999formato
01-01T01:00:00”
yyyy-MMddTHH:mm:
ss”
não permite nulo
tamanho mínimo: 1
Restrição:
possuam o mesmo número de baixa.
Relacionamento:
1 O atributo nroBaixa identifica o registro da guia de pagamento.
Path: http://e-gov.betha.com.br/arrecadacao-conversaoservices/rest/conversao/guiascanceladasprotocolo

Regras da migração dos dados para o sistema

Transcrição

Documentos relacionados

programação

Lista5-INE5603-Strings

2ª lista - Departamento de Matemática - PUC-Rio

Aula05 - String

(Microsoft PowerPoint - algoritmo II

Teste 7:00h – 33F 9:00h – 33G

dicas técnicas

Boletim Operário 71 Caxias do Sul, 06 de agosto de 2010.

¢¡¤£¦¥ §¢¨¦©

Programaç˜ao Funcional (LMCC)