O módulo Ato de Pessoal permite consultar informações sobre admissões de servidores e concessões de benefícios (aposentadoria, reforma e reserva).

Ao checar um endpoint, podemos ver as informações específicas dele, como parâmetros necessários e o modelo de resposta. Com o “GET /v1/atos-pessoal/admissoes”, o sistema da sua UG pode recuperar todos os atos de admissão.

É possível filtrar por CPF do servidor, número de processo do TCEES, número da certidão, número da decisão ou ano de referência.

O retorno inclui informações detalhadas de cada admissão, como nome do servidor, cargo, tipo de ato, datas de homologação e publicação, situação do ato e dados do processo administrativo, e está em um formato facilmente manipulável por um técnico.

Além da admissão, também é possível consultar os atos de concessão de benefícios com “GET /v1/atos-pessoal/concessoes”.

O módulo Contratações permite consultar, cadastrar, atualizar e excluir contratações realizadas pela Unidade Gestora.

Ao checar o endpoint “POST /v1/contratacoes”, podemos ver as informações necessárias para cadastrar uma nova contratação por meio da API.

Aqui, é necessário enviar a identificação da contratação, tipo, modalidade, objeto, datas, valores estimados e dados do processo administrativo.

O retorno confirma o registro da contratação e fornece o identificador gerado, permitindo que o sistema acompanhe e atualize essas informações.

Além do cadastro, também é possível consultar todas as contratações (GET /v1/contratacoes), consultar uma contratação específica (GET /v1/contratacoes/{id}), atualizar (PUT /v1/contratacoes/{id}), excluir (DELETE /v1/contratacoes/{id}) ou realizar atualizações parciais (PATCH /v1/contratacoes/{id}) na contratação.

O módulo Instrumentos de Contratação permite consultar os documentos que formalizam as contratações, como contratos e termos aditivos.

Com o endpoint “GET /v1/instrumentos-contratacao”, o sistema da sua UG consegue recuperar todos os instrumentos de contratação cadastrados.

É possível refinar a busca informando o código da UG e o identificador da contratação, além de controlar a quantidade de resultados retornados por página.

O retorno inclui detalhes como número do instrumento, tipo, situação, datas de assinatura e publicação, valores, informações do contratado e links para os documentos.

Além deste endpoint, é possível buscar um instrumento específico pelo identificador dele (GET /v1/instrumentos-contratacao/{id}), útil quando você quer verificar um documento individualmente.

O módulo Remessas é voltado para o envio e acompanhamento de informações enviadas ao Tribunal. Com ele, é possível verificar o status das remessas e consultar possíveis inconsistências.

Ao acessar o endpoint “GET /v1/remessas”, o sistema da UG consegue listar todas as remessas ativas. É possível filtrar pelo tipo de remessa (como PCM, PCF, RCB, RCO, PCA, PES ou EPE), pelo ano de referência e pelo código da UG, além de controlar a paginação.

O retorno inclui informações detalhadas sobre cada remessa, como situação, datas de homologação e recebimento, status de validação e chaves associadas, permitindo que o sistema acompanhe facilmente o andamento das remessas.

Além desse endpoint, a API oferece outros recursos, como consultar uma remessa específica (GET /v1/remessas/{id}), enviar remessas (POST /v1/remessas/{id}), listar os ids habilitados para envio (GET /v1/remessas/ids-habilitados-envio/{modulo}) e verificar inconsistências (GET /v1/remessas/{id}/inconsistencias).

Então, com essa integração, você só vai precisar acessar o CidadES para homologar a remessa!

O módulo Unidades Gestoras fornece informações detalhadas sobre cada UG e seus responsáveis, bem como dados sobre obrigações e autorizações associadas.

O endpoint “GET /v1/unidades-gestoras” permite ao sistema da sua UG recuperar todas as unidades cadastradas ou filtrar por uma específica.

O retorno inclui código, nome, sigla, CNPJ, tipo, esfera de poder, situação e datas de cadastro e atualização.

Além deste endpoint principal, a API permite consultar uma UG específica (GET /v1/unidades-gestoras/{id}), listar todos os responsáveis (GET /v1/unidades-gestoras/{id}/responsaveis), verificar obrigações (GET /v1/unidades-gestoras/{id}/obrigatoriedades), autorizações de convênios (GET /v1/unidades-gestoras/{id}/autorizacoes/cnpj-extratos-banestes), datas limite das remessas (GET /v1/unidades-gestoras/{id}/datas-limite) e autos de infração (GET /v1/unidades-gestoras/{id}/autos-infracao).

Ao consultar os endpoints, você encontrará também os schemas no final da página da documentação da API. Eles descrevem todos os campos que podem ser enviados ou recebidos, indicando o tipo de dado, se é obrigatório ou opcional, e fornecendo exemplos de valores.

Esses schemas ajudam a entender melhor como estruturar as requisições e como interpretar as respostas, garantindo que a integração do seu sistema com o CidadES seja correta e segura.