GET/nfcom/relatorio

NFCom issuance report

Generates a summary report of NFCom issuances for every CNPJ linked to the organization. The query window is limited to 31 days. The last array element always contains pagination data (page, perPage, totalPages, totalItems).

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

Parameters

from query	Start date of the issuance report period (Ex. 2018-11-01T00:00:00). If omitted together with 'to', the API automatically filters the last 31 days.
to query	End date of the issuance report period (Ex. 2018-12-01T23:59:59). If omitted together with 'from', the API automatically filters the last 31 days.
page query	Desired page number (default: 1).
perPage query	Items per page. Default: 100. Maximum: 100 (higher values are replaced automatically).

Request

cURL

curl -X GET 'https://api.otentecnologia.com.br/nfcom/relatorio' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json'

Responses

200OK

JSON

[
  {
    "emitente": {
      "cpfCnpj": "43641688000100",
      "razaoSocial": "Empresa Exemplo LTDA",
      "tipoContrato": 0
    },
    "documentos": [
      {
        "situacao": "CONCLUIDO",
        "quantidade": 42
      },
      {
        "situacao": "CANCELADO",
        "quantidade": 5
      },
      {
        "situacao": "DENEGADO",
        "quantidade": 20
      },
      {
        "situacao": "ENCERRADO",
        "quantidade": 20
      },
      {
        "situacao": "REJEITADO",
        "quantidade": 10
      },
      {
        "situacao": "PROCESSANDO",
        "quantidade": 5
      }
    ]
  },
  {
    "page": 1,
    "perPage": 100,
    "totalPages": 5,
    "totalItems": 500
  }
]

400Bad Request

JSON

{
  "error": {
    "message": "A data final deve ser informada."
  }
}

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"
  }
}