Últimas atualizações do documento

Versão do documento Data da atualização Descrição da atualização
v1.05 14/10/2026 - Correção de URLs, nomes de campos e descrições incorretas - Adição de campos faltantes (comissaoContratacao, dataInicioVigenciaARP, dataFimVigenciaARP) - Documentação de endpoints não documentados: Excluir PC, Inserir Lista de Licitantes, Excluir IJ, Listar IJ, Inserir Lista de Partes do IJ, Download de Documento do IJ (sistema), Execução de IJ (CRUD), Obra de IJ (CRUD), Download Público de Documentos
v1.04 30/04/2026 - Adicionar quadro especificando as últimas atualizações do documento - Atualização do sumário do documento para incluir os endpoints "4.1.16 Consultar Resultado da Contratação" e "4.2.12 Importar Itens do Instrumento Jurídico a partir de Processo de Contratação vinculado"
v1.03 10/04/2026 - Adicionar especificação dos endpoints "4.1.16 Consultar Resultado da Contratação" e "4.2.12 Importar Itens do Instrumento Jurídico a partir de Processo de Contratação vinculado"

Sumário

1. Introdução

2. Acesso ao RemessaTCEPE (API REST)

2.1. Credenciais para acesso

2.2. Autenticação e Autorização

2.3. Endereços de Acesso

3. Tabelas de Domínio

3.1. Estágio do Processo de Contratação

3.2. Regramento

3.3. Modalidade/Contratação Direta

3.4. Natureza do Objeto

3.5. Classificação do Objeto

3.6. Fonte de Publicação

3.7. Regime de Execução

3.8. Critério de Julgamento

3.9. Fundamentação Legal

3.10. Tipo de Documento do Processo de Contratação

3.11. Tipo de Pessoa (Licitante/Contratado)

3.12. Status de Habilitação do Licitante

3.13. Estágio do Instrumento Jurídico

3.14. Tipo do Instrumento Jurídico/Execução de Obras

3.15. Tipo do Termo do Instrumento Jurídico

3.16. Tipo de Documento do Instrumento Jurídico

3.17. Natureza da Obra

3.18. Tipo de Geometria da Obra

3.19. Situação da Obra

4. API de Serviços

4.1. Serviços para Processo de Contratação

4.1.1. Inserir Processo de Contratação

4.1.2. Atualizar Processo de Contratação

4.1.3. Consultar Processo de Contratação

4.1.4. Alterar Estágio do Processo de Contratação

4.1.5. Inserir Documento na Contratação

4.1.6. Excluir Documento da Contratação

4.1.7. Consultar Documentos da Contratação

4.1.8. Listar processos licitatórios

4.1.9. Download do Documento da Contratação

4.1.10. Inserir Orçamento na Contratação

4.1.11. Excluir Orçamento da Contratação

4.1.12. Inserir Licitante na Contratação

4.1.13. Atualizar Habilitação do Licitante da Contratação

4.1.14. Excluir Licitante da Contratação

4.1.15. Inserir Resultado na Contratação

4.1.16. Consultar Resultado da Contratação

4.1.17. Excluir Resultado da Contratação

4.1.18. Excluir Processo de Contratação

4.1.19. Inserir Lista de Licitantes na Contratação

4.2. Serviços para Instrumento Jurídico (ou Obras)

4.2.1. Inserir Instrumento Jurídico

4.2.2. Atualizar Instrumento Jurídico

4.2.3. Consultar Instrumentos Jurídico

4.2.4. Alterar Estágio do Instrumento Jurídico

4.2.5. Inserir Parte do Instrumento Jurídico

4.2.6. Excluir Parte do Instrumento Jurídico

4.2.7. Inserir Documento no Instrumento Jurídico

4.2.8. Excluir Documento do Instrumento Jurídico

4.2.9. Consultar Documentos do Instrumento Jurídico

4.2.10. Download do Documento do Instrumento Jurídico

4.2.11. Inserir Itens do Instrumento Jurídico

4.2.12. Importar Itens do Instrumento Jurídico a partir de Processo de Contratação vinculado

4.2.13. Excluir Itens do Instrumento Jurídico

4.2.14. Inserir Termo no Instrumento Jurídico

4.2.15. Excluir Termo do Instrumento Jurídico

4.2.16. Consultar Termos do Instrumento Jurídico

4.2.17. Excluir Instrumento Jurídico

4.2.18. Listar Instrumentos Jurídicos

4.2.19. Inserir Lista de Partes do Instrumento Jurídico

4.2.20. Download do Documento do Instrumento Jurídico (Sistema)

4.3. Serviços para Execução do Instrumento Jurídico

4.3.1. Inserir Execução

4.3.2. Atualizar Execução

4.3.3. Consultar Execução

4.3.4. Excluir Execução

4.4. Serviços para Obra do Instrumento Jurídico

4.4.1. Inserir Obra

4.4.2. Atualizar Obra

4.4.3. Consultar Obra

4.5. Serviços Públicos

4.5.1. Download Público de Documento

1. Introdução#

Este manual tem como objetivo fornecer orientações sobre a utilização da API REST do RemessaTCEPE, viabilizando a integração de sistemas externos para o envio e recebimento de dados conforme Resolução TC Nº 231/2024. É importante ressaltar que este documento não aborda as nuances das regras de negócio para o envio de dados por meio da API. Para informações detalhadas sobre essas regras, recomenda-se a consulta ao manual do usuário na página do RemessaTCEPE.

O protocolo utilizado na comunicação é o REST - Representational State Transfer e os dados transmitidos no corpo da requisição devem utilizar o formato JSON - JavaScript Object Notation. Informações enviadas no header devem utilizar o charset ISO-8859-1 e os arquivos devem ser codificados em charset UTF-8 (exemplo: arquivos .csv utilizados para importação do orçamento).

2. Acesso ao RemessaTCEPE (API REST)#

2.1 Credenciais para acesso#

Para visualizar as credenciais de acesso que possibilitam a utilização da API de integração, o gerenciador do RemessaTCEPE deve acessar o sistema utilizando seu login (CPF) e senha. Após autenticação, o usuário deve selecionar a Unidade Jurisdicionada de trabalho e posteriormente o menu “Suporte -> Credenciais de Acesso ao Webservice”.

Para empresas não jurisdicionadas ao TCE-PE, o acesso será concedido através de solicitação, cujo encaminhamento deverá ser realizado através do site do TCE-PE, em Principais Serviços -> Protocolar/Consultar Documentos.

2.2 Autenticação e Autorização#

Antes de utilizar qualquer endpoint disponível na API, o sistema ou aplicativo externo deverá autenticar-se utilizando login (CNPJ da UJ) e Senha definida previamente através do RemessaTCEPE. Esse processo permitirá a obtenção de um Access Token que terá validade de 5 minutos após sua emissão. Estando dentro de seu período de validade, o mesmo token pode ser utilizado para realizar uma ou várias operações no RemessaTCEPE. Uma vez expirado, será necessário realizar uma nova autenticação para obter um novo token.

Para receber o token, o aplicativo externo deverá acessar a API de login que retornará o valor no cabeçalho (header) da resposta HTTP (campo “Authorization”, texto que fica logo após o termo “Bearer”). Todas as demais operações realizadas a partir de requisições a APIs do RemessaTCEPE necessitam que esse campo de cabeçalho seja idêntico para autenticação e autorização. Além do token de acesso, todas as requisições também precisam enviar o parâmetro CodigoTCE_UJ no header contendo o código de 6 dígitos da Unidade Jurisdicionada que está realizando a operação.

Informações necessárias para autenticação e recebimento do Access Token:

Tipo de Autenticação: OAuth 2.0
URL: https://portal.tce.pe.gov.br/auth/realms/sistemas/protocol/openid-connect/token
Client ID: licon
Client Secret: 95f411e1-0793-4ad5-981f-1381d73eb480
Usuário: CNPJ da Unidade Jurisdicionada informado no Sistema de Cadastro de UJ
Senha: Chave definida no RemessaTCEPE pelo Gerenciador do sistema no ambiente de produção

2.3 Endereços de Acesso#

Com as credenciais de acesso previamente liberadas e utilizando os requisitos de segurança explicados na seção anterior, será possível acessar as seguintes URLs para realizar as operações descritas nesse documento:

Ambiente de Treinamento/Testes

Ambiente de Produção

Importante: será utilizado o termo ${BASE_URL} no restante deste documento para referenciar os links acima, a depender do ambiente

3. Tabelas de Domínio#

3.1 Estágio do Processo de Contratação#

3.2 Regramento#

3.3 Modalidade/Contratação Direta#

3.4 Natureza do Objeto#

3.5 Classificação do Objeto#

Aplicável apenas para Naturezas do Objeto “(id=7) Obras” e “(id=9) Serviços de Engenharia”

3.6 Fonte de Publicação#

3.7 Regime de Execução#

3.8 Critério de Julgamento#

3.10 Tipo de Documento do Processo de Contratação#

3.11 Tipo de Pessoa (Licitante/Contratado)#

3.12 Status de Habilitação do Licitante#

3.13 Estágio do Instrumento Jurídico#

3.14 Tipo do Instrumento Jurídico/Execução de Obras#

3.15 Tipo do Termo do Instrumento Jurídico#

3.16 Tipo de Documento do Instrumento Jurídico#

3.17 Natureza da Obra#

3.18 Tipo de Geometria da Obra#

3.19 Situação da Obra#

4. API de Serviços#

4.1 Serviços para Processo de Contratação#

4.1.1 Inserir Processo de Contratação#

