Produtos ·
CupomFiscalIncluirAdicionar cupons fiscais
0consultas
6alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Efetua o fechamento de um determinado caixa.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
seqCaixa | número inteiro | Número sequencial do movimento do caixa. Caso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
fechamento | objeto | Dados do fechamento do caixa. |
fechamento.dAberturaobrigatório | texto · até 10 | Data de abertura do caixa. |
fechamento.dFechamentoobrigatório | texto · até 10 | Data de fechamento do caixa. |
fechamento.hAberturaobrigatório | texto · até 8 | Hora de abertura do caixa. |
fechamento.hFechamentoobrigatório | texto · até 8 | Hora de fechamento do caixa. |
fechamento.vAbertura | número | Valor de abertura do caixa (Caixa Inicial). |
fechamento.vFechamento | número | Valor do fechamento do caixa (Caixa Final). |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
listaProcessados | lista de objetos | Lista de cupons processados. |
listaProcessados[].dEmi | texto | Data da emissão do cupom fiscal. |
listaProcessados[].idCupom | número inteiro | Identificação do cupom fiscal. |
listaProcessados[].idLote | número inteiro | Identificação do lote do cupom fiscal. |
listaProcessados[].vCF | decimal | Valor do Cupom Fiscal. |
nIdProc | número inteiro | Número de identificação do processamento da solicitação. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "FecharCaixa", "param": [{"emissor": {"emiNome": "OmiePDV", "emiVersao": "1.0", "emiSerial": "ASDadsADSasdADS", "emiId": "01"}, "seqCaixa": 0}]}'import os
import requests
corpo = {'call': 'FecharCaixa',
'param': [{'emissor': {'emiNome': 'OmiePDV',
'emiVersao': '1.0',
'emiSerial': 'ASDadsADSasdADS',
'emiId': '01'},
'seqCaixa': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "FecharCaixa",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"seqCaixa": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "FecharCaixa",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"seqCaixa": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "FecharCaixa",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"seqCaixa": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "FecharCaixa",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"seqCaixa": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""FecharCaixa"", ""param"": [{""emissor"": {""emiNome"": ""OmiePDV"", ""emiVersao"": ""1.0"", ""emiSerial"": ""ASDadsADSasdADS"", ""emiId"": ""01""}, ""seqCaixa"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosIncluir Cupom Fiscal para SAT.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 9Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
caixa | objeto | Caixa |
caixa.lCxAberto | sim/não | Indica se o Caixa está aberto. O padrão é false. Quando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado. |
caixa.seqCaixaobrigatório | número inteiro | Número sequencial do movimento do caixa. Caso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia. |
caixa.seqCupomobrigatório | número inteiro | Número sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda. |
categorias | lista de objetos | Distribuição por Categorias. |
categorias[].idCategoria | texto · até 20 | Código da Categoria. (Gerado internamente, não é visualizado na tela) |
categorias[].pCategoria | número | Percentual da categoria |
categorias[].vCategoria | número | Valor da categoria |
cfeSat | objeto | |
cfeSat.chCFeobrigatório | texto · até 44 | Chave de Acesso do CF-e-SAT. |
cfeSat.dEmiobrigatório | texto · até 10 | Data da emissão do cupom fiscal. |
cfeSat.det | lista de objetos | Itens do cupom fiscal. |
cfeSat.det[].imposto | objeto | Dados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT. |
cfeSat.det[].imposto.ICMS | objeto | |
cfeSat.det[].imposto.ICMS.CST | texto · até 2 | Código da Situação Tributária. |
cfeSat.det[].imposto.ICMS.pICMS | número | Alíquota do ICMS. |
cfeSat.det[].imposto.ICMS.vBC | número | Valor da Base de Cálculo. |
cfeSat.det[].imposto.ICMS.vICMS | número | Valor do ICMS. |
cfeSat.det[].imposto.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
cfeSat.det[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
cfeSat.det[].lNaoMovEstoque | texto · até 5 | Indica que o item do Cupom Fiscal não deve movimentar o estoque. |
cfeSat.det[].lote_validade | objeto | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
cfeSat.det[].lote_validade.nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
cfeSat.det[].lote_validade.nQtdLoteobrigatório | número | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
cfeSat.det[].prod | objeto | |
cfeSat.det[].prod.CFOP | texto · até 10 | CFOP. |
cfeSat.det[].prod.NCM | texto · até 13 | NCM. |
cfeSat.det[].prod.cEAN | texto · até 14 | EAN do produto. |
cfeSat.det[].prod.cProd | texto · até 60 | Código do produto conforme destacado no Cupom Fiscal. |
cfeSat.det[].prod.cUn | texto · até 6 | Unidade de medida. |
cfeSat.det[].prod.nQuant | número | Quantidade. |
cfeSat.det[].prod.vAcresc | número | Valor do acréscimo. |
cfeSat.det[].prod.vDesc | número | Valor do desconto. |
cfeSat.det[].prod.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
cfeSat.det[].prod.vProd | número | Valor do produto. vProd = nQuant x vUnit |
cfeSat.det[].prod.vUnit | número | Valor unitário. |
cfeSat.det[].prod.xProd | texto · até 120 | Descrição do produto conforme destacado no Cupom Fiscal. |
cfeSat.det[].prodIdent | objeto | |
cfeSat.det[].prodIdent.emiProduto | texto · até 60 | Código do produto no emissor de cupom fiscal. |
cfeSat.det[].prodIdent.idLocalEstoque | número inteiro | Codigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão. |
cfeSat.det[].prodIdent.idProduto | número inteiro | Código do produto. |
cfeSat.det[].seqItemobrigatório | número inteiro | Número sequencial do item. |
cfeSat.hEmiobrigatório | texto · até 10 | Hora da emissão do cupom fiscal. |
cfeSat.lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
cfeSat.nCFeobrigatório | texto · até 20 | Número do cupom fiscal ou Número do Extrato do SAT. |
cfeSat.outrasInf | objeto | Outras informações do cupom fiscal. |
cfeSat.outrasInf.nMesa | texto · até 10 | Número / identificação da mesa. |
cfeSat.outrasInf.nPessoas | número inteiro | Número/quantidade de pessoas atendidas. |
cfeSat.total | objeto | Totais do cupom fiscal. |
cfeSat.total.vAcresc | número | Valor do acréscimo. |
cfeSat.total.vCFobrigatório | número | Valor do Cupom Fiscal. |
cfeSat.total.vDesc | número | Valor do desconto. |
cfeSat.total.vICMS | número | Valor do ICMS. |
cfeSat.total.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
cfeSat.total.vTaxa | número | Valor da taxa. |
cfeSat.total.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
cfeSat.tpAmbobrigatório | texto · até 1 | Ambiente. Pode ser: H-Homologação. P-Produção. |
cupomIdent | objeto | |
cupomIdent.cNumeroContrato | texto · até 30 | Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cPedidoCliente | texto · até 30 | Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cUsuario | texto · até 10 | Código do Usuário. Quando não informado, assumirá o usuário "Integração" como o usuário responsáivel pela emissão do cupom fiscal. |
cupomIdent.idCliente | número inteiro | Código do cliente. Quando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente. |
cupomIdent.idProjeto | número inteiro | Código do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal. |
cupomIdent.idVendedor | número inteiro | Código do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamento | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
formasPag | lista de objetos | |
formasPag[].Cheque | objeto | Informações do Cheque. |
formasPag[].Cheque.chAgencia | texto · até 4 | Número da Agência. |
formasPag[].Cheque.chBanco | texto · até 5 | Número do Banco. |
formasPag[].Cheque.chConta | texto · até 15 | Número da Conta. |
formasPag[].Cheque.chNumero | texto · até 15 | Número do Cheque. |
formasPag[].Cheque.chSerie | texto · até 10 | Série do Cheque. |
formasPag[].Cheque.chVencimento | texto · até 10 | Data de vencimento do cheque. |
formasPag[].PIX | objeto | |
formasPag[].PIX.cCodIntPixobrigatório | texto · até 60 | Código do lançamento gerado pelo integrador. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "cCodInt" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].PIX.nIdPixobrigatório | número inteiro | ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "nIdPix" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].POS | objeto | |
formasPag[].POS.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].POS.cRedePos | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].POS.dTransacao | texto · até 10 | Data da transação. |
formasPag[].POS.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].POS.nParcPos | número inteiro | Número de parcelas. |
formasPag[].POS.nValorAut | número | Valor autorizado. |
formasPag[].TEF | objeto | |
formasPag[].TEF.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].TEF.NSUHost | texto · até 200 | NSU (Número Sequencial Único) Identifica uma operação de venda no host. |
formasPag[].TEF.TID | texto · até 200 | TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente. Essa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce. |
formasPag[].TEF.cBandeiraTef | texto · até 30 | Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD |
formasPag[].TEF.cRedeTef | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].TEF.cTipoCartao | texto · até 1 | Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito. |
formasPag[].TEF.dTransacao | texto · até 10 | Data da transação. |
formasPag[].TEF.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].TEF.nNumeroAut | texto · até 40 | Número da autorização. |
formasPag[].TEF.nParcTef | número inteiro | Número de parcelas. |
formasPag[].TEF.nValorAut | número | Valor autorizado. |
formasPag[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
formasPag[].lNaoGerarTitulo | texto · até 5 | Indica que a parcela não deve gerar um título no financeiro. |
formasPag[].pag | objeto | |
formasPag[].pag.pTaxa | número | Percentual da taxa da administradora de cartões. |
formasPag[].pag.vLiqobrigatório | número | Valor líquido do pagamento. |
formasPag[].pag.vPagobrigatório | número | Valor do pagamento. |
formasPag[].pag.vTaxa | número | Valor da taxa da administradora de cartões. |
formasPag[].pag.vTroco | número | Valor do troco. |
formasPag[].pagIdent | objeto | |
formasPag[].pagIdent.cCategoria | texto · até 20 | Código da categoria. Utilize a tag "codigo" do método "ListarCategorias" da API /api/v1/geral/categorias/ para obter essa informação. |
formasPag[].pagIdent.cTipoPagobrigatório | texto · até 5 | Tipo de pagamento. Se não preenchido assumirá o código "99999" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro. Opções disponíveis: "BOL" - Boleto "DIN" - Dinheiro "CRE" - Crediário "CRT" - Cartão "CRC" - Cartão de Crédito "CRD" - Cartão de Débito "CHQ" - Cheque "CHT" - Cheque de Terceiros "PIX" - Pix "99999" - Outros Valor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos: Caixinha => "DIN", "CHQ", "CHT", "99999" e "PIX" Administradora de Cartões => "CRT", "CRC" e "CRD" Carteira Virtual => "CRT", "CRC" e "CRD" Conta Corrente => "DIN", "CRT", "CRC", "CRD", "BOL" e "PIX" Crediário / Carnê => "CRE" e "BOL" |
formasPag[].pagIdent.idContaobrigatório | número inteiro | Código da Conta Corrente. |
formasPag[].parcelas | lista de objetos | |
formasPag[].parcelas[].dVenc | texto · até 10 | Data de vencimento da parcela. Formato: dd/mm/aaaa. |
formasPag[].parcelas[].nParc | texto · até 7 | Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003 |
formasPag[].parcelas[].vParc | número | Valor da parcela. |
formasPag[].seqPagobrigatório | número inteiro | Sequência do pagamento. |
sat | objeto | |
sat.satMd5obrigatório | texto · até 32 | MD5 do arquivo XML enviado em "satXML". |
sat.satModeloobrigatório | texto · até 20 | Modelo do SAT. Exemplo: "DIMEP" |
sat.satProtobrigatório | texto · até 20 | Protocolo de envio do Cupom Fiscal. |
sat.satSerieobrigatório | texto · até 20 | Número de série do SAT. Exemplos: "0001882143" |
sat.satSessaoobrigatório | número inteiro | Sessão do SAT. |
sat.satXmlobrigatório | texto | XML do Cupom Fiscal enviado. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "satMd5". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
satCanc | objeto | Dados do Cancelamento do SAT. |
satCanc.satMd5Can | texto · até 32 | MD5 do arquivo XML enviado em "satXmlCan". |
satCanc.satProtCan | texto · até 20 | Protocolo de envio do cancelamento do Cupom Fiscal. |
satCanc.satXmlCan | texto | XML do Cupom Fiscal enviado. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para & > para > < para < " para " " para ' | para | Após essa conversão aplique o MD5 para enviar no campo "satMd5Can". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
idCupom | número inteiro | Identificação do cupom fiscal. |
idLote | número inteiro | Identificação do lote do cupom fiscal. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirCfeSat", "param": [{"caixa": {"lCxAberto": true, "seqCaixa": 3428, "seqCupom": 384559}, "cfeSat": {"chCFe": "99999999999999999999999999999999999999999999", "dEmi": "07/02/2022", "det": [{"imposto": {"ICMS": {"CST": "60"}, "vTotTrib": 5.98}, "lCanc": false, "prod": {"cUn": "UN", "vAcresc": 0, "vDesc": 0, "vItem": 21.47, "vProd": 19.0, "vUnit": 19.0}, "prodIdent": {"emiProduto": "30218001", "idLocalEstoque": 393938380, "idProduto": 453975843}, "seqItem": 1}], "hEmi": "16:53:23", "lCanc": false, "nCFe": "034799", "total": {"vAcresc": 0, "vCF": 28.82, "vDesc": 0, "vItem": 25.5, "vTotTrib": 8.33}, "tpAmb": "P"}, "cupomIdent": {"idCliente": 423856753}, "emissor": {"emiId": "001", "emiNome": "SeuPDV", "emiSerial": "X128992", "emiVersao": "04.08"}, "formasPag": [{"lCanc": false, "pag": {"pTaxa": 2.65, "vLiq": 28.82, "vPag": 28.82, "vTaxa": 0.76, "vTroco": 0}, "pagIdent": {"cCategoria": "1.01.95", "cTipoPag": "CRC", "idConta": 372946272}, "parcelas": [{"dVenc": "10/02/2022", "nParc": 1, "vParc": 28.82}], "seqPag": 1}], "sat": {"satMd5": "f13df5c85a499d7cekei3f7dacd31c6b5", "satModelo": "DIMEP", "satProt": "12345678", "satSerie": "000756735", "satSessao": "68670", "satXml": "SEU_XML"}}]}'import os
import requests
corpo = {'call': 'IncluirCfeSat',
'param': [{'caixa': {'lCxAberto': True, 'seqCaixa': 3428, 'seqCupom': 384559},
'cfeSat': {'chCFe': '99999999999999999999999999999999999999999999',
'dEmi': '07/02/2022',
'det': [{'imposto': {'ICMS': {'CST': '60'}, 'vTotTrib': 5.98},
'lCanc': False,
'prod': {'cUn': 'UN',
'vAcresc': 0,
'vDesc': 0,
'vItem': 21.47,
'vProd': 19.0,
'vUnit': 19.0},
'prodIdent': {'emiProduto': '30218001',
'idLocalEstoque': 393938380,
'idProduto': 453975843},
'seqItem': 1}],
'hEmi': '16:53:23',
'lCanc': False,
'nCFe': '034799',
'total': {'vAcresc': 0,
'vCF': 28.82,
'vDesc': 0,
'vItem': 25.5,
'vTotTrib': 8.33},
'tpAmb': 'P'},
'cupomIdent': {'idCliente': 423856753},
'emissor': {'emiId': '001',
'emiNome': 'SeuPDV',
'emiSerial': 'X128992',
'emiVersao': '04.08'},
'formasPag': [{'lCanc': False,
'pag': {'pTaxa': 2.65,
'vLiq': 28.82,
'vPag': 28.82,
'vTaxa': 0.76,
'vTroco': 0},
'pagIdent': {'cCategoria': '1.01.95',
'cTipoPag': 'CRC',
'idConta': 372946272},
'parcelas': [{'dVenc': '10/02/2022',
'nParc': 1,
'vParc': 28.82}],
'seqPag': 1}],
'sat': {'satMd5': 'f13df5c85a499d7cekei3f7dacd31c6b5',
'satModelo': 'DIMEP',
'satProt': '12345678',
'satSerie': '000756735',
'satSessao': '68670',
'satXml': 'SEU_XML'}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirCfeSat",
"param": [
{
"caixa": {
"lCxAberto": true,
"seqCaixa": 3428,
"seqCupom": 384559
},
"cfeSat": {
"chCFe": "99999999999999999999999999999999999999999999",
"dEmi": "07/02/2022",
"det": [
{
"imposto": {
"ICMS": {
"CST": "60"
},
"vTotTrib": 5.98
},
"lCanc": false,
"prod": {
"cUn": "UN",
"vAcresc": 0,
"vDesc": 0,
"vItem": 21.47,
"vProd": 19.0,
"vUnit": 19.0
},
"prodIdent": {
"emiProduto": "30218001",
"idLocalEstoque": 393938380,
"idProduto": 453975843
},
"seqItem": 1
}
],
"hEmi": "16:53:23",
"lCanc": false,
"nCFe": "034799",
"total": {
"vAcresc": 0,
"vCF": 28.82,
"vDesc": 0,
"vItem": 25.5,
"vTotTrib": 8.33
},
"tpAmb": "P"
},
"cupomIdent": {
"idCliente": 423856753
},
"emissor": {
"emiId": "001",
"emiNome": "SeuPDV",
"emiSerial": "X128992",
"emiVersao": "04.08"
},
"formasPag": [
{
"lCanc": false,
"pag": {
"pTaxa": 2.65,
"vLiq": 28.82,
"vPag": 28.82,
"vTaxa": 0.76,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.95",
"cTipoPag": "CRC",
"idConta": 372946272
},
"parcelas": [
{
"dVenc": "10/02/2022",
"nParc": 1,
"vParc": 28.82
}
],
"seqPag": 1
}
],
"sat": {
"satMd5": "f13df5c85a499d7cekei3f7dacd31c6b5",
"satModelo": "DIMEP",
"satProt": "12345678",
"satSerie": "000756735",
"satSessao": "68670",
"satXml": "SEU_XML"
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirCfeSat",
"param": [
{
"caixa": {
"lCxAberto": true,
"seqCaixa": 3428,
"seqCupom": 384559
},
"cfeSat": {
"chCFe": "99999999999999999999999999999999999999999999",
"dEmi": "07/02/2022",
"det": [
{
"imposto": {
"ICMS": {
"CST": "60"
},
"vTotTrib": 5.98
},
"lCanc": false,
"prod": {
"cUn": "UN",
"vAcresc": 0,
"vDesc": 0,
"vItem": 21.47,
"vProd": 19.0,
"vUnit": 19.0
},
"prodIdent": {
"emiProduto": "30218001",
"idLocalEstoque": 393938380,
"idProduto": 453975843
},
"seqItem": 1
}
],
"hEmi": "16:53:23",
"lCanc": false,
"nCFe": "034799",
"total": {
"vAcresc": 0,
"vCF": 28.82,
"vDesc": 0,
"vItem": 25.5,
"vTotTrib": 8.33
},
"tpAmb": "P"
},
"cupomIdent": {
"idCliente": 423856753
},
"emissor": {
"emiId": "001",
"emiNome": "SeuPDV",
"emiSerial": "X128992",
"emiVersao": "04.08"
},
"formasPag": [
{
"lCanc": false,
"pag": {
"pTaxa": 2.65,
"vLiq": 28.82,
"vPag": 28.82,
"vTaxa": 0.76,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.95",
"cTipoPag": "CRC",
"idConta": 372946272
},
"parcelas": [
{
"dVenc": "10/02/2022",
"nParc": 1,
"vParc": 28.82
}
],
"seqPag": 1
}
],
"sat": {
"satMd5": "f13df5c85a499d7cekei3f7dacd31c6b5",
"satModelo": "DIMEP",
"satProt": "12345678",
"satSerie": "000756735",
"satSessao": "68670",
"satXml": "SEU_XML"
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "IncluirCfeSat",
"param": [
{
"caixa": {
"lCxAberto": true,
"seqCaixa": 3428,
"seqCupom": 384559
},
"cfeSat": {
"chCFe": "99999999999999999999999999999999999999999999",
"dEmi": "07/02/2022",
"det": [
{
"imposto": {
"ICMS": {
"CST": "60"
},
"vTotTrib": 5.98
},
"lCanc": false,
"prod": {
"cUn": "UN",
"vAcresc": 0,
"vDesc": 0,
"vItem": 21.47,
"vProd": 19.0,
"vUnit": 19.0
},
"prodIdent": {
"emiProduto": "30218001",
"idLocalEstoque": 393938380,
"idProduto": 453975843
},
"seqItem": 1
}
],
"hEmi": "16:53:23",
"lCanc": false,
"nCFe": "034799",
"total": {
"vAcresc": 0,
"vCF": 28.82,
"vDesc": 0,
"vItem": 25.5,
"vTotTrib": 8.33
},
"tpAmb": "P"
},
"cupomIdent": {
"idCliente": 423856753
},
"emissor": {
"emiId": "001",
"emiNome": "SeuPDV",
"emiSerial": "X128992",
"emiVersao": "04.08"
},
"formasPag": [
{
"lCanc": false,
"pag": {
"pTaxa": 2.65,
"vLiq": 28.82,
"vPag": 28.82,
"vTaxa": 0.76,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.95",
"cTipoPag": "CRC",
"idConta": 372946272
},
"parcelas": [
{
"dVenc": "10/02/2022",
"nParc": 1,
"vParc": 28.82
}
],
"seqPag": 1
}
],
"sat": {
"satMd5": "f13df5c85a499d7cekei3f7dacd31c6b5",
"satModelo": "DIMEP",
"satProt": "12345678",
"satSerie": "000756735",
"satSessao": "68670",
"satXml": "SEU_XML"
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirCfeSat",
"param": [
{
"caixa": {
"lCxAberto": true,
"seqCaixa": 3428,
"seqCupom": 384559
},
"cfeSat": {
"chCFe": "99999999999999999999999999999999999999999999",
"dEmi": "07/02/2022",
"det": [
{
"imposto": {
"ICMS": {
"CST": "60"
},
"vTotTrib": 5.98
},
"lCanc": false,
"prod": {
"cUn": "UN",
"vAcresc": 0,
"vDesc": 0,
"vItem": 21.47,
"vProd": 19.0,
"vUnit": 19.0
},
"prodIdent": {
"emiProduto": "30218001",
"idLocalEstoque": 393938380,
"idProduto": 453975843
},
"seqItem": 1
}
],
"hEmi": "16:53:23",
"lCanc": false,
"nCFe": "034799",
"total": {
"vAcresc": 0,
"vCF": 28.82,
"vDesc": 0,
"vItem": 25.5,
"vTotTrib": 8.33
},
"tpAmb": "P"
},
"cupomIdent": {
"idCliente": 423856753
},
"emissor": {
"emiId": "001",
"emiNome": "SeuPDV",
"emiSerial": "X128992",
"emiVersao": "04.08"
},
"formasPag": [
{
"lCanc": false,
"pag": {
"pTaxa": 2.65,
"vLiq": 28.82,
"vPag": 28.82,
"vTaxa": 0.76,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.95",
"cTipoPag": "CRC",
"idConta": 372946272
},
"parcelas": [
{
"dVenc": "10/02/2022",
"nParc": 1,
"vParc": 28.82
}
],
"seqPag": 1
}
],
"sat": {
"satMd5": "f13df5c85a499d7cekei3f7dacd31c6b5",
"satModelo": "DIMEP",
"satProt": "12345678",
"satSerie": "000756735",
"satSessao": "68670",
"satXml": "SEU_XML"
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirCfeSat"", ""param"": [{""caixa"": {""lCxAberto"": true, ""seqCaixa"": 3428, ""seqCupom"": 384559}, ""cfeSat"": {""chCFe"": ""99999999999999999999999999999999999999999999"", ""dEmi"": ""07/02/2022"", ""det"": [{""imposto"": {""ICMS"": {""CST"": ""60""}, ""vTotTrib"": 5.98}, ""lCanc"": false, ""prod"": {""cUn"": ""UN"", ""vAcresc"": 0, ""vDesc"": 0, ""vItem"": 21.47, ""vProd"": 19.0, ""vUnit"": 19.0}, ""prodIdent"": {""emiProduto"": ""30218001"", ""idLocalEstoque"": 393938380, ""idProduto"": 453975843}, ""seqItem"": 1}], ""hEmi"": ""16:53:23"", ""lCanc"": false, ""nCFe"": ""034799"", ""total"": {""vAcresc"": 0, ""vCF"": 28.82, ""vDesc"": 0, ""vItem"": 25.5, ""vTotTrib"": 8.33}, ""tpAmb"": ""P""}, ""cupomIdent"": {""idCliente"": 423856753}, ""emissor"": {""emiId"": ""001"", ""emiNome"": ""SeuPDV"", ""emiSerial"": ""X128992"", ""emiVersao"": ""04.08""}, ""formasPag"": [{""lCanc"": false, ""pag"": {""pTaxa"": 2.65, ""vLiq"": 28.82, ""vPag"": 28.82, ""vTaxa"": 0.76, ""vTroco"": 0}, ""pagIdent"": {""cCategoria"": ""1.01.95"", ""cTipoPag"": ""CRC"", ""idConta"": 372946272}, ""parcelas"": [{""dVenc"": ""10/02/2022"", ""nParc"": 1, ""vParc"": 28.82}], ""seqPag"": 1}], ""sat"": {""satMd5"": ""f13df5c85a499d7cekei3f7dacd31c6b5"", ""satModelo"": ""DIMEP"", ""satProt"": ""12345678"", ""satSerie"": ""000756735"", ""satSessao"": ""68670"", ""satXml"": ""SEU_XML""}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosIncluir Cupom Fiscal (ECF).
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
caixa | objeto | Caixa |
caixa.lCxAberto | sim/não | Indica se o Caixa está aberto. O padrão é false. Quando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado. |
caixa.seqCaixaobrigatório | número inteiro | Número sequencial do movimento do caixa. Caso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia. |
caixa.seqCupomobrigatório | número inteiro | Número sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda. |
categorias | lista de objetos | Distribuição por Categorias. |
categorias[].idCategoria | texto · até 20 | Código da Categoria. (Gerado internamente, não é visualizado na tela) |
categorias[].pCategoria | número | Percentual da categoria |
categorias[].vCategoria | número | Valor da categoria |
cupom | objeto | |
cupom.dEmiobrigatório | texto · até 10 | Data da emissão do cupom fiscal. |
cupom.det | lista de objetos | Itens do cupom fiscal. |
cupom.det[].imposto | objeto | Dados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT. |
cupom.det[].imposto.ICMS | objeto | |
cupom.det[].imposto.ICMS.CST | texto · até 2 | Código da Situação Tributária. |
cupom.det[].imposto.ICMS.pICMS | número | Alíquota do ICMS. |
cupom.det[].imposto.ICMS.vBC | número | Valor da Base de Cálculo. |
cupom.det[].imposto.ICMS.vICMS | número | Valor do ICMS. |
cupom.det[].imposto.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
cupom.det[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
cupom.det[].lNaoMovEstoque | texto · até 5 | Indica que o item do Cupom Fiscal não deve movimentar o estoque. |
cupom.det[].lote_validade | objeto | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
cupom.det[].lote_validade.nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
cupom.det[].lote_validade.nQtdLoteobrigatório | número | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
cupom.det[].prod | objeto | |
cupom.det[].prod.CFOP | texto · até 10 | CFOP. |
cupom.det[].prod.NCM | texto · até 13 | NCM. |
cupom.det[].prod.cEAN | texto · até 14 | EAN do produto. |
cupom.det[].prod.cProd | texto · até 60 | Código do produto conforme destacado no Cupom Fiscal. |
cupom.det[].prod.cUn | texto · até 6 | Unidade de medida. |
cupom.det[].prod.nQuant | número | Quantidade. |
cupom.det[].prod.vAcresc | número | Valor do acréscimo. |
cupom.det[].prod.vDesc | número | Valor do desconto. |
cupom.det[].prod.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
cupom.det[].prod.vProd | número | Valor do produto. vProd = nQuant x vUnit |
cupom.det[].prod.vUnit | número | Valor unitário. |
cupom.det[].prod.xProd | texto · até 120 | Descrição do produto conforme destacado no Cupom Fiscal. |
cupom.det[].prodIdent | objeto | |
cupom.det[].prodIdent.emiProduto | texto · até 60 | Código do produto no emissor de cupom fiscal. |
cupom.det[].prodIdent.idLocalEstoque | número inteiro | Codigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão. |
cupom.det[].prodIdent.idProduto | número inteiro | Código do produto. |
cupom.det[].seqItemobrigatório | número inteiro | Número sequencial do item. |
cupom.hEmiobrigatório | texto · até 10 | Hora da emissão do cupom fiscal. |
cupom.lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
cupom.nCCFobrigatório | número inteiro | Número do Contador de Cupom Fiscal (CCF). |
cupom.nCOOobrigatório | número inteiro | Número do cupom fiscal ou número do Contador de Ordem de Operação (COO). |
cupom.outrasInf | objeto | Outras informações do cupom fiscal. |
cupom.outrasInf.nMesa | texto · até 10 | Número / identificação da mesa. |
cupom.outrasInf.nPessoas | número inteiro | Número/quantidade de pessoas atendidas. |
cupom.total | objeto | Totais do cupom fiscal. |
cupom.total.vAcresc | número | Valor do acréscimo. |
cupom.total.vCFobrigatório | número | Valor do Cupom Fiscal. |
cupom.total.vDesc | número | Valor do desconto. |
cupom.total.vICMS | número | Valor do ICMS. |
cupom.total.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
cupom.total.vTaxa | número | Valor da taxa. |
cupom.total.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
cupom.tpAmbobrigatório | texto · até 1 | Ambiente. Pode ser: H-Homologação. P-Produção. |
cupomIdent | objeto | |
cupomIdent.cNumeroContrato | texto · até 30 | Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cPedidoCliente | texto · até 30 | Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cUsuario | texto · até 10 | Código do Usuário. Quando não informado, assumirá o usuário "Integração" como o usuário responsáivel pela emissão do cupom fiscal. |
cupomIdent.idCliente | número inteiro | Código do cliente. Quando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente. |
cupomIdent.idProjeto | número inteiro | Código do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal. |
cupomIdent.idVendedor | número inteiro | Código do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamento | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
ecf | objeto | |
ecf.ecfModeloobrigatório | texto · até 20 | Modelo da Impressora Fiscal. Exemplo: "MP-2100 TH FI" |
ecf.ecfSerieobrigatório | texto · até 20 | Número de série da impressora fiscal. Exemplos: "BE051475610000207422" "EP121710000000018789" "SW040900000000009860" "DR0815BR000000462568" |
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
formasPag | lista de objetos | |
formasPag[].Cheque | objeto | Informações do Cheque. |
formasPag[].Cheque.chAgencia | texto · até 4 | Número da Agência. |
formasPag[].Cheque.chBanco | texto · até 5 | Número do Banco. |
formasPag[].Cheque.chConta | texto · até 15 | Número da Conta. |
formasPag[].Cheque.chNumero | texto · até 15 | Número do Cheque. |
formasPag[].Cheque.chSerie | texto · até 10 | Série do Cheque. |
formasPag[].Cheque.chVencimento | texto · até 10 | Data de vencimento do cheque. |
formasPag[].PIX | objeto | |
formasPag[].PIX.cCodIntPixobrigatório | texto · até 60 | Código do lançamento gerado pelo integrador. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "cCodInt" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].PIX.nIdPixobrigatório | número inteiro | ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "nIdPix" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].POS | objeto | |
formasPag[].POS.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].POS.cRedePos | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].POS.dTransacao | texto · até 10 | Data da transação. |
formasPag[].POS.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].POS.nParcPos | número inteiro | Número de parcelas. |
formasPag[].POS.nValorAut | número | Valor autorizado. |
formasPag[].TEF | objeto | |
formasPag[].TEF.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].TEF.NSUHost | texto · até 200 | NSU (Número Sequencial Único) Identifica uma operação de venda no host. |
formasPag[].TEF.TID | texto · até 200 | TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente. Essa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce. |
formasPag[].TEF.cBandeiraTef | texto · até 30 | Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD |
formasPag[].TEF.cRedeTef | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].TEF.cTipoCartao | texto · até 1 | Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito. |
formasPag[].TEF.dTransacao | texto · até 10 | Data da transação. |
formasPag[].TEF.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].TEF.nNumeroAut | texto · até 40 | Número da autorização. |
formasPag[].TEF.nParcTef | número inteiro | Número de parcelas. |
formasPag[].TEF.nValorAut | número | Valor autorizado. |
formasPag[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
formasPag[].lNaoGerarTitulo | texto · até 5 | Indica que a parcela não deve gerar um título no financeiro. |
formasPag[].pag | objeto | |
formasPag[].pag.pTaxa | número | Percentual da taxa da administradora de cartões. |
formasPag[].pag.vLiqobrigatório | número | Valor líquido do pagamento. |
formasPag[].pag.vPagobrigatório | número | Valor do pagamento. |
formasPag[].pag.vTaxa | número | Valor da taxa da administradora de cartões. |
formasPag[].pag.vTroco | número | Valor do troco. |
formasPag[].pagIdent | objeto | |
formasPag[].pagIdent.cCategoria | texto · até 20 | Código da categoria. Utilize a tag "codigo" do método "ListarCategorias" da API /api/v1/geral/categorias/ para obter essa informação. |
formasPag[].pagIdent.cTipoPagobrigatório | texto · até 5 | Tipo de pagamento. Se não preenchido assumirá o código "99999" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro. Opções disponíveis: "BOL" - Boleto "DIN" - Dinheiro "CRE" - Crediário "CRT" - Cartão "CRC" - Cartão de Crédito "CRD" - Cartão de Débito "CHQ" - Cheque "CHT" - Cheque de Terceiros "PIX" - Pix "99999" - Outros Valor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos: Caixinha => "DIN", "CHQ", "CHT", "99999" e "PIX" Administradora de Cartões => "CRT", "CRC" e "CRD" Carteira Virtual => "CRT", "CRC" e "CRD" Conta Corrente => "DIN", "CRT", "CRC", "CRD", "BOL" e "PIX" Crediário / Carnê => "CRE" e "BOL" |
formasPag[].pagIdent.idContaobrigatório | número inteiro | Código da Conta Corrente. |
formasPag[].parcelas | lista de objetos | |
formasPag[].parcelas[].dVenc | texto · até 10 | Data de vencimento da parcela. Formato: dd/mm/aaaa. |
formasPag[].parcelas[].nParc | texto · até 7 | Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003 |
formasPag[].parcelas[].vParc | número | Valor da parcela. |
formasPag[].seqPagobrigatório | número inteiro | Sequência do pagamento. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
idCupom | número inteiro | Identificação do cupom fiscal. |
idLote | número inteiro | Identificação do lote do cupom fiscal. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirCupom", "param": [{"emissor": {"emiNome": "EmissorPDV", "emiVersao": "1.0", "emiSerial": "781818814968638", "emiId": "001"}, "ecf": {"ecfSerie": "BE051475610000201537", "ecfModelo": "MP-2100 TH FI"}, "caixa": {"seqCaixa": "75716", "seqCupom": "1790776571"}, "cupom": {"nCOO": "1790776571", "nCCF": "1790776571", "dEmi": "30/09/2026", "hEmi": "13:14:30", "lCanc": false, "det": [{"seqItem": 1, "lCanc": false, "prod": {"cProd": "700309", "xProd": "Misiones de Rengo Carmenere 2016", "CFOP": "5.101", "NCM": "2204.21.00", "cEAN": "", "cUn": "GF", "nQuant": 10, "vUnit": 5.5, "vProd": 55, "vDesc": 0, "vAcresc": 0, "vItem": 55}, "prodIdent": {"idProduto": 369356862, "emiProduto": "3229"}, "imposto": {"vTotTrib": 5, "ICMS": {"CST": "00", "vBC": 55, "pICMS": 18, "vICMS": 9.9}}}, {"seqItem": 2, "lCanc": false, "prod": {"cProd": "700307", "xProd": "Periquita Reserva 2014", "CFOP": "5.101", "NCM": "2204.21.00", "cEAN": "", "cUn": "GF", "nQuant": 10, "vUnit": 4, "vProd": 40, "vDesc": 0, "vAcresc": 0, "vItem": 40}, "prodIdent": {"idProduto": 369356851, "emiProduto": "3224"}, "imposto": {"vTotTrib": 5, "ICMS": {"CST": "00", "vBC": 40, "pICMS": 18, "vICMS": 7.2}}}], "outrasInf": {"nMesa": 0, "nPessoas": 0}, "total": {"vItem": 95, "vICMS": 17.1, "vDesc": 0, "vAcresc": 0, "vTaxa": 3, "vCF": 95, "vTotTrib": 10}}, "cupomIdent": {"idCliente": 0, "idVendedor": 0, "idProjeto": 0, "cUsuario": ""}, "formasPag": [{"seqPag": 1, "lCanc": false, "pag": {"vPag": 40, "vTroco": 0, "vTaxa": 0, "pTaxa": 0, "vLiq": 40}, "pagIdent": {"cCategoria": "1.01.03", "cTipoPag": "CRT", "idConta": 1610386}, "TEF": {"NSU": "1029333", "nNumeroAut": "2222", "nValorAut": 100, "cTipoCartao": "D", "cRedeTef": "VISANET", "cBandeiraTef": "VISA", "nParcTef": 2}, "parcelas": [{"nParc": 1, "dVenc": "01/10/2026", "vParc": 25}, {"nParc": 2, "dVenc": "27/12/2026", "vParc": 15}]}, {"seqPag": 2, "lCanc": false, "pag": {"vPag": 55, "vTroco": 0, "vTaxa": 0, "pTaxa": 0, "vLiq": 55}, "pagIdent": {"cCategoria": "1.01.03", "cTipoPag": "CHQ", "idConta": 1208238}, "Cheque": {"chBanco": "001", "chAgencia": "4321", "chConta": "003004", "chSerie": "01", "chNumero": "01234"}}]}]}'import os
import requests
corpo = {'call': 'IncluirCupom',
'param': [{'emissor': {'emiNome': 'EmissorPDV',
'emiVersao': '1.0',
'emiSerial': '781818814968638',
'emiId': '001'},
'ecf': {'ecfSerie': 'BE051475610000201537', 'ecfModelo': 'MP-2100 TH FI'},
'caixa': {'seqCaixa': '75716', 'seqCupom': '1790776571'},
'cupom': {'nCOO': '1790776571',
'nCCF': '1790776571',
'dEmi': '30/09/2026',
'hEmi': '13:14:30',
'lCanc': False,
'det': [{'seqItem': 1,
'lCanc': False,
'prod': {'cProd': '700309',
'xProd': 'Misiones de Rengo Carmenere 2016',
'CFOP': '5.101',
'NCM': '2204.21.00',
'cEAN': '',
'cUn': 'GF',
'nQuant': 10,
'vUnit': 5.5,
'vProd': 55,
'vDesc': 0,
'vAcresc': 0,
'vItem': 55},
'prodIdent': {'idProduto': 369356862,
'emiProduto': '3229'},
'imposto': {'vTotTrib': 5,
'ICMS': {'CST': '00',
'vBC': 55,
'pICMS': 18,
'vICMS': 9.9}}},
{'seqItem': 2,
'lCanc': False,
'prod': {'cProd': '700307',
'xProd': 'Periquita Reserva 2014',
'CFOP': '5.101',
'NCM': '2204.21.00',
'cEAN': '',
'cUn': 'GF',
'nQuant': 10,
'vUnit': 4,
'vProd': 40,
'vDesc': 0,
'vAcresc': 0,
'vItem': 40},
'prodIdent': {'idProduto': 369356851,
'emiProduto': '3224'},
'imposto': {'vTotTrib': 5,
'ICMS': {'CST': '00',
'vBC': 40,
'pICMS': 18,
'vICMS': 7.2}}}],
'outrasInf': {'nMesa': 0, 'nPessoas': 0},
'total': {'vItem': 95,
'vICMS': 17.1,
'vDesc': 0,
'vAcresc': 0,
'vTaxa': 3,
'vCF': 95,
'vTotTrib': 10}},
'cupomIdent': {'idCliente': 0,
'idVendedor': 0,
'idProjeto': 0,
'cUsuario': ''},
'formasPag': [{'seqPag': 1,
'lCanc': False,
'pag': {'vPag': 40,
'vTroco': 0,
'vTaxa': 0,
'pTaxa': 0,
'vLiq': 40},
'pagIdent': {'cCategoria': '1.01.03',
'cTipoPag': 'CRT',
'idConta': 1610386},
'TEF': {'NSU': '1029333',
'nNumeroAut': '2222',
'nValorAut': 100,
'cTipoCartao': 'D',
'cRedeTef': 'VISANET',
'cBandeiraTef': 'VISA',
'nParcTef': 2},
'parcelas': [{'nParc': 1,
'dVenc': '01/10/2026',
'vParc': 25},
{'nParc': 2,
'dVenc': '27/12/2026',
'vParc': 15}]},
{'seqPag': 2,
'lCanc': False,
'pag': {'vPag': 55,
'vTroco': 0,
'vTaxa': 0,
'pTaxa': 0,
'vLiq': 55},
'pagIdent': {'cCategoria': '1.01.03',
'cTipoPag': 'CHQ',
'idConta': 1208238},
'Cheque': {'chBanco': '001',
'chAgencia': '4321',
'chConta': '003004',
'chSerie': '01',
'chNumero': '01234'}}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirCupom",
"param": [
{
"emissor": {
"emiNome": "EmissorPDV",
"emiVersao": "1.0",
"emiSerial": "781818814968638",
"emiId": "001"
},
"ecf": {
"ecfSerie": "BE051475610000201537",
"ecfModelo": "MP-2100 TH FI"
},
"caixa": {
"seqCaixa": "75716",
"seqCupom": "1790776571"
},
"cupom": {
"nCOO": "1790776571",
"nCCF": "1790776571",
"dEmi": "30/09/2026",
"hEmi": "13:14:30",
"lCanc": false,
"det": [
{
"seqItem": 1,
"lCanc": false,
"prod": {
"cProd": "700309",
"xProd": "Misiones de Rengo Carmenere 2016",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 5.5,
"vProd": 55,
"vDesc": 0,
"vAcresc": 0,
"vItem": 55
},
"prodIdent": {
"idProduto": 369356862,
"emiProduto": "3229"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 55,
"pICMS": 18,
"vICMS": 9.9
}
}
},
{
"seqItem": 2,
"lCanc": false,
"prod": {
"cProd": "700307",
"xProd": "Periquita Reserva 2014",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 4,
"vProd": 40,
"vDesc": 0,
"vAcresc": 0,
"vItem": 40
},
"prodIdent": {
"idProduto": 369356851,
"emiProduto": "3224"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 40,
"pICMS": 18,
"vICMS": 7.2
}
}
}
],
"outrasInf": {
"nMesa": 0,
"nPessoas": 0
},
"total": {
"vItem": 95,
"vICMS": 17.1,
"vDesc": 0,
"vAcresc": 0,
"vTaxa": 3,
"vCF": 95,
"vTotTrib": 10
}
},
"cupomIdent": {
"idCliente": 0,
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 40,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 40
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1610386
},
"TEF": {
"NSU": "1029333",
"nNumeroAut": "2222",
"nValorAut": 100,
"cTipoCartao": "D",
"cRedeTef": "VISANET",
"cBandeiraTef": "VISA",
"nParcTef": 2
},
"parcelas": [
{
"nParc": 1,
"dVenc": "01/10/2026",
"vParc": 25
},
{
"nParc": 2,
"dVenc": "27/12/2026",
"vParc": 15
}
]
},
{
"seqPag": 2,
"lCanc": false,
"pag": {
"vPag": 55,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 55
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CHQ",
"idConta": 1208238
},
"Cheque": {
"chBanco": "001",
"chAgencia": "4321",
"chConta": "003004",
"chSerie": "01",
"chNumero": "01234"
}
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirCupom",
"param": [
{
"emissor": {
"emiNome": "EmissorPDV",
"emiVersao": "1.0",
"emiSerial": "781818814968638",
"emiId": "001"
},
"ecf": {
"ecfSerie": "BE051475610000201537",
"ecfModelo": "MP-2100 TH FI"
},
"caixa": {
"seqCaixa": "75716",
"seqCupom": "1790776571"
},
"cupom": {
"nCOO": "1790776571",
"nCCF": "1790776571",
"dEmi": "30/09/2026",
"hEmi": "13:14:30",
"lCanc": false,
"det": [
{
"seqItem": 1,
"lCanc": false,
"prod": {
"cProd": "700309",
"xProd": "Misiones de Rengo Carmenere 2016",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 5.5,
"vProd": 55,
"vDesc": 0,
"vAcresc": 0,
"vItem": 55
},
"prodIdent": {
"idProduto": 369356862,
"emiProduto": "3229"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 55,
"pICMS": 18,
"vICMS": 9.9
}
}
},
{
"seqItem": 2,
"lCanc": false,
"prod": {
"cProd": "700307",
"xProd": "Periquita Reserva 2014",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 4,
"vProd": 40,
"vDesc": 0,
"vAcresc": 0,
"vItem": 40
},
"prodIdent": {
"idProduto": 369356851,
"emiProduto": "3224"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 40,
"pICMS": 18,
"vICMS": 7.2
}
}
}
],
"outrasInf": {
"nMesa": 0,
"nPessoas": 0
},
"total": {
"vItem": 95,
"vICMS": 17.1,
"vDesc": 0,
"vAcresc": 0,
"vTaxa": 3,
"vCF": 95,
"vTotTrib": 10
}
},
"cupomIdent": {
"idCliente": 0,
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 40,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 40
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1610386
},
"TEF": {
"NSU": "1029333",
"nNumeroAut": "2222",
"nValorAut": 100,
"cTipoCartao": "D",
"cRedeTef": "VISANET",
"cBandeiraTef": "VISA",
"nParcTef": 2
},
"parcelas": [
{
"nParc": 1,
"dVenc": "01/10/2026",
"vParc": 25
},
{
"nParc": 2,
"dVenc": "27/12/2026",
"vParc": 15
}
]
},
{
"seqPag": 2,
"lCanc": false,
"pag": {
"vPag": 55,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 55
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CHQ",
"idConta": 1208238
},
"Cheque": {
"chBanco": "001",
"chAgencia": "4321",
"chConta": "003004",
"chSerie": "01",
"chNumero": "01234"
}
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "IncluirCupom",
"param": [
{
"emissor": {
"emiNome": "EmissorPDV",
"emiVersao": "1.0",
"emiSerial": "781818814968638",
"emiId": "001"
},
"ecf": {
"ecfSerie": "BE051475610000201537",
"ecfModelo": "MP-2100 TH FI"
},
"caixa": {
"seqCaixa": "75716",
"seqCupom": "1790776571"
},
"cupom": {
"nCOO": "1790776571",
"nCCF": "1790776571",
"dEmi": "30/09/2026",
"hEmi": "13:14:30",
"lCanc": false,
"det": [
{
"seqItem": 1,
"lCanc": false,
"prod": {
"cProd": "700309",
"xProd": "Misiones de Rengo Carmenere 2016",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 5.5,
"vProd": 55,
"vDesc": 0,
"vAcresc": 0,
"vItem": 55
},
"prodIdent": {
"idProduto": 369356862,
"emiProduto": "3229"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 55,
"pICMS": 18,
"vICMS": 9.9
}
}
},
{
"seqItem": 2,
"lCanc": false,
"prod": {
"cProd": "700307",
"xProd": "Periquita Reserva 2014",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 4,
"vProd": 40,
"vDesc": 0,
"vAcresc": 0,
"vItem": 40
},
"prodIdent": {
"idProduto": 369356851,
"emiProduto": "3224"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 40,
"pICMS": 18,
"vICMS": 7.2
}
}
}
],
"outrasInf": {
"nMesa": 0,
"nPessoas": 0
},
"total": {
"vItem": 95,
"vICMS": 17.1,
"vDesc": 0,
"vAcresc": 0,
"vTaxa": 3,
"vCF": 95,
"vTotTrib": 10
}
},
"cupomIdent": {
"idCliente": 0,
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 40,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 40
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1610386
},
"TEF": {
"NSU": "1029333",
"nNumeroAut": "2222",
"nValorAut": 100,
"cTipoCartao": "D",
"cRedeTef": "VISANET",
"cBandeiraTef": "VISA",
"nParcTef": 2
},
"parcelas": [
{
"nParc": 1,
"dVenc": "01/10/2026",
"vParc": 25
},
{
"nParc": 2,
"dVenc": "27/12/2026",
"vParc": 15
}
]
},
{
"seqPag": 2,
"lCanc": false,
"pag": {
"vPag": 55,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 55
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CHQ",
"idConta": 1208238
},
"Cheque": {
"chBanco": "001",
"chAgencia": "4321",
"chConta": "003004",
"chSerie": "01",
"chNumero": "01234"
}
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirCupom",
"param": [
{
"emissor": {
"emiNome": "EmissorPDV",
"emiVersao": "1.0",
"emiSerial": "781818814968638",
"emiId": "001"
},
"ecf": {
"ecfSerie": "BE051475610000201537",
"ecfModelo": "MP-2100 TH FI"
},
"caixa": {
"seqCaixa": "75716",
"seqCupom": "1790776571"
},
"cupom": {
"nCOO": "1790776571",
"nCCF": "1790776571",
"dEmi": "30/09/2026",
"hEmi": "13:14:30",
"lCanc": false,
"det": [
{
"seqItem": 1,
"lCanc": false,
"prod": {
"cProd": "700309",
"xProd": "Misiones de Rengo Carmenere 2016",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 5.5,
"vProd": 55,
"vDesc": 0,
"vAcresc": 0,
"vItem": 55
},
"prodIdent": {
"idProduto": 369356862,
"emiProduto": "3229"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 55,
"pICMS": 18,
"vICMS": 9.9
}
}
},
{
"seqItem": 2,
"lCanc": false,
"prod": {
"cProd": "700307",
"xProd": "Periquita Reserva 2014",
"CFOP": "5.101",
"NCM": "2204.21.00",
"cEAN": "",
"cUn": "GF",
"nQuant": 10,
"vUnit": 4,
"vProd": 40,
"vDesc": 0,
"vAcresc": 0,
"vItem": 40
},
"prodIdent": {
"idProduto": 369356851,
"emiProduto": "3224"
},
"imposto": {
"vTotTrib": 5,
"ICMS": {
"CST": "00",
"vBC": 40,
"pICMS": 18,
"vICMS": 7.2
}
}
}
],
"outrasInf": {
"nMesa": 0,
"nPessoas": 0
},
"total": {
"vItem": 95,
"vICMS": 17.1,
"vDesc": 0,
"vAcresc": 0,
"vTaxa": 3,
"vCF": 95,
"vTotTrib": 10
}
},
"cupomIdent": {
"idCliente": 0,
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 40,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 40
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1610386
},
"TEF": {
"NSU": "1029333",
"nNumeroAut": "2222",
"nValorAut": 100,
"cTipoCartao": "D",
"cRedeTef": "VISANET",
"cBandeiraTef": "VISA",
"nParcTef": 2
},
"parcelas": [
{
"nParc": 1,
"dVenc": "01/10/2026",
"vParc": 25
},
{
"nParc": 2,
"dVenc": "27/12/2026",
"vParc": 15
}
]
},
{
"seqPag": 2,
"lCanc": false,
"pag": {
"vPag": 55,
"vTroco": 0,
"vTaxa": 0,
"pTaxa": 0,
"vLiq": 55
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CHQ",
"idConta": 1208238
},
"Cheque": {
"chBanco": "001",
"chAgencia": "4321",
"chConta": "003004",
"chSerie": "01",
"chNumero": "01234"
}
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirCupom"", ""param"": [{""emissor"": {""emiNome"": ""EmissorPDV"", ""emiVersao"": ""1.0"", ""emiSerial"": ""781818814968638"", ""emiId"": ""001""}, ""ecf"": {""ecfSerie"": ""BE051475610000201537"", ""ecfModelo"": ""MP-2100 TH FI""}, ""caixa"": {""seqCaixa"": ""75716"", ""seqCupom"": ""1790776571""}, ""cupom"": {""nCOO"": ""1790776571"", ""nCCF"": ""1790776571"", ""dEmi"": ""30/09/2026"", ""hEmi"": ""13:14:30"", ""lCanc"": false, ""det"": [{""seqItem"": 1, ""lCanc"": false, ""prod"": {""cProd"": ""700309"", ""xProd"": ""Misiones de Rengo Carmenere 2016"", ""CFOP"": ""5.101"", ""NCM"": ""2204.21.00"", ""cEAN"": """", ""cUn"": ""GF"", ""nQuant"": 10, ""vUnit"": 5.5, ""vProd"": 55, ""vDesc"": 0, ""vAcresc"": 0, ""vItem"": 55}, ""prodIdent"": {""idProduto"": 369356862, ""emiProduto"": ""3229""}, ""imposto"": {""vTotTrib"": 5, ""ICMS"": {""CST"": ""00"", ""vBC"": 55, ""pICMS"": 18, ""vICMS"": 9.9}}}, {""seqItem"": 2, ""lCanc"": false, ""prod"": {""cProd"": ""700307"", ""xProd"": ""Periquita Reserva 2014"", ""CFOP"": ""5.101"", ""NCM"": ""2204.21.00"", ""cEAN"": """", ""cUn"": ""GF"", ""nQuant"": 10, ""vUnit"": 4, ""vProd"": 40, ""vDesc"": 0, ""vAcresc"": 0, ""vItem"": 40}, ""prodIdent"": {""idProduto"": 369356851, ""emiProduto"": ""3224""}, ""imposto"": {""vTotTrib"": 5, ""ICMS"": {""CST"": ""00"", ""vBC"": 40, ""pICMS"": 18, ""vICMS"": 7.2}}}], ""outrasInf"": {""nMesa"": 0, ""nPessoas"": 0}, ""total"": {""vItem"": 95, ""vICMS"": 17.1, ""vDesc"": 0, ""vAcresc"": 0, ""vTaxa"": 3, ""vCF"": 95, ""vTotTrib"": 10}}, ""cupomIdent"": {""idCliente"": 0, ""idVendedor"": 0, ""idProjeto"": 0, ""cUsuario"": """"}, ""formasPag"": [{""seqPag"": 1, ""lCanc"": false, ""pag"": {""vPag"": 40, ""vTroco"": 0, ""vTaxa"": 0, ""pTaxa"": 0, ""vLiq"": 40}, ""pagIdent"": {""cCategoria"": ""1.01.03"", ""cTipoPag"": ""CRT"", ""idConta"": 1610386}, ""TEF"": {""NSU"": ""1029333"", ""nNumeroAut"": ""2222"", ""nValorAut"": 100, ""cTipoCartao"": ""D"", ""cRedeTef"": ""VISANET"", ""cBandeiraTef"": ""VISA"", ""nParcTef"": 2}, ""parcelas"": [{""nParc"": 1, ""dVenc"": ""01/10/2026"", ""vParc"": 25}, {""nParc"": 2, ""dVenc"": ""27/12/2026"", ""vParc"": 15}]}, {""seqPag"": 2, ""lCanc"": false, ""pag"": {""vPag"": 55, ""vTroco"": 0, ""vTaxa"": 0, ""pTaxa"": 0, ""vLiq"": 55}, ""pagIdent"": {""cCategoria"": ""1.01.03"", ""cTipoPag"": ""CHQ"", ""idConta"": 1208238}, ""Cheque"": {""chBanco"": ""001"", ""chAgencia"": ""4321"", ""chConta"": ""003004"", ""chSerie"": ""01"", ""chNumero"": ""01234""}}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosIncluir Nota Fiscal Consumidor Eletrônico.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 10Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
NFe | objeto | |
NFe.cTipoAcao | texto · até 100 | Ação para o faturamento de serviços. Essa tag é deve ser apenas na inclusão de cupons fiscais com itens de serviço quando a tag 'servicos' estiver preenchida. Indica se as ordens de serviço faturadas para o cupom ou rps serão geradas de forma agrupada ou individual. 'AGRUPADO' (Default). 'AGRUPADO-SALAO-PARCEIRO' 'INDIVIDUAL' |
NFe.chNFeobrigatório | texto · até 44 | Chave de Acesso da Nota Fiscal Consumidor Eletrônico. |
NFe.dEmiobrigatório | texto · até 10 | Data da emissão do cupom fiscal. |
NFe.det | lista de objetos | Itens do cupom fiscal. |
NFe.det[].imposto | objeto | Dados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT. |
NFe.det[].imposto.ICMS | objeto | |
NFe.det[].imposto.ICMS.CST | texto · até 2 | Código da Situação Tributária. |
NFe.det[].imposto.ICMS.pICMS | número | Alíquota do ICMS. |
NFe.det[].imposto.ICMS.vBC | número | Valor da Base de Cálculo. |
NFe.det[].imposto.ICMS.vICMS | número | Valor do ICMS. |
NFe.det[].imposto.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
NFe.det[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
NFe.det[].lNaoMovEstoque | texto · até 5 | Indica que o item do Cupom Fiscal não deve movimentar o estoque. |
NFe.det[].lote_validade | objeto | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
NFe.det[].lote_validade.nIdLote | número inteiro | Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
NFe.det[].lote_validade.nQtdLoteobrigatório | número | Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
NFe.det[].prod | objeto | |
NFe.det[].prod.CFOP | texto · até 10 | CFOP. |
NFe.det[].prod.NCM | texto · até 13 | NCM. |
NFe.det[].prod.cEAN | texto · até 14 | EAN do produto. |
NFe.det[].prod.cProd | texto · até 60 | Código do produto conforme destacado no Cupom Fiscal. |
NFe.det[].prod.cUn | texto · até 6 | Unidade de medida. |
NFe.det[].prod.nQuant | número | Quantidade. |
NFe.det[].prod.vAcresc | número | Valor do acréscimo. |
NFe.det[].prod.vDesc | número | Valor do desconto. |
NFe.det[].prod.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
NFe.det[].prod.vProd | número | Valor do produto. vProd = nQuant x vUnit |
NFe.det[].prod.vUnit | número | Valor unitário. |
NFe.det[].prod.xProd | texto · até 120 | Descrição do produto conforme destacado no Cupom Fiscal. |
NFe.det[].prodIdent | objeto | |
NFe.det[].prodIdent.emiProduto | texto · até 60 | Código do produto no emissor de cupom fiscal. |
NFe.det[].prodIdent.idLocalEstoque | número inteiro | Codigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão. |
NFe.det[].prodIdent.idProduto | número inteiro | Código do produto. |
NFe.det[].seqItemobrigatório | número inteiro | Número sequencial do item. |
NFe.hEmiobrigatório | texto · até 10 | Hora da emissão do cupom fiscal. |
NFe.lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
NFe.nNFobrigatório | texto · até 20 | Número da Nota Fiscal Consumidor Eletrônico. |
NFe.outrasInf | objeto | Outras informações do cupom fiscal. |
NFe.outrasInf.nMesa | texto · até 10 | Número / identificação da mesa. |
NFe.outrasInf.nPessoas | número inteiro | Número/quantidade de pessoas atendidas. |
NFe.serie | texto · até 4 | Série da Nota Fiscal Consumidor Eletrônico. |
NFe.total | objeto | Totais do cupom fiscal. |
NFe.total.vAcresc | número | Valor do acréscimo. |
NFe.total.vCFobrigatório | número | Valor do Cupom Fiscal. |
NFe.total.vDesc | número | Valor do desconto. |
NFe.total.vICMS | número | Valor do ICMS. |
NFe.total.vItem | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
NFe.total.vTaxa | número | Valor da taxa. |
NFe.total.vTotTrib | número | Valor aproximado dos tributos (IBPT). |
NFe.tpAmbobrigatório | texto · até 1 | Ambiente. Pode ser: H-Homologação. P-Produção. |
NFe.tpEmisobrigatório | texto · até 1 | Tipo de emissão da Nota Fiscal Consumidor Eletrônico. Pode ser: 1 - Emissão normal. 9 - Emissão em contingência. |
caixa | objeto | Caixa |
caixa.lCxAberto | sim/não | Indica se o Caixa está aberto. O padrão é false. Quando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado. |
caixa.seqCaixaobrigatório | número inteiro | Número sequencial do movimento do caixa. Caso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia. |
caixa.seqCupomobrigatório | número inteiro | Número sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda. |
categorias | lista de objetos | Distribuição por Categorias. |
categorias[].idCategoria | texto · até 20 | Código da Categoria. (Gerado internamente, não é visualizado na tela) |
categorias[].pCategoria | número | Percentual da categoria |
categorias[].vCategoria | número | Valor da categoria |
cupomIdent | objeto | |
cupomIdent.cNumeroContrato | texto · até 30 | Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cPedidoCliente | texto · até 30 | Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cUsuario | texto · até 10 | Código do Usuário. Quando não informado, assumirá o usuário "Integração" como o usuário responsáivel pela emissão do cupom fiscal. |
cupomIdent.idCliente | número inteiro | Código do cliente. Quando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente. |
cupomIdent.idProjeto | número inteiro | Código do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal. |
cupomIdent.idVendedor | número inteiro | Código do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamento | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
formasPag | lista de objetos | |
formasPag[].Cheque | objeto | Informações do Cheque. |
formasPag[].Cheque.chAgencia | texto · até 4 | Número da Agência. |
formasPag[].Cheque.chBanco | texto · até 5 | Número do Banco. |
formasPag[].Cheque.chConta | texto · até 15 | Número da Conta. |
formasPag[].Cheque.chNumero | texto · até 15 | Número do Cheque. |
formasPag[].Cheque.chSerie | texto · até 10 | Série do Cheque. |
formasPag[].Cheque.chVencimento | texto · até 10 | Data de vencimento do cheque. |
formasPag[].PIX | objeto | |
formasPag[].PIX.cCodIntPixobrigatório | texto · até 60 | Código do lançamento gerado pelo integrador. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "cCodInt" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].PIX.nIdPixobrigatório | número inteiro | ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "nIdPix" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].POS | objeto | |
formasPag[].POS.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].POS.cRedePos | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].POS.dTransacao | texto · até 10 | Data da transação. |
formasPag[].POS.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].POS.nParcPos | número inteiro | Número de parcelas. |
formasPag[].POS.nValorAut | número | Valor autorizado. |
formasPag[].TEF | objeto | |
formasPag[].TEF.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].TEF.NSUHost | texto · até 200 | NSU (Número Sequencial Único) Identifica uma operação de venda no host. |
formasPag[].TEF.TID | texto · até 200 | TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente. Essa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce. |
formasPag[].TEF.cBandeiraTef | texto · até 30 | Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD |
formasPag[].TEF.cRedeTef | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].TEF.cTipoCartao | texto · até 1 | Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito. |
formasPag[].TEF.dTransacao | texto · até 10 | Data da transação. |
formasPag[].TEF.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].TEF.nNumeroAut | texto · até 40 | Número da autorização. |
formasPag[].TEF.nParcTef | número inteiro | Número de parcelas. |
formasPag[].TEF.nValorAut | número | Valor autorizado. |
formasPag[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
formasPag[].lNaoGerarTitulo | texto · até 5 | Indica que a parcela não deve gerar um título no financeiro. |
formasPag[].pag | objeto | |
formasPag[].pag.pTaxa | número | Percentual da taxa da administradora de cartões. |
formasPag[].pag.vLiqobrigatório | número | Valor líquido do pagamento. |
formasPag[].pag.vPagobrigatório | número | Valor do pagamento. |
formasPag[].pag.vTaxa | número | Valor da taxa da administradora de cartões. |
formasPag[].pag.vTroco | número | Valor do troco. |
formasPag[].pagIdent | objeto | |
formasPag[].pagIdent.cCategoria | texto · até 20 | Código da categoria. Utilize a tag "codigo" do método "ListarCategorias" da API /api/v1/geral/categorias/ para obter essa informação. |
formasPag[].pagIdent.cTipoPagobrigatório | texto · até 5 | Tipo de pagamento. Se não preenchido assumirá o código "99999" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro. Opções disponíveis: "BOL" - Boleto "DIN" - Dinheiro "CRE" - Crediário "CRT" - Cartão "CRC" - Cartão de Crédito "CRD" - Cartão de Débito "CHQ" - Cheque "CHT" - Cheque de Terceiros "PIX" - Pix "99999" - Outros Valor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos: Caixinha => "DIN", "CHQ", "CHT", "99999" e "PIX" Administradora de Cartões => "CRT", "CRC" e "CRD" Carteira Virtual => "CRT", "CRC" e "CRD" Conta Corrente => "DIN", "CRT", "CRC", "CRD", "BOL" e "PIX" Crediário / Carnê => "CRE" e "BOL" |
formasPag[].pagIdent.idContaobrigatório | número inteiro | Código da Conta Corrente. |
formasPag[].parcelas | lista de objetos | |
formasPag[].parcelas[].dVenc | texto · até 10 | Data de vencimento da parcela. Formato: dd/mm/aaaa. |
formasPag[].parcelas[].nParc | texto · até 7 | Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003 |
formasPag[].parcelas[].vParc | número | Valor da parcela. |
formasPag[].seqPagobrigatório | número inteiro | Sequência do pagamento. |
nfce | objeto | |
nfce.nfceMd5obrigatório | texto · até 32 | MD5 do arquivo XML enviado em "nfceXml". |
nfce.nfceProtobrigatório | texto · até 30 | Protocolo de envio da NFC-e. |
nfce.nfceXmlobrigatório | texto | XML da NFC-e enviada. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "nfceMd5". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
nfceCanc | objeto | Dados do cancelamento da NFC-e. |
nfceCanc.nfceMd5Can | texto · até 32 | MD5 do arquivo XML enviado em "nfceXmlCan". |
nfceCanc.nfceProtCan | texto · até 30 | Protocolo de cancelamento da NFC-e. |
nfceCanc.nfceXmlCanobrigatório | texto | XML da NFC-e cancelada. Preechimento obrigatório para indicar o cancelamento da NFC-e. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "nfceMd5Can". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
servicos | lista de objetos | Informações dos Itens de serviço. |
servicos[].cCnpjVend | texto · até 20 | CNPJ do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP. |
servicos[].cMunFG | texto · até 7 | Código IBGE do município de ocorrência do fato gerador do ISSQN. (Cidade de prestação do serviço). Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].cNomeVend | texto · até 100 | Nome do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP. |
servicos[].nCodServ | número inteiro | ID do serviço. (Gerado internamente, não é visualizado na tela). Pode ser obtido através da API 'api/v1/servicos/servico/#ListarCadastroServico'. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nItem | número inteiro | Sequencia do item de serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nQtde | número | Quantidade de serviços. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nValorCom | número | Valor de comissão do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o valor de comissão do ERP. |
servicos[].nValorDed | número | Valor dedução para redução da Base de Calculo. |
servicos[].nValorTot | número | Valor Total do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nValorUni | número | Valor Unitário do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].vAcresc | número | Valor de acréscimo. |
servicos[].vDesc | número | Valor de desconto. |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
idCupom | número inteiro | Identificação do cupom fiscal. |
idLote | número inteiro | Identificação do lote do cupom fiscal. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirNfce", "param": [{"NFe": {"chNFe": "99999999999999999999999999999999999999999999", "dEmi": "dd/mm/aaaa", "det": [{"lCanc": false, "lNaoMovEstoque": false, "prod": {"CFOP": "5405", "NCM": "04061090", "cEAN": "SEM GTIN", "cProd": "325", "cUn": "UN", "nQuant": 1, "vAcresc": 0, "vDesc": 0, "vItem": 15, "vProd": 15, "vUnit": 15, "xProd": "REQUEIJAO CREMOSO 400GR MINAS MILK"}, "prodIdent": {"emiProduto": "325", "idLocalEstoque": "1205784081", "idProduto": 1208514897}, "seqItem": 1}], "hEmi": "08:24:01", "lCanc": false, "nNF": "000016064", "serie": "002", "total": {"vAcresc": "0.00", "vCF": "25.00", "vDesc": "0.00", "vICMS": "0.00", "vItem": "25.00", "vTaxa": 0, "vTotTrib": 0}, "tpAmb": "P", "tpEmis": "1"}, "caixa": {"lCxAberto": false, "seqCaixa": 710, "seqCupom": 1012303}, "cupomIdent": {"idCliente": 120834285, "idProjeto": 0, "idVendedor": 0}, "emissor": {"emiId": "0001", "emiNome": "SEU_PDV", "emiSerial": "WD-WXS1A499REDFTB58F00D65", "emiVersao": "1.9.00"}, "formasPag": [{"Parcelas": [{"dVenc": "dd/mm/aaaa", "nParc": "001/001", "vParc": 25}], "TEF": {"NSU": "", "cBandeiraTef": "", "cRedeTef": "Outros", "cTipoCartao": "", "nNumeroAut": "", "nParcTef": 0, "nValorAut": 25}, "lCanc": false, "lNaoGerarTitulo": false, "pag": {"pTaxa": 0, "vLiq": 25, "vPag": 25, "vTaxa": 0, "vTroco": 0}, "pagIdent": {"cCategoria": "1.01.03", "cTipoPag": "CRT", "idConta": 1298842804}, "seqPag": 1}], "nfce": {"nfceMd5": "754d4c0594e4ebcbcf7fdd75547f9d7d", "nfceProt": "999999999999999", "nfceXml": "SEU_XML"}}]}'import os
import requests
corpo = {'call': 'IncluirNfce',
'param': [{'NFe': {'chNFe': '99999999999999999999999999999999999999999999',
'dEmi': 'dd/mm/aaaa',
'det': [{'lCanc': False,
'lNaoMovEstoque': False,
'prod': {'CFOP': '5405',
'NCM': '04061090',
'cEAN': 'SEM GTIN',
'cProd': '325',
'cUn': 'UN',
'nQuant': 1,
'vAcresc': 0,
'vDesc': 0,
'vItem': 15,
'vProd': 15,
'vUnit': 15,
'xProd': 'REQUEIJAO CREMOSO 400GR MINAS MILK'},
'prodIdent': {'emiProduto': '325',
'idLocalEstoque': '1205784081',
'idProduto': 1208514897},
'seqItem': 1}],
'hEmi': '08:24:01',
'lCanc': False,
'nNF': '000016064',
'serie': '002',
'total': {'vAcresc': '0.00',
'vCF': '25.00',
'vDesc': '0.00',
'vICMS': '0.00',
'vItem': '25.00',
'vTaxa': 0,
'vTotTrib': 0},
'tpAmb': 'P',
'tpEmis': '1'},
'caixa': {'lCxAberto': False, 'seqCaixa': 710, 'seqCupom': 1012303},
'cupomIdent': {'idCliente': 120834285, 'idProjeto': 0, 'idVendedor': 0},
'emissor': {'emiId': '0001',
'emiNome': 'SEU_PDV',
'emiSerial': 'WD-WXS1A499REDFTB58F00D65',
'emiVersao': '1.9.00'},
'formasPag': [{'Parcelas': [{'dVenc': 'dd/mm/aaaa',
'nParc': '001/001',
'vParc': 25}],
'TEF': {'NSU': '',
'cBandeiraTef': '',
'cRedeTef': 'Outros',
'cTipoCartao': '',
'nNumeroAut': '',
'nParcTef': 0,
'nValorAut': 25},
'lCanc': False,
'lNaoGerarTitulo': False,
'pag': {'pTaxa': 0,
'vLiq': 25,
'vPag': 25,
'vTaxa': 0,
'vTroco': 0},
'pagIdent': {'cCategoria': '1.01.03',
'cTipoPag': 'CRT',
'idConta': 1298842804},
'seqPag': 1}],
'nfce': {'nfceMd5': '754d4c0594e4ebcbcf7fdd75547f9d7d',
'nfceProt': '999999999999999',
'nfceXml': 'SEU_XML'}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirNfce",
"param": [
{
"NFe": {
"chNFe": "99999999999999999999999999999999999999999999",
"dEmi": "dd/mm/aaaa",
"det": [
{
"lCanc": false,
"lNaoMovEstoque": false,
"prod": {
"CFOP": "5405",
"NCM": "04061090",
"cEAN": "SEM GTIN",
"cProd": "325",
"cUn": "UN",
"nQuant": 1,
"vAcresc": 0,
"vDesc": 0,
"vItem": 15,
"vProd": 15,
"vUnit": 15,
"xProd": "REQUEIJAO CREMOSO 400GR MINAS MILK"
},
"prodIdent": {
"emiProduto": "325",
"idLocalEstoque": "1205784081",
"idProduto": 1208514897
},
"seqItem": 1
}
],
"hEmi": "08:24:01",
"lCanc": false,
"nNF": "000016064",
"serie": "002",
"total": {
"vAcresc": "0.00",
"vCF": "25.00",
"vDesc": "0.00",
"vICMS": "0.00",
"vItem": "25.00",
"vTaxa": 0,
"vTotTrib": 0
},
"tpAmb": "P",
"tpEmis": "1"
},
"caixa": {
"lCxAberto": false,
"seqCaixa": 710,
"seqCupom": 1012303
},
"cupomIdent": {
"idCliente": 120834285,
"idProjeto": 0,
"idVendedor": 0
},
"emissor": {
"emiId": "0001",
"emiNome": "SEU_PDV",
"emiSerial": "WD-WXS1A499REDFTB58F00D65",
"emiVersao": "1.9.00"
},
"formasPag": [
{
"Parcelas": [
{
"dVenc": "dd/mm/aaaa",
"nParc": "001/001",
"vParc": 25
}
],
"TEF": {
"NSU": "",
"cBandeiraTef": "",
"cRedeTef": "Outros",
"cTipoCartao": "",
"nNumeroAut": "",
"nParcTef": 0,
"nValorAut": 25
},
"lCanc": false,
"lNaoGerarTitulo": false,
"pag": {
"pTaxa": 0,
"vLiq": 25,
"vPag": 25,
"vTaxa": 0,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1298842804
},
"seqPag": 1
}
],
"nfce": {
"nfceMd5": "754d4c0594e4ebcbcf7fdd75547f9d7d",
"nfceProt": "999999999999999",
"nfceXml": "SEU_XML"
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirNfce",
"param": [
{
"NFe": {
"chNFe": "99999999999999999999999999999999999999999999",
"dEmi": "dd/mm/aaaa",
"det": [
{
"lCanc": false,
"lNaoMovEstoque": false,
"prod": {
"CFOP": "5405",
"NCM": "04061090",
"cEAN": "SEM GTIN",
"cProd": "325",
"cUn": "UN",
"nQuant": 1,
"vAcresc": 0,
"vDesc": 0,
"vItem": 15,
"vProd": 15,
"vUnit": 15,
"xProd": "REQUEIJAO CREMOSO 400GR MINAS MILK"
},
"prodIdent": {
"emiProduto": "325",
"idLocalEstoque": "1205784081",
"idProduto": 1208514897
},
"seqItem": 1
}
],
"hEmi": "08:24:01",
"lCanc": false,
"nNF": "000016064",
"serie": "002",
"total": {
"vAcresc": "0.00",
"vCF": "25.00",
"vDesc": "0.00",
"vICMS": "0.00",
"vItem": "25.00",
"vTaxa": 0,
"vTotTrib": 0
},
"tpAmb": "P",
"tpEmis": "1"
},
"caixa": {
"lCxAberto": false,
"seqCaixa": 710,
"seqCupom": 1012303
},
"cupomIdent": {
"idCliente": 120834285,
"idProjeto": 0,
"idVendedor": 0
},
"emissor": {
"emiId": "0001",
"emiNome": "SEU_PDV",
"emiSerial": "WD-WXS1A499REDFTB58F00D65",
"emiVersao": "1.9.00"
},
"formasPag": [
{
"Parcelas": [
{
"dVenc": "dd/mm/aaaa",
"nParc": "001/001",
"vParc": 25
}
],
"TEF": {
"NSU": "",
"cBandeiraTef": "",
"cRedeTef": "Outros",
"cTipoCartao": "",
"nNumeroAut": "",
"nParcTef": 0,
"nValorAut": 25
},
"lCanc": false,
"lNaoGerarTitulo": false,
"pag": {
"pTaxa": 0,
"vLiq": 25,
"vPag": 25,
"vTaxa": 0,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1298842804
},
"seqPag": 1
}
],
"nfce": {
"nfceMd5": "754d4c0594e4ebcbcf7fdd75547f9d7d",
"nfceProt": "999999999999999",
"nfceXml": "SEU_XML"
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "IncluirNfce",
"param": [
{
"NFe": {
"chNFe": "99999999999999999999999999999999999999999999",
"dEmi": "dd/mm/aaaa",
"det": [
{
"lCanc": false,
"lNaoMovEstoque": false,
"prod": {
"CFOP": "5405",
"NCM": "04061090",
"cEAN": "SEM GTIN",
"cProd": "325",
"cUn": "UN",
"nQuant": 1,
"vAcresc": 0,
"vDesc": 0,
"vItem": 15,
"vProd": 15,
"vUnit": 15,
"xProd": "REQUEIJAO CREMOSO 400GR MINAS MILK"
},
"prodIdent": {
"emiProduto": "325",
"idLocalEstoque": "1205784081",
"idProduto": 1208514897
},
"seqItem": 1
}
],
"hEmi": "08:24:01",
"lCanc": false,
"nNF": "000016064",
"serie": "002",
"total": {
"vAcresc": "0.00",
"vCF": "25.00",
"vDesc": "0.00",
"vICMS": "0.00",
"vItem": "25.00",
"vTaxa": 0,
"vTotTrib": 0
},
"tpAmb": "P",
"tpEmis": "1"
},
"caixa": {
"lCxAberto": false,
"seqCaixa": 710,
"seqCupom": 1012303
},
"cupomIdent": {
"idCliente": 120834285,
"idProjeto": 0,
"idVendedor": 0
},
"emissor": {
"emiId": "0001",
"emiNome": "SEU_PDV",
"emiSerial": "WD-WXS1A499REDFTB58F00D65",
"emiVersao": "1.9.00"
},
"formasPag": [
{
"Parcelas": [
{
"dVenc": "dd/mm/aaaa",
"nParc": "001/001",
"vParc": 25
}
],
"TEF": {
"NSU": "",
"cBandeiraTef": "",
"cRedeTef": "Outros",
"cTipoCartao": "",
"nNumeroAut": "",
"nParcTef": 0,
"nValorAut": 25
},
"lCanc": false,
"lNaoGerarTitulo": false,
"pag": {
"pTaxa": 0,
"vLiq": 25,
"vPag": 25,
"vTaxa": 0,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1298842804
},
"seqPag": 1
}
],
"nfce": {
"nfceMd5": "754d4c0594e4ebcbcf7fdd75547f9d7d",
"nfceProt": "999999999999999",
"nfceXml": "SEU_XML"
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirNfce",
"param": [
{
"NFe": {
"chNFe": "99999999999999999999999999999999999999999999",
"dEmi": "dd/mm/aaaa",
"det": [
{
"lCanc": false,
"lNaoMovEstoque": false,
"prod": {
"CFOP": "5405",
"NCM": "04061090",
"cEAN": "SEM GTIN",
"cProd": "325",
"cUn": "UN",
"nQuant": 1,
"vAcresc": 0,
"vDesc": 0,
"vItem": 15,
"vProd": 15,
"vUnit": 15,
"xProd": "REQUEIJAO CREMOSO 400GR MINAS MILK"
},
"prodIdent": {
"emiProduto": "325",
"idLocalEstoque": "1205784081",
"idProduto": 1208514897
},
"seqItem": 1
}
],
"hEmi": "08:24:01",
"lCanc": false,
"nNF": "000016064",
"serie": "002",
"total": {
"vAcresc": "0.00",
"vCF": "25.00",
"vDesc": "0.00",
"vICMS": "0.00",
"vItem": "25.00",
"vTaxa": 0,
"vTotTrib": 0
},
"tpAmb": "P",
"tpEmis": "1"
},
"caixa": {
"lCxAberto": false,
"seqCaixa": 710,
"seqCupom": 1012303
},
"cupomIdent": {
"idCliente": 120834285,
"idProjeto": 0,
"idVendedor": 0
},
"emissor": {
"emiId": "0001",
"emiNome": "SEU_PDV",
"emiSerial": "WD-WXS1A499REDFTB58F00D65",
"emiVersao": "1.9.00"
},
"formasPag": [
{
"Parcelas": [
{
"dVenc": "dd/mm/aaaa",
"nParc": "001/001",
"vParc": 25
}
],
"TEF": {
"NSU": "",
"cBandeiraTef": "",
"cRedeTef": "Outros",
"cTipoCartao": "",
"nNumeroAut": "",
"nParcTef": 0,
"nValorAut": 25
},
"lCanc": false,
"lNaoGerarTitulo": false,
"pag": {
"pTaxa": 0,
"vLiq": 25,
"vPag": 25,
"vTaxa": 0,
"vTroco": 0
},
"pagIdent": {
"cCategoria": "1.01.03",
"cTipoPag": "CRT",
"idConta": 1298842804
},
"seqPag": 1
}
],
"nfce": {
"nfceMd5": "754d4c0594e4ebcbcf7fdd75547f9d7d",
"nfceProt": "999999999999999",
"nfceXml": "SEU_XML"
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirNfce"", ""param"": [{""NFe"": {""chNFe"": ""99999999999999999999999999999999999999999999"", ""dEmi"": ""dd/mm/aaaa"", ""det"": [{""lCanc"": false, ""lNaoMovEstoque"": false, ""prod"": {""CFOP"": ""5405"", ""NCM"": ""04061090"", ""cEAN"": ""SEM GTIN"", ""cProd"": ""325"", ""cUn"": ""UN"", ""nQuant"": 1, ""vAcresc"": 0, ""vDesc"": 0, ""vItem"": 15, ""vProd"": 15, ""vUnit"": 15, ""xProd"": ""REQUEIJAO CREMOSO 400GR MINAS MILK""}, ""prodIdent"": {""emiProduto"": ""325"", ""idLocalEstoque"": ""1205784081"", ""idProduto"": 1208514897}, ""seqItem"": 1}], ""hEmi"": ""08:24:01"", ""lCanc"": false, ""nNF"": ""000016064"", ""serie"": ""002"", ""total"": {""vAcresc"": ""0.00"", ""vCF"": ""25.00"", ""vDesc"": ""0.00"", ""vICMS"": ""0.00"", ""vItem"": ""25.00"", ""vTaxa"": 0, ""vTotTrib"": 0}, ""tpAmb"": ""P"", ""tpEmis"": ""1""}, ""caixa"": {""lCxAberto"": false, ""seqCaixa"": 710, ""seqCupom"": 1012303}, ""cupomIdent"": {""idCliente"": 120834285, ""idProjeto"": 0, ""idVendedor"": 0}, ""emissor"": {""emiId"": ""0001"", ""emiNome"": ""SEU_PDV"", ""emiSerial"": ""WD-WXS1A499REDFTB58F00D65"", ""emiVersao"": ""1.9.00""}, ""formasPag"": [{""Parcelas"": [{""dVenc"": ""dd/mm/aaaa"", ""nParc"": ""001/001"", ""vParc"": 25}], ""TEF"": {""NSU"": """", ""cBandeiraTef"": """", ""cRedeTef"": ""Outros"", ""cTipoCartao"": """", ""nNumeroAut"": """", ""nParcTef"": 0, ""nValorAut"": 25}, ""lCanc"": false, ""lNaoGerarTitulo"": false, ""pag"": {""pTaxa"": 0, ""vLiq"": 25, ""vPag"": 25, ""vTaxa"": 0, ""vTroco"": 0}, ""pagIdent"": {""cCategoria"": ""1.01.03"", ""cTipoPag"": ""CRT"", ""idConta"": 1298842804}, ""seqPag"": 1}], ""nfce"": {""nfceMd5"": ""754d4c0594e4ebcbcf7fdd75547f9d7d"", ""nfceProt"": ""999999999999999"", ""nfceXml"": ""SEU_XML""}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosIncluir Cupom RPS.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
caixa | objeto | Caixa |
caixa.lCxAberto | sim/não | Indica se o Caixa está aberto. O padrão é false. Quando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado. |
caixa.seqCaixaobrigatório | número inteiro | Número sequencial do movimento do caixa. Caso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia. |
caixa.seqCupomobrigatório | número inteiro | Número sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda. |
categorias | lista de objetos | Distribuição por Categorias. |
categorias[].idCategoria | texto · até 20 | Código da Categoria. (Gerado internamente, não é visualizado na tela) |
categorias[].pCategoria | número | Percentual da categoria |
categorias[].vCategoria | número | Valor da categoria |
cupomIdent | objeto | |
cupomIdent.cNumeroContrato | texto · até 30 | Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cPedidoCliente | texto · até 30 | Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal. |
cupomIdent.cUsuario | texto · até 10 | Código do Usuário. Quando não informado, assumirá o usuário "Integração" como o usuário responsáivel pela emissão do cupom fiscal. |
cupomIdent.idCliente | número inteiro | Código do cliente. Quando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente. |
cupomIdent.idProjeto | número inteiro | Código do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal. |
cupomIdent.idVendedor | número inteiro | Código do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal. |
departamentos | lista de objetos | Distribuição por Departamentos. |
departamentos[].idDepartamento | texto · até 40 | Código do departamento. (Gerado internamente, não é visualizado na tela) |
departamentos[].pDepartamentoobrigatório | número | Percentual do departamento. Preenchimento obrigatório |
departamentos[].vDepartamentoobrigatório | número | Valor do departamento. Preenchimento obrigatório |
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
formasPag | lista de objetos | |
formasPag[].Cheque | objeto | Informações do Cheque. |
formasPag[].Cheque.chAgencia | texto · até 4 | Número da Agência. |
formasPag[].Cheque.chBanco | texto · até 5 | Número do Banco. |
formasPag[].Cheque.chConta | texto · até 15 | Número da Conta. |
formasPag[].Cheque.chNumero | texto · até 15 | Número do Cheque. |
formasPag[].Cheque.chSerie | texto · até 10 | Série do Cheque. |
formasPag[].Cheque.chVencimento | texto · até 10 | Data de vencimento do cheque. |
formasPag[].PIX | objeto | |
formasPag[].PIX.cCodIntPixobrigatório | texto · até 60 | Código do lançamento gerado pelo integrador. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "cCodInt" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].PIX.nIdPixobrigatório | número inteiro | ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. É obrigatório o preenchimento das tags "nIdPix" ou "cCodInt". Utilize a tag "nIdPix" do método "ListarPix" da API /api/v1/financas/pix/ para obter essa informação. |
formasPag[].POS | objeto | |
formasPag[].POS.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].POS.cRedePos | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].POS.dTransacao | texto · até 10 | Data da transação. |
formasPag[].POS.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].POS.nParcPos | número inteiro | Número de parcelas. |
formasPag[].POS.nValorAut | número | Valor autorizado. |
formasPag[].TEF | objeto | |
formasPag[].TEF.NSU | texto · até 100 | NSU (Número Sequencial Único) identifica uma operação de venda. Permite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais. Para vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV. Para vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível. |
formasPag[].TEF.NSUHost | texto · até 200 | NSU (Número Sequencial Único) Identifica uma operação de venda no host. |
formasPag[].TEF.TID | texto · até 200 | TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente. Essa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce. |
formasPag[].TEF.cBandeiraTef | texto · até 30 | Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD |
formasPag[].TEF.cRedeTef | texto · até 30 | Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO |
formasPag[].TEF.cTipoCartao | texto · até 1 | Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito. |
formasPag[].TEF.dTransacao | texto · até 10 | Data da transação. |
formasPag[].TEF.hTransacao | texto · até 10 | Hora da transação. |
formasPag[].TEF.nNumeroAut | texto · até 40 | Número da autorização. |
formasPag[].TEF.nParcTef | número inteiro | Número de parcelas. |
formasPag[].TEF.nValorAut | número | Valor autorizado. |
formasPag[].lCanc | sim/não | Status de cancelamento. true - Cancelado. false - Ativo. |
formasPag[].lNaoGerarTitulo | texto · até 5 | Indica que a parcela não deve gerar um título no financeiro. |
formasPag[].pag | objeto | |
formasPag[].pag.pTaxa | número | Percentual da taxa da administradora de cartões. |
formasPag[].pag.vLiqobrigatório | número | Valor líquido do pagamento. |
formasPag[].pag.vPagobrigatório | número | Valor do pagamento. |
formasPag[].pag.vTaxa | número | Valor da taxa da administradora de cartões. |
formasPag[].pag.vTroco | número | Valor do troco. |
formasPag[].pagIdent | objeto | |
formasPag[].pagIdent.cCategoria | texto · até 20 | Código da categoria. Utilize a tag "codigo" do método "ListarCategorias" da API /api/v1/geral/categorias/ para obter essa informação. |
formasPag[].pagIdent.cTipoPagobrigatório | texto · até 5 | Tipo de pagamento. Se não preenchido assumirá o código "99999" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro. Opções disponíveis: "BOL" - Boleto "DIN" - Dinheiro "CRE" - Crediário "CRT" - Cartão "CRC" - Cartão de Crédito "CRD" - Cartão de Débito "CHQ" - Cheque "CHT" - Cheque de Terceiros "PIX" - Pix "99999" - Outros Valor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos: Caixinha => "DIN", "CHQ", "CHT", "99999" e "PIX" Administradora de Cartões => "CRT", "CRC" e "CRD" Carteira Virtual => "CRT", "CRC" e "CRD" Conta Corrente => "DIN", "CRT", "CRC", "CRD", "BOL" e "PIX" Crediário / Carnê => "CRE" e "BOL" |
formasPag[].pagIdent.idContaobrigatório | número inteiro | Código da Conta Corrente. |
formasPag[].parcelas | lista de objetos | |
formasPag[].parcelas[].dVenc | texto · até 10 | Data de vencimento da parcela. Formato: dd/mm/aaaa. |
formasPag[].parcelas[].nParc | texto · até 7 | Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003 |
formasPag[].parcelas[].vParc | número | Valor da parcela. |
formasPag[].seqPagobrigatório | número inteiro | Sequência do pagamento. |
rps | objeto | Informe os detalhes do Cupom/RPS |
rps.cTipoAcao | texto · até 100 | Ação para o faturamento de serviços. Essa tag é deve ser apenas na inclusão de cupons fiscais com itens de serviço quando a tag 'servicos' estiver preenchida. Indica se as ordens de serviço faturadas para o cupom ou rps serão geradas de forma agrupada ou individual. 'AGRUPADO' (Default). 'AGRUPADO-SALAO-PARCEIRO' 'INDIVIDUAL' |
rps.dEmiobrigatório | texto · até 10 | Data da emissão do cupom fiscal. |
rps.hEmiobrigatório | texto · até 10 | Hora da emissão do cupom fiscal. |
rps.numeroobrigatório | número inteiro | Número do cupom. |
rps.serieobrigatório | texto · até 4 | Série do Cupom. |
rps.totalRps | objeto | Total do cupom RPS. |
rps.totalRps.vDesc | número | Valor do desconto. |
rps.totalRps.vItemobrigatório | número | Valor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc |
rps.totalRps.vRPSobrigatório | número | |
servicos | lista de objetos | Informações dos Itens de serviço. |
servicos[].cCnpjVend | texto · até 20 | CNPJ do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP. |
servicos[].cMunFG | texto · até 7 | Código IBGE do município de ocorrência do fato gerador do ISSQN. (Cidade de prestação do serviço). Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].cNomeVend | texto · até 100 | Nome do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP. |
servicos[].nCodServ | número inteiro | ID do serviço. (Gerado internamente, não é visualizado na tela). Pode ser obtido através da API 'api/v1/servicos/servico/#ListarCadastroServico'. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nItem | número inteiro | Sequencia do item de serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nQtde | número | Quantidade de serviços. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nValorCom | número | Valor de comissão do vendedor - salão Parceiro. Essa tag só deve ser informada na modalidade 'salão parceiro'. (Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.' Obs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o valor de comissão do ERP. |
servicos[].nValorDed | número | Valor dedução para redução da Base de Calculo. |
servicos[].nValorTot | número | Valor Total do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].nValorUni | número | Valor Unitário do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce". |
servicos[].vAcresc | número | Valor de acréscimo. |
servicos[].vDesc | número | Valor de desconto. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
idCupom | número inteiro | Identificação do cupom fiscal. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirRps", "param": [{"emissor": {"emiNome": "SEU_PDV", "emiVersao": "1.3.0", "emiSerial": "1.0", "emiId": "02"}, "caixa": {"seqCaixa": 1206, "seqCupom": 2508}, "cupomIdent": {"idCliente": "", "idVendedor": 0, "idProjeto": 0, "cUsuario": ""}, "servicos": [{"nCodServ": 200000027377888, "nItem": 1, "nQtde": 3, "nValorUni": 2, "nValorTot": 6, "cMunFG": "3550308", "vDesc": 0}, {"nCodServ": 200000027377888, "nItem": 2, "nQtde": 1, "nValorUni": 2, "nValorTot": 2, "cMunFG": "3550308", "vDesc": 0}, {"nCodServ": 200000027377888, "nItem": 3, "nQtde": 1, "nValorUni": 2, "nValorTot": 2, "cMunFG": "3550308", "vDesc": 0}], "rps": {"numero": 2508, "serie": "4", "dEmi": "27/03/2025", "hEmi": "16:52:56", "totalRps": {"vItem": 10.0, "vDesc": 0, "vRPS": 10.0}}, "formasPag": [{"seqPag": 1, "lCanc": false, "pag": {"vPag": 10.0, "vLiq": 10.0}, "pagIdent": {"cCategoria": "1.01.03", "idConta": 200000005530780, "cTipoPag": "CRT"}, "parcelas": [{"nParc": "001/001", "dVenc": "08/05/2025", "vParc": 10.0}]}]}]}'import os
import requests
corpo = {'call': 'IncluirRps',
'param': [{'emissor': {'emiNome': 'SEU_PDV',
'emiVersao': '1.3.0',
'emiSerial': '1.0',
'emiId': '02'},
'caixa': {'seqCaixa': 1206, 'seqCupom': 2508},
'cupomIdent': {'idCliente': '',
'idVendedor': 0,
'idProjeto': 0,
'cUsuario': ''},
'servicos': [{'nCodServ': 200000027377888,
'nItem': 1,
'nQtde': 3,
'nValorUni': 2,
'nValorTot': 6,
'cMunFG': '3550308',
'vDesc': 0},
{'nCodServ': 200000027377888,
'nItem': 2,
'nQtde': 1,
'nValorUni': 2,
'nValorTot': 2,
'cMunFG': '3550308',
'vDesc': 0},
{'nCodServ': 200000027377888,
'nItem': 3,
'nQtde': 1,
'nValorUni': 2,
'nValorTot': 2,
'cMunFG': '3550308',
'vDesc': 0}],
'rps': {'numero': 2508,
'serie': '4',
'dEmi': '27/03/2025',
'hEmi': '16:52:56',
'totalRps': {'vItem': 10.0, 'vDesc': 0, 'vRPS': 10.0}},
'formasPag': [{'seqPag': 1,
'lCanc': False,
'pag': {'vPag': 10.0, 'vLiq': 10.0},
'pagIdent': {'cCategoria': '1.01.03',
'idConta': 200000005530780,
'cTipoPag': 'CRT'},
'parcelas': [{'nParc': '001/001',
'dVenc': '08/05/2025',
'vParc': 10.0}]}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirRps",
"param": [
{
"emissor": {
"emiNome": "SEU_PDV",
"emiVersao": "1.3.0",
"emiSerial": "1.0",
"emiId": "02"
},
"caixa": {
"seqCaixa": 1206,
"seqCupom": 2508
},
"cupomIdent": {
"idCliente": "",
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"servicos": [
{
"nCodServ": 200000027377888,
"nItem": 1,
"nQtde": 3,
"nValorUni": 2,
"nValorTot": 6,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 2,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 3,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
}
],
"rps": {
"numero": 2508,
"serie": "4",
"dEmi": "27/03/2025",
"hEmi": "16:52:56",
"totalRps": {
"vItem": 10.0,
"vDesc": 0,
"vRPS": 10.0
}
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 10.0,
"vLiq": 10.0
},
"pagIdent": {
"cCategoria": "1.01.03",
"idConta": 200000005530780,
"cTipoPag": "CRT"
},
"parcelas": [
{
"nParc": "001/001",
"dVenc": "08/05/2025",
"vParc": 10.0
}
]
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirRps",
"param": [
{
"emissor": {
"emiNome": "SEU_PDV",
"emiVersao": "1.3.0",
"emiSerial": "1.0",
"emiId": "02"
},
"caixa": {
"seqCaixa": 1206,
"seqCupom": 2508
},
"cupomIdent": {
"idCliente": "",
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"servicos": [
{
"nCodServ": 200000027377888,
"nItem": 1,
"nQtde": 3,
"nValorUni": 2,
"nValorTot": 6,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 2,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 3,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
}
],
"rps": {
"numero": 2508,
"serie": "4",
"dEmi": "27/03/2025",
"hEmi": "16:52:56",
"totalRps": {
"vItem": 10.0,
"vDesc": 0,
"vRPS": 10.0
}
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 10.0,
"vLiq": 10.0
},
"pagIdent": {
"cCategoria": "1.01.03",
"idConta": 200000005530780,
"cTipoPag": "CRT"
},
"parcelas": [
{
"nParc": "001/001",
"dVenc": "08/05/2025",
"vParc": 10.0
}
]
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "IncluirRps",
"param": [
{
"emissor": {
"emiNome": "SEU_PDV",
"emiVersao": "1.3.0",
"emiSerial": "1.0",
"emiId": "02"
},
"caixa": {
"seqCaixa": 1206,
"seqCupom": 2508
},
"cupomIdent": {
"idCliente": "",
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"servicos": [
{
"nCodServ": 200000027377888,
"nItem": 1,
"nQtde": 3,
"nValorUni": 2,
"nValorTot": 6,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 2,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 3,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
}
],
"rps": {
"numero": 2508,
"serie": "4",
"dEmi": "27/03/2025",
"hEmi": "16:52:56",
"totalRps": {
"vItem": 10.0,
"vDesc": 0,
"vRPS": 10.0
}
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 10.0,
"vLiq": 10.0
},
"pagIdent": {
"cCategoria": "1.01.03",
"idConta": 200000005530780,
"cTipoPag": "CRT"
},
"parcelas": [
{
"nParc": "001/001",
"dVenc": "08/05/2025",
"vParc": 10.0
}
]
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirRps",
"param": [
{
"emissor": {
"emiNome": "SEU_PDV",
"emiVersao": "1.3.0",
"emiSerial": "1.0",
"emiId": "02"
},
"caixa": {
"seqCaixa": 1206,
"seqCupom": 2508
},
"cupomIdent": {
"idCliente": "",
"idVendedor": 0,
"idProjeto": 0,
"cUsuario": ""
},
"servicos": [
{
"nCodServ": 200000027377888,
"nItem": 1,
"nQtde": 3,
"nValorUni": 2,
"nValorTot": 6,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 2,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
},
{
"nCodServ": 200000027377888,
"nItem": 3,
"nQtde": 1,
"nValorUni": 2,
"nValorTot": 2,
"cMunFG": "3550308",
"vDesc": 0
}
],
"rps": {
"numero": 2508,
"serie": "4",
"dEmi": "27/03/2025",
"hEmi": "16:52:56",
"totalRps": {
"vItem": 10.0,
"vDesc": 0,
"vRPS": 10.0
}
},
"formasPag": [
{
"seqPag": 1,
"lCanc": false,
"pag": {
"vPag": 10.0,
"vLiq": 10.0
},
"pagIdent": {
"cCategoria": "1.01.03",
"idConta": 200000005530780,
"cTipoPag": "CRT"
},
"parcelas": [
{
"nParc": "001/001",
"dVenc": "08/05/2025",
"vParc": 10.0
}
]
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirRps"", ""param"": [{""emissor"": {""emiNome"": ""SEU_PDV"", ""emiVersao"": ""1.3.0"", ""emiSerial"": ""1.0"", ""emiId"": ""02""}, ""caixa"": {""seqCaixa"": 1206, ""seqCupom"": 2508}, ""cupomIdent"": {""idCliente"": """", ""idVendedor"": 0, ""idProjeto"": 0, ""cUsuario"": """"}, ""servicos"": [{""nCodServ"": 200000027377888, ""nItem"": 1, ""nQtde"": 3, ""nValorUni"": 2, ""nValorTot"": 6, ""cMunFG"": ""3550308"", ""vDesc"": 0}, {""nCodServ"": 200000027377888, ""nItem"": 2, ""nQtde"": 1, ""nValorUni"": 2, ""nValorTot"": 2, ""cMunFG"": ""3550308"", ""vDesc"": 0}, {""nCodServ"": 200000027377888, ""nItem"": 3, ""nQtde"": 1, ""nValorUni"": 2, ""nValorTot"": 2, ""cMunFG"": ""3550308"", ""vDesc"": 0}], ""rps"": {""numero"": 2508, ""serie"": ""4"", ""dEmi"": ""27/03/2025"", ""hEmi"": ""16:52:56"", ""totalRps"": {""vItem"": 10.0, ""vDesc"": 0, ""vRPS"": 10.0}}, ""formasPag"": [{""seqPag"": 1, ""lCanc"": false, ""pag"": {""vPag"": 10.0, ""vLiq"": 10.0}, ""pagIdent"": {""cCategoria"": ""1.01.03"", ""idConta"": 200000005530780, ""cTipoPag"": ""CRT""}, ""parcelas"": [{""nParc"": ""001/001"", ""dVenc"": ""08/05/2025"", ""vParc"": 10.0}]}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInutiliza um lote de NFC-e.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
emissor | objeto | |
emissor.emiIdobrigatório | texto · até 20 | Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55". |
emissor.emiNomeobrigatório | texto · até 20 | Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte. |
emissor.emiSerial | texto · até 100 | Serial do HD em que o aplicativo emissor do cupom fiscal está instalado. |
emissor.emiVersaoobrigatório | texto · até 20 | Versão do aplicativo emissor do cupom fiscal. |
nfceInut | objeto | |
nfceInut.nfceMd5Inutobrigatório | texto · até 32 | MD5 do arquivo XML enviado em "nfceXmlInut". |
nfceInut.nfceProtInutobrigatório | texto · até 30 | Protocolo de inutilização da NFC-e. |
nfceInut.nfceXmlInutobrigatório | texto | XML da inutização de NFC-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "nfceMd5Inut". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]> |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado. |
cDesStatus | texto | Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado. |
nIdProc | número inteiro | Número de identificação do processamento da solicitação. |
POST /api/v1/produtos/cupomfiscalincluir/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "InutilizarNfce", "param": [{"emissor": {"emiNome": "OmiePDV", "emiVersao": "1.0", "emiSerial": "ASDadsADSasdADS", "emiId": "01"}, "nfceInut": {"nfceProtInut": 0, "nfceXmlInut": "", "nfceMd5Inut": ""}}]}'import os
import requests
corpo = {'call': 'InutilizarNfce',
'param': [{'emissor': {'emiNome': 'OmiePDV',
'emiVersao': '1.0',
'emiSerial': 'ASDadsADSasdADS',
'emiId': '01'},
'nfceInut': {'nfceProtInut': 0, 'nfceXmlInut': '', 'nfceMd5Inut': ''}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "InutilizarNfce",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"nfceInut": {
"nfceProtInut": 0,
"nfceXmlInut": "",
"nfceMd5Inut": ""
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "InutilizarNfce",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"nfceInut": {
"nfceProtInut": 0,
"nfceXmlInut": "",
"nfceMd5Inut": ""
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/")
corpo = <<~'JSON'
{
"call": "InutilizarNfce",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"nfceInut": {
"nfceProtInut": 0,
"nfceXmlInut": "",
"nfceMd5Inut": ""
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "InutilizarNfce",
"param": [
{
"emissor": {
"emiNome": "OmiePDV",
"emiVersao": "1.0",
"emiSerial": "ASDadsADSasdADS",
"emiId": "01"
},
"nfceInut": {
"nfceProtInut": 0,
"nfceXmlInut": "",
"nfceMd5Inut": ""
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""InutilizarNfce"", ""param"": [{""emissor"": {""emiNome"": ""OmiePDV"", ""emiVersao"": ""1.0"", ""emiSerial"": ""ASDadsADSasdADS"", ""emiId"": ""01""}, ""nfceInut"": {""nfceProtInut"": 0, ""nfceXmlInut"": """", ""nfceMd5Inut"": """"}}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados