Documentação da API

POST /get_inventory_reports

Resumo

Este endpoint permite gerar relatórios de movimentação de estoque agrupados por mês e produto para uma unidade específica.

---

Descrição

Use este endpoint para obter relatórios consolidados de movimentações de estoque de uma unidade da plataforma. Os dados podem ser agrupados por quantidade ou valor monetário, permitindo análises mensais detalhadas.

---

Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	b31643fc-a45f-448c-99ee-736a547f6989
unit_token	string	Sim	Token identificador da unidade.	e6988e9e-b0c1-410c-ae08-aed7c64ac71f
year	number	Sim	Ano para gerar o relatório.	2024
type_data	string	Sim	Tipo de dados: "quantity" para quantidade ou "monetary_value" para valores monetários.	"quantity"
id_contact	string	Não	Token do contato para filtrar movimentações.	d125837d-a4f7-4562-91bb-e63db2e86ab2
id_product	string	Não	Token do produto para filtrar movimentações.	a6927665-6d56-4839-ad23-37d48717da13

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/get_inventory_reports' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "year": 2024,
  "type_data": "quantity",
  "id_product": "a6927665-6d56-4839-ad23-37d48717da13"
}'

---

Resposta

200 OK

Relatório gerado com sucesso.

{
  "success": true,
  "message": "Sucesso ao buscar relatório",
  "data": [
    {
      "product": "Produto A",
      "month": "Jan",
      "month_num": 1,
      "total": "150.50",
      "type": "in"
    },
    {
      "product": "Produto A",
      "month": "Jan",
      "month_num": 1,
      "total": "75.25",
      "type": "out"
    },
    {
      "product": "Produto A",
      "month": "Feb",
      "month_num": 2,
      "total": "200.00",
      "type": "in"
    }
  ]
}

Erros Comuns

Status	Mensagem	Descrição
400	"Parâmetros 'year' e 'type_data' são obrigatórios."	Os campos year e type_data devem ser fornecidos.
403	"Invalid data"	Token inválido ou não autorizado.
404	"Unit not found"	A unidade com o token fornecido não foi encontrada no sistema.
500	"DB Query Error"	Erro interno no servidor.

---

Observações

• Os relatórios são gerados apenas para movimentações ativas no ano especificado.
• Quando type_data for "quantity", o campo total representa a soma das quantidades.
• Quando type_data for "monetary_value", o campo total representa a soma dos valores (unitary_value * quantity).
• Os dados são agrupados por produto, mês e tipo de movimentação (entrada/saída).
• O campo month retorna o nome do mês abreviado em inglês (Jan, Feb, Mar, etc.).
• O campo month_num retorna o número do mês (1-12) para facilitar ordenações.
• Os resultados são ordenados por produto e número do mês.
• Filtros opcionais permitem restringir o relatório a contatos ou produtos específicos.