GET/nfse/relatorio

Service invoice issuance report

Generates a summary report of NFS-e 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. 2023-03-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. 2023-03-10T23: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).
grupoEmpresaId query	Company-group ID used to filter the report by group companies.

Request

cURL

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

Responses

200OK

JSON

[
  {
    "prestador": {
      "cpfCnpj": "08187168000160"
    },
    "documentos": [
      {
        "situacao": "REJEITADO",
        "quantidade": 17
      },
      {
        "situacao": "CONCLUIDO",
        "quantidade": 36
      }
    ]
  },
  {
    "page": 1,
    "perPage": 100,
    "totalPages": 5,
    "totalItems": 500
  }
]

400Bad Request

JSON

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