Serviço que permite inserir um processo de contratação no RemessaTCEPE. A contratação pode ser um processo licitatório ou uma contratação direta. Os processos de contratação sempre são inseridos inicialmente com estágio “Em Rascunho (não enviado ao TCE)”. Ou seja, ainda não foram formalizados ao TCE-PE. Para serem consideradas adimplentes, as unidades jurisdicionadas devem, após inserir os processos de contratação, formalizá-los via método de mudança de estágio.

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios
Método HTTP POST
Exemplo de payload 
{
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000
}
Exemplo de retorno (corpo da requisição) 
{
  "id": 123,
  "estagioId": 1,
  "unidadeJurisdicionada": 0,
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000,
  "licitantes": [],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": null,
  "usuarioUltimaAtualizacao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "unidadeJurisdicionada",
      "mensagem": "O campo unidadeJurisdicionada é obrigatório"
    },
    {
      "campo": null,
      "mensagem": "Já existe processo de contratação com a mesma comissão de licitação, número do PC e ano do PC"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código gerado pelo RemessaTCEPE após inclusão do Processo de Contratação
estagioId Inteiro Não Saída Código do Estágio do Processo de Contratação (verificar Tabelas de Domínio). Esse campo retorna sempre 1 na inclusão
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
unidadeOrcamentaria Texto(6) Não Entrada / Saída Código da unidade orçamentária/subunidade responsável pela contratação. Preencher com null caso não se aplique
orgaoDemandanteDiferente Booleano Sim Entrada / Saída Informar se a unidade jurisdicionada solicitante da contratação é diferente da proprietária
orgaoDemandante Texto(6) Não Entrada / Saída Código da unidade jurisdicionada solicitante da contratação. Preencher com null caso não se aplique
regramentoId Inteiro Sim Entrada / Saída Código do Regramento do Processo de Contratação (verificar Tabelas de Domínio)
modalidadeId Inteiro Sim Entrada / Saída Código da Modalidade do Processo de Contratação (verificar Tabelas de Domínio)
numero Texto(100) Sim Entrada / Saída Número do Processo de Contratação
ano Inteiro Sim Entrada / Saída Ano do Processo de Contratação
numeroModalidade Texto(100) Sim Entrada / Saída Número da Modalidade do Processo de Contratação
anoModalidade Inteiro Sim Entrada / Saída Ano da Modalidade do Processo de Contratação
processoAdministrativo Texto(100) Não Entrada / Saída Número do Processo Administrativo do Processo de Contratação
srp Booleano Sim Entrada / Saída Informar se o processo de contratação é um sistema de registro de preços
comissaoContratacao Texto(100) Não Entrada / Saída Identificador Único da comissão de licitação caso a contratação seja feita por uma comissão
agenteContratacao Vetor Sim Entrada / Saída Vetor com os CPFs da comissão de licitação ou dos agentes responsáveis
objetoConformeEdital Texto(5000) Sim Entrada / Saída Texto com a descrição do objeto conforme edital publicado
naturezaId Inteiro Sim Entrada / Saída Código da Natureza do Processo de Contratação (verificar Tabelas de Domínio)
classificacaoId Inteiro Sim Entrada / Saída Código da Classificação do Processo de Contratação (verificar Tabelas de Domínio)
dataPublicacao Data Sim Entrada / Saída Data de publicação do processo de contratação no padrão AAAA-MM-DD
dataSessaoAbertura Data Não Entrada / Saída Data da sessão de abertura do processo de contratação no padrão AAAA-MM-DD
fontePublicacao Vetor Sim Entrada / Saída Vetor com os códigos das fontes de publicação onde o certame foi divulgado
linkOrigem Texto(5000) Sim Entrada / Saída Link da público onde o aviso de licitação ou contratação direta foi disponibilizado
regimeExecucaoId Inteiro Não Entrada / Saída Código do Regime de Execução da Obra ou Serviço de Engenharia (verificar Tabelas de Domínio)
criterioJulgamentoId Inteiro Sim Entrada / Saída Código do Critério de Julgamento do Processo de Contratação (verificar Tabelas de Domínio)
fundamentacaoLegalId Inteiro Não Entrada / Saída Fundamentação Legal da Dispensa ou Inexigibilidade (verificar Tabelas de Domínio)
formaAgrupamento Texto(4) Sim Entrada / Saída Forma de agrumaneto do objeto, podendo ser LOTE ou ITEM
orcamentoSigiloso Booleano Sim Entrada / Saída Informar se o orçamento é sigiloso
justificativaSigilo Texto(500) Não Entrada / Saída Caso o orçamento seja sigiloso, informar a justificativa do sigilo
concessaoME_EPP Booleano Sim Entrada / Saída Informar se o Processo de Contratação possui concessão de tratamento diferenciado para as ME e EPP (LC nº 123/2006)
receita Booleano Sim Entrada / Saída Informar se o objetivo do Processo de Contratação é a geração de receita para a administração pública
valorGlobal Decimal(20,4) Sim Entrada / Saída Valor global estimado do Processo de Contratação. Precisão de 4 dígitos decimais; Ex: 10000.0000;
licitantes Vetor Não Saída Vetor de licitantes vazio
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.2 Atualizar Processo de Contratação#

Serviço que permite atualização dos dados de um processo de contratação previamente cadastrado. Através deste endpoint não é possível atualizar o estágio.

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios
Método HTTP PUT
Exemplo de payload 
{
  "id": 123,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000
}
Exemplo de retorno (corpo da requisição) 
{
  "id": 123,
  "estagioId": 1,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000,
  "licitantes": [
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PF",
      "cpf": "10000000001"
    },
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:51:11.023",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "id do objeto é obrigatório"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Processo de Contratação. Deve ser utilizado para identificar o PC que será alterado
estagioId Inteiro Não Saída Código do Estágio do Processo de Contratação (verificar Tabelas de Domínio). Esse campo retorna sempre 1 na inclusão
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
unidadeOrcamentaria Texto(6) Não Entrada / Saída Código da unidade orçamentária/subunidade responsável pela contratação. Preencher com null caso não se aplique
orgaoDemandanteDiferente Booleano Sim Entrada / Saída Informar se a unidade jurisdicionada solicitante da contratação é diferente da proprietária
orgaoDemandante Texto(6) Não Entrada / Saída Código da unidade jurisdicionada solicitante da contratação. Preencher com null caso não se aplique
regramentoId Inteiro Sim Entrada / Saída Código do Regramento do Processo de Contratação (verificar Tabelas de Domínio)
modalidadeId Inteiro Sim Entrada / Saída Código da Modalidade do Processo de Contratação (verificar Tabelas de Domínio)
numero Texto(100) Sim Entrada / Saída Número do Processo de Contratação
ano Inteiro Sim Entrada / Saída Ano do Processo de Contratação
numeroModalidade Texto(100) Sim Entrada / Saída Número da Modalidade do Processo de Contratação
anoModalidade Inteiro Sim Entrada / Saída Ano da Modalidade do Processo de Contratação
processoAdministrativo Texto(100) Não Entrada / Saída Número do Processo Administrativo do Processo de Contratação
srp Booleano Sim Entrada / Saída Informar se o processo de contratação é um sistema de registro de preços
comissaoContratacao Texto(100) Não Entrada / Saída Identificador Único da comissão de licitação caso a contratação seja feita por uma comissão
agenteContratacao Vetor Sim Entrada / Saída Vetor com os CPFs da comissão de licitação ou dos agentes responsáveis
objetoConformeEdital Texto(5000) Sim Entrada / Saída Texto com a descrição do objeto conforme edital publicado
naturezaId Inteiro Sim Entrada / Saída Código da Natureza do Processo de Contratação (verificar Tabelas de Domínio)
classificacaoId Inteiro Sim Entrada / Saída Código da Classificação do Processo de Contratação (verificar Tabelas de Domínio)
dataPublicacao Data Sim Entrada / Saída Data de publicação do processo de contratação no padrão AAAA-MM-DD
dataSessaoAbertura Data Não Entrada / Saída Data da sessão de abertura do processo de contratação no padrão AAAA-MM-DD
fontePublicacao Vetor Sim Entrada / Saída Vetor com os códigos das fontes de publicação onde o certame foi divulgado
linkOrigem Texto(5000) Sim Entrada / Saída Link da público onde o aviso de licitação ou contratação direta foi disponibilizado
regimeExecucaoId Inteiro Não Entrada / Saída Código do Regime de Execução da Obra ou Serviço de Engenharia (verificar Tabelas de Domínio)
criterioJulgamentoId Inteiro Sim Entrada / Saída Código do Critério de Julgamento do Processo de Contratação (verificar Tabelas de Domínio)
fundamentacaoLegalId Inteiro Não Entrada / Saída Fundamentação Legal da Dispensa ou Inexigibilidade (verificar Tabelas de Domínio)
formaAgrupamento Texto(4) Sim Entrada / Saída Forma de agrumaneto do objeto, podendo ser LOTE ou ITEM
orcamentoSigiloso Booleano Sim Entrada / Saída Informar se o orçamento é sigiloso
justificativaSigilo Texto(500) Não Entrada / Saída Caso o orçamento seja sigiloso, informar a justificativa do sigilo
concessaoME_EPP Booleano Sim Entrada / Saída Informar se o Processo de Contratação possui concessão de tratamento diferenciado para as ME e EPP (LC nº 123/2006)
receita Booleano Sim Entrada / Saída Informar se o objetivo do Processo de Contratação é a geração de receita para a administração pública
valorGlobal Decimal(20,4) Sim Entrada / Saída Valor global estimado do Processo de Contratação. Precisão de 4 dígitos decimais; Ex: 10000.0000;
licitantes Vetor Não Saída Vetor com os licitantes e seus detalhes
licitantes.statusHabilitacaoId Inteiro Não Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
licitantes.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitantes.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitantes.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitantes.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.3 Consultar Processo de Contratação#

Serviço para consultar processos de contratação previamente cadastrados no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/processo-licitatorios?id=123&unidadeJurisdicionada=999004
ou
${BASE_URL}/api/webservice/processo-licitatorios?numero=001&ano=2024&unidadeJurisdicionada=999004
ou
${BASE_URL}/api/webservice/processo-licitatorios?numeroModalidade=001&anoModalidade=2024&modalidadeId=6&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 123,
  "estagioId": 1,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000,
  "licitantes": [
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PF",
      "cpf": "10000000001"
    },
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:51:11.023",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Não existe processo de contratação com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Processo de Contratação
estagioId Inteiro Não Saída Código do Estágio do Processo de Contratação (verificar Tabelas de Domínio)
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
unidadeOrcamentaria Texto(6) Não Saída Código da unidade orçamentária/subunidade responsável pela contratação. Preencher com null caso não se aplique
orgaoDemandanteDiferente Booleano Não Saída Informar se a unidade jurisdicionada solicitante da contratação é diferente da proprietária
orgaoDemandante Texto(6) Não Saída Código da unidade jurisdicionada solicitante da contratação. Preencher com null caso não se aplique
regramentoId Inteiro Não Saída Código do Regramento do Processo de Contratação (verificar Tabelas de Domínio)
modalidadeId Inteiro Não Saída Código da Modalidade do Processo de Contratação (verificar Tabelas de Domínio)
numero Texto(100) Não Saída Número do Processo de Contratação
ano Inteiro Não Saída Ano do Processo de Contratação
numeroModalidade Texto(100) Não Saída Número da Modalidade do Processo de Contratação
anoModalidade Inteiro Não Saída Ano da Modalidade do Processo de Contratação
processoAdministrativo Texto(100) Não Saída Número do Processo Administrativo do Processo de Contratação
srp Booleano Não Saída Informar se o processo de contratação é um sistema de registro de preços
comissaoContratacao Texto(100) Não Saída Identificador Único da comissão de licitação caso a contratação seja feita por uma comissão
agenteContratacao Vetor Não Saída Vetor com os CPFs da comissão de licitação ou dos agentes responsáveis
objetoConformeEdital Texto(5000) Não Saída Texto com a descrição do objeto conforme edital publicado
naturezaId Inteiro Não Saída Código da Natureza do Processo de Contratação (verificar Tabelas de Domínio)
classificacaoId Inteiro Não Saída Código da Classificação do Processo de Contratação (verificar Tabelas de Domínio)
dataPublicacao Data Não Saída Data de publicação do processo de contratação no padrão AAAA-MM-DD
dataSessaoAbertura Data Não Saída Data da sessão de abertura do processo de contratação no padrão AAAA-MM-DD
fontePublicacao Vetor Não Saída Vetor com os códigos das fontes de publicação onde o certame foi divulgado
linkOrigem Texto(5000) Não Saída Link da público onde o aviso de licitação ou contratação direta foi disponibilizado
regimeExecucaoId Inteiro Não Saída Código do Regime de Execução da Obra ou Serviço de Engenharia (verificar Tabelas de Domínio)
criterioJulgamentoId Inteiro Não Saída Código do Critério de Julgamento do Processo de Contratação (verificar Tabelas de Domínio)
fundamentacaoLegalId Inteiro Não Saída Fundamentação Legal da Dispensa ou Inexigibilidade (verificar Tabelas de Domínio)
formaAgrupamento Texto(4) Não Saída Forma de agrumaneto do objeto, podendo ser LOTE ou ITEM
orcamentoSigiloso Booleano Não Saída Informar se o orçamento é sigiloso
justificativaSigilo Texto(500) Não Saída Caso o orçamento seja sigiloso, informar a justificativa do sigilo
concessaoME_EPP Booleano Não Saída Informar se o Processo de Contratação possui concessão de tratamento diferenciado para as ME e EPP (LC nº 123/2006)
receita Booleano Não Saída Informar se o objetivo do Processo de Contratação é a geração de receita para a administração pública
valorGlobal Decimal(20,4) Não Saída Valor global estimado do Processo de Contratação. Precisão de 4 dígitos decimais; Ex: 10000.0000;
licitantes Vetor Não Saída Vetor com os licitantes e seus detalhes
licitantes.statusHabilitacaoId Inteiro Não Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
licitantes.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitantes.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitantes.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitantes.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.4 Alterar Estágio do Processo de Contratação#

Serviço que permite alterar o estágio de um processo de contratação. Os processos de contratação sempre são inseridos inicialmente com estágio “Em Rascunho (não enviado ao TCE)”. Ou seja, ainda não foram formalizados ao TCE-PE. Para serem consideradas adimplentes, as unidades jurisdicionadas devem formalizar todos os processos de contratação ao TCE-PE através desse método.

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios/alterar-estagio
Método HTTP PUT
Exemplo de payload 
{
  "id": 123,
  "unidadeJurisdicionada": "999004",
  "estagioId": 3,
  "justificativa": "Processo suspenso por decisão…"
}
Exemplo de retorno (sucesso) 
{
  "id": 123,
  "estagioId": 3,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "orgaoDemandanteDiferente": false,
  "orgaoDemandante": null,
  "regramentoId": 2,
  "modalidadeId": 6,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "processoAdministrativo": "TCE.PE.PA.001",
  "srp": false,
  "comissaoContratacao": "CPL01/2024",
  "agenteContratacao": ["99999999999"],
  "objetoConformeEdital": "Contratação de empresa especializada…",
  "naturezaId": 3,
  "classificacaoId": null,
  "dataPublicacao": "2024-05-02",
  "dataSessaoAbertura": "2024-07-02",
  "fontePublicacao": [1, 2],
  "linkOrigem": "https://sistemas.tce.pe.gov.br/internet/DiarioOficial!download.action?abrirJanela=true&data=2/5/2024",
  "regimeExecucaoId": null,
  "criterioJulgamentoId": 1,
  "fundamentacaoLegalId": null,
  "formaAgrupamento": "LOTE",
  "orcamentoSigiloso": false,
  "justificativaSigilo": null,
  "concessaoME_EPP": true,
  "receita": false,
  "valorGlobal": 100000.0000,
  "licitantes": [
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PF",
      "cpf": "10000000001"
    },
    {
      "statusHabilitacaoId": 1,
      "tipoLicitanteId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:51:11.023",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "justificativa",
      "mensagem": "Campo justificativa é obrigatório"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Processo de Contratação. Deve ser utilizado para identificar o PC que será alterado
estagioId Inteiro Sim Entrada / Saída Código do novo Estágio do Processo de Contratação (verificar Tabelas de Domínio)
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
justificativa Texto(100) Sim Entrada Justificativa para mudança do estágio
unidadeOrcamentaria Texto(6) Não Saída Código da unidade orçamentária/subunidade responsável pela contratação. Preencher com null caso não se aplique
orgaoDemandanteDiferente Booleano Não Saída Informar se a unidade jurisdicionada solicitante da contratação é diferente da proprietária
orgaoDemandante Texto(6) Não Saída Código da unidade jurisdicionada solicitante da contratação. Preencher com null caso não se aplique
regramentoId Inteiro Não Saída Código do Regramento do Processo de Contratação (verificar Tabelas de Domínio)
modalidadeId Inteiro Não Saída Código da Modalidade do Processo de Contratação (verificar Tabelas de Domínio)
numero Texto(100) Não Saída Número do Processo de Contratação
ano Inteiro Não Saída Ano do Processo de Contratação
numeroModalidade Texto(100) Não Saída Número da Modalidade do Processo de Contratação
anoModalidade Inteiro Não Saída Ano da Modalidade do Processo de Contratação
processoAdministrativo Texto(100) Não Saída Número do Processo Administrativo do Processo de Contratação
srp Booleano Não Saída Informar se o processo de contratação é um sistema de registro de preços
comissaoContratacao Texto(100) Não Saída Identificador Único da comissão de licitação caso a contratação seja feita por uma comissão
agenteContratacao Vetor Não Saída Vetor com os CPFs da comissão de licitação ou dos agentes responsáveis
objetoConformeEdital Texto(5000) Não Saída Texto com a descrição do objeto conforme edital publicado
naturezaId Inteiro Não Saída Código da Natureza do Processo de Contratação (verificar Tabelas de Domínio)
classificacaoId Inteiro Não Saída Código da Classificação do Processo de Contratação (verificar Tabelas de Domínio)
dataPublicacao Data Não Saída Data de publicação do processo de contratação no padrão AAAA-MM-DD
dataSessaoAbertura Data Não Saída Data da sessão de abertura do processo de contratação no padrão AAAA-MM-DD
fontePublicacao Vetor Não Saída Vetor com os códigos das fontes de publicação onde o certame foi divulgado
linkOrigem Texto(5000) Não Saída Link da público onde o aviso de licitação ou contratação direta foi disponibilizado
regimeExecucaoId Inteiro Não Saída Código do Regime de Execução da Obra ou Serviço de Engenharia (verificar Tabelas de Domínio)
criterioJulgamentoId Inteiro Não Saída Código do Critério de Julgamento do Processo de Contratação (verificar Tabelas de Domínio)
fundamentacaoLegalId Inteiro Não Saída Fundamentação Legal da Dispensa ou Inexigibilidade (verificar Tabelas de Domínio)
formaAgrupamento Texto(4) Não Saída Forma de agrumaneto do objeto, podendo ser LOTE ou ITEM
orcamentoSigiloso Booleano Não Saída Informar se o orçamento é sigiloso
justificativaSigilo Texto(500) Não Saída Caso o orçamento seja sigiloso, informar a justificativa do sigilo
concessaoME_EPP Booleano Não Saída Informar se o Processo de Contratação possui concessão de tratamento diferenciado para as ME e EPP (LC nº 123/2006)
receita Booleano Não Saída Informar se o objetivo do Processo de Contratação é a geração de receita para a administração pública
valorGlobal Decimal(20,4) Não Saída Valor global estimado do Processo de Contratação. Precisão de 4 dígitos decimais; Ex: 10000.0000;
licitantes Vetor Não Saída Vetor com os licitantes e seus detalhes
licitantes.statusHabilitacaoId Inteiro Não Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
licitantes.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitantes.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitantes.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitantes.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.5 Inserir Documento na Contratação#

Serviço que permite adicionar documentos a um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos
Método HTTP POST
Exemplo de payload 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 39,
  "licitante": {
    "tipoLicitanteId": "PF",
    "cpf": "10000000001"
  },
  "descricao": "Comprovantes de especialização ...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
}
Exemplo de retorno (sucesso) 
{
  "id": 5615,
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 39,
  "licitante": {
    "tipoLicitanteId": "PF",
    "cpf": "10000000001"
  },
  "descricao": "Comprovantes de especialização ...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "dataCadastro": "2024-05-02T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "tipoDocumentoId",
      "mensagem": "Tipo de documento inexistente"
    },
    {
      "campo": "processoLicitatorioId",
      "mensagem": "Processo de contratação inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá o documento
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoDocumentoId Inteiro Sim Entrada / Saída Código do Tipo de Documento que será incluído na contratação (verificar Tabelas de Domínio)
licitante Objeto Não Entrada / Saída Objeto contendo as informações do licitante que será associado ao documento, quando for o caso
licitante.tipoLicitanteId Texto(2) Não Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitante.cpf Texto(11) Não Entrada / Saída CPF do Licitante (caso o tipo seja PF)
licitante.cnpj Texto(14) Não Entrada / Saída CNPJ do Licitante (caso o tipo seja PJ)
licitante.documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
descricao Texto(100) Não Entrada / Saída Breve descrição do documento que será incluído
nomeArquivo Texto(100) Sim Entrada / Saída Nome do arquivo que será incluído
arquivoContentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será incluído. Atualmente o RemessaTCEPE só aceita o tipo “application/pdf”
conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema. No caso da inclusão sempre retorna null
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema. No caso da inclusão sempre retorna null
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.6 Excluir Documento da Contratação#

Serviço que permite excluir logicamente um documento previamente cadastrado em um processo de contratação no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos?id=5615&processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 5615,
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 39,
  "licitante": {
    "tipoLicitanteId": "PF",
    "cpf": "10000000001"
  },
  "descricao": "Comprovantes de especialização ...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "dataCadastro": "2024-05-02T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-05-02T12:40:26.482",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Documento já excluído"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que terá o documento excluído
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento excluído da contratação (verificar Tabelas de Domínio)
licitante Objeto Não Saída Objeto contendo as informações do licitante do documento excluído, quando for o caso
licitante.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitante.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitante.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitante.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
descricao Texto(100) Não Saída Breve descrição do documento excluído
nomeArquivo Texto(100) Não Saída Nome do arquivo excluído
arquivoContentType Texto(100) Não Saída Tipo do arquivo excluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na exclusão do Processo de Contratação
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.7 Consultar Documentos da Contratação#

Serviço que permite consultar os dados estruturados de todos os documentos previamente cadastrados em um processo de contratação no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos?processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "documentos": [
    {
      "id": 5615,
      "processoLicitatorioId": 123,
      "unidadeJurisdicionada": "999004",
      "tipoDocumentoId": 39,
      "licitante": {
        "tipoLicitanteId": "PF",
        "cpf": "10000000001"
      },
      "descricao": "Comprovantes de especialização ...",
      "nomeArquivo": "nomeArquivo.pdf",
      "arquivoContentType": "application/pdf",
      "dataCadastro": "2024-05-02T12:39:21.957",
      "usuarioCadastro": "11435633000149",
      "dataExclusao": null,
      "usuarioExclusao": null
    },
    {
      "id": 5616,
      "processoLicitatorioId": 123,
      "unidadeJurisdicionada": "999004",
      "tipoDocumentoId": 4,
      "licitante": null,
      "descricao": null,
      "nomeArquivo": "nomeArquivo2.pdf",
      "arquivoContentType": "application/pdf",
      "dataCadastro": "2024-05-02T12:39:25.937",
      "usuarioCadastro": "11435633000149",
      "dataExclusao": null,
      "usuarioExclusao": null
    },
    …
  ]
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "processoLicitatorioId",
      "mensagem": "Processo de contratação inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada Código do processo de contratação consultado
unidadeJurisdicionada Texto(6) Sim Entrada Código da unidade jurisdicionada proprietária do processo de contratação
documentos Vetor Não Saída Vetor contendo documentos existentes no processo de contratação consultado
id Inteiro Não Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
processoLicitatorioId Inteiro Não Saída Código do processo de contratação que possui o documento
unidadeJurisdicionada Texto(6) Não Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento (verificar Tabelas de Domínio)
licitante Objeto Não Saída Objeto contendo as informações do licitante do documento, quando for o caso
licitante.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitante.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitante.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitante.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
descricao Texto(100) Não Saída Breve descrição do documento
nomeArquivo Texto(100) Não Saída Nome do arquivo do documento
arquivoContentType Texto(100) Não Saída Tipo do arquivo do documento
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.8 Listar processos licitatórios#

Serviço para listar processos de contratação previamente cadastrados no RemessaTCEPE. Diferente da consulta de processos licitatórios descrita anteriormente, esse endpoint retorna uma lista de processos de contratações que atendem ao critério de busca. Nesse endpoint também é possível consultar processos de outras UJs da mesma esfera, município e poder para recuperar o id do registro que deve ser passado no corpo da requisição no cadastro do contrato (processoLicitatorioId).

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios/listar
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/processo-licitatorios/listar?id=123&unidadeJurisdicionada=999004
ou
${BASE_URL}/api/webservice/processo-licitatorios/listar?numero=4&ano=2023&unidadeJurisdicionada=999004
ou
${BASE_URL}/api/webservice/processo-licitatorios/listar?numeroModalidade=001&anoModalidade=2024&modalidadeId=6&comissaoContratacao=CPL01&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "processoLicitatorios": [
    {
      "id": 1,
      "numero": "4",
      "ano": 2023,
      "numeroModalidade": "4",
      "anoModalidade": 2023,
      "unidadeJurisdicionada": "999004",
      "unidadeOrcamentaria": null,
      "modalidadeId": 13,
      "modalidade": "Leilão - Presencial",
      "estagioId": 2,
      "estagio": "Em andamento",
      "objetoConformeEdital": "Exemplo de preenchimento para manual da API"
    }
  ],
  "erros": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Não existe processo de contratação com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Processo de Contratação
estagioId Inteiro Não Saída Código do Estágio do Processo de Contratação (verificar Tabelas de Domínio)
estagio Texto(100) Não Saída Descrição do estágio do PC
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
unidadeOrcamentaria Texto(6) Não Saída Código da unidade orçamentária/subunidade responsável pela contratação. Preencher com null caso não se aplique
modalidadeId Inteiro Não Saída Código da Modalidade do Processo de Contratação (verificar Tabelas de Domínio)
numero Texto(100) Não Saída Número do Processo de Contratação
ano Inteiro Não Saída Ano do Processo de Contratação
numeroModalidade Texto(100) Não Saída Número da Modalidade do Processo de Contratação
anoModalidade Inteiro Não Saída Ano da Modalidade do Processo de Contratação
comissaoContratacao Texto(100) Não Entrada / Saída Identificador da comissão de licitação para filtro
modalidade Texto(100) Não Saída Texto com o nome da modalidade
objetoConformeEdital Texto(1000) Não Saída Objeto conforme cadastrado no RemessaTCEPE
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.9 Download do Documento da Contratação#

Serviço que permite consultar os dados estruturados e conteúdo de um documento previamente cadastrado em um processo de contratação no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos-download
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos-download?id=5615&processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 5615,
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 39,
  "licitante": {
    "tipoLicitanteId": "PF",
    "cpf": "10000000001"
  },
  "descricao": "Comprovantes de especialização ...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW...",
  "dataCadastro": "2024-05-02T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "processoLicitatorioId",
      "mensagem": "Processo de contratação inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Entrada / Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
processoLicitatorioId Inteiro Não Entrada / Saída Código do processo de contratação que possui o documento
unidadeJurisdicionada Texto(6) Não Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento (verificar Tabelas de Domínio)
licitante Objeto Não Saída Objeto contendo as informações do licitante do documento, quando for o caso
licitante.tipoLicitanteId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
licitante.cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
licitante.cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
licitante.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
descricao Texto(100) Não Saída Breve descrição do documento
nomeArquivo Texto(100) Não Saída Nome do arquivo do documento
arquivoContentType Texto(100) Não Saída Tipo do arquivo do documento
conteudo Image Sim Saída Texto contendo a imagem (binário) do arquivo
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.10 Inserir Orçamento na Contratação#

Serviço que permite importar orçamento em um processo de contratação previamente cadastrado no RemessaTCEPE.
O orçamento a ser enviado deve estar em um dos formatos: xlsx ou csv.

Endpoint 
${BASE_URL}/api/webservice/orcamentos
Método HTTP POST
Exemplo de payload 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataOrcamento": "2024-04-21",
  "nomeArquivo": "orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
}
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataOrcamento": "2024-04-21",
  "nomeArquivo": "orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-05-02T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "A forma de agrupamento do processo de contratação é ITEM"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá o orçamento
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
dataOrcamento Data Sim Entrada / Saída Data da elaboração do orçamento estimativo
nomeArquivo Texto(100) Sim Entrada / Saída Nome do arquivo que será importado
arquivoContentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será importado. Atualmente o RemessaTCEPE só aceita os tipos “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet” ou “application/csv”
conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.11 Excluir Orçamento da Contratação#

Serviço que permite excluir um orçamento de um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/orcamentos
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/orcamentos?processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataOrcamento": "2024-04-21",
  "nomeArquivo": "orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-05-02T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-05-02T14:49:52.321",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "O processo de contratação não possui orçamento importado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que terá o orçamento excluído
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
dataOrcamento Data Não Saída Data da elaboração do orçamento estimativo
nomeArquivo Texto(100) Não Saída Nome do arquivo que foi importado
arquivoContentType Texto(100) Não Saída Tipo do arquivo que foi importado
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.12 Inserir Licitante na Contratação#

Serviço que permite adicionar licitantes a um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/licitantes
Método HTTP POST
Exemplo de payload 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoLicitanteId": "PF",
  "cpf": "10000000001",
  "statusHabilitacaoId": null
}
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoLicitanteId": "PF",
  "cpf": "10000000001",
  "cnpj": null,
  "documentoEstrangeiro": null,
  "statusHabilitacaoId": null,
  "dataCadastro": "2024-07-12T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": null,
  "usuarioUltimaAtualizacao": null,
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "cpf",
      "mensagem": "CPF inválido"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá o licitante
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoLicitanteId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
cpf Texto(11) Não Entrada / Saída CPF do Licitante (caso o tipo seja PF)
cnpj Texto(14) Não Entrada / Saída CNPJ do Licitante (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
statusHabilitacaoId Inteiro Não Entrada / Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última alteração do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última alteração do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema. No caso da inclusão sempre retorna null
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema. No caso da inclusão sempre retorna null
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.13 Atualizar Habilitação do Licitante da Contratação#

Serviço que permite atualizar o status de habilitação de um licitante de um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/licitantes
Método HTTP PUT
Exemplo de payload 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoLicitanteId": "PF",
  "cpf": "10000000001",
  "statusHabilitacaoId": 2
}
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoLicitanteId": "PF",
  "cpf": "10000000001",
  "cnpj": null,
  "documentoEstrangeiro": null,
  "statusHabilitacaoId": 2,
  "dataCadastro": "2024-07-12T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-07-12T14:39:41.957",
  "usuarioUltimaAtualizacao": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Licitante não existente no processo de contratação"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá a alteração do licitante
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoLicitanteId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
cpf Texto(11) Não Entrada / Saída CPF do Licitante (caso o tipo seja PF)
cnpj Texto(14) Não Entrada / Saída CNPJ do Licitante (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
statusHabilitacaoId Inteiro Não Entrada / Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última alteração do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última alteração do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.14 Excluir Licitante da Contratação#

Serviço que permite excluir um licitante de um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/licitantes
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/licitantes?processoLicitatorioId=123&unidadeJurisdicionada=999004&tipoLicitanteId=PF&documento=10000000001
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "tipoLicitanteId": "PF",
  "cpf": "10000000001",
  "cnpj": null,
  "documentoEstrangeiro": null,
  "statusHabilitacaoId": 2,
  "dataCadastro": "2024-07-12T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-07-12T14:39:41.957",
  "usuarioUltimaAtualizacao": "11435633000149",
  "dataExclusao": "2024-07-12T14:39:51.957",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Licitante está vinculado a um item/lote no resultado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que terá a exclusão do licitante
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoLicitanteId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
documento Texto(100) Sim Entrada Documento do licitante (CPF, CNPJ ou Documento Estrangeiro)
cpf Texto(11) Não Saída CPF do Licitante (caso o tipo seja PF)
cnpj Texto(14) Não Saída CNPJ do Licitante (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
statusHabilitacaoId Inteiro Não Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última alteração do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última alteração do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.15 Inserir Resultado na Contratação#

Serviço que permite importar um resultado em um processo de contratação previamente cadastrado no RemessaTCEPE. Só será permitido importar o resultado após os licitantes serem cadastrados no processo de contratação.
O arquivo do resultado deve ser uma continuidade do arquivo importado no orçamento, contendo as mesmas informações já enviadas além de dados acerca do resultado da licitação/contratação direta.

Endpoint 
${BASE_URL}/api/webservice/resultados
Método HTTP POST
Exemplo de payload 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataResultado": "2024-07-21",
  "nomeArquivo": "resultado_orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
}
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataResultado": "2024-07-21",
  "nomeArquivo": "resultado_orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-07-21T14:39:21.957",
  "usuarioCadastro": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Os itens/lotes do resultado são diferentes do orçamento"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá o resultado
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
dataResultado Data Sim Entrada / Saída Data do resultado (homologação/adjudicação)
nomeArquivo Texto(100) Sim Entrada / Saída Nome do arquivo que será importado
arquivoContentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será importado. Atualmente o RemessaTCEPE só aceita os tipos “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet” ou “application/csv”
conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.16 Consultar Resultado da Contratação#

Serviço que permite consultar os dados estruturados de todos os documentos previamente cadastrados em um processo de contratação no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/resultados
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/resultados?processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 100,
  "dataResultado": "2024-06-30T03:00:00",
  "valorTotal": 24797.52,
  "lotes": [
    {
      "id": 200,
      "numero": 1,
      "descricao": "LOTE 01",
      "valorTotal": 24797.52,
      "itens": [
        {
          "id": 300,
          "numero": 1,
          "tipoBeneficio": 4,
          "materialServico": "S",
          "fonteReferencia": "COMPOSICAO",
          "dataReferencia": "2024-02-01",
          "codigoReferencia": "0000000",
          "descricaoItem": "Prestação de serviço contínuo de engenharia em manutenção corretiva e preventiva no …",
          "unidadeMedida": "CONJ.",
          "quantidade": 1.0,
          "valorUnitario": 24797.52,
          "valorTotal": 24797.52,
          "bdi": 29.98,
          "indiceAtualizacao": "INCC",
          "situacao": 2,
          "tipoPessoa": "PJ",
          "niFornecedor": "11435633000149",
          "quantidadeHomologada": 1.0,
          "valorUnitarioHomologado": 24797.52,
          "valorTotalHomologado": 24797.52,
          "bdiHomologado": 29.98,
          "percentualHomologado": null
        }
      ]
    }
  ],
  "usuarioCadastro": "11435633000149",
  "dataCadastro": "2024-06-30T09:03:42.04-03:00",
  "usuarioUltimaAtualizacao": "11435633000149",
  "dataUltimaAtualizacao": "2024-06-30T09:03:42.04-03:00",
  "erros": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "processoLicitatorioId",
      "mensagem": "Processo de contratação inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada Código do processo de contratação consultado
unidadeJurisdicionada Texto(6) Sim Entrada Código da unidade jurisdicionada proprietária do processo de contratação
id Inteiro Não Saída Id do resultado do processo de contratação
dataResultado Data e Hora Não Saída Data do resultado do processo de contratação
valorTotal Decimal(20,4) Não Saída Valor total do resultado do processo de contratação
lotes Vetor Não Saída Vetor contendo os lotes do resultado. Caso a forma de agrupamento do orçamento seja por itens, este vetor irá conter apenas uma entrada com os itens do orçamento
lotes.id Inteiro Não Saída Id do lote
lotes.numero Inteiro Não Saída Número do lote
lotes.descricao Texto(1000) Não Saída Descrição do lote
lotes.valorTotal Decimal(20,4) Não Saída Valor total resultante do lote
lotes.itens Vetor Não Saída Vetor contendo os itens do lote
lotes.itens.id Inteiro Não Saída Id do item
lotes.itens.numero Inteiro Não Saída Número do item
lotes.itens.tipoBeneficio Inteiro Não Saída Tipo de benefício do item
lotes.itens.materialServico Texto(1) Não Saída Indicativo se o item é material (M) ou serviço (S)
lotes.itens.fonteReferencia Texto(100) Não Saída Fonte de referência do item
lotes.itens.dataReferencia Data Não Saída Data de referência do item
lotes.itens.codigoReferencia Texto(100) Não Saída Código de referência do item
lotes.itens.descricaoItem Texto(1000) Não Saída Descrição do item
lotes.itens.unidadeMedida Texto(100) Não Saída Unidade de medida do item
lotes.itens.quantidade Decimal(20,4) Não Saída Quantidade de itens no orçamento
lotes.itens.valorUnitario Decimal(20,4) Não Saída Valor unitário do item no orçamento
lotes.itens.valorTotal Decimal(20,4) Não Saída Valor total do item no orçamento
lotes.itens.bdi Decimal(20,4) Não Saída BDI do item no orçamento
lotes.itens.indiceAtualizacao Texto(100) Não Saída Índice de atualização do item
lotes.itens.situacao Inteiro Não Saída Situação do item. Ver possíveis valores em: https://sistemas.tcepe.tc.br/DadosAbertos/Exemplo!detalhar?dadosAbertos.id=74
lotes.itens.tipoPessoa Texto(2) Não Saída Tipo de pessoa com proposta vencedora (PJ, PF ou PE)
lotes.itens.niFornecedor Texto(100) Não Saída CPF do Licitante (caso o tipo seja PF), CNPJ do Licitante (caso o tipo seja PJ) ou Documento Identificador do Estrangeiro (caso o tipo seja PE)
lotes.itens.quantidadeHomologada Decimal(20,4) Não Saída Quantidade homologada do item
lotes.itens.valorUnitarioHomologado Decimal(20,4) Não Saída Valor unitário homologado do item
lotes.itens.valorTotalHomologado Decimal(20,4) Não Saída Valor total homologado do item
lotes.itens.bdiHomologado Decimal(20,4) Não Saída BDI homologado do item
lotes.itens.percentualHomologado Decimal(20,4) Não Saída Percentual homologado do item
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.17 Excluir Resultado da Contratação#

Serviço que permite excluir um resultado de um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/resultados
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/resultados?processoLicitatorioId=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "processoLicitatorioId": 123,
  "unidadeJurisdicionada": "999004",
  "dataResultado": "2024-07-21",
  "nomeArquivo": "resultado_orcamento_lote.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-07-21T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-07-21T14:49:52.321",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "O processo de contratação não possui resultado importado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que terá o resultado excluído
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
dataResultado Data Não Saída Data do resultado (homologação/adjudicação)
nomeArquivo Texto(100) Não Saída Nome do arquivo que foi importado
arquivoContentType Texto(100) Não Saída Tipo do arquivo que foi importado
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.18 Excluir Processo de Contratação#

Serviço que permite excluir (exclusão lógica) um processo de contratação previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/processo-licitatorios
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/processo-licitatorios?id=123&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 123,
  "numero": "001",
  "ano": 2024,
  "numeroModalidade": "001",
  "anoModalidade": 2024,
  "unidadeJurisdicionada": "999004",
  "modalidadeId": 1,
  "estagioId": 1,
  "dataCadastro": "2024-07-12T14:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-07-15T09:22:33.123",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Não existe processo de contratação com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do processo de contratação gerado pelo RemessaTCEPE
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
numero Texto(100) Não Saída Número do processo de contratação
ano Inteiro Não Saída Ano do processo de contratação
numeroModalidade Texto(100) Não Saída Número da modalidade
anoModalidade Inteiro Não Saída Ano da modalidade
modalidadeId Inteiro Não Saída Código da modalidade (verificar Tabelas de Domínio)
estagioId Inteiro Não Saída Código do Estágio do Processo de Contratação (verificar Tabelas de Domínio)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.1.19 Inserir Lista de Licitantes na Contratação#

Serviço que permite adicionar uma lista de licitantes a um processo de contratação previamente cadastrado no RemessaTCEPE, em uma única requisição. Similar ao serviço de Inserir Licitante na Contratação, porém recebe um vetor de licitantes.

Endpoint 
${BASE_URL}/api/webservice/licitantes/salvar/lista
Método HTTP POST
Exemplo de payload 
[
  {
    "processoLicitatorioId": 123,
    "unidadeJurisdicionada": "999004",
    "tipoLicitanteId": "PF",
    "cpf": "00000000272",
    "statusHabilitacaoId": null
  },
  {
    "processoLicitatorioId": 123,
    "unidadeJurisdicionada": "999004",
    "tipoLicitanteId": "PJ",
    "cnpj": "10000000000005",
    "statusHabilitacaoId": null
  }
]
Exemplo de retorno (sucesso) 
[
  {
    "id": 100,
    "processoLicitatorioId": 123,
    "unidadeJurisdicionada": "999004",
    "tipoLicitanteId": "PF",
    "cpf": "00000000272",
    "cnpj": null,
    "documentoEstrangeiro": null,
    "statusHabilitacaoId": null,
    "dataCadastro": "2024-07-12T14:39:21.957",
    "usuarioCadastro": "11435633000149",
    "dataUltimaAtualizacao": null,
    "usuarioUltimaAtualizacao": null,
    "dataExclusao": null,
    "usuarioExclusao": null
  },
  {
    "id": 101,
    "processoLicitatorioId": 123,
    "unidadeJurisdicionada": "999004",
    "tipoLicitanteId": "PJ",
    "cpf": null,
    "cnpj": "10000000000005",
    "documentoEstrangeiro": null,
    "statusHabilitacaoId": null,
    "dataCadastro": "2024-07-12T14:39:21.957",
    "usuarioCadastro": "11435633000149",
    "dataUltimaAtualizacao": null,
    "usuarioUltimaAtualizacao": null,
    "dataExclusao": null,
    "usuarioExclusao": null
  }
]
Exemplo de retorno (erro) 
[
  {
    "erros": [
      {
        "campo": "cpf",
        "mensagem": "CPF inválido"
      }
    ]
  }
]

Detalhamento dos campos

O payload de entrada é um vetor (array JSON) de objetos. Cada objeto segue a mesma estrutura descrita na seção 4.1.12 Inserir Licitante na Contratação. O retorno também é um vetor, contendo o resultado de cada operação individualmente.

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
processoLicitatorioId Inteiro Sim Entrada / Saída Código do processo de contratação que receberá os licitantes
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
tipoLicitanteId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
cpf Texto(11) Não Entrada / Saída CPF do Licitante (caso o tipo seja PF)
cnpj Texto(14) Não Entrada / Saída CNPJ do Licitante (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
nome Texto(200) Não Entrada / Saída Nome do licitante
statusHabilitacaoId Inteiro Não Entrada / Saída Código do Status de Habilitação do Licitante (verificar Tabelas de Domínio)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última alteração do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última alteração do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2 Serviços para Instrumento Jurídico (ou Obras)#

4.2.1 Inserir Instrumento Jurídico#

Serviço que permite inserir um instrumento jurídico no RemessaTCEPE. Os dados obrigatórios dependem do tipo do instrumento jurídico a ser cadastrado (ver tabelas de domínio). Os instrumentos jurídicos sempre são inseridos inicialmente com estágio “Em Rascunho (não enviado ao TCE)”. Ou seja, ainda não foram formalizados ao TCE-PE. Para serem consideradas adimplentes, as unidades jurisdicionadas devem, após inserir os instrumentos jurídicos, formalizá-los via método de mudança de estágio.

Endpoint 
${BASE_URL}/api/webservice/contratos
Método HTTP POST
Exemplo de payload 
{
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2025-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  }
}
Exemplo de retorno (corpo da requisição) 
{
  "id": 456,
  "estagioContratoId": 1,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2024-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  },
  "contratados": [],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": null,
  "usuarioUltimaAtualizacao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "unidadeJurisdicionada",
      "mensagem": "O campo unidadeJurisdicionada é obrigatório"
    },
    {
      "campo": null,
      "mensagem": "Já existe instrumento jurídico do mesmo tipo com o número e ano informados"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código gerado pelo RemessaTCEPE após inclusão do Instrumento Jurídico
estagioContratoId Inteiro Não Saída Código do Estágio do Instrumento Jurídico (verificar Tabelas de Domínio). Esse campo retorna sempre 1 na inclusão
tipoContratoId Inteiro Sim Entrada / Saída Código do Tipo de Instrumento Jurídico (verificar Tabelas de Domínio)
processoLicitatorioId Inteiro Não Entrada / Saída Identificador único gerado pelo RemessaTCEPE do Processo de Contratação previamente cadastro e que resultou no instrumento jurídico. Esse campo será obrigatório a depender do tipo do instrumento jurídico cadastrado
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do Instrumento Jurídico
unidadeOrcamentaria Texto(6) Não Entrada / Saída Código da unidade orçamentária/subunidade responsável pelo instrumento jurídico. Preencher com null caso não se aplique
naturezaId Inteiro Sim Entrada / Saída Código da Natureza do Instrumento Jurídico (verificar Tabelas de Domínio)
classificacaoId Inteiro Sim Entrada / Saída Código da Classificação do Instrumento Jurídico (verificar Tabelas de Domínio)
dataAssinatura Data Sim Entrada / Saída Data de assinatura do instrumento jurídico no padrão AAAA-MM-DD
dataInicioVigencia Data Sim Entrada / Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigencia Data Não Entrada / Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Sim Entrada / Saída Informar se o instrumento jurídico possui prazo indeterminado. Em caso positivo, a dataFimVigencia não deve ser informada
fiscaisContratos Vetor Sim Entrada / Saída CPFs dos fiscais do instrumento jurídico.
urlTransparencia Texto(5000) Sim Entrada / Saída Link da público direto para o instrumento público no portal de transparência da unidade jurisdicionada
valorGlobal Decimal(20,4) Sim Entrada / Saída Valor global do instrumento jurídico. Este campo é obrigatório. Caso não exista despesa, deve ser preenchido com 0.0. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Sim Entrada / Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
receita Booleano Sim Entrada / Saída Informar se o objetivo do Instrumento Jurídico é a geração de receita para a administração pública
oss Booleano Sim Entrada / Saída Se o tipo de instrumento for de contrato de gestão, informar se é com Organização Social de Saúde
objetoContrato Texto(5000) Sim Entrada / Saída Texto com a descrição do objeto do instrumento jurídico
processoLicitatorioExterno Objeto Não Entrada / Saída Objeto contendo as informações do processo de contratação e ARP do órgão gerenciador da ata. Os campos deste objeto serão obrigatórios a depender do tipo do instrumento jurídico cadastrado
processoLicitatorioExterno.regramentoId Inteiro Não Entrada / Saída Código do Regramento do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.modalidadeId Inteiro Não Entrada / Saída Código da Modalidade do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.numeroProcesso Texto(100) Não Entrada / Saída Número do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoProcesso Inteiro Não Entrada / Saída Ano do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroModalidade Texto(100) Não Entrada / Saída Número da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoModalidade Inteiro Não Entrada / Saída Ano da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroARP Texto(100) Não Entrada / Saída Número da ARP
processoLicitatorioExterno.anoARP Inteiro Não Entrada / Saída Ano da ARP
processoLicitatorioExterno.cnpjOrgao Texto(14) Não Entrada / Saída CNPJ do órgão gerenciador da ARP aderida
processoLicitatorioExterno.dataInicioVigenciaARP Data Não Entrada / Saída Data de início de vigência da ARP no padrão AAAA-MM-DD
processoLicitatorioExterno.dataFimVigenciaARP Data Não Entrada / Saída Data de fim de vigência da ARP no padrão AAAA-MM-DD
contratados Vetor Não Saída Vetor de partes do IJ vazio
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.2 Atualizar Instrumento Jurídico#

Serviço que permite atualizar um instrumento jurídico previamente cadastrado no sistema RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratos
Método HTTP PUT
Exemplo de payload 
{
  "id": 456,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2024-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  }
}
Exemplo de retorno (corpo da requisição) 
{
  "id": 456,
  "estagioContratoId": 1,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2024-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  },
  "contratados": [
    {
      "tipoContratadoId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:23:12.524",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "O campo id é obrigatório para atualização do instrumento jurídico"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Instrumento Jurídico
estagioContratoId Inteiro Não Saída Código do Estágio do Instrumento Jurídico (verificar Tabelas de Domínio). Esse campo retorna sempre 1 na inclusão
tipoContratoId Inteiro Sim Entrada / Saída Código do Tipo de Instrumento Jurídico (verificar Tabelas de Domínio)
processoLicitatorioId Inteiro Não Entrada / Saída Identificador único gerado pelo RemessaTCEPE do Processo de Contratação previamente cadastro e que resultou no instrumento jurídico. Esse campo será obrigatório a depender do tipo do instrumento jurídico cadastrado
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do Instrumento Jurídico
unidadeOrcamentaria Texto(6) Não Entrada / Saída Código da unidade orçamentária/subunidade responsável pelo instrumento jurídico. Preencher com null caso não se aplique
naturezaId Inteiro Sim Entrada / Saída Código da Natureza do Instrumento Jurídico (verificar Tabelas de Domínio)
classificacaoId Inteiro Sim Entrada / Saída Código da Classificação do Instrumento Jurídico (verificar Tabelas de Domínio)
dataAssinatura Data Sim Entrada / Saída Data de assinatura do instrumento jurídico no padrão AAAA-MM-DD
dataInicioVigencia Data Sim Entrada / Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigencia Data Não Entrada / Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Sim Entrada / Saída Informar se o instrumento jurídico possui prazo indeterminado. Em caso positivo, a dataFimVigencia não deve ser informada
fiscaisContratos Vetor Sim Entrada / Saída CPFs dos fiscais do instrumento jurídico.
urlTransparencia Texto(5000) Sim Entrada / Saída Link da público direto para o instrumento público no portal de transparência da unidade jurisdicionada
valorGlobal Decimal(20,4) Sim Entrada / Saída Valor global do instrumento jurídico. Este campo é obrigatório. Caso não exista despesa, deve ser preenchido com 0.0. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Sim Entrada / Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
receita Booleano Sim Entrada / Saída Informar se o objetivo do Instrumento Jurídico é a geração de receita para a administração pública
oss Booleano Sim Entrada / Saída Se o tipo de instrumento for de contrato de gestão, informar se é com Organização Social de Saúde
objetoContrato Texto(5000) Sim Entrada / Saída Texto com a descrição do objeto do instrumento jurídico
processoLicitatorioExterno Objeto Não Entrada / Saída Objeto contendo as informações do processo de contratação e ARP do órgão gerenciador da ata. Os campos deste objeto serão obrigatórios a depender do tipo do instrumento jurídico cadastrado
processoLicitatorioExterno.regramentoId Inteiro Não Entrada / Saída Código do Regramento do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.modalidadeId Inteiro Não Entrada / Saída Código da Modalidade do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.numeroProcesso Texto(100) Não Entrada / Saída Número do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoProcesso Inteiro Não Entrada / Saída Ano do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroModalidade Texto(100) Não Entrada / Saída Número da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoModalidade Inteiro Não Entrada / Saída Ano da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroARP Texto(100) Não Entrada / Saída Número da ARP
processoLicitatorioExterno.anoARP Inteiro Não Entrada / Saída Ano da ARP
processoLicitatorioExterno.cnpjOrgao Texto(14) Não Entrada / Saída CNPJ do órgão gerenciador da ARP aderida
processoLicitatorioExterno.dataInicioVigenciaARP Data Não Entrada / Saída Data de início de vigência da ARP no padrão AAAA-MM-DD
processoLicitatorioExterno.dataFimVigenciaARP Data Não Entrada / Saída Data de fim de vigência da ARP no padrão AAAA-MM-DD
contratados Vetor Não Saída Vetor com as partes do IJ e seus detalhes
contratados.tipoContratadoId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
contratados.cpf Texto(11) Não Saída CPF da parte do IJ (caso o tipo seja PF)
contratados.cnpj Texto(14) Não Saída CNPJ da parte do IJ (caso o tipo seja PJ)
contratados.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.3 Consultar Instrumentos Jurídico#

Serviço para consultar instrumento jurídico previamente cadastrado no sistema RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratos
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/contratos?id=456&unidadeJurisdicionada=999004
ou
${BASE_URL}/api/webservice/contratos?numero=001&ano=2024&tipoContratoId=1&unidadeJurisdicionada=999004
Exemplo de retorno (corpo da requisição) 
{
  "id": 456,
  "estagioContratoId": 1,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2024-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  },
  "contratados": [
    {
      "tipoContratadoId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:23:12.524",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Não existe instrumento jurídico com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Instrumento Jurídico
estagioContratoId Inteiro Não Saída Código do Estágio do Instrumento Jurídico (verificar Tabelas de Domínio)
tipoContratoId Inteiro Não Saída Código do Tipo de Instrumento Jurídico (verificar Tabelas de Domínio)
processoLicitatorioId Inteiro Não Saída Identificador único gerado pelo RemessaTCEPE do Processo de Contratação previamente cadastro e que resultou no instrumento jurídico
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do Instrumento Jurídico
unidadeOrcamentaria Texto(6) Não Saída Código da unidade orçamentária/subunidade responsável pelo instrumento jurídico
naturezaId Inteiro Não Saída Código da Natureza do Instrumento Jurídico (verificar Tabelas de Domínio)
classificacaoId Inteiro Não Saída Código da Classificação do Instrumento Jurídico (verificar Tabelas de Domínio)
dataAssinatura Data Não Saída Data de assinatura do instrumento jurídico no padrão AAAA-MM-DD
dataInicioVigencia Data Não Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigencia Data Não Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Não Saída Informa se o instrumento jurídico possui prazo indeterminado
fiscaisContratos Vetor Não Entrada / Saída CPFs dos fiscais do instrumento jurídico (Obrigatório a depender do tipo do IJ).
urlTransparencia Texto(5000) Não Saída Link da público direto para o instrumento público no portal de transparência da unidade jurisdicionada
valorGlobal Decimal(20,4) Não Saída Valor global do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Não Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
receita Booleano Não Saída Informa se o objetivo do Instrumento Jurídico é a geração de receita para a administração pública
oss Booleano Não Saída Se o tipo de instrumento for de contrato de gestão, informa se é com Organização Social de Saúde
objetoContrato Texto(5000) Não Saída Texto com a descrição do objeto do instrumento jurídico
processoLicitatorioExterno Objeto Não Saída Objeto contendo as informações do processo de contratação e ARP do órgão gerenciador da ata
processoLicitatorioExterno.regramentoId Inteiro Não Saída Código do Regramento do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.modalidadeId Inteiro Não Saída Código da Modalidade do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.numeroProcesso Texto(100) Não Saída Número do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoProcesso Inteiro Não Saída Ano do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroModalidade Texto(100) Não Saída Número da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoModalidade Inteiro Não Saída Ano da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroARP Texto(100) Não Saída Número da ARP
processoLicitatorioExterno.anoARP Inteiro Não Saída Ano da ARP
processoLicitatorioExterno.cnpjOrgao Texto(14) Não Saída CNPJ do órgão gerenciador da ARP aderida
contratados Vetor Não Saída Vetor com as partes do IJ e seus detalhes
contratados.tipoContratadoId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
contratados.cpf Texto(11) Não Saída CPF da parte do IJ (caso o tipo seja PF)
contratados.cnpj Texto(14) Não Saída CNPJ da parte do IJ (caso o tipo seja PJ)
contratados.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.4 Alterar Estágio do Instrumento Jurídico#

Serviço que permite alterar o estágio de um instrumento jurídico. Os instrumentos jurídicos sempre são inseridos inicialmente com estágio “Em Rascunho (não enviado ao TCE)”. Ou seja, ainda não foram formalizados ao TCE-PE. Para serem consideradas adimplentes, as unidades jurisdicionadas devem formalizar todos os instrumentos jurídicos ao TCE-PE através desse método.

Endpoint 
${BASE_URL}/api/webservice/contratos/alterar-estagio
Método HTTP PUT
Exemplo de payload 
{
  "id": 456,
  "unidadeJurisdicionada": "999004",
  "estagioContratoId": 3,
  "justificativa": "Instrumento jurídico suspenso por decisão…"
}
Exemplo de retorno (corpo da requisição) 
{
  "id": 456,
  "estagioContratoId": 3,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "unidadeOrcamentaria": null,
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "naturezaId": 7,
  "classificacaoId": 3,
  "dataAssinatura": "2024-05-02",
  "dataInicioVigencia": "2024-05-02",
  "dataFimVigencia": "2024-05-02",
  "prazoIndeterminado": false,
  "fiscaisContratos": ["00000000272"],
  "urlTransparencia": "https://sistemas.tce.pe.gov.br/remessa/ij/contrato/1/2024/",
  "valorGlobal": 10000.0000,
  "valorRepassado": 0.0,
  "receita": false,
  "oss": false,
  "objetoContrato": "objeto",
  "processoLicitatorioExterno": {
    "regramentoId": 1,
    "modalidadeId": 1,
    "numeroProcesso": "001",
    "anoProcesso": 2023,
    "numeroModalidade": "001",
    "anoModalidade": 2023,
    "numeroARP": "001",
    "anoARP": 2023,
    "cnpjOrgao": "00414607000118",
    "dataInicioVigenciaARP": "2023-12-02",
    "dataFimVigenciaARP": "2024-12-02"
  },
  "contratados": [
    {
      "tipoContratadoId": "PJ",
      "cnpj": "10000000000005"
    }
  ],
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-05-02T10:23:12.524",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "justificativa",
      "mensagem": "Campo justificativa é obrigatório"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código gerado pelo RemessaTCEPE após inclusão do Instrumento Jurídico
estagioContratoId Inteiro Sim Entrada / Saída Código do novo Estágio do Instrumento Jurídico (verificar Tabelas de Domínio)
justificativa Texto(100) Sim Entrada Justificativa para mudança do estágio
tipoContratoId Inteiro Não Saída Código do Tipo de Instrumento Jurídico (verificar Tabelas de Domínio)
processoLicitatorioId Inteiro Não Saída Identificador único gerado pelo RemessaTCEPE do Processo de Contratação previamente cadastro e que resultou no instrumento jurídico
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do Instrumento Jurídico
unidadeOrcamentaria Texto(6) Não Saída Código da unidade orçamentária/subunidade responsável pelo instrumento jurídico
naturezaId Inteiro Não Saída Código da Natureza do Instrumento Jurídico (verificar Tabelas de Domínio)
classificacaoId Inteiro Não Saída Código da Classificação do Instrumento Jurídico (verificar Tabelas de Domínio)
dataAssinatura Data Não Saída Data de assinatura do instrumento jurídico no padrão AAAA-MM-DD
dataInicioVigencia Data Não Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigencia Data Não Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Não Saída Informa se o instrumento jurídico possui prazo indeterminado
fiscaisContratos Vetor Não Saída CPFs dos fiscais do instrumento jurídico (Obrigatório a depender do tipo do IJ).
urlTransparencia Texto(5000) Não Saída Link da público direto para o instrumento público no portal de transparência da unidade jurisdicionada
valorGlobal Decimal(20,4) Não Saída Valor global do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Não Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
receita Booleano Não Saída Informa se o objetivo do Instrumento Jurídico é a geração de receita para a administração pública
oss Booleano Não Saída Se o tipo de instrumento for de contrato de gestão, informa se é com Organização Social de Saúde
objetoContrato Texto(5000) Não Saída Texto com a descrição do objeto do instrumento jurídico
processoLicitatorioExterno Objeto Não Saída Objeto contendo as informações do processo de contratação e ARP do órgão gerenciador da ata
processoLicitatorioExterno.regramentoId Inteiro Não Saída Código do Regramento do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.modalidadeId Inteiro Não Saída Código da Modalidade do Processo de Contratação que resultou na ARP (verificar Tabelas de Domínio)
processoLicitatorioExterno.numeroProcesso Texto(100) Não Saída Número do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoProcesso Inteiro Não Saída Ano do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroModalidade Texto(100) Não Saída Número da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.anoModalidade Inteiro Não Saída Ano da Modalidade do Processo de Contratação que resultou na ARP
processoLicitatorioExterno.numeroARP Texto(100) Não Saída Número da ARP
processoLicitatorioExterno.anoARP Inteiro Não Saída Ano da ARP
processoLicitatorioExterno.cnpjOrgao Texto(14) Não Saída CNPJ do órgão gerenciador da ARP aderida
contratados Vetor Não Saída Vetor com as partes do IJ e seus detalhes
contratados.tipoContratadoId Texto(2) Não Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
contratados.cpf Texto(11) Não Saída CPF da parte do IJ (caso o tipo seja PF)
contratados.cnpj Texto(14) Não Saída CNPJ da parte do IJ (caso o tipo seja PJ)
contratados.documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.5 Inserir Parte do Instrumento Jurídico#

Serviço que permite adicionar partes a um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratados
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoContratadoId": "PJ",
  "cnpj": "10000000000005"
}
Exemplo de retorno (sucesso) 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoContratadoId": "PJ",
  "cpf": null,
  "cnpj": "10000000000005",
  "documentoEstrangeiro": null,
  "dataCadastro": "2024-05-02T15:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "cnpj",
      "mensagem": "CNPJ inválido"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá a parte
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoContratadoId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
cpf Texto(11) Não Entrada / Saída CPF da parte (caso o tipo seja PF)
cnpj Texto(14) Não Entrada / Saída CNPJ da parte (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.6 Excluir Parte do Instrumento Jurídico#

Serviço que permite excluir uma parte de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratados
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/contratados?contratoId=456&unidadeJurisdicionada=999004&tipoContratadoId=PJ&documento=10000000000005
Exemplo de retorno (sucesso) 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoContratadoId": "PJ",
  "cpf": null,
  "cnpj": "10000000000005",
  "documentoEstrangeiro": null,
  "dataCadastro": "2024-05-02T15:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-05-02T15:49:11.145",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Contratado não está vinculado ao instrumento jurídico"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que terá a parte excluída
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoContratadoId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
documento Texto(100) Sim Entrada Documento da parte (CPF, CNPJ ou Documento Estrangeiro)
cpf Texto(11) Não Saída CPF da parte (caso o tipo seja PF)
cnpj Texto(14) Não Saída CNPJ da parte (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.7 Inserir Documento no Instrumento Jurídico#

Serviço que permite adicionar documentos a um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos-contratos
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 6,
  "descricao": "Exemplo de descrição do documento...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
}
Exemplo de retorno (sucesso) 
{
  "id": 5123,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 6,
  "termoContratoId": null,
  "descricao": "Exemplo de descrição do documento...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "dataCadastro": "2024-05-03T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "tipoDocumentoId",
      "mensagem": "Tipo de documento inexistente"
    },
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá o documento
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoDocumentoId Inteiro Sim Entrada / Saída Código do Tipo de Documento que será incluído no instrumento jurídico (verificar Tabelas de Domínio)
termoContratoId Inteiro Não Saída Código do Termo do Contrato caso o documento esteja associado a um termo (Aditivo, Apostilamento ou Extinção)
descricao Texto(100) Não Entrada / Saída Breve descrição do documento que será incluído
nomeArquivo Texto(100) Sim Entrada / Saída Nome do arquivo que será incluído
arquivoContentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será incluído. Atualmente o RemessaTCEPE só aceita o tipo “application/pdf”
conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema. No caso da inclusão sempre retorna null
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema. No caso da inclusão sempre retorna null
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.8 Excluir Documento do Instrumento Jurídico#

Serviço que permite excluir logicamente um documento previamente cadastrado em um instrumento jurídico no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos-contratos
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos-contratos?id=5123&contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 5123,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 6,
  "termoContratoId": null,
  "descricao": "Exemplo de descrição do documento...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "dataCadastro": "2024-05-03T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-05-03T12:49:21.957",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Documento já excluído"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que terá o documento excluído
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento excluído do instrumento jurídico (verificar Tabelas de Domínio)
termoContratoId Inteiro Não Saída Código do Termo do Contrato caso o documento esteja associado a um termo (Aditivo, Apostilamento ou Extinção)
descricao Texto(100) Não Saída Breve descrição do documento excluído
nomeArquivo Texto(100) Não Saída Nome do arquivo excluído
arquivoContentType Texto(100) Não Saída Tipo do arquivo excluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.9 Consultar Documentos do Instrumento Jurídico#

Serviço que permite consultar os dados estruturados de todos os documentos previamente cadastrados em um instrumento jurídico no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos-contratos
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos-contratos?contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "documentos": [
    {
      "id": 5123,
      "contratoId": 456,
      "unidadeJurisdicionada": "999004",
      "tipoDocumentoId": 6,
      "termoContratoId": null,
      "descricao": "Exemplo de descrição do documento...",
      "nomeArquivo": "nomeArquivo.pdf",
      "arquivoContentType": "application/pdf",
      "dataCadastro": "2024-05-03T12:39:21.957",
      "usuarioCadastro": "11435633000149",
      "dataExclusao": null,
      "usuarioExclusao": null
    },
    …
  ]
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada Código do instrumento jurídico consultado
unidadeJurisdicionada Texto(6) Sim Entrada Código da unidade jurisdicionada proprietária do instrumento jurídico
documentos Vetor Não Saída Vetor contendo documentos existentes no instrumento jurídico consultado
id Inteiro Não Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Não Saída Código do instrumento jurídico que possui o documento
unidadeJurisdicionada Texto(6) Não Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento (verificar Tabelas de Domínio)
termoContratoId Inteiro Não Saída Código do Termo do Contrato caso o documento esteja associado a um termo (Aditivo, Apostilamento ou Extinção)
descricao Texto(100) Não Saída Breve descrição do documento
nomeArquivo Texto(100) Não Saída Nome do arquivo do documento
arquivoContentType Texto(100) Não Saída Tipo do arquivo do documento
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.10 Download do Documento do Instrumento Jurídico#

Serviço que permite consultar os dados estruturados e conteúdo de um documento previamente cadastrado em um instrumento jurídico no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/documentos-contratos-download
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos-contratos-download?id=5123&contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 5123,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 6,
  "termoContratoId": null,
  "descricao": "Exemplo de descrição do documento...",
  "nomeArquivo": "nomeArquivo.pdf",
  "arquivoContentType": "application/pdf",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW...",
  "dataCadastro": "2024-05-03T12:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Entrada / Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Não Entrada / Saída Código do instrumento jurídico que possui o documento
unidadeJurisdicionada Texto(6) Não Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento (verificar Tabelas de Domínio)
termoContratoId Inteiro Não Saída Código do Termo do Contrato caso o documento esteja associado a um termo (Aditivo, Apostilamento ou Extinção)
descricao Texto(100) Não Saída Breve descrição do documento
nomeArquivo Texto(100) Não Saída Nome do arquivo do documento
arquivoContentType Texto(100) Não Saída Tipo do arquivo do documento
conteudo Image Sim Saída Texto contendo a imagem (binário) do arquivo
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.11 Inserir Itens do Instrumento Jurídico#

Serviço que permite importar itens em um instrumento jurídico previamente cadastrado no RemessaTCEPE.
O arquivo dos itens do contrato a ser enviado deve estar em um dos formatos: xlsx ou csv.

Endpoint 
${BASE_URL}/api/webservice/contratos-itens
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "nomeArquivo": "itens_contrato.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
}
Exemplo de retorno (sucesso) 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "nomeArquivo": "itens_contrato.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-05-03T11:22:22.123",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "O arquivo está em um formato incorreto"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá os itens
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
nomeArquivo Texto(100) Sim Entrada / Saída Nome do arquivo que será importado
arquivoContentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será importado. Atualmente o RemessaTCEPE só aceita os tipos “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet” ou “application/csv”
conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.12 Importar Itens do Instrumento Jurídico a partir de Processo de Contratação vinculado#

Serviço que permite importar itens em um instrumento jurídico a partir do processo de contratação vinculado no RemessaTCEPE.
Os possíveis filtros para os itens que devem ser importados são: cnpj, cpf, documentoEstrangeiro, lotes. Caso nenhum deles seja informado, todos os itens do resultado serão importados para o IJ.

Endpoint 
${BASE_URL}/api/webservice/contratos-itens/importar-processos
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "cnpj": "10000000000005",
  "lotes": [2, 3]
}
Exemplo de retorno (sucesso) 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "cpf": null,
  "cnpj": "10000000000005",
  "documentoEstrangeiro": null,
  "lotes": [2, 3],
  "dataCadastro": "2026-04-02T15:39:21.957",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Contrato não tem Processo de Contratação vinculado."
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá os itens
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
cpf Texto(11) Não Entrada / Saída CPF do licitante vencedor que deve ter os itens importados
cnpj Texto(14) Não Entrada / Saída CNPJ do licitante vencedor que deve ter os itens importados
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro do licitante vencedor que deve ter os itens importados
lotes Vetor Não Entrada / Saída Vetor com os números dos lotes que devem ser importados
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.13 Excluir Itens do Instrumento Jurídico#

Serviço que permite excluir os itens de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratos-itens
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/contratos-itens?contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "nomeArquivo": "itens_contrato.xlsx",
  "arquivoContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "dataCadastro": "2024-05-03T11:22:22.123",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-05-03T11:25:22.123",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "O instrumento jurídico está no estágio em execução e não pode ter os itens excluídos"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que terá o orçamento excluído
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do processo de contratação
nomeArquivo Texto(100) Não Saída Nome do arquivo que foi importado
arquivoContentType Texto(100) Não Saída Tipo do arquivo que foi importado
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.14 Inserir Termo no Instrumento Jurídico#

Serviço que permite adicionar termos (aditivo, apostilamento e extinção) a um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/termos
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoTermoContratoId": 2,
  "numeroTermo": "001/2024",
  "fundamentoLegal": "Fundamentação legal do Termo",
  "objetoTermo": "Detalhamento do objeto do termo",
  "informacaoComplementar": "Informações complementares, caso necessário",
  "valorContrato": 11000.0000,
  "valorRepassado": 0.0,
  "dataAssinaturaTermo": "2025-04-02",
  "dataInicioVigenciaContrato": "2024-05-02",
  "dataFimVigenciaContrato": "2026-05-02",
  "prazoIndeterminado": false,
  "arquivoTermo": {
    "nome": "nomeArquivo.pdf",
    "contentType": "application/pdf",
    "conteudo": "JVBERi0xLjQKJeLjz9MKNCAwIG9iaiA8PC9MZW..."
  }
}
Exemplo de retorno (sucesso) 
{
  "id": 159,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoTermoContratoId": 2,
  "numeroTermo": "001/2024",
  "fundamentoLegal": "Fundamentação legal do Termo",
  "objetoTermo": "Detalhamento do objeto do termo",
  "informacaoComplementar": "Informações complementares, caso necessário",
  "valorContrato": 11000.0000,
  "valorRepassado": null,
  "dataAssinaturaTermo": "2025-04-02",
  "dataInicioVigenciaContrato": "2024-05-02",
  "dataFimVigenciaContrato": "2026-05-02",
  "prazoIndeterminado": false,
  "arquivoTermo": {
    "id": 954,
    "nome": "nomeArquivo.pdf",
    "contentType": "application/pdf"
  },
  "dataCadastro": "2025-05-03T11:22:22.123",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código único do termo gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá o termo
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoTermoContratoId Inteiro Sim Entrada / Saída Código do Tipo do Termo que será incluído no instrumento jurídico (verificar Tabelas de Domínio)
numeroTermo Texto(50) Sim Entrada / Saída Número e ano do termo
fundamentoLegal Texto(5000) Sim Entrada / Saída Fundamentação legal do termo
objetoTermo Texto(5000) Sim Entrada / Saída Objeto do termo
informacaoComplementar Texto(5000) Não Entrada / Saída Informação complementar
valorContrato Decimal(20,4) Sim Entrada / Saída Novo valor global do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Sim Entrada / Saída Novo valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
dataAssinaturaTermo Data Sim Entrada / Saída Data de assinatura do termo no padrão AAAA-MM-DD
dataInicioVigenciaContrato Data Sim Entrada / Saída Nova data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigenciaContrato Data Não Entrada / Saída Nova data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Sim Entrada / Saída Informar se o instrumento jurídico é de prazo indeterminado
arquivoTermo Objeto Sim Entrada / Saída Objeto contendo dados do arquivo do termo que será incluído
arquivoTermo.id Inteiro Não Saída Código único do arquivo do termo gerado pelo RemessaTCEPE após inclusão
arquivoTermo.nome Texto(100) Sim Entrada / Saída Nome do arquivo que será incluído
arquivoTermo.contentType Texto(100) Sim Entrada / Saída Tipo do arquivo que será incluído. Atualmente o RemessaTCEPE só aceita o tipo “application/pdf”
arquivoTermo.conteudo Image Sim Entrada Texto contendo a imagem (binário) do arquivo que será incluído
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema. No caso da inclusão sempre retorna null
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema. No caso da inclusão sempre retorna null
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.15 Excluir Termo do Instrumento Jurídico#

Serviço que permite excluir termos (aditivo, apostilamento e extinção) de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/termos
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/termos?id=159&contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 159,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoTermoContratoId": 2,
  "numeroTermo": "001/2024",
  "fundamentoLegal": "Fundamentação legal do Termo",
  "objetoTermo": "Detalhamento do objeto do termo",
  "informacaoComplementar": "Informações complementares, caso necessário",
  "valorContrato": 11000.0000,
  "valorRepassado": null,
  "dataAssinaturaTermo": "2025-04-02",
  "dataInicioVigenciaContrato": "2024-05-02",
  "dataFimVigenciaContrato": "2026-05-02",
  "prazoIndeterminado": false,
  "arquivoTermo": {
    "id": 954,
    "nome": "nomeArquivo.pdf",
    "contentType": "application/pdf"
  },
  "dataCadastro": "2025-05-03T11:22:22.123",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2025-05-03T11:25:22.123",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "Termo não pertence ao instrumento jurídico informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do termo gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoTermoContratoId Inteiro Não Saída Código do Tipo do Termo que será incluído no instrumento jurídico (verificar Tabelas de Domínio)
numeroTermo Texto(50) Não Saída Número e ano do termo
fundamentoLegal Texto(5000) Não Saída Fundamentação legal do termo
objetoTermo Texto(5000) Não Saída Objeto do termo
informacaoComplementar Texto(5000) Não Saída Informação complementar
valorContrato Decimal(20,4) Não Saída Valor global do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Não Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
dataAssinaturaTermo Data Não Saída Data de assinatura do termo no padrão AAAA-MM-DD
dataInicioVigenciaContrato Data Não Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigenciaContrato Data Não Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Não Saída Informar se o instrumento jurídico é de prazo indeterminado
arquivoTermo Objeto Não Saída Objeto contendo dados do arquivo do termo
arquivoTermo.id Inteiro Não Saída Código único do arquivo do termo gerado pelo RemessaTCEPE após inclusão
arquivoTermo.nome Texto(100) Não Saída Nome do arquivo do termo
arquivoTermo.contentType Texto(100) Não Saída Tipo do arquivo. Atualmente o RemessaTCEPE só aceita o tipo “application/pdf”
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.16 Consultar Termos do Instrumento Jurídico#

Serviço que retorna todos os termos (aditivo, apostilamento e extinção) de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/termos
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/termos?contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "termos": [
    {
      "id": 159,
      "contratoId": 456,
      "unidadeJurisdicionada": "999004",
      "tipoTermoContratoId": 2,
      "numeroTermo": "001/2024",
      "fundamentoLegal": "Fundamentação legal do Termo",
      "objetoTermo": "Detalhamento do objeto do termo",
      "informacaoComplementar": "Informações complementares, caso necessário",
      "valorContrato": 11000.0000,
      "valorRepassado": null,
      "dataAssinaturaTermo": "2025-04-02",
      "dataInicioVigenciaContrato": "2024-05-02",
      "dataFimVigenciaContrato": "2026-05-02",
      "prazoIndeterminado": false,
      "arquivoTermo": {
        "id": 954,
        "nome": "nomeArquivo.pdf",
        "contentType": "application/pdf"
      },
      "dataCadastro": "2025-05-03T11:22:22.123",
      "usuarioCadastro": "11435633000149",
      "dataExclusao": null,
      "usuarioExclusao": null
    },
    ...
  ]
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": null,
      "mensagem": "O instrumento jurídico não possui termos cadastrados"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá o termo
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
termos Vetor Não Saída Vetor com os termos do instrumento jurídico consultado
id Inteiro Sim Entrada / Saída Código único do termo gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoTermoContratoId Inteiro Não Saída Código do Tipo do Termo que será incluído no instrumento jurídico (verificar Tabelas de Domínio)
numeroTermo Texto(50) Não Saída Número e ano do termo
fundamentoLegal Texto(5000) Não Saída Fundamentação legal do termo
objetoTermo Texto(5000) Não Saída Objeto do termo
informacaoComplementar Texto(5000) Não Saída Informação complementar
valorContrato Decimal(20,4) Não Saída Valor global do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
valorRepassado Decimal(20,4) Não Saída Valor do repasse do instrumento jurídico. Precisão de 4 dígitos decimais; Ex: 10000.0000;
dataAssinaturaTermo Data Não Saída Data de assinatura do termo no padrão AAAA-MM-DD
dataInicioVigenciaContrato Data Não Saída Data de início de vigência do instrumento jurídico no padrão AAAA-MM-DD
dataFimVigenciaContrato Data Não Saída Data de fim de vigência do instrumento jurídico no padrão AAAA-MM-DD
prazoIndeterminado Booleano Não Saída Informar se o instrumento jurídico é de prazo indeterminado
arquivoTermo Objeto Não Saída Objeto contendo dados do arquivo do termo
arquivoTermo.id Inteiro Não Saída Código único do arquivo do termo gerado pelo RemessaTCEPE após inclusão
arquivoTermo.nome Texto(100) Não Saída Nome do arquivo do termo
arquivoTermo.contentType Texto(100) Não Saída Tipo do arquivo. Atualmente o RemessaTCEPE só aceita o tipo “application/pdf”
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.17 Excluir Instrumento Jurídico#

Serviço que permite excluir (exclusão lógica) um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/contratos
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/contratos?id=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 456,
  "estagioContratoId": 1,
  "processoLicitatorioId": 25,
  "unidadeJurisdicionada": "999004",
  "tipoContratoId": 1,
  "numero": "1",
  "ano": 2024,
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-06-10T14:30:00.000",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Não existe instrumento jurídico com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do instrumento jurídico gerado pelo RemessaTCEPE
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
estagioContratoId Inteiro Não Saída Código do Estágio do Instrumento Jurídico (verificar Tabelas de Domínio)
processoLicitatorioId Inteiro Não Saída Identificador único do Processo de Contratação que resultou no instrumento jurídico
tipoContratoId Inteiro Não Saída Código do Tipo de Instrumento Jurídico (verificar Tabelas de Domínio)
numero Texto(100) Não Saída Número do instrumento jurídico
ano Inteiro Não Saída Ano do instrumento jurídico
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.18 Listar Instrumentos Jurídicos#

Serviço que permite listar instrumentos jurídicos com paginação. Diferente do serviço de consulta (GET sem path adicional), este endpoint retorna uma lista paginada de instrumentos jurídicos com base em critérios de filtro.

Endpoint 
${BASE_URL}/api/webservice/contratos/listar
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/contratos/listar?unidadeJurisdicionada=999004&ano.equals=2024&page=0&size=20&sort=id,desc
Exemplo de retorno (sucesso) 
{
  "content": [
    {
      "id": 456,
      "estagioContratoId": 1,
      "processoLicitatorioId": 25,
      "unidadeJurisdicionada": "999004",
      "tipoContratoId": 1,
      "numero": "1",
      "ano": 2024,
      "naturezaId": 7,
      "classificacaoId": 3,
      "dataAssinatura": "2024-05-02",
      "dataInicioVigencia": "2024-05-02",
      "dataFimVigencia": "2024-05-02",
      "prazoIndeterminado": false,
      "valorGlobal": 10000.0000,
      "valorRepassado": 0.0,
      "objetoContrato": "objeto",
      "contratados": [
        {
          "tipoContratadoId": "PJ",
          "cnpj": "10000000000005"
        }
      ],
      "dataCadastro": "2024-05-02T08:59:24.967",
      "usuarioCadastro": "11435633000149"
    },
    ...
  ],
  "totalElements": 150,
  "totalPages": 8,
  "size": 20,
  "number": 0
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "filtros",
      "mensagem": "Informe pelo menos um filtro de pesquisa."
    }
  ]
}

Detalhamento dos campos

Filtros de pesquisa (query parameters):

Nome Tipo Obrigatório Descrição
unidadeJurisdicionada Texto(6) Sim Código da unidade jurisdicionada proprietária dos instrumentos jurídicos
id.equals Inteiro Não Filtrar por código do instrumento jurídico
numero.contains Texto Não Filtrar por número do instrumento jurídico (busca parcial)
ano.equals Inteiro Não Filtrar por ano do instrumento jurídico
estagioContratoId.equals Inteiro Não Filtrar por código do Estágio (verificar Tabelas de Domínio)
tipoContratoId.equals Inteiro Não Filtrar por código do Tipo de IJ (verificar Tabelas de Domínio)
naturezaId.equals Inteiro Não Filtrar por código da Natureza (verificar Tabelas de Domínio)
dataInicioVigencia.greaterThanOrEqual Data Não Filtrar por data de início de vigência (AAAA-MM-DD)
dataFimVigencia.lessThanOrEqual Data Não Filtrar por data de fim de vigência (AAAA-MM-DD)
dataAssinatura.equals Data Não Filtrar por data de assinatura (AAAA-MM-DD)
identificacaoContratado Texto Não Filtrar por identificação da parte (nome, CPF ou CNPJ, busca parcial)
objetoContrato.contains Texto Não Filtrar pelo objeto do instrumento jurídico (busca parcial)

Parâmetros de paginação:

Nome Tipo Obrigatório Descrição
page Inteiro Não Número da página (inicia em 0). Padrão: 0
size Inteiro Não Quantidade de registros por página. Máximo: 100
sort Texto Não Campo e direção de ordenação (ex: id,desc)

Campos de retorno: Os campos de cada instrumento jurídico no vetor content seguem a mesma estrutura descrita na seção 4.2.3 Consultar Instrumentos Jurídico. Os campos de paginação retornados no objeto raiz são:

Nome Tipo Descrição
content Vetor Vetor com os instrumentos jurídicos da página atual
totalElements Inteiro Total de registros encontrados
totalPages Inteiro Total de páginas
size Inteiro Quantidade de registros por página
number Inteiro Número da página atual (inicia em 0)

4.2.19 Inserir Lista de Partes do Instrumento Jurídico#

Serviço que permite adicionar uma lista de partes a um instrumento jurídico previamente cadastrado no RemessaTCEPE, em uma única requisição. Similar ao serviço de Inserir Parte do Instrumento Jurídico, porém recebe um vetor de partes.

Endpoint 
${BASE_URL}/api/webservice/contratados/salvar/lista
Método HTTP POST
Exemplo de payload 
[
  {
    "contratoId": 456,
    "unidadeJurisdicionada": "999004",
    "tipoContratadoId": "PJ",
    "cnpj": "10000000000005"
  },
  {
    "contratoId": 456,
    "unidadeJurisdicionada": "999004",
    "tipoContratadoId": "PF",
    "cpf": "00000000272"
  }
]
Exemplo de retorno (sucesso) 
[
  {
    "contratoId": 456,
    "unidadeJurisdicionada": "999004",
    "tipoContratadoId": "PJ",
    "cpf": null,
    "cnpj": "10000000000005",
    "documentoEstrangeiro": null,
    "dataCadastro": "2024-05-02T15:39:21.957",
    "usuarioCadastro": "11435633000149",
    "dataExclusao": null,
    "usuarioExclusao": null
  },
  {
    "contratoId": 456,
    "unidadeJurisdicionada": "999004",
    "tipoContratadoId": "PF",
    "cpf": "00000000272",
    "cnpj": null,
    "documentoEstrangeiro": null,
    "dataCadastro": "2024-05-02T15:39:22.100",
    "usuarioCadastro": "11435633000149",
    "dataExclusao": null,
    "usuarioExclusao": null
  }
]
Exemplo de retorno (erro) 
[
  {
    "erros": [
      {
        "campo": "cnpj",
        "mensagem": "CNPJ inválido"
      }
    ]
  }
]

Detalhamento dos campos

O payload de entrada é um vetor (array JSON) de objetos. Cada objeto segue a mesma estrutura descrita na seção 4.2.5 Inserir Parte do Instrumento Jurídico. O retorno também é um vetor, contendo o resultado de cada operação individualmente.

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que receberá a parte
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoContratadoId Texto(2) Sim Entrada / Saída Código do Tipo de Licitante (verificar Tabelas de Domínio)
cpf Texto(11) Não Entrada / Saída CPF da parte (caso o tipo seja PF)
cnpj Texto(14) Não Entrada / Saída CNPJ da parte (caso o tipo seja PJ)
documentoEstrangeiro Texto(100) Não Entrada / Saída Documento Identificador do Estrangeiro (caso o tipo seja PE)
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do registro no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.2.20 Download do Documento do Instrumento Jurídico (Sistema)#

Serviço que permite o download de documentos de um instrumento jurídico por sistemas integrados. Funciona de forma similar ao endpoint de Download do Documento do Instrumento Jurídico, porém com permissões de integração de sistema.

Endpoint 
${BASE_URL}/api/webservice/documentos-download/documentos-contratos
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/documentos-download/documentos-contratos?id=5123&contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 5123,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "tipoDocumentoId": 3,
  "termoContratoId": null,
  "descricao": "Contrato assinado",
  "nomeArquivo": "contrato.pdf",
  "arquivoContentType": "application/pdf",
  "conteudo": "JVBERi0xLjQK...",
  "dataCadastro": "2024-05-02T08:59:24.967",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": null,
  "usuarioExclusao": null
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Não existe instrumento jurídico com o id informado"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código único do documento gerado pelo RemessaTCEPE após inclusão
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico que possui o documento
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
tipoDocumentoId Inteiro Não Saída Código do Tipo de Documento (verificar Tabelas de Domínio)
termoContratoId Inteiro Não Saída Código do Termo do Contrato caso o documento esteja associado a um termo
descricao Texto(100) Não Saída Breve descrição do documento
nomeArquivo Texto(100) Não Saída Nome do arquivo do documento
arquivoContentType Texto(100) Não Saída Tipo do arquivo do documento
conteudo Image Não Saída Texto contendo a imagem (binário) do arquivo
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do documento no sistema
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ de exclusão do documento no sistema
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.3 Serviços para Execução do Instrumento Jurídico#

4.3.1 Inserir Execução#

Serviço que permite inserir dados de execução (medições, pagamentos, empenhos) de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/execucao
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "situacaoObraId": 1,
  "anoExecucao": 2024,
  "mesExecucao": 6,
  "valorMedido": 5000.0000,
  "valorPago": 5000.0000,
  "naoTemBm": false,
  "naoTemFotos": false,
  "empenhos": [
    {
      "numeroEmpenho": "001",
      "anoEmpenho": 2024,
      "unidadeOrcamentaria": "999004"
    }
  ],
  "arquivosBoletimsMedicoes": [
    {
      "id": null,
      "nome": "boletim.pdf",
      "contentType": "application/pdf",
      "conteudo": "JVBERi0xLjQK..."
    }
  ],
  "arquivosFotos": [
    {
      "id": null,
      "nome": "foto.jpg",
      "contentType": "image/jpeg",
      "conteudo": "/9j/4AAQSkZJRg..."
    }
  ]
}
Exemplo de retorno (sucesso) 
{
  "id": 789,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "situacaoObraId": 1,
  "anoExecucao": 2024,
  "mesExecucao": 6,
  "valorMedido": 5000.0000,
  "valorPago": 5000.0000,
  "naoTemBm": false,
  "naoTemFotos": false,
  "dataCadastro": "2024-06-15T10:22:33.123",
  "usuarioCadastro": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código gerado pelo RemessaTCEPE após inclusão da execução
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico ao qual a execução pertence
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
situacaoObraId Inteiro Não Entrada / Saída Código da Situação da Obra (verificar Tabelas de Domínio)
anoExecucao Inteiro Sim Entrada / Saída Ano da execução
mesExecucao Inteiro Sim Entrada / Saída Mês da execução
valorMedido Decimal(20,4) Não Entrada / Saída Valor medido no período. Precisão de 4 dígitos decimais
valorPago Decimal(20,4) Não Entrada / Saída Valor pago no período. Precisão de 4 dígitos decimais
naoTemBm Booleano Não Entrada / Saída Informar se a execução não possui boletim de medição
naoTemFotos Booleano Não Entrada / Saída Informar se a execução não possui fotos
empenhos Vetor Não Entrada / Saída Vetor com os empenhos da execução
empenhos.id Inteiro Não Saída Código do empenho
empenhos.numeroEmpenho Texto(100) Não Entrada / Saída Número do empenho
empenhos.anoEmpenho Inteiro Não Entrada / Saída Ano do empenho
empenhos.unidadeOrcamentaria Texto(6) Não Entrada / Saída Código da unidade orçamentária do empenho
arquivosBoletimsMedicoes Vetor Não Entrada / Saída Vetor com arquivos de boletins de medições
arquivosBoletimsMedicoes.id Inteiro Não Entrada / Saída Código do arquivo
arquivosBoletimsMedicoes.nome Texto(100) Não Entrada / Saída Nome do arquivo
arquivosBoletimsMedicoes.contentType Texto(100) Não Entrada / Saída Tipo do arquivo
arquivosBoletimsMedicoes.conteudo Image Não Entrada Conteúdo binário do arquivo codificado em Base64
arquivosFotos Vetor Não Entrada / Saída Vetor com arquivos de fotos
arquivosFotos.id Inteiro Não Entrada / Saída Código do arquivo
arquivosFotos.nome Texto(100) Não Entrada / Saída Nome do arquivo
arquivosFotos.contentType Texto(100) Não Entrada / Saída Tipo do arquivo
arquivosFotos.conteudo Image Não Entrada Conteúdo binário do arquivo codificado em Base64
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.3.2 Atualizar Execução#

Serviço que permite atualizar dados de execução de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/execucao
Método HTTP PUT
Exemplo de payload 
{
  "id": 789,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "situacaoObraId": 1,
  "anoExecucao": 2024,
  "mesExecucao": 6,
  "valorMedido": 6000.0000,
  "valorPago": 6000.0000,
  "naoTemBm": false,
  "naoTemFotos": false,
  "empenhos": [
    {
      "numeroEmpenho": "001",
      "anoEmpenho": 2024,
      "unidadeOrcamentaria": "999004"
    }
  ]
}
Exemplo de retorno (sucesso) 
{
  "id": 789,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "situacaoObraId": 1,
  "anoExecucao": 2024,
  "mesExecucao": 6,
  "valorMedido": 6000.0000,
  "valorPago": 6000.0000,
  "dataCadastro": "2024-06-15T10:22:33.123",
  "usuarioCadastro": "11435633000149",
  "dataUltimaAtualizacao": "2024-06-16T09:11:22.456",
  "usuarioUltimaAtualizacao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Execução inexistente"
    }
  ]
}

Detalhamento dos campos

Os campos são os mesmos descritos em Inserir Execução, com a diferença de que o campo id é obrigatório na entrada para identificar a execução que será atualizada.

4.3.3 Consultar Execução#

Serviço para consultar dados de execução de um instrumento jurídico previamente cadastrado no RemessaTCEPE. Todos os parâmetros de busca são opcionais.

Endpoint 
${BASE_URL}/api/webservice/execucao
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/execucao?contratoId=456&unidadeJurisdicionada=999004
ou 
${BASE_URL}/api/webservice/execucao?id=789
Exemplo de retorno (sucesso)
Retorna os dados da execução com todos os campos descritos em Inserir Execução.
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Entrada / Saída Código da execução
contratoId Inteiro Não Entrada / Saída Código do instrumento jurídico
unidadeJurisdicionada Texto(6) Não Entrada / Saída Código da unidade jurisdicionada

Os campos de retorno seguem a mesma estrutura descrita em Inserir Execução.

4.3.4 Excluir Execução#

Serviço que permite excluir dados de execução de um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/execucao
Método HTTP DELETE
Exemplo de requisição 
${BASE_URL}/api/webservice/execucao?id=789&contratoId=456&unidadeJurisdicionada=999004
Exemplo de retorno (sucesso) 
{
  "id": 789,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "dataCadastro": "2024-06-15T10:22:33.123",
  "usuarioCadastro": "11435633000149",
  "dataExclusao": "2024-06-20T14:30:00.000",
  "usuarioExclusao": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Execução inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Sim Entrada / Saída Código da execução que será excluída
contratoId Inteiro Sim Entrada Código do instrumento jurídico ao qual a execução pertence
unidadeJurisdicionada Texto(6) Sim Entrada Código da unidade jurisdicionada proprietária do instrumento jurídico
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.4 Serviços para Obra do Instrumento Jurídico#

4.4.1 Inserir Obra#

Serviço que permite inserir dados de obra vinculada a um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/obras
Método HTTP POST
Exemplo de payload 
{
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "naturezaObra": [1, 12],
  "dataInicio": "2024-06-01",
  "possuiConvenio": true,
  "convenios": [
    {
      "numero": "001",
      "ano": 2024,
      "cnpjOrgao": "10000000000005",
      "nomeOrgao": "Órgão Exemplo",
      "valorRepassado": 50000.0000,
      "valorRecebido": 50000.0000,
      "tipoRecursoId": 1
    }
  ],
  "situacaoObraId": 1,
  "informacoesAdicionais": "Informações complementares da obra",
  "tipoGeometriaId": 1,
  "geometrias": [
    {
      "descricao": "Ponto 1",
      "latitude": -8.0476,
      "longitude": -34.8770,
      "uf": "PE",
      "municipio": "Recife",
      "endereco": "Av. Exemplo, 123",
      "cep": "50000000"
    }
  ],
  "arquivoOrdemServico": {
    "id": null,
    "nome": "ordem_servico.pdf",
    "contentType": "application/pdf",
    "conteudo": "JVBERi0xLjQK..."
  }
}
Exemplo de retorno (sucesso) 
{
  "id": 111,
  "contratoId": 456,
  "unidadeJurisdicionada": "999004",
  "naturezaObra": [1, 12],
  "dataInicio": "2024-06-01",
  "possuiConvenio": true,
  "situacaoObraId": 1,
  "dataCadastro": "2024-06-01T09:22:33.123",
  "usuarioCadastro": "11435633000149"
}
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Saída Código gerado pelo RemessaTCEPE após inclusão da obra
contratoId Inteiro Sim Entrada / Saída Código do instrumento jurídico ao qual a obra pertence
unidadeJurisdicionada Texto(6) Sim Entrada / Saída Código da unidade jurisdicionada proprietária do instrumento jurídico
naturezaObra Vetor de Inteiros Sim Entrada / Saída Vetor com os códigos de natureza da obra (verificar Tabelas de Domínio)
dataInicio Data Sim Entrada / Saída Data de início da obra no padrão AAAA-MM-DD
dataConclusao Data Não Entrada / Saída Data de conclusão da obra no padrão AAAA-MM-DD
possuiConvenio Booleano Sim Entrada / Saída Informar se a obra possui convênio
convenios Vetor Não Entrada / Saída Vetor com os convênios da obra (obrigatório se possuiConvenio = true)
convenios.id Inteiro Não Saída Código do convênio
convenios.numero Texto(100) Não Entrada / Saída Número do convênio
convenios.ano Inteiro Não Entrada / Saída Ano do convênio
convenios.cnpjOrgao Texto(14) Não Entrada / Saída CNPJ do órgão do convênio
convenios.nomeOrgao Texto(200) Não Entrada / Saída Nome do órgão do convênio
convenios.valorRepassado Decimal(20,4) Não Entrada / Saída Valor repassado do convênio
convenios.valorRecebido Decimal(20,4) Não Entrada / Saída Valor recebido do convênio
convenios.tipoRecursoId Inteiro Não Entrada / Saída Tipo do recurso do convênio (verificar Tabelas de Domínio)
situacaoObraId Inteiro Sim Entrada / Saída Código da Situação da Obra (verificar Tabelas de Domínio)
informacoesAdicionais Texto(5000) Não Entrada / Saída Informações adicionais sobre a obra
tipoGeometriaId Inteiro Não Entrada / Saída Código do Tipo de Geometria (verificar Tabelas de Domínio)
geometrias Vetor Não Entrada / Saída Vetor com os pontos geográficos da obra
geometrias.id Inteiro Não Saída Código do ponto geográfico
geometrias.descricao Texto(200) Não Entrada / Saída Descrição do ponto
geometrias.latitude Decimal Não Entrada / Saída Latitude do ponto
geometrias.longitude Decimal Não Entrada / Saída Longitude do ponto
geometrias.uf Texto(2) Não Entrada / Saída UF do ponto
geometrias.municipio Texto(200) Não Entrada / Saída Município do ponto
geometrias.endereco Texto(500) Não Entrada / Saída Endereço do ponto
geometrias.cep Texto(8) Não Entrada / Saída CEP do ponto
justificativaAusenciaGeometria Texto(5000) Não Entrada / Saída Justificativa caso não exista geometria
arquivoOrdemServico Objeto Não Entrada / Saída Objeto contendo dados do arquivo de ordem de serviço
arquivoOrdemServico.id Inteiro Não Saída Código do arquivo
arquivoOrdemServico.nome Texto(100) Não Entrada / Saída Nome do arquivo
arquivoOrdemServico.contentType Texto(100) Não Entrada / Saída Tipo do arquivo
arquivoOrdemServico.conteudo Image Não Entrada Conteúdo binário do arquivo codificado em Base64
dataCadastro Data e Hora Não Saída Data e hora de cadastro do registro
usuarioCadastro Texto(14) Não Saída CPF ou CNPJ do usuário de cadastro do registro
dataUltimaAtualizacao Data e Hora Não Saída Data e hora de última atualização do registro
usuarioUltimaAtualizacao Texto(14) Não Saída CPF ou CNPJ do usuário de última atualização do registro
dataExclusao Data e Hora Não Saída Data e hora de exclusão do registro
usuarioExclusao Texto(14) Não Saída CPF ou CNPJ do usuário de exclusão do registro
erros Vetor Não Saída Vetor com erros identificados na operação realizada
erros.campo Texto(100) Não Saída Campo originou o erro na operação ou null caso não se aplique
erros.mensagem Texto(500) Não Saída Mensagem de erro na operação realizada

4.4.2 Atualizar Obra#

Serviço que permite atualizar dados de obra vinculada a um instrumento jurídico previamente cadastrado no RemessaTCEPE.

Endpoint 
${BASE_URL}/api/webservice/obras
Método HTTP PUT
Exemplo de payload
Mesmos campos de Inserir Obra, com o campo id obrigatório para identificar a obra que será atualizada.
Exemplo de retorno (sucesso)
Retorna os dados atualizados da obra com os campos descritos em Inserir Obra.
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "id",
      "mensagem": "Obra inexistente"
    }
  ]
}

