Consulta de documentos fiscais

Listagem dos documentos fiscais gerados por meio de filtros de seleção, que limitam o resultado e podem ser zero ou mais entre: período, serie_codigo e ultimo_serie_contador.

Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelo campo registrado_em.

O parâmetro serie_codigo limita o resultado pelo campo serie_codigo.

O parâmetro ultimo_serie_contador limita o resultado para listar apenas os contadores acima do ultimo_serie_contador

Caso esses parâmetros não sejam informados, a resposta será gerada sem a aplicação de filtros.

Para evitar sobrecarga nas respostas, o sistema realiza automaticamente a paginação dos dados. Caso os parâmetros page e per_page não sejam informados, serão utilizados, respectivamente, os valores padrão 1 e 20.

GET api/documentos_fiscais

HEADERS

CHAVE	VALOR	DESCRIÇÃO	OBRIGATÓRIO
Accept	application/vnd.linkc.com.br; version=1	Versão da API.	SIM
Authorization	Bearer <TOKEN>	Token obtido na autenticação	SIM
Content-Type	application/json	Tipo de conteúdo do request	SIM

PARÂMETROS QUERY STRING

CHAVE	DESCRIÇÃO	OBRIGATÓRIO
page	Número da página da listagem	NÃO
per_page	Quantidade de registros por página	NÃO
inicio_datahora	Data e hora inicial do período de consulta, aplicada sobre o campo registrado_em	NÃO
fim_datahora	Data e hora final do período de consulta, aplicada sobre o campo registrado_em	NÃO
serie_codigo	Código da série do documento fiscal	NÃO
ultima_serie_contador	Última série do contador	NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE	DESCRIÇÃO
documentos_fiscais[]	Lista dos documentos fiscais
documentos_fiscais[].id	Identificador único do documento fiscal
documentos_fiscais[].serie_codigo	Código da série do documento fiscal
documentos_fiscais[].serie_contador	Contador da série do documento fiscal
documentos_fiscais[].registrado_em	Data e hora da emissão do documento fiscal
documentos_fiscais[].valor	Valor do documento fiscal
documentos_fiscais[].pessoa.id	Código da pessoa
documentos_fiscais[].pessoa.nome	Nome da pessoa
documentos_fiscais[].documento	Documento da pessoa
documentos_fiscais[].lote_documento_fiscal.data_em	Data do lote
documentos_fiscais[].modalidades	Lista das modalidades utilizadas no faturamento
documentos_fiscais[].modalidades[].id	Código da modalidade de pagamento
documentos_fiscais[].modalidades[].identificacao	Identificação da modalidade de pagamento
documentos_fiscais[].modalidades[].valor	Valor pago através da modalidade de pagamento
documentos_fiscais[].estadia	Presente quando o documento fiscal está vinculado a estadia
documentos_fiscais[].estadia.localizador	Localizador da estadia
documentos_fiscais[].estadia.placa	Placa do veículo da estadia
documentos_fiscais[].estadia.entrada_datahora	Data e hora de registro de entrada da estadia no estacionamento.
documentos_fiscais[].estadia.pessoa.id	Código da pessoa da estadia
documentos_fiscais[].estadia.pessoa.nome	Nome da pessoa da estadia
documentos_fiscais[].estadia.plano.id	Código do plano da estadia
documentos_fiscais[].estadia.plano.identificacao	Identificação do plano da estadia
documentos_fiscais[].plano_contrato	Presente quando o documento fiscal está vinculado a contrato de plano
documentos_fiscais[].plano_contrato.pessoa.id	Código da pessoa do contrato de plano
documentos_fiscais[].plano_contrato.pessoa.nome	Nome da pessoa do contrato de plano
documentos_fiscais[].plano_contrato.plano.id	Código do plano do contrato de plano
documentos_fiscais[].plano_contrato.plano.identificacao	Identificação do plano do contrato de plano
documentos_fiscais[].receita	Presente quando o documento fiscal está vinculado a receita
documentos_fiscais[].receita.descricao	Descrição da receita
metadata	Informações adicionais sobre a consulta
metadata.page	Página atual.
metadata.per_page	Quantidade de registros por página.
metatada.total_page	Total de páginas.
metatada.total_items	Total de registros.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "documentos_fiscais": [
        {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "serie_codigo": "A",
        "serie_contador": "0001",
        "valor": 10.0
        "registrado_em": "2019-08-30T20:49:20.000000-03:00",
        "pessoa": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "FULANO",
          "documento": "012345678901",
        },
        "lote_documento_fiscal": {  
          "data_em": "2019-08-30",
        },
          "estadia": {
            "localizador": "1234567890",
            "palca": "AAA1234",
            "parceiro": {
              "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
              "identificacao": "CIELO"
            ,
            "pessoa": {
              "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
              "nome": "FULANO",
            },
            "plano": {          
              "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
              "identificacao": "MENSAL"
            }
        },
        "plano_contrato": {
          "pessoa": {
            id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
            "nome": "MARIA VITÓRIA OLIVEIRA",
            "documento": "64454846626"
          },
          "plano": {
            "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
            "identificao": "PLANO MENSAL"
          }
       },
        "receita": {
          "descricao": "teste"
    }, …
    ],
    "metadata": {
      "page": 1,
      "per_page": 20,
      "total_page": 10,
      "total_items": 197
    }
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
401	Caso as credenciais sejam inválidas.