---
title: "Incluir Nota Fiscal de Consumidor eletronico"
method: POST
path: "/v1/vendas/nfce"
tags: ["Vendas NFC-e"]
---

# Incluir Nota Fiscal de Consumidor eletronico

`POST /v1/vendas/nfce`

Inclui uma Nota Fiscal de Consumidor eletronico modelo 65 emitido em um PDV externo.

## Request body

- Movimento — Os atributos apresentados aqui estão vinculados ao cabeçalho da nota, mapeados pela entidade "CabecalhoNota". Além disso, é possível utilizar campos que, embora não estejam detalhados nesta documentação, fazem parte do dicionário de dados, como por exemplo "CODNAT" que é o "código da natureza".
  - `notaModelo` integer, required — Este atributo é utilizado para preparar a inclusão do movimento no SankhyaOm, permitindo que o serviço obtenha informações essenciais, como empresa, tipo de operação, natureza, entre outros. É importante destacar que é possível enviar parâmetros que sobrescrevem os valores definidos no modelo da nota, como, por exemplo, o campo CODEMP (código da empresa). Para saber mais como configurar um Modelo de Nota, [clique aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/360047012513-Config-Modelo-de-Notas)
  - `ambiente` integer, required — Indica o ambiente de emissão do documento fiscal. Aceitos: - 1 - Produção - 2 - Homologação
  - `tipoEmissao` integer, required — Valores aceitos: - 1 - Emissão normal (não em contingência) - 2 - Contingência - 3 - Contingência SCAN - 4 - Contingência EPEC - 5 - Contingência FS-DA - 6 - Contingência SVC-AN - 7 - Contingência SVC-RS - 9 - Contingência off-line da NFC-e
  - `finalidade` integer, required — Valores aceitos: - 1 - NF-e normal; - 2 - NF-e complementar; - 3 - NF-e de ajuste; - 4 - Devolução de mercadoria.
  - `protocolo` string, required — Protocolodo de emissão do documento.
  - `dataProtocolo` string, required — Data do protocolo de emissão do documento
  - `horaProtocolo` string, required — Hora do protocolo de emissão do documento
  - `numeroAleatorio` integer, required — Número aleatório gerado pelo emitente para cada NF-e para evitar acessos indevidos da NF-e.
  - `numeroDocumento` string, required — Número do documento
  - `serie` string, required — Série utilizada para emissão do documento
  - `data` string, required — Data da emissão do documento
  - `hora` string, required — Data da emissão do documento
  - `codigoPedidoOrigem` integer — Utilizado para "faturar" pedidos lançados no SankhyaOm. Para registrar a origem da venda, insira o código do pedido lançado no SankhyaOm quando houver. Esse código pode ser acessado e validado através da nossa API, na entidade "CabecalhoNota" (NUNOTA). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
  - `codigoVendedor` integer — Para registrar com precisão as vendas, insira o código do vendedor responsável pela negociação. Esse código é facilmente acessível através da nossa API, na entidade "Vendedor" (CODVEND). Obtenha essa informação e mantenha seus registros sempre atualizados. Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
  - `codigoCaixa` integer — Identificador do Caixa/PDV que está aberto. Esta informação é retonrada ao abrir o caixa e pode ser consultada também pelo endpoint caixa/{codigoPdv}/{cpfOperador}
  - `consumidor` Consumidor — Esta tag é opcional e funciona da seguinte forma: - Enviar sem a tag consumidor. O serviço assume o CODPARC contido na nota modelo utilizada para vincular ao documento. - Enviar na tag consumidor, apenas o cnpjCpf. O serviço vai tentar encontrar o cliente com base nesse número. Se o serviço não conseguir localizar o cliente, ele vai salvar o CPF ou CNPJ no cabeçalho do documento (TGFCAB) em um campo específico para essa informação. - Enviar tag consumidor completa. O serviço exigirá que todos os campos sejam preenchidos para poder incluir ou atualizar as informações do parceiro. Os atributos apresentados aqui estão vinculados ao cliente, mapeados pela entidade "Parceiro". Para personalizar a integração, é possível enviar os atributos dessa entidade, como "CGCCPF" em vez de "cnpjCpf". Além disso, é possível utilizar campos que, embora não estejam detalhados nesta documentação, fazem parte do dicionário de dados.
    - `atualizar` boolean — Ao configurar como "true", este parâmetro atualizará os dados cadastrais do parceiro, caso ele já exista no SankhyaOm. Se configurado como "false", a API não realizará atualizações cadastrais. Independentemente da configuração, se o parceiro não for encontrado pelo CPF ou CNPJ informado, ele será automaticamente incluído no SankhyaOm com o tipo "cliente" habilitado.
    - `tipo` 'PF' | 'PJ' — Tipo da pessoa que pode ser Física ou Jurídica
    - `cnpjCpf` string — Documento CNPJ ou CPF, de acordo com o tipo do consumidor
    - `ieRg` string — Documento Inscrição Estadual ou RG, de acordo com o tipo do consumidor
    - `nome` string — Nome da pessoa física ou nome fantasia para pessoa juridica
    - `razao` string — Nome social para pessoa jurídica
    - `email` string
    - `telefoneDdd` string
    - `telefoneNumero` string
    - `endereco` Endereco
      - `entrega` boolean — Para e-commerces e outros cenários onde é necessário especificar o endereço de entrega, utilize o atributo "tipo" para definir essa ação com precisão. Enviando este atributo com "true" indica que o endereço é destinado à entrega, com isso o cadastro será registrado como contato do cliente e vinculado à negociação.
      - `logradouro` string
      - `numero` string, int64
      - `complemento` string
      - `bairro` string
      - `cidade` string
      - `codigoIbge` string
      - `uf` string
      - `cep` string
  - `observacao` string
  - `valorFrete` number
  - `valorIcms` number
  - `valorPis` number
  - `valorCofins` number
  - `valorFcp` number — Valor referente a ICMS Fundo de Combate a Pobreza
  - `valorJuro` number — Valor referente a juros acrescidos no documento
  - `valorTotal` number, required — Valor total final do documento
  - `numeroSerieSat` string — Enviado apenas para documentos fiscais modelo 59 (cfe-sat)
  - `chaveNfe` string, required
  - `xml` string, required — XML do movimento codificado em padrão base64
  - `itens` Item[], required
    - `sequencia` integer, required — Sequência dos itens da negociação. Deve seguir uma sequência numérica crescente, começando de 1, e prosseguir como 2, 3, e assim por diante.
    - `sequenciaItemOrigem` integer — Utilizado para "faturar" pedidos lançados no SankhyaOm. Para registrar a origem do item na venda, insira aqui a "sequencia" do item no pedido lançado no SankhyaOm quando houver. Essa informação pode ser obtida e validada através da nossa API, na entidade "ItemNota" (SEQUENCIA da NUNOTA registrada no atributo "codigoPedidoOrigem"). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `cancelado` ItemCancelado — Propriedade opcional e utilizadas apenas em situação onde há a necessidade de registrar os itens que foram incluídos na venda, mas por alguma razão foram retirados.
      - `cpfOperador` string, required — Insira o CPF do operador de caixa que autorizou o cancelamento do item. Para mais detalhes sobre o cadastro de usuários, [clique aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/360044597874-Usu%C3%A1rios)
      - `motivo` string, required
    - `codigoProduto` integer, required — Para registrar os produtos utilizados da negociação, informe neste atributo o "código do produto" disponível no SankhyaOm. Esse código é facilmente acessível através da nossa API, na entidade "Produto" (CODPROD). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `cfop` string, required
    - `unidade` string, required — Para registrar os produtos utilizados da negociação, informe neste atributo a "unidade de medida" disponível no SankhyaOm. Essa informação é facilmente acessível através da nossa API, na entidade "Produto" ou "UnidadeAlternativa" (CODVOL). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `quantidade` number, required
    - `controle` string — Para registrar os produtos utilizados na negociação, insira neste campo o "controle" correspondente. No SankhyaOm, o controle é essencial para a gestão de estoque e pode incluir características como voltagem, sabor, tamanho, cor, entre outros. Por exemplo, para um produto controlado por cor, o valor "verde" seria uma informação esperada. Certifique-se de obter esses dados previamente através das entidades "Produto" ou "Estoque". Veja como funciona controle adicional de estoque em nossa ajuda [clicando aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/360045112113-Cadastro-de-Produtos#sub-abacontroleadicional). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `codigoLocalEstoque` integer — Código do Local de Estoque para o produto utilizado na negociação. Necessário quando existe controle de estoque envolvendo local. Essa informação deve ser obtida previamente pela entidade "Estoque" (CODLOCAL). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `valorDesconto` number
    - `valorUnitario` number, required
    - `icms` Icms
      - `cst` '00' | '10' | '20' | '30' | '40' | '41' | '50' | '51' | '60' | '70' | '90' — Valores aceitos: - 00 – Tributada integralmente - 10 – Tributada e com cobrança do ICMS por substituição tributária - 20 – Com redução de base de cálculo - 30 – Isenta ou não tributada e com cobrança do ICMS por substituição tributária - 40 – Isenta - 41 – Não tributada - 50 – Suspensão - 51 – Diferimento - 60 – ICMS cobrado anteriormente por substituição tributária - 70 – Com redução de base de cálculo e cobrança do ICMS por substituição tributária - 90 – Outras
      - `valorBaseCalculo` number
      - `percentual` number
      - `valor` number
      - `valorFcp` number — Valor referente a ICMS Fundo de Combate a Pobreza
      - `percentualFcp` number — Percentual referente a ICMS Fundo de Combate a Pobreza
    - `pis` Pis
      - `cst` string — Conforme tabela de CST – PIS / COFINS
      - `valorBaseCalculo` number
      - `percentual` number
      - `valor` number
    - `cofins` Cofins
      - `cst` string — Conforme tabela de CST – PIS / COFINS
      - `valorBaseCalculo` number
      - `percentual` number
      - `valor` number
  - `financeiros` Financeiro[], required — Todos os dados financeiros envolvidos na transação devem ser enviados. No caso de cartão de crédito parcelado, envie as parcelas em sequência. Se houver pagamento misto, envie todas as formas de pagamento também em sequência. É importante destacar que a API está preparada para receber diferentes formas de pagamento, incluindo parcelas de cartão de crédito. Basta garantir que todos os pagamentos, inclusive as parcelas, sejam enviados sequenciadas.
    - `tipoPagamento` integer — Tipo de Título para o respectivo financeiro. Essa informação deve ser obtida previamente pela entidade "TipoTitulo" (CODTIPTIT). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `cheque` Cheque — Esta informação deve ser enviada "apenas" quando a opção de pagamento (atributo "tipoPagamento") seja do tipo "Cheque" ("02"). Recebe dados de Cheque utilizado como meio de pagamento
      - `codigoBarras` string
      - `banco` string
      - `agencia` string
      - `conta` string
      - `numero` string
      - `nome` string
      - `cnpjCpf` string
    - `cartao` Cartao
      - `bandeira` string — Segue padrão para bandeiras de cartões de créditos disponível no layout da nota fiscal eletronica. - 01 - Visa - 02 - Mastercard - 03 - American Express - 04 - Sorocred - 05 - Diners Club - 06 - Elo - 07 - Hipercard - 08 - Aura - 09 - Cabal - 99 - Outros
      - `autorizacao` string — Código de autorização na transação fornecedido pela administradora do cartão de crédito. Informação utilizada para conciliação financeira.
    - `dataVencimento` string — Data do vencimento do financeiro.
    - `dataBaixa` string — Data da baixa do financeiro. Em casos de deixar sem baixar, basta não enviar esta informação.
    - `valorParcela` number — Valor total da parcela.
    - `idTransacao` string — ID da transação quando houver. Por exemplo o protocolo da transação PIX.

## Response `200`

Operação bem sucedida

- RetornoMovimento
  - `codigo` integer
  - `tipo` string
  - `mensagem` string

## Other responses

- `400` — Informações Inválidas. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `401` — Não autenticado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `403` — Autenticação inválida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `404` — Dados não encontrados. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `500` — Erro interno no servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `501` — Não implementado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `502` — Retorno inválido do servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `503` — Serviço indisponível no momento. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `504` — Tempo de execução excedido. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.

---

[API](https://skmtc.net/sankhya/apis/api-sankhya.md) · [All operations](https://skmtc.net/sankhya/apis/api-sankhya/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sankhya/api-sankhya/revisions/0a3e81ca6195/schema)