Blog

Objetivo

Permite consultar os empenhos positivos e negativos dos produtos, identificando a data, a natureza e a movimentação que originou o empenho.

Rota

GET /v1/produto_empenhoextrato_get

Parâmetros

Parâmetro	Tipo	Descrição
Page	Integer	Número da página.
PageSize	Integer	Quantidade de registros por página.
CodigoEmpresa	String	Código da empresa.
CodigoFilial	String	Código da filial.
CodigoProduto	String	Código do produto.
GrupoProdutoInicial	String	Grupo inicial do intervalo.
GrupoProdutoFinal	String	Grupo final do intervalo.
DataInicial	Date-time	Data inicial da consulta.
DataFinal	Date-time	Data final da consulta.
TipoEmpenho	String	Tipo do empenho.

As datas devem ser informadas no formato:

AAAA-MM-DD

DataInicial e DataFinal são obrigatórias.

Exemplo de requisição

GET /v1/produto_empenhoextrato_get?Page=1&PageSize=50&CodigoEmpresa=1&CodigoFilial=1&CodigoProduto=B1&DataInicial=2026-08-01&DataFinal=2026-08-31

Estrutura do retorno

{
  "pageSize": 50,
  "currentPage": 1,
  "maxPageSize": 200,
  "totalPages": 1,
  "totalItens": 1,
  "data": [
    {
      "codigoProduto": "B1",
      "descricaoProduto": "suco Limao",
      "unidadeMedida": "UN",
      "empenhos": [
        {
          "dataEmpenho": "2026-08-03",
          "quantidadeEmpenhada": -100,
          "naturezaEmpenho": "NEGATIVO",
          "tipoEmpenho": "NOTA_SAIDA",
          "descricaoEmpenho": "Nota Fiscal de Saída: 44387/1"
        }
      ]
    }
  ]
}

O retorno agrupa os registros localizados dentro da propriedade empenhos.

Campos do produto

Campo	Descrição
codigoProduto	Código do produto.
descricaoProduto	Descrição do produto.
unidadeMedida	Unidade de medida.
empenhos	Lista de empenhos do produto.

Campos do empenho

Campo	Descrição
dataEmpenho	Data do empenho.
quantidadeEmpenhada	Quantidade empenhada.
naturezaEmpenho	Indica se o empenho é positivo ou negativo.
tipoEmpenho	Código da origem funcional do empenho.
descricaoEmpenho	Descrição da movimentação de origem.

O tipo de empenho pode representar movimentações como pedidos, notas fiscais, ordens de produção e outras origens classificadas pelo MaxManager.