Changelog da API

Cadastro de Projeto e Recebimento de Materiais

• Novo endpoint POST /v2/projeto — inclui um projeto (descricaoDoProjeto obrigatória)
• Novo endpoint PUT /v2/projeto — altera um projeto (codigoDoProjeto obrigatório); atualiza apenas os campos do contrato e preserva os demais dados do cadastro
• Novo endpoint DELETE /v2/projeto/{codigo} — exclui um projeto pelo código
• A consulta GET /v2/projeto continua como antes

POST /v2/projeto

{
  "descricaoDoProjeto": "Implantação Cliente XPTO",
  "seuCodigo": "PROJ-001",
  "ativo": true
}

• Novo endpoint GET /v2/compras/recebimento/pendentes — lista recebimentos pendentes
• Novo endpoint GET /v2/compras/recebimento/pedido/{numeroPedido} — obtém recebimentos de um pedido
• Novo endpoint GET /v2/compras/recebimento/{mov}/{id}/{seq} — obtém um recebimento pela chave de movimentação
• Novo endpoint PUT /v2/compras/recebimento — altera um recebimento pendente
• Novo endpoint POST /v2/compras/recebimento/processar — processa o recebimento e gera a entrada de estoque
• Os campos podeEditar e podeProcessar do retorno indicam qual ação é válida para o registro

POST /v2/compras/recebimento/processar

{
  "numeroDaMovimentacao": 1001,
  "numeroDoPedido": 1024,
  "seqMovimentacao": 1,
  "quantidade": 10
}

Webhooks de saída

• Cadastro de endpoints HTTPS com os eventos assinados e token exclusivo, em /api/webhooks
• Primeiro evento disponível: compras.pedido-de-compra.processado
• Entregas com headers X-Gestio-Webhook-Id, X-Gestio-Event e X-Gestio-Webhook-Token, novas tentativas automáticas, histórico e reenvio
• Teste do endpoint com payload de exemplo de cada evento assinado (dados fictícios e teste: true no envelope)

{
  "id": "3f2b8c1e-6a4d-4f0b-9c2e-1d7a5b8e9f10",
  "tipo": "compras.pedido-de-compra.processado",
  "versao": 1,
  "ocorridoEm": "2026-11-03T14:30:00Z",
  "dados": { "numeroDoPedido": 1024, "sequencia": 1, "valorTotal": 1500.0 }
}

Itens e aprovações nas Requisições de Estoque

• GET /v2/estoque/requisicao/pendentes e GET /v2/estoque/requisicao/finalizadas agora retornam itens e aprovacoesReprovacoes preenchidos — antes esses campos vinham vazios
• Como a resposta ficou maior, use o parâmetro qtde para limitar a quantidade de requisições por chamada

Inclusão, exclusão e ativação de endereçamento de produto

• Novo endpoint POST /v2/estoque/produto/mapeamento — inclui um endereçamento
• Novo endpoint DELETE /v2/estoque/produto/mapeamento — exclui um endereçamento (chave enviada no corpo da requisição)
• Novos endpoints POST /v2/estoque/produto/mapeamento/ativar e POST /v2/estoque/produto/mapeamento/desativar
• Em todos eles, idProd, codigoDaFilial e codigoDoAlmoxarifado são obrigatórios; ativar/desativar consideram também codigoDaSecao
• Os campos podeAtivar e podeDesativar do retorno indicam qual ação é válida para o registro
• As consultas GET /v2/estoque/produto/mapeamento e GET /v2/estoque/produto/mapeamento/{id} continuam como antes

POST /v2/estoque/produto/mapeamento

{
  "idProd": 1523,
  "codigoDaFilial": 1,
  "codigoDoAlmoxarifado": 2,
  "codigoDaSecao": "A01"
}

Inclusão de produtos em lote

• Novo endpoint POST /v2/produto/lote — recebe um array não vazio de produtos e cadastra todos em uma única chamada
• O retorno traz apenas totalDeProdutosInseridos, e não a lista dos produtos criados
• POST /v2/produto continua sendo a rota de inclusão unitária, com o produto inserido no retorno

