Changelog da API

​

Novos campos e anexos em Contas a Pagar e Pedido de Compra

• Novos campos opcionais em POST /v2/financeiro/contaspagar, PUT /v2/financeiro/contaspagar e nas consultas GET /v2/financeiro/contaspagar, /baixados e /{ex}/{fil}/{nrtrs}/{seqtrs}:
  • PeriodoDeCompetencia (datetime) — período de competência do lançamento
  • CodigoDeBarras (string) — código de barras do boleto
  • CodigoDoCustoABC (string) — código do Custo ABC; quando informado, precisa ser um Custo ABC válido da empresa
  • DescricaoDoCustoABC (string, somente leitura) — descrição do Custo ABC
• Novos campos somente leitura em GET /v2/compras/pedido/{numeroPedido}:
  • Arquivos — anexos do pedido (Id, NomeDoArquivo, Url com token SAS e Observacao)
  • ArquivosNotasFiscais — anexos de notas fiscais do pedido, no mesmo formato
• As listas GET /v2/compras/pedido/abertos e /encerrados não preenchem os anexos
• Mudança aditiva: integrações existentes continuam funcionando sem alteração

{
  "numeroDaTransacao": 44102,
  "periodoDeCompetencia": "2026-09-01T00:00:00",
  "codigoDeBarras": "34191790010104351004791020150008291070026000",
  "codigoDoCustoABC": "ABC-01",
  "descricaoDoCustoABC": "Custo operacional"
}

{
  "numeroDoPedido": 9021,
  "arquivos": [
    {
      "id": "8c1e2a40-1b2f-4d3a-9e10-6f7a8b9c0d11",
      "nomeDoArquivo": "proposta.pdf",
      "url": "https://storage.example/proposta.pdf?sv=...",
      "observacao": null
    }
  ],
  "arquivosNotasFiscais": [
    {
      "id": "a11b22c3-d44e-455f-8667-77889900aabb",
      "nomeDoArquivo": "nfe-9021.xml",
      "url": "https://storage.example/nfe-9021.xml?sv=...",
      "observacao": null
    }
  ]
}

​

Responsável de compras e total de cotações na Ordem de Compra

• Novos campos somente leitura em GET /v2/compras/ordem/abertas, /encerradas e /{id}:
  • DescricaoDoColaboradorResponsavelCompras (string) — nome do colaborador responsável pelas compras
  • TotalDeCotacoes (int) — quantidade de cotações vinculadas à ordem
• Mudança aditiva: integrações existentes continuam funcionando sem alteração

{
  "numeroDaOrdem": 5821,
  "descricaoDoColaboradorResponsavelCompras": "Maria Souza",
  "totalDeCotacoes": 3
}

​

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

• Novos campos em GET /v2/faturamento/nfse/{id} e demais consultas e gravações de NFS-e (POST/PUT /v2/faturamento/nfse):
  • CodigoIndicadorDaOperacao (string), CodigoTipoDaOperacao (int) e CodigoIndicadorDoDestinatario (int) — indicadores da operação IBS/CBS
  • CodigoDaSituacaoTributariaIBSCBS (string) — CST de IBS/CBS
  • ClassificacaoIBSCBS (string) — classificação tributária (cClassTrib)
  • AliquotaIBSMunicipal, ValorIBSMunicipal, AliquotaIBSEstadual, ValorIBSEstadual, AliquotaCBS e ValorCBS (decimal)
  • CodigoDaSituacaoTributariaPIS e CodigoDaSituacaoTributariaCOFINS (string) — CST de PIS e COFINS
  • CodigoDaRetencaoPisCofinsCsll (string) — tipo de retenção de PIS, COFINS e CSLL
• Mudança aditiva: integrações existentes continuam funcionando sem alteração

{
  "codigoNBS": "1.1502.10.00",
  "codigoIndicadorDaOperacao": "100301",
  "codigoTipoDaOperacao": 1,
  "codigoDaSituacaoTributariaIBSCBS": "000",
  "classificacaoIBSCBS": "000001",
  "aliquotaIBSMunicipal": 0.1,
  "valorIBSMunicipal": 10.0,
  "aliquotaIBSEstadual": 0.1,
  "valorIBSEstadual": 10.0,
  "aliquotaCBS": 0.9,
  "valorCBS": 90.0
}

​

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

• Novos campos em POST /v2/financeiro/contaspagar, PUT /v2/financeiro/contaspagar e nas consultas GET /v2/financeiro/contaspagar, /baixados e /{ex}/{fil}/{nrtrs}/{seqtrs}:
  • ValorBruto (decimal) — valor do lançamento antes dos impostos retidos
  • ValorPISRetido, ValorCOFINSRetido, ValorCSLLRetido, ValorIRRetido, ValorISSRetido e ValorINSSRetido (decimal)
• ValorDoLancamento passa a representar o valor líquido do título
• Novo campo somente leitura Arquivos no GET /v2/financeiro/contaspagar/{ex}/{fil}/{nrtrs}/{seqtrs} e nas respostas de inclusão, alteração e exclusão — lista os anexos do lançamento (Id, NomeDoArquivo, Url com token SAS e Observacao)
• As listagens GET /v2/financeiro/contaspagar e /baixados não preenchem Arquivos
• Mudança aditiva: integrações existentes continuam funcionando sem alteração

{
  "valorBruto": 1650.5,
  "valorPISRetido": 10.73,
  "valorCOFINSRetido": 49.52,
  "valorCSLLRetido": 16.51,
  "valorIRRetido": 24.76,
  "valorISSRetido": 33.01,
  "valorINSSRetido": 15.47,
  "valorDoLancamento": 1500.5,
  "arquivos": [
    {
      "id": "3f2a1b00-9c8d-4e7f-a123-456789abcdef",
      "nomeDoArquivo": "boleto.pdf",
      "url": "https://storage.example/boleto.pdf?sv=...",
      "observacao": null
    }
  ]
}

​

Novos campos no cadastro de Produto

• Novos campos opcionais em POST /v2/produto e PUT /v2/produto (também retornados nas consultas GET):
  • CodigoGenerico (string) — código genérico do produto
  • DescricaoDoProdutoIngles (string) — descrição em inglês (o campo DescricaoDoProduto continua preenchendo apenas a descrição em português)
  • PesoBruto e PesoLiquido (decimal) — substituem o uso do campo Peso, que não preenchia os pesos bruto e líquido na plataforma
  • Altura, Largura e Comprimento (string) — dimensões do produto
• O campo Peso permanece no contrato por compatibilidade, mas não popula PesoBruto/PesoLiquido. Prefira os novos campos.
• Mudança aditiva: integrações existentes continuam funcionando sem alteração

{
  "codigoInterno": "PROD-001",
  "codigoGenerico": "GEN-001",
  "descricaoDoProduto": "Produto exemplo",
  "descricaoDoProdutoIngles": "Example product",
  "pesoBruto": 1.5,
  "pesoLiquido": 1.2,
  "altura": "10",
  "largura": "20",
  "comprimento": "30"
}

​

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"
}