Através deste endpoint é possível consultar a lista de nsNRecs vinculados a uma NFS-e a partir de seu número na Prefeitura ou número e série do documento.
URL
Produção: POST https://nfseapi.ns.eti.br/v1/nfse/listarnsnrecs
Dados de entrada
| Campo | Descrição | Tipo | Tamanho | Ocorrência | Observação |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | String | 1-1 | Pode ser enviado no Header | |
| CNPJ | CNPJ do emitente da NFS-e | String | 14 | 1-1 | |
| tpAmb | Tipo de ambiente | Inteiro | 1 | 1-1 | 1 - Produção; 2 - Homologação |
| nNF | Número da NFS-e | Inteiro | 1-9 | 0-1 | Obrigatório quando não informado nRPS e serieRPS |
| nRPS | Número do RPS | Inteiro | 1-9 | 0-1 | Obrigatório quando não informado nNF |
| serieRPS | Serie do RPS | Inteiro | 1-3 | 0-1 | Obrigatório quando não informado nNF |
Exemplo de requisição
Requisição de Lista de NSNRecs
curl -X POST
\-H "Content-Type: application/json"
\-H "X-AUTH-TOKEN: SEU_TOKEN"
\-d '{"tpAmb": 2,"CNPJ": "99999999999999", "nNF": 75}'
https://nfseapi.ns.eti.br/v1/nfse/listarnsnrecs
Dados retornados
| Campo | Descrição | Tipo | Ocorrência | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | Inteiro | 1-1 | ||
| motivo | Descrição literal do status de processamento | String | 1-1 | ||
| nsNRecs | Lista de objetos contendo os dados da pessoa solicitada | Array | 0-1 | Conterá items apenas se forem encontrados nsNRecsvinculados a chave da NF-e fornecida | |
| nsNRec | nsNRec vinculado | Inteiro | 1-1 | nsNRecs | |
| cStat | Código do status do nsNRec | Inteiro | 1-1 | nsNRecs | |
| xMotivo | Descrição literal do status do nsNRec | String | 1-1 | nsNRecs | |
| erro | Objeto contendo os dados do erro | Objeto | 0-1 | Apenas quando status != 200 | |
| cStat | Código de status | Inteiro | 1-1 | erro | |
| xMotivo | Descrição literal | String | 1-1 | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"cStat": 100,
"nsNRec": 202,
"xMotivo": "Documento Autorizado com Sucesso"
}
]
}
Códigos de retorno
| Campo | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -6 | Não foi possível realizar a operação |