Permissões de Usuário:

3865 – API Transferência Interna (Incluir)

Agora no Bluesoft ERP, a API de inclusão de transferência interna permite informar uma lista de centros de resultado para o rateio financeiro da operação.

A API de transferência interna permite informar o rateio financeiro por centro de resultado na mesma solicitação que inclui a transferência. O rateio pode ser usado nas transferências de Consumo com nota, Consumo sem nota e Insumo sem nota, de acordo com as condições já existentes para cada operação.

As validações do rateio são executadas antes da criação da nota fiscal, dos movimentos de estoque e dos demais registros da transferência.

Pré-requisitos

  • Gerar o token da API para um usuário com a permissão 3865 - API Transferência Interna (Incluir).
  • Cadastrar os centros de resultado financeiros que serão usados no rateio.
  • Habilitar a utilização de centro de resultado nos parâmetros contábeis para que o rateio seja aplicado à contabilização.
  • Para usar o centro do setor quando a lista não for enviada, vincular ao setor de transferência interna um subgrupo que possua um centro de resultado ativo.

Endpoint

Envie uma requisição POST para:

/api/modulos/estoque/operacoes/transferencia-interna

A estrutura já existente da transferência é preservada. O rateio financeiro é informado no campo opcional centroResultados.

Dados da transferência

CampoObrigatórioDescrição
lojaKeySimCódigo da loja responsável pela transferência.
estoqueOrigemSimEstoque de origem da operação.
setorTransferenciaKeySimCódigo do setor de transferência interna.
localDeEstoqueKeySimCódigo do local de estoque associado à loja.
produtosSimLista não vazia dos produtos da transferência.
centroResultadosNãoLista das parcelas do rateio financeiro. A omissão e o envio de uma lista vazia possuem comportamentos diferentes.

Cada item de produtos deve informar uma quantidade positiva e identificar o produto por produtoKey ou gtin.

Dados do rateio financeiro

CampoObrigatórioDescrição
centroResultadoKeySimCódigo de um centro de resultado financeiro existente.
valorNãoValor monetário da parcela. Não pode ser negativo.
porcentagemNãoPercentual da parcela. Não pode ser negativo.

Exemplo com percentuais

Os códigos abaixo são fictícios e devem ser substituídos pelos códigos do ambiente integrado.

{
  "lojaKey": 1,
  "estoqueOrigem": "ESTOQUE_VENDA",
  "setorTransferenciaKey": 1001,
  "localDeEstoqueKey": 10,
  "produtos": [
    {
      "produtoKey": 2001,
      "quantidade": 10
    }
  ],
  "centroResultados": [
    {
      "centroResultadoKey": 3001,
      "porcentagem": 60
    },
    {
      "centroResultadoKey": 3002,
      "porcentagem": 40
    }
  ]
}

Origem do rateio

O conteúdo de centroResultados determina a origem do rateio:

  • Campo omitido: quando a utilização de centro de resultado estiver habilitada, o ERP procura o centro ativo vinculado ao subgrupo do setor e atribui 100% a ele.
  • Lista vazia ([]): o ERP não herda o centro do setor. A operação continua sem rateio quando o preenchimento for opcional e é recusada quando for obrigatório.
  • Valor nulo (null): a solicitação é recusada com a mensagem A lista de centros de resultado não pode ser nula.
  • Lista preenchida: os centros informados têm precedência. O ERP não completa a lista com o centro configurado no setor.

Quando a utilização de centro de resultado estiver desabilitada, a lista recebida ainda será validada, mas não será aplicada à contabilização. Se o campo for omitido, nenhum centro será herdado.

Cálculo das parcelas

Para cada item do rateio:

  • Se somente valor for informado, o ERP calcula porcentagem com base no valor total da transferência.
  • Se somente porcentagem for informada, o ERP calcula valor com duas casas decimais e arredondamento HALF_UP.
  • Se valor e porcentagem forem informados, os dois dados devem representar a mesma parcela.
  • Se os dois campos forem omitidos, o ERP atribui 100% ao item.
  • O valor zero e o percentual zero são considerados dados informados.

O preenchimento de 100% ocorre por item. Assim, uma lista com dois itens sem valor e sem porcentagem resulta em 200% e é recusada.

Validações do rateio

A soma das porcentagens deve atingir 100%. O ERP aceita uma diferença de até 0,01 ponto percentual para mais ou para menos.

Os centros informados também seguem estas regras:

  • Um código inexistente recusa toda a solicitação.
  • Centros inativos não são aplicados e suas parcelas não são redistribuídas entre os centros ativos.
  • Quando houver centros ativos na lista, as parcelas ativas também devem atingir 100%.
  • Se o uso e a obrigatoriedade de centro de resultado estiverem habilitados, deve restar ao menos um centro ativo.
  • Quando o cálculo exigir uma base monetária, essa base deve ser positiva.

Resultado da operação

Após a validação, o rateio é encaminhado ao fluxo contábil já utilizado pela transferência interna. Ele é aplicado aos débitos elegíveis do processo, sem alterar as regras fiscais, o tratamento dos créditos ou as condições existentes para geração e faturamento da nota.

A resposta da API permanece com os identificadores dos movimentos de estoque e, quando houver emissão, o número da nota fiscal. Não é acrescentado um detalhamento do rateio à resposta.

Exemplo de resposta com dados fictícios:

{
  "movimentosEstoqueKeys": [900001, 900002],
  "notaFiscal": 12345
}

Exemplo de solicitação e resposta com dados fictícios:

Documentações relacionadas

Para saber mais sobre a utilização das APIs do ERP, clique aqui.

Disponível a partir da versão r376.01.