OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · CupomFiscalIncluir

Adicionar cupons fiscais

POSThttps://app.omie.com.br/api/v1/produtos/cupomfiscalincluir/WSDL
0consultas
6alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

FecharCaixa

altera dadosClaudeMCP

Efetua o fechamento de um determinado caixa.

Obrigatórios 1

CampoTipoDescrição
seqCaixanúmero inteiroNú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
CampoTipoDescrição
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
fechamentoobjetoDados do fechamento do caixa.
fechamento.dAberturaobrigatóriotexto · até 10Data de abertura do caixa.
fechamento.dFechamentoobrigatóriotexto · até 10Data de fechamento do caixa.
fechamento.hAberturaobrigatóriotexto · até 8Hora de abertura do caixa.
fechamento.hFechamentoobrigatóriotexto · até 8Hora de fechamento do caixa.
fechamento.vAberturanúmeroValor de abertura do caixa (Caixa Inicial).
fechamento.vFechamentonúmeroValor do fechamento do caixa (Caixa Final).
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
listaProcessadoslista de objetosLista de cupons processados.
listaProcessados[].dEmitextoData da emissão do cupom fiscal.
listaProcessados[].idCupomnúmero inteiroIdentificação do cupom fiscal.
listaProcessados[].idLotenúmero inteiroIdentificação do lote do cupom fiscal.
listaProcessados[].vCFdecimalValor do Cupom Fiscal.
nIdProcnúmero inteiroNú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}]}'

IncluirCfeSat

altera dadosClaudeMCP

