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/
Notas Fiscais: API BULK para leitura de dados
Já está disponível API Bulk Relatório Notas Fiscais, que possibilita a leitura dos dados de itens das notas fiscais. A consulta traz os dados completos dos itens das notas fiscais no formato de uma API Bulk Data que pode ser consumido por um BI ou Excel.
Atenção! Esta API não busca dados diretamente das notas fiscais do sistema, como NFe, ou NFS, sejam recebidas ou emitidas. E sim os dados dos itens das informações fiscais dos títulos e notas fiscais avulsas cadastradas no sistema. Esses títulos podem ter vínculo com notas de produto/serviço emitidas ou recepcionadas, bem como podem ser títulos cadastrados de forma avulsa no sistema.
Regras que precisam ser atendidas para retorno dos dados:
1) Contas a Pagar: Serão retornados os itens das informações fiscais (cujo status seja "completo") de títulos com status "Completo" do contas a pagar. Além disso, a data de entrada cadastrada nas informações fiscais do título precisa estar compreendida entre as datas de início (startDate) e fim (endDate) passadas como parâmetro ao chamar a API.
2) Contas a Receber: Serão retornados os itens das informações fiscais de títulos do contas a receber. Além disso, a data de saída cadastrada nas informações fiscais do título precisa estar compreendida entre as datas de início (startDate) e fim (endDate) passadas como parâmetro ao chamar a API.
3) Notas Fiscais Avulsas (Notas Fiscais>Emissão de NF-e ou Notas Fiscais>Emissão de NFS-e ou NOtas Fiscais>Recepção de NF-e ou notas Fiscais>Recepção de NFS-e): Serão retornados os itens das notas fiscais avulsas de entrada/saída com status "Completo". Além disso, a data de entrada/saída cadastrada na nota fiscal avulsa precisa estar compreendida entre as datas de início (startDate) e fim (endDate) passadas como parâmetro ao chamar a API.
Esta API Bulk retorna os mesmos dados que podem ser obtidos no Relatório de Notas Fiscais acessível em: Contabilidade/Fiscal > Obrigações Fiscais > Relatórios > Notas Fiscais.
A API Bulk Data Relatório Notas Fiscais traz as seguintes informações:
- Valor de despesas acessórias do item
- Valor da base de cálculo do COFINS.
- Valor da alíquota do COFINS.
- Código da situação tributária do COFINS.
- Valor total do COFINS.
- Número do empreendimento.
- Valor de desconto do item.
- Código do documento utilizado (CT, NF, NFE).
- Número do documento da nota fiscal.
- Data de entrada/saída da nota fiscal.
- Tipo da nota fiscal quando avulsa.
- Valor do frete do item.
- Valor da base de cálculo do ICMS.
- Valor do ICMS isento.
- Valor do ICMS desonerado.
- Valor do ICMS outros.
- Valor da alíquota do ICMS.
- Valor da base de cálculo do ICMS-ST.
- Valor da alíquota do ICMS-ST.
- Valor total do ICMS-ST.
- Código da situção tributária do ICMS.
- Valor total do ICMS.
- Valor do seguro do item.
- Valor da base de cálculo do IPI.
- Valor do IPI isento.
- Valor total do IPI informado na totalização do item.
- Valor do IPI outros.
- Valor da alíquota do IPI.
- Código da situção tributária do IPI
- Valor total do IPI.
- Data de emissão da nota fiscal.
- Tipo do item.
- Código do NCM.
- Código fiscal da operação.
- Código do participante da operação.
- CPF/CNPJ do participante da operação;
- UF do participante da operação.
- Nome do participante da operação
- Inscrição estadual do participante da operação.
- Valor da base de cálculo do PIS.
- Valor da alíquota do PIS.
- Código da situção tributária do PIS.
- Valor total do PIS.
- Código do produto fiscal
- Descrição do produto fiscal
- Código da origem da mercadoria (ICMS).
- Quantidade do item.
- Número de sério da nota fiscal.
- Valor total do item.
- Símbolo da unidade de medida (Kg, m2, m3)
- Valor unitário do item.
Com os seguintes filtros:
- Código da empresa.
- Data fim para entrada/saída da nota fiscal
- Define se o código do empreendimento presente nas apropriações financeiras da nota será trazido no resultado da consulta. Valores válidos: "S" ou "N".
- Data de início para entrada/saída da nota fiscal.
Para encontrar esse recurso basta acessar o endpoint:/bulk-data/v1/invoice-itens Disponível em nossa página de APIs.
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 está 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!