POST /v2/produto/lote

[
  { "codigoInterno": "PROD-001", "descricaoDoProduto": "Produto exemplo 1", "controleDeEstoque": true, "ativo": true },
  { "codigoInterno": "PROD-002", "descricaoDoProduto": "Produto exemplo 2", "controleDeEstoque": true, "ativo": true }
]

{
  "success": true,
  "data": { "totalDeProdutosInseridos": 2 }
}

Anexos do Pedido de Compra e novos campos em Contas a Pagar

• Novos campos arquivos e arquivosNotasFiscais em GET /v2/compras/pedido/{numeroPedido} — anexos do pedido e anexos de notas fiscais, cada um com id, nomeDoArquivo, observacao e url (URL de acesso com token). Os anexos não são retornados nas listagens /abertos e /encerrados
• Novos campos CodigoDeBarras (string), PeriodoDeCompetencia (datetime, opcional), CodigoDoCustoABC (string) e DescricaoDoCustoABC (string) no retorno de Contas a Pagar

{
  "numeroDoPedido": 1024,
  "arquivos": [
    {
      "id": "3f2b8c1e-6a4d-4f0b-9c2e-1d7a5b8e9f10",
      "nomeDoArquivo": "cotacao-fornecedor.pdf",
      "observacao": "Cotação aprovada",
      "url": "https://.../cotacao-fornecedor.pdf?sas=..."
    }
  ],
  "arquivosNotasFiscais": []
}

Novos campos na Ordem de Compra

• Novo campo DescricaoDoColaboradorResponsavelCompras (string) em GET /v2/compras/ordem/abertas, /encerradas e /{id} — nome do comprador responsável pela ordem
• Novo campo TotalDeCotacoes (int) nos mesmos endpoints — quantidade de cotações registradas na ordem

Campos da reforma tributária na Nota Fiscal de Serviço

• Novos campos no retorno e no envio de NFS-e (GET, POST e PUT /v2/faturamento/nfse e demais consultas):
  • IBS/CBS: CodigoDaSituacaoTributariaIBSCBS (CST), ClassificacaoIBSCBS (cClassTrib), AliquotaIBSEstadual, ValorIBSEstadual, AliquotaIBSMunicipal, ValorIBSMunicipal, AliquotaCBS e ValorCBS
  • PIS/COFINS/CSLL: CodigoDaSituacaoTributariaPIS, CodigoDaSituacaoTributariaCOFINS e CodigoDaRetencaoPisCofinsCsll
  • Operação: CodigoIndicadorDaOperacao, CodigoTipoDaOperacao e CodigoIndicadorDoDestinatario
• Todos são opcionais; integrações que ainda não tratam IBS/CBS continuam funcionando sem alteração

Valor bruto, retenções e anexos em Contas a Pagar

• Novos campos de valores no retorno de Contas a Pagar: ValorBruto, ValorPISRetido, ValorCOFINSRetido, ValorCSLLRetido, ValorIRRetido, ValorISSRetido e ValorINSSRetido (decimal) — permitem conciliar o valor do título antes e depois das retenções
• Novo campo arquivos com os anexos do título (id, nomeDoArquivo, observacao e url de acesso com token), retornado em GET /v2/financeiro/contaspagar/{ex}/{fil}/{nrtrs}/{seqtrs} e nas respostas de inclusão, alteração e exclusão. As listagens GET /v2/financeiro/contaspagar e /baixados retornam arquivos vazio

{
  "numeroDaTransacao": 88231,
  "valorBruto": 1000.0,
  "valorDoLancamento": 940.0,
  "valorIRRetido": 15.0,
  "valorISSRetido": 45.0,
  "arquivos": [
    {
      "id": "7c1e3f2b-4d6a-0b4f-2e9c-5b8e1d7a9f10",
      "nomeDoArquivo": "nota-fornecedor.pdf",
      "observacao": null,
      "url": "https://.../nota-fornecedor.pdf?sas=..."
    }
  ]
}

Novos campos no cadastro de Produto

• Novos campos em GET, POST e PUT /v2/produto: CodigoGenerico (string), DescricaoDoProdutoIngles (string), PesoBruto e PesoLiquido (decimal, opcionais) e Largura, Altura e Comprimento (string)
• Úteis para integrações de logística e comércio exterior, que precisam de peso e dimensões do produto

Previsões de Contas a Pagar e Contas a Receber

• Novos endpoints GET /v2/financeiro/previsaocontaspagar e GET /v2/financeiro/previsaocontasreceber — listam as previsões ordenadas pela data do próximo vencimento, com filtros opcionais codigoDaFilial e status (ativo, inativo ou todos; o padrão retorna ativas e inativas)
• Novos endpoints GET /v2/financeiro/previsaocontaspagar/{id} e GET /v2/financeiro/previsaocontasreceber/{id} — retornam uma previsão específica
• Novos endpoints POST /v2/financeiro/previsaocontaspagar e POST /v2/financeiro/previsaocontasreceber — incluem uma previsão; o id é gerado automaticamente
• A frequência é informada em frequencia: U (única), M (mensal), W (semanal), Q (quinzenal), B (bimestral), T (trimestral), S (semestral) ou A (anual)
• Alteração e exclusão de previsões continuam disponíveis apenas pelo sistema

GET /v2/financeiro/previsaocontaspagar?codigoDaFilial=1&status=ativo

{
  "success": true,
  "data": [
    {
      "id": 42,
      "codigoDaFilial": 1,
      "codigoDoFornecedor": 1523,
      "historico": "Aluguel da matriz",
      "lancamentoRecorrente": true,
      "frequencia": "M",
      "numeroDeParcelas": 12,
      "numeroDaProximaParcela": 3,
      "dataDoProximoVencimento": "2026-08-10T00:00:00",
      "valorDoLancamento": 1500.5,
      "ativo": true
    }
  ]
}

Filtro por centro de custo nas Requisições de Compra

• Novo parâmetro opcional CodigosCentroCustos (lista de string) em GET /v2/compras/requisicao/abertas e GET /v2/compras/requisicao/encerradas
• Se omitido, o comportamento é o mesmo de antes: retorna requisições de todos os centros de custo
• O parâmetro é repetido na query string para enviar múltiplos códigos

GET /v2/compras/requisicao/abertas?CodigoDaFilial=1&CodigosCentroCustos=001&CodigosCentroCustos=002

Campo de projeto liberado na Requisição de Compra

• Campos CodigoDoProjeto (int, opcional) e DescricaoDoProjeto (string) passam a ser retornados em GET /v2/compras/requisicao/abertas, GET /v2/compras/requisicao/encerradas e GET /v2/compras/requisicao/{id}
• Nenhuma ação é necessária caso sua integração já ignore campos desconhecidos no payload

{
  "numeroDaRequisicao": 1024,
  "codigoDoCentroDeCusto": "001",
  "codigoDoProjeto": 42,
  "descricaoDoProjeto": "Reforma Filial Centro"
}

Novos endpoints de Tipo e Motivo de Compra

• Novo endpoint GET /v2/compras/gerenciamento/tipodecompra — lista os tipos de compra cadastrados, com filtro opcional somenteAtivos
• Novo endpoint GET /v2/compras/gerenciamento/motivo — lista os motivos de compra cadastrados (ordenados por descrição), com filtro opcional somenteAtivos

GET /v2/compras/gerenciamento/tipodecompra?somenteAtivos=true

[
  {
    "codigoDoTipoDeCompra": 1,
    "descricaoDoTipoDeCompra": "Material de Consumo",
    "ativo": true
  }
]

Campo de código NBS na Nota Fiscal de Serviço

• Novo campo CodigoNBS (string) no retorno de GET /v2/faturamento/nfse/{id} e demais consultas de NFS-e, com a classificação do serviço prestado conforme a tabela NBS (Nomenclatura Brasileira de Serviços)

