O que são APIs?
API, Application Programming Interface ou Interface de Programação de Aplicativos, é uma padronização para comunicação, transferência e/ou carregamento de dados entre dois sistemas, softwares ou aplicativos. Ou seja, APIs são Interfaces de Programação de Aplicações, ou um conjunto de endpoints de que formam um recurso como por exemplo: Clientes, Credores, Títulos a Receber. Podemos, por exemplo, obter dados, persistir, editar ou excluir um Cliente. O Recurso ou API é esse conjunto de algumas destas ações que podem ser feitas.
A documentação de APIs do Sienge Plataforma é um conteúdo técnico destinado principalmente à desenvolvedores, mas é possível de ser compreendida por usuários não técnicos seguindo os passos deste documento, que visa esclarecer os principais termos técnicos contidos na documentação. Alguns termos técnicos comuns em integrações que são abordados na nossa documentação são: Como entender a documentação das APIs? : Sienge Plataforma
A documentação de APIs é bem dinâmica e pode sofrer atualizações diárias, você pode acessar por este link: https://api.sienge.com.br/docs/
API BULK DATA de Insumos da Obra
Com esta API são retornados todos os insumos que pertencem a uma obra (exceto Item de Transporte e Item de Incidência) e estejam orçados ou apropriados. Vale lembrar que insumos que estão na Obra podem ser em quantidade igual ou superior a quantidade que consta em Orçamento (motivado pelas inclusões avulsas feitas no Suprimentos).
Nota! Um (1) insumo é composto por: código Insumo + código Detalhe + código Marca.
Caso não tenha Detalhe e Marca, é considerado como Preço Básico.
Atenção! Observações Gerais:
1) Quando um (1) insumo estiver na obra, mas não estiver no Orçamento e não existir qualquer tipo de apropriação com ele, NADA deste insumo será retornado no endpoint.
2) Caso o nível de apropriação da obra seja "Obra" somente são apresentados os insumos que estão orçados. Os dados de apropriação não são apresentados pois não tem o detalhamento por item de orçamento nessa situação.
Passo a passo
Atenção! Os filtros obrigatórios desta API são:
BuildingId - Código da Obra
Start Date - Data de início, somente aplicado nas Apropriações Atendidas.
End Date - Data de Término, somente aplicado nas Apropriações Atendidas.
Dica! Os filtros opcionais desta API são:
Include Disbursement - Parâmetro para trazer os desembolsos dos insumos. Esse parâmetro é falso como padrão.
BDI - Tipo de BDI ou percentual específico a ser utilizado no cálculo dos preços orçados. Esse parâmetro é 0 (zero) como padrão.
Labor Burden - Tipo de encargos sociais ou percentual específico a ser utilizado no cálculo dos preços orçados. Esse parâmetro é 0 (zero) como padrão.
Nota! Para cada insumo, será retornado:
- Informações cadastrais:
Aqui estamos falando dos dados de cadastro do insumo como por exemplo:
Código, Código auxiliar, Descrição, Obra (Id e Nome), Sinônimo, Unidade de Medida, Grupo de Insumos, Conta financeira, Classificação Fiscal, Produto fiscal, Tempo de entrega estimado em dias*, Situação do insumo (ativo ou não), Detalhe (id e descrição), Marca (id e descrição), Preço Unitário, Data do preço, Desembolso (Intervalo de entregas em dias e Parcelas (% e dias)), Unidades de Movimento (símbolo, nome, fator de conversão e se é o padrão ou não), Observações (id e descrição), Estoque mínimo e Estoque máximo.
- Representatividade deste insumo nos Itens do Orçamento:
Itens do Orçamento onde o Insumo está contido.
- Cronograma de Desembolso do insumo:
Relação de desembolsos do insumo. Cada item possui o ano, mês, valor e quantidade do desembolso. O cálculo de desembolso vai considerar percentuais de execução dos serviços. Quando a definição do custo da tarefa no planejamento estiver incompleta, valor e quantidade dos desembolsos podem ser menores que as que constam no orçamento. A diferença também pode ser observada no "Relatório de Composições dos Custos da Tarefa".
- Apropriações Pendentes e Apropriações Atendidas:
Para estas informações estamos retornando dados em conformidade com a regra de negócio existente no RELATÓRIO DE APROPRIAÇÕES DE INSUMOS do Gerencial Suprimentos.
Apropriações Pendentes são compostas por “Pedidos de compra pendentes” e “Contratos pendentes”. “Solicitações de Compras pendentes” não estão sendo consideradas e possivelmente nunca serão pelo fato de não terem valor financeiro associado.
Apropriações Atendidas são compostas por “Notas fiscais de compra” e “Medições registradas”. “Movimento de estoque” não está sendo considerados NESTE MOMENTO, ficando este ponto de atenção e adaptação para ser executado no futuro em momento oportuno.
Quais clientes podem utilizar APIs e Quais recursos do sistema estão disponíveis?
Clientes DC tem disponível os recursos de APIs. Para os clientes com servidor local o acesso de APIs não esta disponível.
Para saber mais sobre a disponibilidade e planos acesse Quais clientes podem utilizar APIs e Quais recursos do sistema estão disponíveis? : Sienge Plataforma
Esperamos que este artigo tenha ajudado!