Detalhamento dos campos

Os campos são os mesmos descritos em Inserir Obra, com a diferença de que o campo id é obrigatório na entrada para identificar a obra que será atualizada.

4.4.3 Consultar Obra#

Serviço para consultar dados de obra vinculada a um instrumento jurídico previamente cadastrado no RemessaTCEPE. Todos os parâmetros de busca são opcionais.

Endpoint 
${BASE_URL}/api/webservice/obras
Método HTTP GET
Exemplo de requisição 
${BASE_URL}/api/webservice/obras?contratoId=456&unidadeJurisdicionada=999004
ou 
${BASE_URL}/api/webservice/obras?id=111
Exemplo de retorno (sucesso)
Retorna os dados da obra com todos os campos descritos em Inserir Obra.
Exemplo de retorno (erro) 
{
  "erros": [
    {
      "campo": "contratoId",
      "mensagem": "Instrumento jurídico inexistente"
    }
  ]
}

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
id Inteiro Não Entrada / Saída Código da obra
contratoId Inteiro Não Entrada / Saída Código do instrumento jurídico
unidadeJurisdicionada Texto(6) Não Entrada / Saída Código da unidade jurisdicionada

Os campos de retorno seguem a mesma estrutura descrita em Inserir Obra.

4.5 Serviços Públicos#

4.5.1 Download Público de Documento#

Serviço público (não requer autenticação) que permite realizar o download de documentos através de seu identificador e tipo de fonte. Este endpoint utiliza uma URL base pública, diferente dos demais endpoints que requerem autenticação.

Endpoint 
${BASE_URL_PUBLICA}/api/publico/webservice/documentos-download/externo
Método HTTP GET
Autenticação Não requer autenticação
Exemplo de requisição 
${BASE_URL_PUBLICA}/api/publico/webservice/documentos-download/externo?idDocumento=5615&tipoFonteDocumento=PROCESSO_LICITATORIO
Exemplo de retorno (sucesso)
Retorna o conteúdo do documento solicitado.
Exemplo de retorno (erro)
HTTP 404 Not Found (caso o documento não exista)

Detalhamento dos campos

Nome Tipo Obrigatório Entrada Entrada / Saída Descrição
idDocumento Inteiro Sim Entrada Código do documento a ser baixado
tipoFonteDocumento Texto Sim Entrada Tipo da fonte do documento (ex: PROCESSO_LICITATORIO, CONTRATO)