Incluir Cupom Fiscal para SAT.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 9Campos e estruturas que você pode enviar
CampoTipoDescrição
caixaobjetoCaixa
caixa.lCxAbertosim/nãoIndica 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órionúmero inteiroNú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órionúmero inteiroNúmero sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda.
categoriaslista de objetosDistribuição por Categorias.
categorias[].idCategoriatexto · até 20Código da Categoria. (Gerado internamente, não é visualizado na tela)
categorias[].pCategorianúmeroPercentual da categoria
categorias[].vCategorianúmeroValor da categoria
cfeSatobjeto
cfeSat.chCFeobrigatóriotexto · até 44Chave de Acesso do CF-e-SAT.
cfeSat.dEmiobrigatóriotexto · até 10Data da emissão do cupom fiscal.
cfeSat.detlista de objetosItens do cupom fiscal.
cfeSat.det[].impostoobjetoDados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT.
cfeSat.det[].imposto.ICMSobjeto
cfeSat.det[].imposto.ICMS.CSTtexto · até 2Código da Situação Tributária.
cfeSat.det[].imposto.ICMS.pICMSnúmeroAlíquota do ICMS.
cfeSat.det[].imposto.ICMS.vBCnúmeroValor da Base de Cálculo.
cfeSat.det[].imposto.ICMS.vICMSnúmeroValor do ICMS.
cfeSat.det[].imposto.vTotTribnúmeroValor aproximado dos tributos (IBPT).
cfeSat.det[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
cfeSat.det[].lNaoMovEstoquetexto · até 5Indica que o item do Cupom Fiscal não deve movimentar o estoque.
cfeSat.det[].lote_validadeobjetoInformaçõ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.nIdLotenúmero inteiroId 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órionúmeroInforme 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[].prodobjeto
cfeSat.det[].prod.CFOPtexto · até 10CFOP.
cfeSat.det[].prod.NCMtexto · até 13NCM.
cfeSat.det[].prod.cEANtexto · até 14EAN do produto.
cfeSat.det[].prod.cProdtexto · até 60Código do produto conforme destacado no Cupom Fiscal.
cfeSat.det[].prod.cUntexto · até 6Unidade de medida.
cfeSat.det[].prod.nQuantnúmeroQuantidade.
cfeSat.det[].prod.vAcrescnúmeroValor do acréscimo.
cfeSat.det[].prod.vDescnúmeroValor do desconto.
cfeSat.det[].prod.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
cfeSat.det[].prod.vProdnúmeroValor do produto. vProd = nQuant x vUnit
cfeSat.det[].prod.vUnitnúmeroValor unitário.
cfeSat.det[].prod.xProdtexto · até 120Descrição do produto conforme destacado no Cupom Fiscal.
cfeSat.det[].prodIdentobjeto
cfeSat.det[].prodIdent.emiProdutotexto · até 60Código do produto no emissor de cupom fiscal.
cfeSat.det[].prodIdent.idLocalEstoquenúmero inteiroCodigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão.
cfeSat.det[].prodIdent.idProdutonúmero inteiroCódigo do produto.
cfeSat.det[].seqItemobrigatórionúmero inteiroNúmero sequencial do item.
cfeSat.hEmiobrigatóriotexto · até 10Hora da emissão do cupom fiscal.
cfeSat.lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
cfeSat.nCFeobrigatóriotexto · até 20Número do cupom fiscal ou Número do Extrato do SAT.
cfeSat.outrasInfobjetoOutras informações do cupom fiscal.
cfeSat.outrasInf.nMesatexto · até 10Número / identificação da mesa.
cfeSat.outrasInf.nPessoasnúmero inteiroNúmero/quantidade de pessoas atendidas.
cfeSat.totalobjetoTotais do cupom fiscal.
cfeSat.total.vAcrescnúmeroValor do acréscimo.
cfeSat.total.vCFobrigatórionúmeroValor do Cupom Fiscal.
cfeSat.total.vDescnúmeroValor do desconto.
cfeSat.total.vICMSnúmeroValor do ICMS.
cfeSat.total.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
cfeSat.total.vTaxanúmeroValor da taxa.
cfeSat.total.vTotTribnúmeroValor aproximado dos tributos (IBPT).
cfeSat.tpAmbobrigatóriotexto · até 1Ambiente. Pode ser: H-Homologação. P-Produção.
cupomIdentobjeto
cupomIdent.cNumeroContratotexto · até 30Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cPedidoClientetexto · até 30Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cUsuariotexto · até 10Có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.idClientenúmero inteiroCó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.idProjetonúmero inteiroCódigo do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal.
cupomIdent.idVendedornúmero inteiroCódigo do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal.
departamentoslista de objetosDistribuição por Departamentos.
departamentos[].idDepartamentotexto · até 40Código do departamento. (Gerado internamente, não é visualizado na tela)
departamentos[].pDepartamentoobrigatórionúmeroPercentual do departamento. Preenchimento obrigatório
departamentos[].vDepartamentoobrigatórionúmeroValor do departamento. Preenchimento obrigatório
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
formasPaglista de objetos
formasPag[].ChequeobjetoInformações do Cheque.
formasPag[].Cheque.chAgenciatexto · até 4Número da Agência.
formasPag[].Cheque.chBancotexto · até 5Número do Banco.
formasPag[].Cheque.chContatexto · até 15Número da Conta.
formasPag[].Cheque.chNumerotexto · até 15Número do Cheque.
formasPag[].Cheque.chSerietexto · até 10Série do Cheque.
formasPag[].Cheque.chVencimentotexto · até 10Data de vencimento do cheque.
formasPag[].PIXobjeto
formasPag[].PIX.cCodIntPixobrigatóriotexto · até 60Có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órionúmero inteiroID 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[].POSobjeto
formasPag[].POS.NSUtexto · até 100NSU (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.cRedePostexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].POS.dTransacaotexto · até 10Data da transação.
formasPag[].POS.hTransacaotexto · até 10Hora da transação.
formasPag[].POS.nParcPosnúmero inteiroNúmero de parcelas.
formasPag[].POS.nValorAutnúmeroValor autorizado.
formasPag[].TEFobjeto
formasPag[].TEF.NSUtexto · até 100NSU (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.NSUHosttexto · até 200NSU (Número Sequencial Único) Identifica uma operação de venda no host.
formasPag[].TEF.TIDtexto · até 200TID (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.cBandeiraTeftexto · até 30Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD
formasPag[].TEF.cRedeTeftexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].TEF.cTipoCartaotexto · até 1Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito.
formasPag[].TEF.dTransacaotexto · até 10Data da transação.
formasPag[].TEF.hTransacaotexto · até 10Hora da transação.
formasPag[].TEF.nNumeroAuttexto · até 40Número da autorização.
formasPag[].TEF.nParcTefnúmero inteiroNúmero de parcelas.
formasPag[].TEF.nValorAutnúmeroValor autorizado.
formasPag[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
formasPag[].lNaoGerarTitulotexto · até 5Indica que a parcela não deve gerar um título no financeiro.
formasPag[].pagobjeto
formasPag[].pag.pTaxanúmeroPercentual da taxa da administradora de cartões.
formasPag[].pag.vLiqobrigatórionúmeroValor líquido do pagamento.
formasPag[].pag.vPagobrigatórionúmeroValor do pagamento.
formasPag[].pag.vTaxanúmeroValor da taxa da administradora de cartões.
formasPag[].pag.vTroconúmeroValor do troco.
formasPag[].pagIdentobjeto
formasPag[].pagIdent.cCategoriatexto · até 20Có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óriotexto · até 5Tipo 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órionúmero inteiroCódigo da Conta Corrente.
formasPag[].parcelaslista de objetos
formasPag[].parcelas[].dVenctexto · até 10Data de vencimento da parcela. Formato: dd/mm/aaaa.
formasPag[].parcelas[].nParctexto · até 7Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003
formasPag[].parcelas[].vParcnúmeroValor da parcela.
formasPag[].seqPagobrigatórionúmero inteiroSequência do pagamento.
satobjeto
sat.satMd5obrigatóriotexto · até 32MD5 do arquivo XML enviado em "satXML".
sat.satModeloobrigatóriotexto · até 20Modelo do SAT. Exemplo: "DIMEP"
sat.satProtobrigatóriotexto · até 20Protocolo de envio do Cupom Fiscal.
sat.satSerieobrigatóriotexto · até 20Número de série do SAT. Exemplos: "0001882143"
sat.satSessaoobrigatórionúmero inteiroSessão do SAT.
sat.satXmlobrigatóriotextoXML do Cupom Fiscal enviado. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#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: &lt;![CDATA[Conteúdo do campo convertido]]&gt;
satCancobjetoDados do Cancelamento do SAT.
satCanc.satMd5Cantexto · até 32MD5 do arquivo XML enviado em "satXmlCan".
satCanc.satProtCantexto · até 20Protocolo de envio do cancelamento do Cupom Fiscal.
satCanc.satXmlCantextoXML 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 "satMd5Can". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: &lt;![CDATA[Conteúdo do campo convertido]]&gt;
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
idCupomnúmero inteiroIdentificação do cupom fiscal.
idLotenúmero inteiroIdentificaçã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"}}]}'

IncluirCupom

altera dadosClaudeMCP

Incluir Cupom Fiscal (ECF).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 8Campos e estruturas que você pode enviar
CampoTipoDescrição
caixaobjetoCaixa
caixa.lCxAbertosim/nãoIndica 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órionúmero inteiroNú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órionúmero inteiroNúmero sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda.
categoriaslista de objetosDistribuição por Categorias.
categorias[].idCategoriatexto · até 20Código da Categoria. (Gerado internamente, não é visualizado na tela)
categorias[].pCategorianúmeroPercentual da categoria
categorias[].vCategorianúmeroValor da categoria
cupomobjeto
cupom.dEmiobrigatóriotexto · até 10Data da emissão do cupom fiscal.
cupom.detlista de objetosItens do cupom fiscal.
cupom.det[].impostoobjetoDados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT.
cupom.det[].imposto.ICMSobjeto
cupom.det[].imposto.ICMS.CSTtexto · até 2Código da Situação Tributária.
cupom.det[].imposto.ICMS.pICMSnúmeroAlíquota do ICMS.
cupom.det[].imposto.ICMS.vBCnúmeroValor da Base de Cálculo.
cupom.det[].imposto.ICMS.vICMSnúmeroValor do ICMS.
cupom.det[].imposto.vTotTribnúmeroValor aproximado dos tributos (IBPT).
cupom.det[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
cupom.det[].lNaoMovEstoquetexto · até 5Indica que o item do Cupom Fiscal não deve movimentar o estoque.
cupom.det[].lote_validadeobjetoInformaçõ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.nIdLotenúmero inteiroId 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órionúmeroInforme 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[].prodobjeto
cupom.det[].prod.CFOPtexto · até 10CFOP.
cupom.det[].prod.NCMtexto · até 13NCM.
cupom.det[].prod.cEANtexto · até 14EAN do produto.
cupom.det[].prod.cProdtexto · até 60Código do produto conforme destacado no Cupom Fiscal.
cupom.det[].prod.cUntexto · até 6Unidade de medida.
cupom.det[].prod.nQuantnúmeroQuantidade.
cupom.det[].prod.vAcrescnúmeroValor do acréscimo.
cupom.det[].prod.vDescnúmeroValor do desconto.
cupom.det[].prod.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
cupom.det[].prod.vProdnúmeroValor do produto. vProd = nQuant x vUnit
cupom.det[].prod.vUnitnúmeroValor unitário.
cupom.det[].prod.xProdtexto · até 120Descrição do produto conforme destacado no Cupom Fiscal.
cupom.det[].prodIdentobjeto
cupom.det[].prodIdent.emiProdutotexto · até 60Código do produto no emissor de cupom fiscal.
cupom.det[].prodIdent.idLocalEstoquenúmero inteiroCodigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão.
cupom.det[].prodIdent.idProdutonúmero inteiroCódigo do produto.
cupom.det[].seqItemobrigatórionúmero inteiroNúmero sequencial do item.
cupom.hEmiobrigatóriotexto · até 10Hora da emissão do cupom fiscal.
cupom.lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
cupom.nCCFobrigatórionúmero inteiroNúmero do Contador de Cupom Fiscal (CCF).
cupom.nCOOobrigatórionúmero inteiroNúmero do cupom fiscal ou número do Contador de Ordem de Operação (COO).
cupom.outrasInfobjetoOutras informações do cupom fiscal.
cupom.outrasInf.nMesatexto · até 10Número / identificação da mesa.
cupom.outrasInf.nPessoasnúmero inteiroNúmero/quantidade de pessoas atendidas.
cupom.totalobjetoTotais do cupom fiscal.
cupom.total.vAcrescnúmeroValor do acréscimo.
cupom.total.vCFobrigatórionúmeroValor do Cupom Fiscal.
cupom.total.vDescnúmeroValor do desconto.
cupom.total.vICMSnúmeroValor do ICMS.
cupom.total.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
cupom.total.vTaxanúmeroValor da taxa.
cupom.total.vTotTribnúmeroValor aproximado dos tributos (IBPT).
cupom.tpAmbobrigatóriotexto · até 1Ambiente. Pode ser: H-Homologação. P-Produção.
cupomIdentobjeto
cupomIdent.cNumeroContratotexto · até 30Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cPedidoClientetexto · até 30Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cUsuariotexto · até 10Có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.idClientenúmero inteiroCó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.idProjetonúmero inteiroCódigo do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal.
cupomIdent.idVendedornúmero inteiroCódigo do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal.
departamentoslista de objetosDistribuição por Departamentos.
departamentos[].idDepartamentotexto · até 40Código do departamento. (Gerado internamente, não é visualizado na tela)
departamentos[].pDepartamentoobrigatórionúmeroPercentual do departamento. Preenchimento obrigatório
departamentos[].vDepartamentoobrigatórionúmeroValor do departamento. Preenchimento obrigatório
ecfobjeto
ecf.ecfModeloobrigatóriotexto · até 20Modelo da Impressora Fiscal. Exemplo: "MP-2100 TH FI"
ecf.ecfSerieobrigatóriotexto · até 20Número de série da impressora fiscal. Exemplos: "BE051475610000207422" "EP121710000000018789" "SW040900000000009860" "DR0815BR000000462568"
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
formasPaglista de objetos
formasPag[].ChequeobjetoInformações do Cheque.
formasPag[].Cheque.chAgenciatexto · até 4Número da Agência.
formasPag[].Cheque.chBancotexto · até 5Número do Banco.
formasPag[].Cheque.chContatexto · até 15Número da Conta.
formasPag[].Cheque.chNumerotexto · até 15Número do Cheque.
formasPag[].Cheque.chSerietexto · até 10Série do Cheque.
formasPag[].Cheque.chVencimentotexto · até 10Data de vencimento do cheque.
formasPag[].PIXobjeto
formasPag[].PIX.cCodIntPixobrigatóriotexto · até 60Có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órionúmero inteiroID 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[].POSobjeto
formasPag[].POS.NSUtexto · até 100NSU (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.cRedePostexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].POS.dTransacaotexto · até 10Data da transação.
formasPag[].POS.hTransacaotexto · até 10Hora da transação.
formasPag[].POS.nParcPosnúmero inteiroNúmero de parcelas.
formasPag[].POS.nValorAutnúmeroValor autorizado.
formasPag[].TEFobjeto
formasPag[].TEF.NSUtexto · até 100NSU (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.NSUHosttexto · até 200NSU (Número Sequencial Único) Identifica uma operação de venda no host.
formasPag[].TEF.TIDtexto · até 200TID (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.cBandeiraTeftexto · até 30Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD
formasPag[].TEF.cRedeTeftexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].TEF.cTipoCartaotexto · até 1Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito.
formasPag[].TEF.dTransacaotexto · até 10Data da transação.
formasPag[].TEF.hTransacaotexto · até 10Hora da transação.
formasPag[].TEF.nNumeroAuttexto · até 40Número da autorização.
formasPag[].TEF.nParcTefnúmero inteiroNúmero de parcelas.
formasPag[].TEF.nValorAutnúmeroValor autorizado.
formasPag[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
formasPag[].lNaoGerarTitulotexto · até 5Indica que a parcela não deve gerar um título no financeiro.
formasPag[].pagobjeto
formasPag[].pag.pTaxanúmeroPercentual da taxa da administradora de cartões.
formasPag[].pag.vLiqobrigatórionúmeroValor líquido do pagamento.
formasPag[].pag.vPagobrigatórionúmeroValor do pagamento.
formasPag[].pag.vTaxanúmeroValor da taxa da administradora de cartões.
formasPag[].pag.vTroconúmeroValor do troco.
formasPag[].pagIdentobjeto
formasPag[].pagIdent.cCategoriatexto · até 20Có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óriotexto · até 5Tipo 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órionúmero inteiroCódigo da Conta Corrente.
formasPag[].parcelaslista de objetos
formasPag[].parcelas[].dVenctexto · até 10Data de vencimento da parcela. Formato: dd/mm/aaaa.
formasPag[].parcelas[].nParctexto · até 7Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003
formasPag[].parcelas[].vParcnúmeroValor da parcela.
formasPag[].seqPagobrigatórionúmero inteiroSequência do pagamento.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
idCupomnúmero inteiroIdentificação do cupom fiscal.
idLotenúmero inteiroIdentificaçã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"}}]}]}'

IncluirNfce

altera dadosClaudeMCP

Incluir Nota Fiscal Consumidor Eletrônico.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 10Campos e estruturas que você pode enviar
CampoTipoDescrição
NFeobjeto
NFe.cTipoAcaotexto · até 100Açã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óriotexto · até 44Chave de Acesso da Nota Fiscal Consumidor Eletrônico.
NFe.dEmiobrigatóriotexto · até 10Data da emissão do cupom fiscal.
NFe.detlista de objetosItens do cupom fiscal.
NFe.det[].impostoobjetoDados dos impostos. Obrigatórios apenas para Cupom Fiscal SAT.
NFe.det[].imposto.ICMSobjeto
NFe.det[].imposto.ICMS.CSTtexto · até 2Código da Situação Tributária.
NFe.det[].imposto.ICMS.pICMSnúmeroAlíquota do ICMS.
NFe.det[].imposto.ICMS.vBCnúmeroValor da Base de Cálculo.
NFe.det[].imposto.ICMS.vICMSnúmeroValor do ICMS.
NFe.det[].imposto.vTotTribnúmeroValor aproximado dos tributos (IBPT).
NFe.det[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
NFe.det[].lNaoMovEstoquetexto · até 5Indica que o item do Cupom Fiscal não deve movimentar o estoque.
NFe.det[].lote_validadeobjetoInformaçõ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.nIdLotenúmero inteiroId 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órionúmeroInforme 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[].prodobjeto
NFe.det[].prod.CFOPtexto · até 10CFOP.
NFe.det[].prod.NCMtexto · até 13NCM.
NFe.det[].prod.cEANtexto · até 14EAN do produto.
NFe.det[].prod.cProdtexto · até 60Código do produto conforme destacado no Cupom Fiscal.
NFe.det[].prod.cUntexto · até 6Unidade de medida.
NFe.det[].prod.nQuantnúmeroQuantidade.
NFe.det[].prod.vAcrescnúmeroValor do acréscimo.
NFe.det[].prod.vDescnúmeroValor do desconto.
NFe.det[].prod.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
NFe.det[].prod.vProdnúmeroValor do produto. vProd = nQuant x vUnit
NFe.det[].prod.vUnitnúmeroValor unitário.
NFe.det[].prod.xProdtexto · até 120Descrição do produto conforme destacado no Cupom Fiscal.
NFe.det[].prodIdentobjeto
NFe.det[].prodIdent.emiProdutotexto · até 60Código do produto no emissor de cupom fiscal.
NFe.det[].prodIdent.idLocalEstoquenúmero inteiroCodigo do Local do Estoque. Caso não informado assumirá o Local de Estoque padrão.
NFe.det[].prodIdent.idProdutonúmero inteiroCódigo do produto.
NFe.det[].seqItemobrigatórionúmero inteiroNúmero sequencial do item.
NFe.hEmiobrigatóriotexto · até 10Hora da emissão do cupom fiscal.
NFe.lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
NFe.nNFobrigatóriotexto · até 20Número da Nota Fiscal Consumidor Eletrônico.
NFe.outrasInfobjetoOutras informações do cupom fiscal.
NFe.outrasInf.nMesatexto · até 10Número / identificação da mesa.
NFe.outrasInf.nPessoasnúmero inteiroNúmero/quantidade de pessoas atendidas.
NFe.serietexto · até 4Série da Nota Fiscal Consumidor Eletrônico.
NFe.totalobjetoTotais do cupom fiscal.
NFe.total.vAcrescnúmeroValor do acréscimo.
NFe.total.vCFobrigatórionúmeroValor do Cupom Fiscal.
NFe.total.vDescnúmeroValor do desconto.
NFe.total.vICMSnúmeroValor do ICMS.
NFe.total.vItemnúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
NFe.total.vTaxanúmeroValor da taxa.
NFe.total.vTotTribnúmeroValor aproximado dos tributos (IBPT).
NFe.tpAmbobrigatóriotexto · até 1Ambiente. Pode ser: H-Homologação. P-Produção.
NFe.tpEmisobrigatóriotexto · até 1Tipo de emissão da Nota Fiscal Consumidor Eletrônico. Pode ser: 1 - Emissão normal. 9 - Emissão em contingência.
caixaobjetoCaixa
caixa.lCxAbertosim/nãoIndica 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órionúmero inteiroNú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órionúmero inteiroNúmero sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda.
categoriaslista de objetosDistribuição por Categorias.
categorias[].idCategoriatexto · até 20Código da Categoria. (Gerado internamente, não é visualizado na tela)
categorias[].pCategorianúmeroPercentual da categoria
categorias[].vCategorianúmeroValor da categoria
cupomIdentobjeto
cupomIdent.cNumeroContratotexto · até 30Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cPedidoClientetexto · até 30Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cUsuariotexto · até 10Có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.idClientenúmero inteiroCó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.idProjetonúmero inteiroCódigo do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal.
cupomIdent.idVendedornúmero inteiroCódigo do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal.
departamentoslista de objetosDistribuição por Departamentos.
departamentos[].idDepartamentotexto · até 40Código do departamento. (Gerado internamente, não é visualizado na tela)
departamentos[].pDepartamentoobrigatórionúmeroPercentual do departamento. Preenchimento obrigatório
departamentos[].vDepartamentoobrigatórionúmeroValor do departamento. Preenchimento obrigatório
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
formasPaglista de objetos
formasPag[].ChequeobjetoInformações do Cheque.
formasPag[].Cheque.chAgenciatexto · até 4Número da Agência.
formasPag[].Cheque.chBancotexto · até 5Número do Banco.
formasPag[].Cheque.chContatexto · até 15Número da Conta.
formasPag[].Cheque.chNumerotexto · até 15Número do Cheque.
formasPag[].Cheque.chSerietexto · até 10Série do Cheque.
formasPag[].Cheque.chVencimentotexto · até 10Data de vencimento do cheque.
formasPag[].PIXobjeto
formasPag[].PIX.cCodIntPixobrigatóriotexto · até 60Có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órionúmero inteiroID 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[].POSobjeto
formasPag[].POS.NSUtexto · até 100NSU (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.cRedePostexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].POS.dTransacaotexto · até 10Data da transação.
formasPag[].POS.hTransacaotexto · até 10Hora da transação.
formasPag[].POS.nParcPosnúmero inteiroNúmero de parcelas.
formasPag[].POS.nValorAutnúmeroValor autorizado.
formasPag[].TEFobjeto
formasPag[].TEF.NSUtexto · até 100NSU (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.NSUHosttexto · até 200NSU (Número Sequencial Único) Identifica uma operação de venda no host.
formasPag[].TEF.TIDtexto · até 200TID (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.cBandeiraTeftexto · até 30Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD
formasPag[].TEF.cRedeTeftexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].TEF.cTipoCartaotexto · até 1Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito.
formasPag[].TEF.dTransacaotexto · até 10Data da transação.
formasPag[].TEF.hTransacaotexto · até 10Hora da transação.
formasPag[].TEF.nNumeroAuttexto · até 40Número da autorização.
formasPag[].TEF.nParcTefnúmero inteiroNúmero de parcelas.
formasPag[].TEF.nValorAutnúmeroValor autorizado.
formasPag[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
formasPag[].lNaoGerarTitulotexto · até 5Indica que a parcela não deve gerar um título no financeiro.
formasPag[].pagobjeto
formasPag[].pag.pTaxanúmeroPercentual da taxa da administradora de cartões.
formasPag[].pag.vLiqobrigatórionúmeroValor líquido do pagamento.
formasPag[].pag.vPagobrigatórionúmeroValor do pagamento.
formasPag[].pag.vTaxanúmeroValor da taxa da administradora de cartões.
formasPag[].pag.vTroconúmeroValor do troco.
formasPag[].pagIdentobjeto
formasPag[].pagIdent.cCategoriatexto · até 20Có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óriotexto · até 5Tipo 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órionúmero inteiroCódigo da Conta Corrente.
formasPag[].parcelaslista de objetos
formasPag[].parcelas[].dVenctexto · até 10Data de vencimento da parcela. Formato: dd/mm/aaaa.
formasPag[].parcelas[].nParctexto · até 7Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003
formasPag[].parcelas[].vParcnúmeroValor da parcela.
formasPag[].seqPagobrigatórionúmero inteiroSequência do pagamento.
nfceobjeto
nfce.nfceMd5obrigatóriotexto · até 32MD5 do arquivo XML enviado em "nfceXml".
nfce.nfceProtobrigatóriotexto · até 30Protocolo de envio da NFC-e.
nfce.nfceXmlobrigatóriotextoXML da NFC-e enviada. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#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: &lt;![CDATA[Conteúdo do campo convertido]]&gt;
nfceCancobjetoDados do cancelamento da NFC-e.
nfceCanc.nfceMd5Cantexto · até 32MD5 do arquivo XML enviado em "nfceXmlCan".
nfceCanc.nfceProtCantexto · até 30Protocolo de cancelamento da NFC-e.
nfceCanc.nfceXmlCanobrigatóriotextoXML da NFC-e cancelada. Preechimento obrigatório para indicar o cancelamento da NFC-e. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#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: &lt;![CDATA[Conteúdo do campo convertido]]&gt;
servicoslista de objetosInformações dos Itens de serviço.
servicos[].cCnpjVendtexto · até 20CNPJ 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[].cMunFGtexto · até 7Có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[].cNomeVendtexto · até 100Nome 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[].nCodServnúmero inteiroID 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[].nItemnúmero inteiroSequencia do item de serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nQtdenúmeroQuantidade de serviços. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nValorComnúmeroValor 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[].nValorDednúmeroValor dedução para redução da Base de Calculo.
servicos[].nValorTotnúmeroValor Total do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nValorUninúmeroValor Unitário do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].vAcrescnúmeroValor de acréscimo.
servicos[].vDescnúmeroValor de desconto.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
idCupomnúmero inteiroIdentificação do cupom fiscal.
idLotenúmero inteiroIdentificaçã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"}}]}'

IncluirRps

altera dadosClaudeMCP

Incluir Cupom RPS.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 8Campos e estruturas que você pode enviar
CampoTipoDescrição
caixaobjetoCaixa
caixa.lCxAbertosim/nãoIndica 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órionúmero inteiroNú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órionúmero inteiroNúmero sequencial do cupom fiscal enviado. Não é o número do cupom fiscal, mas sim o número sequencial de venda.
categoriaslista de objetosDistribuição por Categorias.
categorias[].idCategoriatexto · até 20Código da Categoria. (Gerado internamente, não é visualizado na tela)
categorias[].pCategorianúmeroPercentual da categoria
categorias[].vCategorianúmeroValor da categoria
cupomIdentobjeto
cupomIdent.cNumeroContratotexto · até 30Número do contrato do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cPedidoClientetexto · até 30Número do pedido do cliente. Utilizado somente na Inclusão do Cupom Fiscal.
cupomIdent.cUsuariotexto · até 10Có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.idClientenúmero inteiroCó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.idProjetonúmero inteiroCódigo do projeto. Quando não informado, será criado um projeto padrão para o emissor de cupom fiscal.
cupomIdent.idVendedornúmero inteiroCódigo do vendedor. Quando não informado, será criado um vendedor padrão para o emissor de cupom fiscal.
departamentoslista de objetosDistribuição por Departamentos.
departamentos[].idDepartamentotexto · até 40Código do departamento. (Gerado internamente, não é visualizado na tela)
departamentos[].pDepartamentoobrigatórionúmeroPercentual do departamento. Preenchimento obrigatório
departamentos[].vDepartamentoobrigatórionúmeroValor do departamento. Preenchimento obrigatório
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
formasPaglista de objetos
formasPag[].ChequeobjetoInformações do Cheque.
formasPag[].Cheque.chAgenciatexto · até 4Número da Agência.
formasPag[].Cheque.chBancotexto · até 5Número do Banco.
formasPag[].Cheque.chContatexto · até 15Número da Conta.
formasPag[].Cheque.chNumerotexto · até 15Número do Cheque.
formasPag[].Cheque.chSerietexto · até 10Série do Cheque.
formasPag[].Cheque.chVencimentotexto · até 10Data de vencimento do cheque.
formasPag[].PIXobjeto
formasPag[].PIX.cCodIntPixobrigatóriotexto · até 60Có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órionúmero inteiroID 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[].POSobjeto
formasPag[].POS.NSUtexto · até 100NSU (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.cRedePostexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].POS.dTransacaotexto · até 10Data da transação.
formasPag[].POS.hTransacaotexto · até 10Hora da transação.
formasPag[].POS.nParcPosnúmero inteiroNúmero de parcelas.
formasPag[].POS.nValorAutnúmeroValor autorizado.
formasPag[].TEFobjeto
formasPag[].TEF.NSUtexto · até 100NSU (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.NSUHosttexto · até 200NSU (Número Sequencial Único) Identifica uma operação de venda no host.
formasPag[].TEF.TIDtexto · até 200TID (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.cBandeiraTeftexto · até 30Descrição da bandeira do cartão. Exemplos: VISA CREDITO VISA ELECTRO ELO DEBITO ELO CREDITO ALIMENTACAO MAESTRO MASTERCARD POLICARD
formasPag[].TEF.cRedeTeftexto · até 30Descrição da rede de pagamento ou adquirente. Exemplos: REDECARD STONE VISANET BCARD CIELO
formasPag[].TEF.cTipoCartaotexto · até 1Tipo de cartão (Débito ou Crédito) Pode ser: "D" - para Débito. "C" - para Crédito.
formasPag[].TEF.dTransacaotexto · até 10Data da transação.
formasPag[].TEF.hTransacaotexto · até 10Hora da transação.
formasPag[].TEF.nNumeroAuttexto · até 40Número da autorização.
formasPag[].TEF.nParcTefnúmero inteiroNúmero de parcelas.
formasPag[].TEF.nValorAutnúmeroValor autorizado.
formasPag[].lCancsim/nãoStatus de cancelamento. true - Cancelado. false - Ativo.
formasPag[].lNaoGerarTitulotexto · até 5Indica que a parcela não deve gerar um título no financeiro.
formasPag[].pagobjeto
formasPag[].pag.pTaxanúmeroPercentual da taxa da administradora de cartões.
formasPag[].pag.vLiqobrigatórionúmeroValor líquido do pagamento.
formasPag[].pag.vPagobrigatórionúmeroValor do pagamento.
formasPag[].pag.vTaxanúmeroValor da taxa da administradora de cartões.
formasPag[].pag.vTroconúmeroValor do troco.
formasPag[].pagIdentobjeto
formasPag[].pagIdent.cCategoriatexto · até 20Có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óriotexto · até 5Tipo 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órionúmero inteiroCódigo da Conta Corrente.
formasPag[].parcelaslista de objetos
formasPag[].parcelas[].dVenctexto · até 10Data de vencimento da parcela. Formato: dd/mm/aaaa.
formasPag[].parcelas[].nParctexto · até 7Número da parcela. Formato: 999/999. Exemplos: 001/001 001/003 002/003 003/003
formasPag[].parcelas[].vParcnúmeroValor da parcela.
formasPag[].seqPagobrigatórionúmero inteiroSequência do pagamento.
rpsobjetoInforme os detalhes do Cupom/RPS
rps.cTipoAcaotexto · até 100Açã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óriotexto · até 10Data da emissão do cupom fiscal.
rps.hEmiobrigatóriotexto · até 10Hora da emissão do cupom fiscal.
rps.numeroobrigatórionúmero inteiroNúmero do cupom.
rps.serieobrigatóriotexto · até 4Série do Cupom.
rps.totalRpsobjetoTotal do cupom RPS.
rps.totalRps.vDescnúmeroValor do desconto.
rps.totalRps.vItemobrigatórionúmeroValor total do item. É o valor líquido dos produtos vendidos no cupom. vItem = vProd - vDesc + vAcresc
rps.totalRps.vRPSobrigatórionúmero
servicoslista de objetosInformações dos Itens de serviço.
servicos[].cCnpjVendtexto · até 20CNPJ 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[].cMunFGtexto · até 7Có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[].cNomeVendtexto · até 100Nome 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[].nCodServnúmero inteiroID 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[].nItemnúmero inteiroSequencia do item de serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nQtdenúmeroQuantidade de serviços. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nValorComnúmeroValor 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[].nValorDednúmeroValor dedução para redução da Base de Calculo.
servicos[].nValorTotnúmeroValor Total do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].nValorUninúmeroValor Unitário do serviço. Obrigatório em "IncluirRps"; opcional nas demais operações que reutilizam esta estrutura, como "IncluirNfce".
servicos[].vAcrescnúmeroValor de acréscimo.
servicos[].vDescnúmeroValor de desconto.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
idCupomnúmero inteiroIdentificaçã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}]}]}]}'

InutilizarNfce

altera dadosClaudeMCP

Inutiliza um lote de NFC-e.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
emissorobjeto
emissor.emiIdobrigatóriotexto · até 20Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV. Exemplos: "01", "20", "55".
emissor.emiNomeobrigatóriotexto · até 20Nome do aplicativo emissor do cupom fiscal. O aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte.
emissor.emiSerialtexto · até 100Serial do HD em que o aplicativo emissor do cupom fiscal está instalado.
emissor.emiVersaoobrigatóriotexto · até 20Versão do aplicativo emissor do cupom fiscal.
nfceInutobjeto
nfceInut.nfceMd5Inutobrigatóriotexto · até 32MD5 do arquivo XML enviado em "nfceXmlInut".
nfceInut.nfceProtInutobrigatóriotexto · até 30Protocolo de inutilização da NFC-e.
nfceInut.nfceXmlInutobrigatóriotextoXML da inutização de NFC-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#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: &lt;![CDATA[Conteúdo do campo convertido]]&gt;
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCó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.
cDesStatustextoDescrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado.
nIdProcnúmero inteiroNú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": ""}}]}'