Consulta dados das notas a partir de seu ID ou protocolo.

Observações:

• • Consulta por ID retorna um documento.
  • Consulta por protocolo retorna um array de documentos.

Rota

GET

Produção

https://api.plugnotas.com.br/nfse/{idNotaOrProtocol}

Sandbox

https://api.sandbox.plugnotas.com.br/nfse/{idNotaOrProtocol}

Headers

Path Parameters;

Retorno

Exemplo de retorno:

{
"idIntegracao": "0922898-a",
"enviarEmail": true,
"rps": {
"dataEmissao": "2020-04-14T00:00:00-03:00",
"competencia": "2020-04-14",
"dataVencimento": "2020-04-14T00:00:00-03:00",
"serie": "string",
"numero": 0
},
"cidadePrestacao": {
"codigo": "4115200",
"descricao": "MARINGA",
"tipoLogradouro": "Avenida",
"logradouro": "Duque de Caxias",
"numero": "882",
"complemento": "17 andar",
"tipoBairro": "Zona",
"bairro": "Zona 01",
"estado": "PR",
"cep": "87020025"
},
"idNotaSubstituida": "5e9a0d999c9a999a9999ee9",
"naturezaTributacao": 1,
"prestador": {
"cpfCnpj": "08187168000160",
"codigoEstrangeiro": "A1B2C3D4",
"endereco": {
"bairro": "Zona 01",
"cep": "87020025",
"codigoCidade": "4115200",
"estado": "PR",
"logradouro": "Duque de Caxias",
"numero": "882",
"tipoLogradouro": "Avenida",
"codigoPais": "1058",
"complemento": "17 andar",
"descricaoCidade": "Maringá",
"descricaoPais": "Brasil",
"tipoBairro": "Zona"
},
"email": "empresa@plugnotas.com.br",
"incentivadorCultural": true,
"incentivoFiscal": true,
"inscricaoEstadual": "1234567850",
"inscricaoMunicipal": "8214100099",
"nomeFantasia": "Tecnospeed",
"razaoSocial": "Tecnospeed S/A",
"regimeTributario": 1,
"regimeTributarioEspecial": 5,
"simplesNacional": true,
"telefone": {
"numero": "30379500",
"ddd": "44"
},
"codigoDistrito": 59
},
"tomador": {
"cpfCnpj": "191.0",
"razaoSocial": "Tomador de teste LTDA",
"endereco": {
"bairro": "Zona 01",
"cep": "87020025",
"codigoCidade": "4115200",
"estado": "PR",
"logradouro": "Duque de Caxias",
"numero": "882",
"tipoLogradouro": "Avenida",
"codigoPais": "1058",
"complemento": "17 andar",
"descricaoCidade": "Maringá",
"descricaoPais": "Brasil",
"tipoBairro": "Zona"
},
"email": "tomador@plugnotas.com.br",
"inscricaoEstadual": "1234567850",
"inscricaoMunicipal": "8214100099",
"inscricaoSuframa": "1234567850",
"nomeFantasia": "Tomador de teste",
"orgaoPublico": true,
"telefone": {
"numero": "30379500",
"ddd": "44"
},
"indicadorInscricaoEstadual": 9,
"codigoEstrangeiro": "A1B2C3D4",
"naoNif": "1"
},
"intermediario": {
"cpfCnpj": "string",
"razaoSocial": "string",
"inscricaoMunicipal": "string",
"endereco": {
"bairro": "Zona 01",
"cep": "87020025",
"codigoCidade": "4115200",
"estado": "PR",
"logradouro": "Duque de Caxias",
"numero": "882",
"tipoLogradouro": "Avenida",
"codigoPais": "1058",
"complemento": "17 andar",
"descricaoCidade": "Maringá",
"descricaoPais": "Brasil",
"tipoBairro": "Zona"
}
},
"servico": [
{
"codigo": "1.02",
"idIntegracao": "A001XT",
"discriminacao": "Descrição dos serviços prestados, utilize | para quebra de linha na impressão.",
"codigoTributacao": "4115200",
"cnae": "4751201",
"codigoCidadeIncidencia": "4115200",
"descricaoCidadeIncidencia": "MARINGA",
"unidade": "UN",
"quantidade": 1,
"iss": {
"tipoTributacao": 6,
"exigibilidade": 1,
"retido": false,
"aliquota": 3,
"valor": 0,
"valorRetido": 0,
"processoSuspensao": "70049875465"
},
"obra": {
"art": "6270201",
"codigo": "21",
"cei": "string",
"endereco": {
"bairro": "Zona 01",
"cep": "87020025",
"codigoCidade": "4115200",
"estado": "PR",
"logradouro": "Duque de Caxias",
"numero": "882",
"tipoLogradouro": "Avenida",
"codigoPais": "1058",
"complemento": "17 andar",
"descricaoCidade": "Maringá",
"descricaoPais": "Brasil",
"tipoBairro": "Zona"
}
},
"valor": {
"servico": 0.1,
"baseCalculo": 0.1,
"deducoes": 0,
"descontoCondicionado": 0,
"descontoIncondicionado": 0,
"liquido": 0.1,
"unitario": 0.1
},
"deducao": {
"tipo": 0,
"descricao": "Sem Deduções"
},
"retencao": {
"pis": {
"baseCalculo": 0,
"retido": 0,
"aliquota": 0,
"valor": 0
},
"cofins": {
"baseCalculo": 0,
"retido": 0,
"aliquota": 0,
"valor": 0
},
"csll": {
"aliquota": 0,
"valor": 0
},
"inss": {
"aliquota": 0,
"valor": 0
},
"irrf": {
"aliquota": 0,
"valor": 0
},
"outrasRetencoes": 0,
"cpp": {
"aliquota": 0,
"valor": 0
}
},
"tributavel": true,
"ibpt": {
"simplificado": {
"aliquota": 0
},
"detalhado": {
"aliquota": {
"municipal": 0,
"estadual": 0,
"federal": 0
}
}
},
"responsavelRetencao": "string"
}
],
"cargaTributaria": {
"valor": 0,
"percentual": 0,
"fonte": "string"
},
"impressao": {
"camposCustomizados": {
"inscricaoMunicipalTomador": "123456"
}
},
"descricao": "string",
"camposExtras": {
"copiasEmail": [
"string"
]
},
"informacoesComplementares": "string",
"parcelas": [
{
"tipoPagamento": 1,
"numero": 1,
"dataVencimento": "2020-04-14",
"valor": 10
}
],
"protocol": "d054f4a6-6764-4952-9cb5-476e2d11d340",
"status": "CONCLUIDO",
"webhook": [
{
"date": "2019-08-24",
"protocol": "string"
}
],
"id": "5e9759e5daf0b760eefbea8d",
"numeroNfse": "16352",
"tipoAutorizacao": "WEBSERVICE",
"substituicao": true,
"pdf": {
"filename": "string"
},
"xml": {
"filename": "string"
},
"retorno": {
"situacao": "AUTORIZADA",
"protocoloPrefeitura": "123456789",
"numeroNfse": "123",
"mensagemRetorno": "RPS Autorizada com sucesso",
"dataAutorizacao": "2022-12-21T03:00:00.000Z",
"codigoVerificacao": "123"
}
}