APIs – Aditivos de Contratos de Suprimentos

Este artigo descreve como consultar dados de Aditivos de Contratos de Suprimentos por meio das APIs do Sienge.
As APIs permitem a consulta e extração massiva de dados, facilitando integrações e análises externas.


Dica! A documentação de APIs é atualizada com frequência. Sempre consulte a versão mais recente no portal oficial:  https://api.sienge.com.br/docs/#/contracts-v1 


Visão geral das APIs disponíveis

Para consultar aditivos de contratos de suprimentos, estão disponíveis duas APIs do tipo GET:

  1. Consulta de aditivos (sem detalhamento de itens)

  2. Consulta dos itens de um aditivo específico

Essas APIs são complementares e devem ser usadas em conjunto quando for necessário obter o detalhamento completo.


API GET - Aditivos de Obras do Contrato (/supply-contracts/addenda)

imagem


Através dessa API GET, é possível consultar os contratos e obras que receberam aditivos, identificando a data, descrição e valores envolvidos, porém, sem o detalhamento dos insumos/serviços envolvidos. Os dados retornados são:

  • Contrato e obra envolvida;
  • Datas envolvidas (data do aditivo, data de cadastro, data da última alteração);
  • Usuários envolvidos (responsável pelo aditivo, pelo cadastro e pala última alteração);
  • Acordo de preço envolvido (caso o aditivo tenha sido gerado automaticamente devido a um Acordo de Preço);
  • Valores aditados totais (sem detalhamentos dos itens envolvidos, apenas valores finais, que podem ser positivos, negativos ou até mesmo zerado);


A API possui filtros disponíveis, mas nenhum deles é obrigatório. Apesar disso, recomendamos que sejam aplicados filtros para reduzir o volume de resultados encontrados, caso contrário, a tendência é que os primeiros resultados apresentados sejam sempre os mais antigos devido a ordenação padrão por "Data de cadastro" dos aditivos. Os filtros disponíveis são:

  • Contrato;
  • Obra;
  • Número do aditivo;
  • Data do aditivo (caso seja utilizado, deve enviar período inicial e final desejado);

 
API GET - Itens do Aditivo do Contrato (/supply-contracts/addenda/items)

 

imagem


Essa API GET complementa a anterior, trazendo o detalhamento dos itens envolvidos em aditivos específicos. Nele, é possível identificar os itens do contrato que receberam aditivo e suas modificações.

  • Itens aditados e suas informações principais (como descrição, detalhe e marca):
  • Quantidades envolvidas (quantidade contratada inicial, quantidade medida no momento do aditivo, quantidade aditada, podendo ser positiva ou negativa);
  • Preços envolvidos (preço unitário no inicio do aditivo e após o aditivo);
  • Valores aditados finais (considerando as modificações na quantidade e preço, caso tenham ocorrido);

Devido ao volume de informações que essa API pode retornar, é necessária a utilização dos filtros de Contrato, Obra e Número do aditivo, onde serão retornados os itens aditados dessa combinação específica.


OBS: Itens presentes no contrato mas que não sofreram nenhuma modificação no aditivo não serão retornados nessa API GET.

Esperamos que este artigo tenha ajudado!

Isso foi útil para você? Sim Não

Enviar feedback
Lamentamos não termos conseguido ajudá-lo(a) mais. Ajude-nos a melhorar este artigo com o seu feedback.