Integração com Terceiros
Visão Geral
O serviço de integração disponibilizado permite que sejam buscadas informações do nosso banco de dados a fim de criação e atualização de registros criados no Procuradoria (Cloud), onde serão disponibilizados 3 objetos que serão retornados em um array.
Cada serviço deve ser acessado utilizando os endpoints fornecidos neste manual, recebendo como parâmetro a data base da busca pelos registros ou o id da dívida, que filtram os registros que foram criados ou alterados a partir da data ou relativo àquele id.
Cada um desses objetos tem sua parte fundamental no processo dentro do Procuradoria, acessando os endpoints exemplificados abaixo:
Tabela 2 - objetos:
Configuração
Para utilizar a integração é necessário que no primeiro acesso seja criado uma chave pública no sistema Procuradoria (Cloud), acessando o menu Utilitários > Gerenciador de acessos > Aplicações.
|
|---|
|
|---|
Ao confirmar será gerado um código de acesso, este deve ser utilizado no header da requisição RESTI.
|
|---|
Como utilizar
Pegando como exemplo o objeto ExecucoesFiscais, ao realizar uma requisição será necessário enviar no header as informações contidas no exemplo abaixo e no final do manual.
Ao enviar a requisição para o endpoint passado na tabela 2 acima, com os parâmetros conforme demonstrados a seguir, serão retornadas todas as execuções fiscais que foram criadas ou alteradas a partir da dataBase em diante. O resultado terá a estrutura conforme os objetos descritos e terá formato JSON possuindo controle da paginação.
Os parâmetros limit e offset controlam a quantidade de registros seguidos do filtro da dataBase, indicado para realizar o controle das integrações. O controle da requisição deve ser utilizado da seguinte forma - abaixo dois exemplos:
ExecucoesFiscais:
https://procuradoria.suite.betha.cloud/integracoes/v1/execucoes-dividas-terceiros?offset=0&limit=100&filter=dataBase>="2023-01-01T00:00:00.000"EnvioSaldo:
https://procuradoria.test.suite.betha.cloud/integracoes/v1/envio-saldo-terceiros?filter=idDivida=3941085
Em se tratando do objeto **ExecucoesFiscais** será retornado o seguinte JSON:
{
"offset": 0,
"limit": 20,
"total": 1,
"hasNext": false,
"content": [
{
"id": 1,
"idDividas": 1,
"ano": 2023,
"codigoExecucao": 1,
"anoLivro": 1,
"dataVencimento": "2023-01-01",
"descricaoCreditoTributario": "Descrição Crédito Tributario",
"descricaoReceita": "Descrição Crédito Tributario",
"folha": 1,
"idCreditoTributario": 1,
"idReceita": 1,
"livro": 1,
"numeroInscricao": 1,
"dataInscricao": "2023-01-01",
"numeroParcela": 1,
"numeroPosicao": 1,
"valorCorrecao": 9.00,
"valorJuro": 7.00,
"valorMulta": 8.00,
"valorTributo": 66.67,
"dataBase": "2023-01-01"
}
]
}
A documentação a seguir tem como finalidade fornecer orientações e diretrizes para a integração de processos que envolvam execução fiscal, como exportação de dados, recebimentos e atualizações de execuções.
A integração tem como objetivo a interação dos sistemas de Procuradoria, visando o fluxo de informações em cinco pontos chave.
Tipos de retorno
| Recebimento | Objeto | Endpoint |
|---|---|---|
| Execução fiscal | ExecucoesFiscais | https://procuradoria.suite.betha.cloud/integracoes/v1/documentos-dividas-terceiros |
| Dívidas da execução fiscal | ExecucoesDividas | https://procuradoria.suite.betha.cloud/integracoes/v1/execucoes-dividas-terceiros |
| CDA | DocumentosDividas | https://procuradoria.suite.betha.cloud/integracoes/v1/documentos-dividas-terceiros |
| Petição | DocumentosDividas | https://procuradoria.suite.betha.cloud/integracoes/v1/documentos-dividas-terceiros |
| Saldos | EnvioSaldo | https://procuradoria.suite.betha.cloud/integracoes/v1/envio-saldo-terceiros |
| Situação da Dívida | EnvioAlteracao | https://procuradoria.suite.betha.cloud/integracoes/v1/alteracao-situacao-divida-terceiros |
| Recebimento do Número de Processo | RecebimentoProcesso | https://procuradoria.suite.betha.cloud/integracoes/v1/recebimento-processo |
| Recebimento da Movimentação | RecebimentoMovimentacao | https://procuradoria.suite.betha.cloud/integracoes/v1/recebimento-movimentacao |
Serão disponibilizados endpoints que aceitam solicitações em formato JSON por meio de uma API REST. Para acessá-los é necessário incluir o token de autorização no cabeçalho de cada requisição. Os parâmetros esperados na requisição estão descritos na tabela 1.
Tabela 1 - Parâmetros
| Campo | Tipo | Descrição |
|---|---|---|
| dataBase | Date | Serão retornados todos os registros criados desde a data base. Este deve ser o parâmetro utilizado para todas as requisições, exceto a de saldo. |
| idDivida | numeric(19) | Serão retornadas as dívidas consultadas. Este deve ser o parâmetro utilizado na requisição do saldo. |
Envio das CDAs, petições iniciais, execuções fiscais e dívidas relacionadas
Se baseando na data base informada, será retornado um array com os registros que foram criados a partir deste parâmetro, conforme modelos apresentados nas tabelas abaixo.
Tabela 2 - Execuções Fiscais:
| Campo | Tipo | Descrição |
|---|---|---|
| codigoExecucao | numeric(19) | Código da execução. |
| processo | varchar(25) | Número do processo da execução fiscal que o tribunal retorna. |
| dataCadastro | Date | Data de cadastro do processo. |
| situacao | bpchar(1) | Situação do processo (valor, descrição): “AJUIZAMENTO”:Aguardando Ajuizamento; “CANCELADO”: Cancelado; “TRAMITACAO”: Em Tramitação; “ENCERRADO”: Encerrado; “SUSPENSO”: Suspenso. |
| idTribunal | numeric(10) | Código de identificação do tribunal. |
| descricaoTribunal | varchar(500) | Descrição/nome do tribunal. |
| idComarca | numeric(10) | Código de identificação da comarca. |
| descricaoComarca | varchar(500) | Descrição/nome da comarca. |
| IdVara | numeric(10) | Código de identificação da vara. |
| descricaoVara | varchar(500) | Descrição/nome da vara. |
| cpfCnpjExecutado | varchar(14) | CPF/CNPJ do executado. |
| nomeExecutado | varchar(500) | Descrição/nome do executado. |
| cpfCnpjAdvogado | varchar(14) | CPF do advogado. |
| nomeAdvogado | varchar(500) | Descrição/nome do advogado. |
| cpfCnpjExequente | varchar(14) | CNPJ do exequente. |
| nomeExequente | varchar(500) | Descrição/nome do exequente. |
| cpfCnpjProcurador | varchar(14) | CPF do procurador. |
| area | varchar(500) | Descrição da área. |
| assunto | varchar(500) | Descrição do assunto. |
| classe | varchar(500) | Descrição da classe. |
| msgForum | varchar(500) | Mensagem retornada pelo tribunal. |
| procedimento | bpchar(2) | Procedimentos: “ES”: Especial; “OR”: Ordinario; “SM”: Sumário; “SS”: Sumaríssimo; |
| segredoJustica | bpchar(1) | Se é um segredo de Justiça: “SIM”: Sim; “NAO”: Não; |
| pedidoUrgencia | bpchar(1) | Se é um pedido de urgência: “SIM”: Sim; “NAO”: Não; |
| valorCausa | numeric(15, 2) | Valor da causa. |
| honorarios | numeric(15, 2) | Valor de honorários. |
| idPeticao | numeric(10) | Código de identificação da Petição. |
| anoPeticao | numeric(10) | Ano da Petição. |
| dataBase | Date | Data base utilizado para a integração. |
Tabela 3 - Execuções Dívidas:
| Campo | Tipo | Descrição |
|---|---|---|
| id | numeric(19) | Código de identificação da dívida. |
| ano | numeric(4) | Ano da dívida. |
| codigoExecucao | numeric(19) | Código da execução. |
| anoLivro | numeric(4) | Ano do livro. |
| dataVencimento | Date | Data de vencimento da dívida. |
| descricaoCreditoTributario | varchar(500) | Descrição do crédito. |
| descricaoReceita | varchar(500) | Descrição do crédito. |
| folha | numeric(9) | Número da folha. |
| idCreditoTributario | numeric(19) | Código de identificação do crédito tributário. |
| idReceita | numeric(19) | Código de identificação da receita. |
| livro | numeric(9) | Número do livro. |
| numeroInscricao | numeric(9) | Número de inscrição da dívida. |
| dataInscricao | Date | Número de inscrição da dívida. |
| dataInscricao | Date | Data de inscrição da dívida. |
| numeroParcela | numeric(5) | Número da parcela da dívida. |
| numeroPosicao | numeric(9) | Número da posição. |
| valorCorrecao | numeric(16,2) | Valor da correção. |
| valorJuros | numeric(16,2) | Valor dos juros. |
| valorMulta | numeric(16,2) | Valor da multa. |
| valorTributo | numeric(16,2) | Valor do tributo. |
| dataBase | Date | Data base utilizado para a integração. |
Tabela 4 - Documentos Dívida:
| Campo | Tipo | Descrição |
|---|---|---|
| anoDocumento | numeric(10) | Ano do documento. |
| idDocumento | numeric(10) | Número do documento. |
| tipoDocumento | varchar(1) | Tipo de documento: "C": Certidão de Dívida Ativa; "P": Petição Inicial. |
| urlDocumento | varchar(500) | URL para download do documento |
| nomePessoa | varchar (500) | Nome do executado da dívida |
| cpfCnpjPessoa | varchar(14) | CPF/CNPJ do executado da dívida. |
| dataCanc | Date | Data de cancelamento do documento. |
| dataEmissao | Date | Data da emissão do documento. |
| dataValidade | Date | Data de validade do documento. |
| valorCorrecao | numeric(14,2) | Valor da correção. |
| valorJuro | numeric(14,2) | Valor dos juros. |
| valorMulta | numeric(14,2) | Valor das multas. |
| valorTributo | numeric(14,2) | Valor do tributo. |
| valorTotal | numeric(14,2) | Valor total do documento. |
| dataBase | Date | Data base utilizado para a integração. |
| inscricaoImobiliaria | varchar(20) | Número da inscrição imobiliária do imóvel. |
| nomeCorresponsavel | varchar(100) | Nome do corresponsável. |
| cpfCnpjCorresponsavel | varchar (50) | CPF/CNPJ do corresponsável. |
| enderecoCorresponsavel | varchar(250) | Endereço do corresponsável. |
Envio de saldo
Se baseando no id da dívida, será retornado um array com os registros que foram criados a partir deste parâmetro, conforme modelos apresentados nas tabelas abaixo.
Tabela 5 - EnvioSaldo
| Campo | Tipo | Descrição |
|---|---|---|
| idDivida | numeric(19) | Código da dívida que será consultada. |
| idReceita | numeric(19) | Código da identificação da receita. |
| valorJuros | numeric(16,2) | Valor dos juros. |
| valorSaldo | numeric(16,2) | Valor do saldo atualizado da dívida. |
| valorMulta | numeric(16,2) | Valor da multa. |
| valorCorrecao | numeric(16,2) | Valor da correção. |
Envio de alteração da situação
Se baseando na data base informada, será retornado um array com os registros que foram criados a partir deste parâmetro, conforme modelos apresentados nas tabelas abaixo.
Tabela 6 - EnvioAlteracao
| Campo | Tipo | Descrição |
|---|---|---|
| idDivida | numeric(19) | Código da dívida que terá situação alterada. |
| situacao | varchar(1) | Situações da dívida: ABERTO; CANCELADA; PAGA; PARCELADO; PRESCRITA; REMIDA; SUSPENSA. |
| valorSaldo | numeric (16,2) | Valor do tributo da dívida. |
| dataBase | Date | Data base utilizado para a integração |
Recebimento do número do processo
Esse serviço é uma entrada de dados, uma requisição POST, em que o sistema terceiro poderá informar um ou mais números do processo da execução, essa rotina irá receber um conjunto de dados, esperando recebê-los como parâmetro, conforme a tabela 7 abaixo, e gravará o número de processo na execução fiscal de código informado e retornará o campo de mensagem preenchido com a situação do processamento individualmente, o campo mensagemRetorno não é necessário ser preenchido pelo sistema terceiro.
Tabela 7 - RecebimentoProcesso
| Campo | Tipo | Descrição |
|---|---|---|
| codigoExecucao | numeric(19) | Código da Execução Fiscal que será alterada. |
| processo | varchar(20) | Número do processo. |
| mensagemRetorno | varchar(100) | Mensagem contendo a situação da execução informada. |
Recebimento das Movimentações do Processo
Serviço que irá disponibilizar uma entrada de dados POST que será utilizada para inserir movimentações nos processos existentes. O sistema Betha irá receber os parâmetros conforme descritos na tabela 8 e devolvido com as informações de cada processamento.
Tabela 8 - RecebimentoMovimentacao
| Campo | Tipo | Descrição |
|---|---|---|
| codigoExecucaoFiscal | numeric(19) | Código da execução que receberá a movimentação.. |
| dataMovimentacao | timestamp(18) | Data da movimentação do processo. |
| codigoMovimentacao | numeric(19) | Código do tipo de movimentação, listagem padrão disponível na tabela 9. |
| comentario | varchar(4000) | Comentário da movimentação. |
| protocolo | varchar(50) | Protocolo da integração. |
Os campos codigoExecucalFiscal, dataMovimentacao e codigoMovimentacao são obrigatórios para o processamento. As informações referentes às movimentações não padrões podem ser obtidas na fonte de dados “tiposMovimentacoes.buscar”. As movimentações padrões do sistema são as demonstradas abaixo, na tabela 9:
Tabela 9 - codigoMovimentacao
| id | Descrição0 | Altera situação | Situação |
|---|---|---|---|
| 2 | Petição Inicial Emitida | N | |
| 3 | Dívida Removida da Execução Fiscal | N | |
| 4 | Petição Intermediária Cancelada | N | |
| 5 | Petição Intermediária Reativada | N | |
| 6 | Execução Fiscal Cancelada pelo Sistema | S | C |
| 7 | Execução Fiscal Reativada pelo Sistema | S | T |
| 8 | Penhora Judicial Deferida | N | |
| 9 | Penhora Judicial Indeferida | N | |
| 310 | Ajuizamento Realizado com Sucesso | S | T |
| 311 | Ajuizamento Não Realizado - Inconsistência | N | |
| 312 | Peticionamento Intermediário Realizado com Sucesso | N | |
| 313 | Peticionamento Intermediário Não Realizado - Inconsistência | N | |
| 959 | Petição Intermediária Emitida | N | |
| 2780 | Suspensão cancelada. Situação anterior reativada para o processo | N | |
| 3067 | Captura Automática de Movimentações | N | |
| 4110 | Envio Realizado com Sucesso | N | |
| 4111 | Envio Não Realizado - Inconsistência | N | |
| 4158 | Ajuizamento Realizado com Sucesso | S | T |
| 4159 | Ajuizamento Não Realizado - Inconsistência | N | |
| 4160 | Peticionamento Intermediário Realizado com Sucesso | N | |
| 4161 | Peticionamento Intermediário Não Realizado - Inconsistência | N | |
| 4162 | Petição Intermediária Emitida | N | |
| 4163 | Suspensão cancelada. Situação anterior reativada para o processo. | N | |
| 4164 | Captura Automática de Movimentações | N | |
| 5562 | Integração Terceiros | N | |
| 6237 | Intimação Eletrônica | N |
Recebimento do Anexo da Movimentação
Este serviço é uma entrada de dados, uma requisição POST, em que o sistema terceiro poderá informar o arquivo codificado em base64 para que seja vinculado a movimentação do processo no sistema - mencionada no item 5, esse serviço pode ser utilizado tanto com movimentações criadas por terceiros ou não.
É importante ressaltar que:
- o sistema será capaz de processar somente um arquivo em uma única requisição;
- o sistema será capaz de processar somente um objeto por requisição, não aceitando listas ou vários objetos de anexo;
- não será possível inserir um anexo duplicado, de mesmo nome, tipo para a mesma movimentação;
- o nome do arquivo não deve exceder 250 caracteres.
Tabela 10 - RecebimentoMovimentacaoAnexo
| Campo | Tipo | Descrição |
|---|---|---|
| idMovimentacao | numeric(16) | Id da movimentação que terá o anexo vinculado. |
| tipoArquivo | varchar(5) | Extensão do arquivo. |
| nomeArquivo | varchar(250) | Nome do arquivo. |
| arquivo64 | blob | Arquivo codificado em base64 com limite de 10MB. |
Consultando dados de protesto e/ou ajuizamento
Através do serviço resumoDivida, é possível consultar dados de protesto e ajuizamento da divida.
Serão apresentadas informações como data, número de processo, situação, número de CDA, número da petição, entre outras.
Documentação dos serviços
OBS: É necessário realizar a troca do campo Select a spec para Procuradoria - Integração terceiros.