POST entradas - Varejonline/api GitHub Wiki

POST https://integrador.varejonline.com.br/apps/api/entradas

• Qualquer valor relativo a tributação que não for informado será considerado como zero.

• Os valores de tributação serão calculados de acordo com o configurado na operação.
• Frete, seguro e outros devem ser informados no total. Cada um desses valores será distribuído proporcionalmente entre os produtos.
• Caso seja informado um desconto total, o valor dos descontos individuais será ignorado.
• Para corrigir algum eventual problema de arredondamento, total.valorProdutos e total.valorTotal podem informados para serem alterados em até 3 centavos.

Somente ao habilitar o parâmetro Permitir Vincular Pedido de Compra de Outra Entidade na Entrada de Notas, será possível selecionar pedidos de compra realizados em entidades diferentes.

Envie um JSON no corpo da requisição, contendo:

• entradaManual: Indica se a entrada deve ignorar cálculos de tributação, frete, seguro, desconto e outros. Todos esses valores devem ser informados manualmente em cada produto e também no total. (boolean) (opcional, padrão: false)

• entidade: id da entidade utilizada (long) (obrigatório)

• fornecedor: terceiro utilizado (obrigatório)

  • id: (opcional)
  • documento: com/sem formatação (opcional)

• dataEmissao: (string dd-MM-yyyy) (obrigatório)

• dataEntrada: (string dd-MM-yyyy) (obrigatório)

• operacao: id da operação, considerada como operação principal. Pode ser alterada em cada produto (long) (obrigatório)

• pedidosCompra: ids dos pedidos de compra (array[long]) (opcional)

• encerrarPedidosCompra: altera automaticamente o status do(s) pedido(s) vinculados a entrada para encerrado (boolean) (opcional, padrão: false)

• numeroDocumento: número da nota (int) (obrigatório)

• serie: (int) (obrigatório)

• chaveNfe: (String) (obrigatório caso tipoNotaFiscal = NOTA_55)

• tipoNotaFiscal: tipo de nota fiscal: NOTA_55, NOTA_1, NOTA_1A ou NOTA_4 (string) (obrigatório)

• dadosAdicionais: dados adicionais da nota (string) (opcional)

• excluirIcmsDaBasePisCofins: excluir o ICMS da base de cálculo do PIS e COFINS (boolean) (opcional, padrão: false)

• cte: Conhecimento de transporte (opcional)

  • numero: (obrigatório)
  • valorIcms: (opcional)
  • valorPis: (opcional)
  • valorCofins: (opcional)
  • valorTotal: (obrigatório)
  • data: (obrigatório)
  • prestadorServico: terceiro terceiro prestador do serviço (obrigatório)
    • id: (opcional)
    • documento: com/sem formatação (opcional)
  • parcelas:
    • numero: (obrigatório)
    • dataVencimento: (obrigatório)
    • valor: (obrigatório)

• produtos: lista de itens do pedido (obrigatório)

  • produto: informar um dos critérios para pesquisa do produto (obrigatório. Usa-se o primeiro critério da ordem)

    • id: id do produto (long) (opcional)
    • codigoSistema: código de sistema (string) (opcional)
    • codigoBarras: código de barras (string) (opcional)
    • codigoInterno: código interno (string) (opcional)

  • quantidade: quantidade do item (decimal) (obrigatório)

  • valorUnitario: valor unitário do item (decimal) (opcional, padrão: preço de custo referencial do produto.)

  • operacao: id da operação (long) (opcional, padrão: operação principal)

  • ean: código ean na nota (String) (opcional)

  • codigoProduto: código do produto na nota (String) (opcional)

  • considerarNoValorTotal: correspondente a tag indTot. Indica se o valor do produto faz parte do valor total da nota (boolean) (opcional, padrão: true)

  • desconto: (decimal) (opcional)

  • frete: (decimal) (opcional)

  • seguro: (decimal) (opcional)

  • outros: (decimal) (opcional)

  • valorIcmsDesonerado: (decimal) (opcional)

  • aliquotaIcms: (decimal) (opcional)

  • baseIcms: (decimal) (opcional)

  • valorIcms: (decimal) (opcional)

  • aliquotaIcmsSn: (decimal) (opcional)

  • baseIcmsSn: (decimal) (opcional)

  • valorIcmsSn: (decimal) (opcional)

  • aliquotaIcmsSt: (decimal) (opcional)

  • baseIcmsSt: (decimal) (opcional)

  • valorIcmsSt: (decimal) (opcional)

  • baseIcmsStAjustado: (decimal) (opcional)

  • valorIcmsStAjustado: (decimal) (opcional)

  • aliquotaDiferencialIcms: (decimal) (opcional)

  • baseDiferencialIcms: (decimal) (opcional)

  • valorDiferencialIcms : (decimal) (opcional)

  • aliquotaDiferimentoIcms: (decimal) (opcional)

  • valorDiferimentoIcms : (decimal) (opcional)

  • aliquotaDiferencialIcmsInter: (decimal) (opcional)

  • aliquotaDiferencialIcmsIntra: (decimal) (opcional)

  • valorIvaAjustado: (decimal) (opcional)

  • aliquotaIpi: (decimal) (opcional)

  • baseIpi: (decimal) (opcional)

  • valorIpi: (decimal) (opcional)

  • aliquotaPis: (decimal) (opcional)

  • basePis: (decimal) (opcional)

  • valorPis: (decimal) (opcional)

  • aliquotaCofins: (decimal) (opcional)

  • baseCofins: (decimal) (opcional)

  • valorCofins: (decimal) (opcional)

  • aliquotaFcp: (decimal) (opcional)

  • baseFcp: (decimal) (opcional)

  • valorFcp: (decimal) (opcional)

  • aliquotaFcpSt: (opcional)

  • baseFcpSt: (decimal) (opcional)

  • valorFcpSt: (decimal) (opcional)

