GET/nfse/consultar/{idNotaOrProtocol}

Retrieve an invoice summary

Returns a short view of an invoice already submitted, by ID or protocol. Notes: - numero is the RPS number sent to City Hall. - numeroNfse is the invoice number assigned by City Hall. Treat it as a string; the format varies by municipality.

Production: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parameters

This route has no path or query parameters.

Request

cURL

curl -X GET 'https://api.otentecnologia.com.br/nfse/consultar/{idNotaOrProtocol}' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json'

Responses

200OK

JSON

[
  {
    "id": "5ecbbaabbdbd4670e36b9999",
    "idIntegracao": "XX999",
    "emissao": "21/12/2020",
    "tipoAutorizacao": "WEBSERVICE",
    "situacao": "CONCLUIDO",
    "prestador": "08187168000160",
    "tomador": "08114280956",
    "valorServico": 425,
    "numeroNfse": "202000000012467",
    "protocoloPrefeitura": "123456",
    "serie": "7",
    "lote": 14176,
    "numero": 12571,
    "codigoVerificacao": "5482010c6",
    "autorizacao": "30/12/2020",
    "mensagem": "RPS Autorizada com sucesso",
    "pdf": "https://api.otentecnologia.com.br/nfse/pdf/5ecbbaabbdbd4670e36b9999",
    "xml": "https://api.otentecnologia.com.br/nfse/xml/5ecbbaabbdbd4670e36b9999"
  }
]

400Bad Request

401Unauthorized

JSON

{
  "error": {
    "message": "O token informado é inválido. Para o ambiente de produção, Acesse https://www.otentecnologia.com.br/, e gere o seu TOKEN de acesso"
  }
}

404Not Found

JSON

{
  "error": {
    "message": "Não localizamos qualquer NFSe com os parâmetros informados",
    "data": {
      "id": "0000000"
    }
  }
}