GET/nfse/relatorio

Relatório de emissão para nota de serviço

Gera um relatório sintético de emissões de NFS-e, com todos os CNPJs vinculados a organização. <span style="color:red">com período de consulta limitado a 31 dias</span>. O último elemento do array sempre contém as informações de paginação (`page`, `perPage`, `totalPages`, `totalItems`).

Produção: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parâmetros

from query	Data inicial do período para geração do relatório de emissões (Ex. 2023-03-01T00:00:00). Se não informado junto com 'to', o sistema filtra automaticamente os últimos 31 dias.
to query	Data final do período para geração do relatório de emissões (Ex. 2023-03-10T23:59:59). Se não informado junto com 'from', o sistema filtra automaticamente os últimos 31 dias.
page query	Número da página desejada (Padrão: 1).
perPage query	Quantidade de itens por página. Padrão: 100. Máximo: 100 (valores acima são substituídos automaticamente).
grupoEmpresaId query	ID do grupo de empresa para filtrar o relatório pelas empresas do grupo.

Requisição

cURL

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

Respostas

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