• totalProdutos: (obrigatório se entradaManual = true)

  • desconto: (decimal) (opcional)

  • frete: (decimal) (opcional)

  • seguro: (decimal) (opcional)

  • outros: (decimal) (opcional)

  • custoAdicional: custo adicional será rateado entre os itens e somado ao custo do produto, para posteriormente ser considerado no custo médio. O valor do item na entrada não será afetado (decimal) (opcional)

  • baseIcms: (decimal ) (opcional)

  • valorIcms: (decimal) (opcional)

  • baseIcmsSn: (decimal) (opcional)

  • valorIcmsSn: (decimal) (opcional)

  • baseIcmsSt: (decimal) (opcional)

  • valorIcmsSt: (decimal) (opcional)

  • valorDiferimentoIcms: (decimal) (opcional)

  • valorDiferencialIcms: (decimal) (opcional)

  • valorDesoneradoIcms: (decimal) (opcional)

  • valorIpi: (decimal) (opcional)

  • valorPis: (decimal) (opcional)

  • valorCofins: (decimal) (opcional)

  • valorFcp: (decimal) (opcional)

  • baseFcp: (decimal) (opcional)

  • valorFcpSt: (decimal)(opcional)

  • baseFcpSt: (decimal) (opcional)

  • valorProdutos: (decimal) (obrigatório se entradaManual = true)

  • valorTotal: (decimal) (obrigatório se entradaManual = true)

• pagamento: detalhes do pagamento da entrada (obrigatório)

  • planoPagamento: id do plano de pagamento (long) (obrigatório)
  • formaPagamentoBancario: (long) (opcional)
  • contaDestinatario: (long) (opcional)
  • parcelas: lista de parcelas da entrada (obrigatório)
    • numero: (long) (obrigatório)
    • dataVencimento: (string dd-MM-yyyy) (obrigatório)
    • valor: (decimal) (obrigatório)
    • dataPagamento: (string dd-MM-yyyy) (opcional)
    • linhaDigitavel: (string) (opcional)
    • chavePix: (string) (opcional)
    • qrCodePix: (string) (opcional)

Sucesso HTTP 201 CREATED:

Retorna um Json com informações do resultado da operação realizada, contendo:

• idRecurso: id do pedido gerado.
• codigoMensagem: Código de identificação da operação realizada. veja a lista de Códigos
• mensagem: Mensagem da operação realizada

Requisição inválida:

• HTTP STATUS 400 – BAD REQUEST
• Body: mensagem de erro

POST https://integrador.varejonline.com.br/apps/api/entradas

'Content-Type'='application/json'

{
  "pedidosCompra": [
    1,
    2,
    3
  ],
  "fornecedor": {
    "id": 10
  },
  "entidade": 1,
  "dataEmissao": "02-08-2023",
  "dataEntrada": "02-08-2023",
  "numeroDocumento": 1,
  "serie": 15,
  "operacao": 20,
  "tipoNotaFiscal": "NOTA_1",
  "dadosAdicionais": "daos adicionais da nota",
  "pagamento": {
    "parcelas": [
      {
        "numero": 1,
        "data": "02-08-2023",
        "valor": 50,
        "dataPagamento": "02-08-2023",
        "dataVencimento": "02-08-2023"
      },
      {
        "numero": 2,
        "data": "02-09-2023",
        "valor": 50,
        "dataPagamento": "02-09-2023",
        "dataVencimento": "02-09-2023"
      }
    ],
    "planoPagamento": 5,
    "quantidadeParcelas": 2
  },
  "produtos": [
    {
      "produto": {
        "id": 24
      },
      "quantidade": 100
    }
  ],
  "cte": {
    "numero": 10,
    "valorTotal": 20,
    "data": "02-08-2023",
    "prestadorServico": {
      "id": 12
    },
    "parcelas": [
      {
        "numero": 1,
        "dataVencimento": "02-08-2023",
        "valor": 10
      },
      {
        "numero": 2,
        "dataVencimento": "02-09-2023",
        "valor": 10
      }
    ]
  },
  "totalProdutos": {}
}