Through this endpoints it’s possible to consult a list of NSNRecs linked to an NF3-e using its access key.
URL
Production: POST https://nf3e.ns.eti.br/v1/util/list/nsnrecs
Input Data
The input data of this method must be sent in the request body in JSON format or as QueryString in the method URL.
| Field | Description | Data Type | Occurrence | Notes |
|---|---|---|---|---|
| X-AUTH-TOKEN | User access token | String | 1-1 | |
| chNF3e | NF3-e access key | Int | 1-1 | |
| tpAmb | NF3-e authorization environment type: 1 - Production, 2 - Homologation | Int | 0-1 | Standard value: 1 |
Request Example
NSNRecs list request
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "YOUR_TOKEN", "chNF3e": "11111111111111111111111111111111111111111111", "tpAmb": 2}'\
https://nf3e.ns.eti.br/v1/util/list/nsnrecs
Returned Data
| Field | Description | Data Type | Occurrence | Parent | Notes |
|---|---|---|---|---|---|
| status | Processing status code | Int | 1-1 | ||
| motivo | Literal description of the processing status | String | 1-1 | ||
| nsNRecs | Object containing the processing data | Array | 1-1 | Will only contain items if founded nsNRecs linked to the give NF3-e key | |
| nsNRecs | Linked nsNRec | Int | 1-1 | nsNRecs | |
| cStat | nsNRec status | Int | 1-1 | nsNRecs | |
| xMotivo | Literal description of the nsNRec status | String | 1-1 | nsNRecs |
Response Examples
Successful response
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"cStat": 437,
"nsNRec": 4,
"xMotivo": "Rejeição: A soma das tarifas aplicadas não pode ser maior que o valor unitário do item [nItem:1]"
},
{
"cStat": 437,
"nsNRec": 5,
"xMotivo": "Rejeição: A soma das tarifas aplicadas não pode ser maior que o valor unitário do item [nItem:1]"
},
{
"cStat": 437,
"nsNRec": 6,
"xMotivo": "Rejeição: A soma das tarifas aplicadas não pode ser maior que o valor unitário do item [nItem:1]"
},
{
"cStat": 100,
"nsNRec": 7,
"xMotivo": "Autorizado o uso da NF3e "
}
]
}
Return Codes
| Code | Description |
|---|---|
| 200 | Consult successfully done |
| -2 | Invalid access key |
| -6 | Error loading information |