Sign in

v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Vendas CF-e/SAT

Incluir Cupom Fiscal eletronico

Inclui um Cupom Fiscal eletronico modelo 59 emitido em um PDV externo.

post/v1/vendas/cfe-sat

Request body

notaModelointeger 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

ambienteinteger required

Indica o ambiente de emissão do documento fiscal. Aceitos:

  • 1 - Produção
  • 2 - Homologação
tipoEmissaointeger 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
finalidadeinteger required

Valores aceitos:

  • 1 - NF-e normal;
  • 2 - NF-e complementar;
  • 3 - NF-e de ajuste;
  • 4 - Devolução de mercadoria.
protocolostring required

Protocolodo de emissão do documento.

dataProtocolostring required

Data do protocolo de emissão do documento

horaProtocolostring required

Hora do protocolo de emissão do documento

numeroAleatoriointeger required

Número aleatório gerado pelo emitente para cada NF-e para evitar acessos indevidos da NF-e.

numeroDocumentostring required

Número do documento

seriestring required

Série utilizada para emissão do documento

datastring required

Data da emissão do documento

horastring required

Data da emissão do documento

codigoPedidoOrigeminteger

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

codigoVendedorinteger

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

codigoCaixainteger

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}

observacaostring
valorFretenumber
valorIcmsnumber
valorPisnumber
valorCofinsnumber
valorFcpnumber

Valor referente a ICMS Fundo de Combate a Pobreza

valorJuronumber

Valor referente a juros acrescidos no documento

valorTotalnumber required

Valor total final do documento

numeroSerieSatstring

Enviado apenas para documentos fiscais modelo 59 (cfe-sat)

chaveNfestring required
xmlstring required

XML do movimento codificado em padrão base64

Example request

{
  "notaModelo": 45941,
  "ambiente": 1,
  "tipoEmissao": 1,
  "finalidade": 1,
  "protocolo": "326230259108944",
  "dataProtocolo": "30/05/2024",
  "horaProtocolo": "07:34",
  "numeroAleatorio": 15948752,
  "data": "30/05/2024",
  "hora": "07:34",
  "codigoPedidoOrigem": 542365,
  "codigoVendedor": 11,
  "codigoCaixa": 348,
  "consumidor": {
    "tipo": "PF",
    "cnpjCpf": "12315914799",
    "ieRg": "12315914799",
    "nome": "José da Silva",
    "email": "contato@provedor.com.br",
    "telefoneDdd": "34",
    "telefoneNumero": "912349966",
    "endereco": {
      "entrega": true,
      "logradouro": "Rua Maria Roberta",
      "complemento": "Apto 104",
      "bairro": "Centro",
      "cidade": "Uberlândia",
      "uf": "MG"
    }
  },
  "observacao": "Observações específicas da venda aqui",
  "valorJuro": 3.38,
  "valorTotal": 3.38,
  "numeroSerieSat": "xxxxxxxx",
  "chaveNfe": "26230507381608000152650030003505701343991111",
  "xml": "PHhtbD54bWwgY29tcGxldG8gYXF1aTwveG1sPg==",
  "itens": [
    {
      "sequencia": 1,
      "sequenciaItemOrigem": 2,
      "cancelado": {
        "cpfOperador": "15975325800",
        "motivo": "Lançado errado"
      },
      "codigoProduto": 9145,
      "unidade": "UN",
      "quantidade": 1,
      "controle": "Verde",
      "valorUnitario": 3.38,
      "icms": {
        "percentual": 18
      },
      "pis": {
        "percentual": 18
      },
      "cofins": {
        "percentual": 18
      }
    }
  ],
  "financeiros": [
    {
      "tipoPagamento": 19,
      "cheque": {
        "codigoBarras": "\"341067330330018805201725766099\"",
        "banco": "341",
        "agencia": "0673",
        "conta": "576609",
        "nome": "José da Silva Souza",
        "cnpjCpf": "14532515955"
      },
      "cartao": {
        "bandeira": "02"
      },
      "dataVencimento": "30/05/2024",
      "dataBaixa": "30/05/2024",
      "valorParcela": 3.38,
      "idTransacao": "dadotiuiwnlkeuhcnhlahdiwlaoaokd48ge65x"
    }
  ]
}

Response

Operação bem sucedida

codigointeger
tipostring
mensagemstring