Data de liberação para aprovação em Ordem, Pedido e Requisição de Compra

• Novo campo DataLiberacaoParaAprovacao (datetime, opcional) no retorno de:
  • GET /v2/compras/ordem/abertas, /encerradas e /{id} (Ordem de Compra)
  • GET /v2/compras/pedido/abertos, /encerrados e /{numeroPedido} (Pedido de Compra)
  • GET /v2/compras/requisicao/abertas, /encerradas e /{id} (Requisição de Compra)
• Indica o momento em que o documento foi liberado para entrar no fluxo de aprovação, sem depender de uma consulta adicional ao histórico de aprovações/reprovações

{
  "numeroDaOrdem": 5821,
  "dataDaOrdem": "2026-05-20T09:12:00",
  "dataLiberacaoParaAprovacao": "2026-05-20T09:15:32"
}

Novos campos em Ordem e Pedido de Compra

• Novo campo NumeroDaRequisicaoDeEstoque (decimal, opcional) em GET /v2/compras/ordem/abertas, /encerradas e /{id} — identifica a requisição de estoque que originou a ordem de compra, quando aplicável
• Novo campo IdPedidoWS (string) em GET /v2/compras/pedido/abertos, /encerrados e /{numeroPedido} — identificador auxiliar do pedido, pensado para facilitar o rastreio de pedidos criados/consultados via integração

Número da requisição de compra na Ordem de Compra

• Novo campo NumeroDaRequisicaoDeCompra (decimal, opcional) em GET /v2/compras/ordem/abertas, /encerradas e /{id} — identifica diretamente qual requisição deu origem à ordem, sem necessidade de consulta adicional

Importação de endereçamento de produtos via API

• Novo endpoint POST /v2/sistema/importacao/enderecamento-de-produto — recebe um arquivo Excel com o mapeamento de endereçamento de produtos no estoque (localização física do produto no almoxarifado)
• Aceita o parâmetro de query preview (bool, padrão false): quando true, retorna apenas o total de registros identificados no arquivo, sem confirmar a importação

POST /v2/sistema/importacao/enderecamento-de-produto?preview=true
Content-Type: multipart/form-data

{
  "totalDeRegistros": 340,
  "produtoMapeamentoEstoque": [
    {
      "codigoDaFilial": 1,
      "codigoDoAlmoxarifado": 2,
      "codigoDaSecao": "A01",
      "idProd": 1523
    }
  ]
}

Novos endpoints de Requisição de Estoque

• Novo endpoint GET /v2/estoque/requisicao/pendentes — retorna as requisições de estoque pendentes por empresa e filial (filial), com limite opcional de registros (qtde)
• Novo endpoint GET /v2/estoque/requisicao/finalizadas — retorna as requisições de estoque já finalizadas, com os mesmos parâmetros

GET /v2/estoque/requisicao/pendentes?filial=1&qtde=50

[
  {
    "numeroDaRequisicao": 771,
    "dataDaRequisicao": "2026-02-24T10:00:00",
    "codigoDoCentroDeCusto": "003",
    "pendente": true,
    "liberadoParaAprovacao": true
  }
]

Filtro por código do cliente e campo de competência em Contas a Receber

• Novo parâmetro opcional codigoDoCliente (int) em GET /v2/financeiro/contasreceber e GET /v2/financeiro/contasreceber/baixados — filtra os títulos a receber de um cliente específico
• Novo campo PeriodoDeCompetencia (datetime, opcional) no retorno de ambos os endpoints

GET /v2/financeiro/contasreceber/baixados?codigoDoCliente=1523

{
  "numeroDaTransacao": 88231,
  "codigoDoCliente": 1523,
  "dataDeEmissao": "2026-01-10T00:00:00",
  "periodoDeCompetencia": "2026-01-01T00:00:00",
  "dataDePagamento": "2026-01-20T00:00:00"
}