Serviços ·
NFSeNota Fiscal de Serviços
1consulta
0alterações
Claude · ChatGPT · MCPpelos assistentes de IA
JSON · XMLformato
Lista de NFS-es.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 24Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cAmbienteNFSe | texto · até 1 | Ambiente da NFS-e. Pode Ser: H-Homologação P-Produção. |
cCodigoCategoria | texto · até 20 | Código da Categoria. |
cCodigoVerifNFSe | texto · até 50 | Código de Verificação da NFS-e. |
cExibirDepartamentos | texto · até 1 | Listar os departamentos da Ordem de Serviço (S/N). |
cExibirDescricao | texto · até 1 | Exibir descrição do Serviço (S/N). |
cNumeroContrato | texto · até 20 | Número do Contrato |
cSerieNFSe | texto · até 10 | Série da NFS-e emitida. |
cStatusNFSe | texto · até 1 | Status da NFS-e. Pode ser: "C"-Cancelada. "F"-Faturada. "N"-Não faturada. |
dEmiFinal | texto · até 10 | Data de emissão final. |
dEmiInicial | texto · até 10 | Data de emissão inicial. |
hEmiFinal | texto · até 8 | Hora de emissão final. |
hEmiInicial | texto · até 8 | Hora de emissão inicial. |
nChaveNFe | texto · até 44 | Chave da NF-e. (para emissões em Brasilia-DF). |
nCodNF | número inteiro | Código da Nota Fiscal gerada. (Gerado Internamente, não é exibido na tela) |
nCodigoCC | número inteiro | Código da Conta Corrente. |
nCodigoCliente | número inteiro | Código do Cliente (destinatário da NFS-e). |
nCodigoContrato | número inteiro | Código do Contrato. |
nCodigoOS | número inteiro | Código da Ordem de Serviço. |
nCodigoProjeto | número inteiro | Código do Projeto. |
nCodigoVendedor | número inteiro | Código do Vendedor. |
nNumeroNFSe | texto · até 20 | Número da NFS-e emitida. |
nNumeroOS | texto · até 15 | Número da Ordem de Serviço. |
nPagina | número inteiro | |
nRegPorPagina | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro | |
nfseEncontradas | lista de objetos | Lista de NF-es encontradas. |
nfseEncontradas[].Adicionais | objeto | Informações adicionais. |
nfseEncontradas[].Adicionais.cCodigoCategoria | texto | Código da Categoria. |
nfseEncontradas[].Adicionais.nCodigoCC | número inteiro | Código da Conta Corrente. |
nfseEncontradas[].Adicionais.nCodigoProjeto | número inteiro | Código do Projeto. |
nfseEncontradas[].Adicionais.nCodigoVendedor | número inteiro | Código do Vendedor. |
nfseEncontradas[].Adicionais.nIdDestinatario | número inteiro | ID Cliente para o Destinatário |
nfseEncontradas[].Alteracao | objeto | Dados da Alteração |
nfseEncontradas[].Alteracao.cDataAlteracao | texto | Data da alteração. |
nfseEncontradas[].Alteracao.cHoraAlteracao | texto | Hora de alteração. |
nfseEncontradas[].Alteracao.cUsuarioAlteracao | texto | Usuário que realizou a alteração. |
nfseEncontradas[].Cabecalho | objeto | Cabeçalho da NFS-e. |
nfseEncontradas[].Cabecalho.cAmbienteNFSe | texto | Ambiente da NFS-e. Pode Ser: H-Homologação P-Produção. |
nfseEncontradas[].Cabecalho.cCNPJDestinatario | texto | CNPJ do Destinatário. |
nfseEncontradas[].Cabecalho.cCNPJEmissor | texto | CNPJ do Emissor. |
nfseEncontradas[].Cabecalho.cCPFDestinatario | texto | CPF do destinatário. |
nfseEncontradas[].Cabecalho.cCidadeEmissor | texto | Cidade do Emissor da NFS-e. |
nfseEncontradas[].Cabecalho.cCodMunDestinatario | texto | Código do Município da cidade do destinatário. |
nfseEncontradas[].Cabecalho.cCodMunEmissor | texto | Código do Município da cidade do emissor. |
nfseEncontradas[].Cabecalho.cCodigoVerifNFSe | texto | Código de Verificação da NFS-e. |
nfseEncontradas[].Cabecalho.cIMDestinatario | texto | Inscrição Municipal do destinatário. |
nfseEncontradas[].Cabecalho.cIMEmissor | texto | Inscrição Municipal do Emissor. |
nfseEncontradas[].Cabecalho.cRazaoDestinatario | texto | Razão Social ou Nome Completo do destinatário da NFS-e. |
nfseEncontradas[].Cabecalho.cRazaoEmissor | texto | Razão Social ou Nome Completo do emissor da NFS-e. |
nfseEncontradas[].Cabecalho.cSerieNFSe | texto | Série da NFS-e emitida. |
nfseEncontradas[].Cabecalho.cStatusNFSe | texto | Status da NFS-e. Pode ser: "C"-Cancelada. "F"-Faturada. "N"-Não faturada. |
nfseEncontradas[].Cabecalho.nChaveNFe | texto | Chave da NF-e. (para emissões em Brasilia-DF). |
nfseEncontradas[].Cabecalho.nCodNF | número inteiro | Código da Nota Fiscal gerada. (Gerado Internamente, não é exibido na tela) |
nfseEncontradas[].Cabecalho.nCodigoCliente | número inteiro | Código do Cliente (destinatário da NFS-e). |
nfseEncontradas[].Cabecalho.nNumeroNFSe | texto | Número da NFS-e emitida. |
nfseEncontradas[].Cabecalho.nValorNFSe | decimal | Valor da NFS-e |
nfseEncontradas[].Cancelamento | objeto | Dados do Cancelamento. |
nfseEncontradas[].Cancelamento.cDataCancelamento | texto | Data da inclusão. |
nfseEncontradas[].Cancelamento.cHoraCancelamento | texto | Hora de inclusão. |
nfseEncontradas[].Cancelamento.cMotivoCancelamento | texto | Motivo do cancelamento da NFS-e. |
nfseEncontradas[].Cancelamento.cUsuarioCancelamento | texto | Usuário que realizou a inclusão. |
nfseEncontradas[].Emissao | objeto | Dados da emissão |
nfseEncontradas[].Emissao.cDataEmissao | texto | Data da emissão. |
nfseEncontradas[].Emissao.cHoraEmissao | texto | Hora de emissão. |
nfseEncontradas[].Emissao.cUsuarioEmissao | texto | Usuário que realizou a emissão. |
nfseEncontradas[].IBPT | objeto | Dados do IBPT. |
nfseEncontradas[].IBPT.CodigoNBS | texto | Código NBS. |
nfseEncontradas[].IBPT.cChaveIBPT | texto | Chave do IBPT. |
nfseEncontradas[].IBPT.cFonteIBPT | texto | Fonte do IBPT. |
nfseEncontradas[].IBPT.nAliqEstadualIBPT | decimal | Alíquota do IBPT - Estadual. |
nfseEncontradas[].IBPT.nAliqFederalIBPT | decimal | Alíquota do IBPT - Federal. |
nfseEncontradas[].IBPT.nAliqMunicipalIBPT | decimal | Alíquota do IBPT - Municipal. |
nfseEncontradas[].IBPT.nValorEstadualIBPT | decimal | Valor do IBPT - Estadual. |
nfseEncontradas[].IBPT.nValorFederalIBPT | decimal | Valor do IBPT - Federal. |
nfseEncontradas[].IBPT.nValorMunicipalIBPT | decimal | Valor do IBPT - Municipal. |
nfseEncontradas[].Inclusao | objeto | Dados da Inclusão |
nfseEncontradas[].Inclusao.cDataInclusao | texto | Data da inclusão. |
nfseEncontradas[].Inclusao.cHoraInclusao | texto | Hora de inclusão. |
nfseEncontradas[].Inclusao.cUsuarioInclusao | texto | Usuário que realizou a inclusão. |
nfseEncontradas[].ListaServicos | lista de objetos | Listas de itens da Nota Fiscal. |
nfseEncontradas[].ListaServicos[].CidadePrestacao | texto | Cidade da Prestação de Serviços. |
nfseEncontradas[].ListaServicos[].CodigoLC116 | texto | Código da LC116. |
nfseEncontradas[].ListaServicos[].CodigoServico | texto | Código do Serviço no município. |
nfseEncontradas[].ListaServicos[].cCST | texto | Código da Situação Tributária do IBS e CBS |
nfseEncontradas[].ListaServicos[].cClassTrib | texto | Código de Classificação Tributária do IBS e CBS |
nfseEncontradas[].ListaServicos[].cCodigoART | texto | Código ART. |
nfseEncontradas[].ListaServicos[].cCodigoEncapsulamento | texto | Código do encapsulamento. |
nfseEncontradas[].ListaServicos[].cCodigoObra | texto | Código da Obra. |
nfseEncontradas[].ListaServicos[].cDescricao | texto | Descrição do serviço. |
nfseEncontradas[].ListaServicos[].cRetCOFINS | texto | |
nfseEncontradas[].ListaServicos[].cRetCSLL | texto | |
nfseEncontradas[].ListaServicos[].cRetINSS | texto | |
nfseEncontradas[].ListaServicos[].cRetIR | texto | |
nfseEncontradas[].ListaServicos[].cRetISS | texto | |
nfseEncontradas[].ListaServicos[].cRetPIS | texto | |
nfseEncontradas[].ListaServicos[].nAliqCBS | decimal | Alíquota da CBS. |
nfseEncontradas[].ListaServicos[].nAliqIbsMun | decimal | Alíquota do IBS de competência do Município. |
nfseEncontradas[].ListaServicos[].nAliqIbsUf | decimal | Alíquota do IBS de competência das UF |
nfseEncontradas[].ListaServicos[].nAliquotaCOFINS | decimal | |
nfseEncontradas[].ListaServicos[].nAliquotaCSLL | decimal | |
nfseEncontradas[].ListaServicos[].nAliquotaINSS | decimal | |
nfseEncontradas[].ListaServicos[].nAliquotaIR | decimal | |
nfseEncontradas[].ListaServicos[].nAliquotaISS | decimal | |
nfseEncontradas[].ListaServicos[].nAliquotaPIS | decimal | |
nfseEncontradas[].ListaServicos[].nBaseIbsCbs | decimal | Valor da Base de Calculo do IBS e CBS |
nfseEncontradas[].ListaServicos[].nDescontoValor | decimal | |
nfseEncontradas[].ListaServicos[].nPercReducaoCbs | decimal | Percentual redução CBS. |
nfseEncontradas[].ListaServicos[].nPercReducaoIbsMun | decimal | Percentual redução IBS municipal |
nfseEncontradas[].ListaServicos[].nPercReducaoIbsUf | decimal | Percentual redução IBS estadual |
nfseEncontradas[].ListaServicos[].nQuantidade | decimal | |
nfseEncontradas[].ListaServicos[].nValorCOFINS | decimal | |
nfseEncontradas[].ListaServicos[].nValorCSLL | decimal | |
nfseEncontradas[].ListaServicos[].nValorCbs | decimal | Valor da CBS. |
nfseEncontradas[].ListaServicos[].nValorINSS | decimal | |
nfseEncontradas[].ListaServicos[].nValorIR | decimal | |
nfseEncontradas[].ListaServicos[].nValorISS | decimal | |
nfseEncontradas[].ListaServicos[].nValorIbsMun | decimal | Valor do IBS de competência do Município |
nfseEncontradas[].ListaServicos[].nValorIbsUf | decimal | Valor do IBS de competência da UF |
nfseEncontradas[].ListaServicos[].nValorOutrasDespesas | decimal | |
nfseEncontradas[].ListaServicos[].nValorPIS | decimal | |
nfseEncontradas[].ListaServicos[].nValorServico | decimal | |
nfseEncontradas[].ListaServicos[].nValorTotal | decimal | |
nfseEncontradas[].ListaServicos[].nValorUnitario | decimal | |
nfseEncontradas[].OrdemServico | objeto | Dados da Ordem de Serviço. |
nfseEncontradas[].OrdemServico.Categorias | lista de objetos | Distribuição por Categorias. |
nfseEncontradas[].OrdemServico.Categorias[].cCodigoCategoria | texto | Código do Categoria. |
nfseEncontradas[].OrdemServico.Categorias[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
nfseEncontradas[].OrdemServico.Categorias[].nValorDistribuicao | decimal | Valor da distribuição. |
nfseEncontradas[].OrdemServico.Categorias[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
nfseEncontradas[].OrdemServico.Departamentos | lista de objetos | Distribuição por Departamentos. |
nfseEncontradas[].OrdemServico.Departamentos[].cCodigoDepartamento | texto | Código do Departamento. |
nfseEncontradas[].OrdemServico.Departamentos[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
nfseEncontradas[].OrdemServico.Departamentos[].nValorDistribuicao | decimal | Valor da distribuição. |
nfseEncontradas[].OrdemServico.Departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
nfseEncontradas[].OrdemServico.cNumeroContrato | texto | Número do Contrato |
nfseEncontradas[].OrdemServico.cPedidoCliente | texto | Número do Pedido do Cliente. |
nfseEncontradas[].OrdemServico.nCodigoContrato | número inteiro | Código do Contrato. |
nfseEncontradas[].OrdemServico.nCodigoOS | número inteiro | Código da Ordem de Serviço. |
nfseEncontradas[].OrdemServico.nNumeroOS | texto | Número da Ordem de Serviço. |
nfseEncontradas[].OrdemServico.nValorOS | decimal | Valor da Ordem de Serviço. |
nfseEncontradas[].RPS | objeto | Dados da RPS |
nfseEncontradas[].RPS.cDataRPS | texto | Data da RPS. |
nfseEncontradas[].RPS.cProtocoloRPS | texto | Número do Protocolo do RPS. |
nfseEncontradas[].RPS.cSerieRPS | texto | Série da RPS. |
nfseEncontradas[].RPS.cStatusRPS | texto | Status da RPS. |
nfseEncontradas[].RPS.nNumeroLote | número inteiro | Número do Lote da RPS. |
nfseEncontradas[].RPS.nNumeroRPS | texto | Número da RPS. |
nfseEncontradas[].RPS.nStatusLote | texto | Status do Lote da RPS. |
nfseEncontradas[].Servicos | objeto | Dados dos Serviços. Utilizar "ListaServicos" para ter acesso a todos os itens da NFS-e. DEPRECATED |
nfseEncontradas[].Servicos.CidadePrestacao | texto | Cidade da Prestação de Serviços. |
nfseEncontradas[].Servicos.CodigoLC116 | texto | Código da LC116. |
nfseEncontradas[].Servicos.CodigoServico | texto | Código do Serviço no município. |
nfseEncontradas[].Servicos.cCST | texto | Código da Situação Tributária do IBS e CBS |
nfseEncontradas[].Servicos.cClassTrib | texto | Código de Classificação Tributária do IBS e CBS |
nfseEncontradas[].Servicos.cCodigoART | texto | Código ART. |
nfseEncontradas[].Servicos.cCodigoEncapsulamento | texto | Código do encapsulamento. |
nfseEncontradas[].Servicos.cCodigoObra | texto | Código da Obra. |
nfseEncontradas[].Servicos.cDescricao | texto | Descrição do serviço. |
nfseEncontradas[].Servicos.cRetCOFINS | texto | |
nfseEncontradas[].Servicos.cRetCSLL | texto | |
nfseEncontradas[].Servicos.cRetINSS | texto | |
nfseEncontradas[].Servicos.cRetIR | texto | |
nfseEncontradas[].Servicos.cRetISS | texto | |
nfseEncontradas[].Servicos.cRetPIS | texto | |
nfseEncontradas[].Servicos.nAliqCBS | decimal | Alíquota da CBS. |
nfseEncontradas[].Servicos.nAliqIbsMun | decimal | Alíquota do IBS de competência do Município. |
nfseEncontradas[].Servicos.nAliqIbsUf | decimal | Alíquota do IBS de competência das UF |
nfseEncontradas[].Servicos.nAliquotaCOFINS | decimal | |
nfseEncontradas[].Servicos.nAliquotaCSLL | decimal | |
nfseEncontradas[].Servicos.nAliquotaINSS | decimal | |
nfseEncontradas[].Servicos.nAliquotaIR | decimal | |
nfseEncontradas[].Servicos.nAliquotaISS | decimal | |
nfseEncontradas[].Servicos.nAliquotaPIS | decimal | |
nfseEncontradas[].Servicos.nBaseIbsCbs | decimal | Valor da Base de Calculo do IBS e CBS |
nfseEncontradas[].Servicos.nDescontoValor | decimal | |
nfseEncontradas[].Servicos.nPercReducaoCbs | decimal | Percentual redução CBS. |
nfseEncontradas[].Servicos.nPercReducaoIbsMun | decimal | Percentual redução IBS municipal |
nfseEncontradas[].Servicos.nPercReducaoIbsUf | decimal | Percentual redução IBS estadual |
nfseEncontradas[].Servicos.nQuantidade | decimal | |
nfseEncontradas[].Servicos.nValorCOFINS | decimal | |
nfseEncontradas[].Servicos.nValorCSLL | decimal | |
nfseEncontradas[].Servicos.nValorCbs | decimal | Valor da CBS. |
nfseEncontradas[].Servicos.nValorINSS | decimal | |
nfseEncontradas[].Servicos.nValorIR | decimal | |
nfseEncontradas[].Servicos.nValorISS | decimal | |
nfseEncontradas[].Servicos.nValorIbsMun | decimal | Valor do IBS de competência do Município |
nfseEncontradas[].Servicos.nValorIbsUf | decimal | Valor do IBS de competência da UF |
nfseEncontradas[].Servicos.nValorOutrasDespesas | decimal | |
nfseEncontradas[].Servicos.nValorPIS | decimal | |
nfseEncontradas[].Servicos.nValorServico | decimal | |
nfseEncontradas[].Servicos.nValorTotal | decimal | |
nfseEncontradas[].Servicos.nValorUnitario | decimal | |
nfseEncontradas[].Valores | objeto | Valores da NFS-e |
nfseEncontradas[].Valores.cIssRetido | texto | Indica que o valor do ISS será retido pelo tomador do serviço |
nfseEncontradas[].Valores.nAliquotaISS | decimal | Alíquota do ISS |
nfseEncontradas[].Valores.nBaseIbsCbs | decimal | Valor total da base de cálculo do IBS e da CBS |
nfseEncontradas[].Valores.nValorBaseCalculo | decimal | Valor da Base de Cálculo. |
nfseEncontradas[].Valores.nValorCOFINS | decimal | Valor do COFINS. |
nfseEncontradas[].Valores.nValorCSLL | decimal | Valor do CSLL. |
nfseEncontradas[].Valores.nValorCbs | decimal | Valor da CBS. |
nfseEncontradas[].Valores.nValorDeducao | decimal | Valor da Dedução. |
nfseEncontradas[].Valores.nValorINSS | decimal | Valor do INSS. |
nfseEncontradas[].Valores.nValorIR | decimal | Valor do IR. |
nfseEncontradas[].Valores.nValorISS | decimal | Valor do ISS |
nfseEncontradas[].Valores.nValorIbsMun | decimal | Valor total do IBS do município |
nfseEncontradas[].Valores.nValorIbsUf | decimal | Valor do IBS da UF |
nfseEncontradas[].Valores.nValorLiquido | decimal | Valor líquido da Nota Fiscal. |
nfseEncontradas[].Valores.nValorPIS | decimal | Valor do PIS |
nfseEncontradas[].Valores.nValorTotalServicos | decimal | Valor Total dos serviços. |
POST /api/v1/servicos/nfse/
curl -s https://app.omie.com.br/api/v1/servicos/nfse/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarNFSEs", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'import os
import requests
corpo = {'call': 'ListarNFSEs', 'param': [{'nPagina': 1, 'nRegPorPagina': 20}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/nfse/",
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/servicos/nfse/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarNFSEs",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/nfse/");
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": "ListarNFSEs",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/nfse/")
corpo = <<~'JSON'
{
"call": "ListarNFSEs",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
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": "ListarNFSEs",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/nfse/"))
.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/servicos/nfse/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarNFSEs"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados