Em breve - API para Consulta de Notas Fiscais de Compra com Filtros Avançados

Esta API permite consultar notas fiscais de compra utilizando filtros avançados, como empresa, fornecedor, número da nota e período de emissão.
O objetivo é facilitar integrações, automações e análises fiscais, reduzindo consultas manuais e centralizando as informações no Sienge Plataforma.


A documentação está disponível no portal de APIs do Sienge Plataforma:
https://api.sienge.com.br/docs/#/purchase-invoices-v1


Pré-requisito


Antes de utilizar a API, verifique se você possui:

  • Usuário API com autenticação válida no Sienge Plataforma.

  • Permissão de acesso para consulta de notas fiscais de compra.


Passo a passo 

Como utilizar a API

Endpoint: GET /purchase-invoices


Filtros disponíveis

Você pode combinar os filtros conforme a sua necessidade:

  • companyId – ID da empresa

  • supplierId – ID do fornecedor

  • documentId – Tipo de documento

  • series – Série da nota fiscal

  • number – Número da nota fiscal

  • startDate e endDate – Período de emissão

A resposta retorna uma lista de notas fiscais de compra (PurchaseInvoice) de acordo com os filtros informados.


Paginação

A API possui suporte à paginação.
O limite de registros pode ser ajustado para melhorar o desempenho das consultas.


Status de resposta

  • 200 OK
    Consulta realizada com sucesso.
    Retorna uma lista de notas fiscais (que pode estar vazia).


Nota!  no momento, a documentação dos tickets não detalha outros códigos de resposta além do 200.


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.