Skip to main content

Consulta de documentos fiscais

ListaListagem umados oudocumentos maisfiscais estadias registradasgerados por meio de filtros de seleção, que limitam o resultado e podem ser zero ou mais entre: período, localizado, documento do clienteserie_codigo e pátio.ultimo_serie_contador.

Os parâmetros inicio_datahora_entradainicio_datahora  e fim_datahora_entradafim_datahora limitam o resultado pelo campo entrada_solicitada_em.registrado_em.

Os parâmetros inicio_datahora_saida e fim_datahora_saida limitam o resultado pelo campo saida_confirmada_em. 

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

O parâmetro documento do clienteultimo_serie_contador limita o resultado pelopara campolistar documentoapenas os contadores acima do cliente que esteja vinculado a estadia.

O parâmetro patio_id limita o resultado pelo campo patio_id.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.

*OBS: Para acessar  esse endpoint, será necessário habilitar a permissão para o usuário no FOKUS.

GET api/estadiasdocumentos_fiscais

* Esse endpoint substituirá o endpoint: https://info.linkc.dev.br/books/fokus/page/consulta-estadias. 

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_entrada

Horário inicial do período de consulta no campo: entrada_solicitada_emregistrado_em

 NÃO

fim_datahora_entrada

Horário final do período de consultanoconsulta no campo: entrada_solicitada_emregistrado_em

 NÃO

inicio_datahora_saidaserie_codigo

HorárioSérie inicialcódigo do períododocumento de consulta no campo: saida_confirmada_emfiscal

 NÃO

fim_datahora_saidaultima_serie_contador

 Última

Horário finalsérie do período de consultano campo: saida_confirmada_em

NÃO

localizador

Localizador da estadia

contador		 NÃO

documento

Documento do clienteNÃO

patio_id

ID do pátio a ser consultadoNÃO

status

Status da estadiaNÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
estadias[documentos_fiscais[]
Lista dasdos estadias.documentos fiscais
estadias[documentos_fiscais[].id
Identificador único dado estadia.documento fiscal
estadias[documentos_fiscais[].localizadorserie_codigo
Código da série do documento fiscal
documentos_fiscais[].serie_contador
LocalizadorContador da estadia.série do documento fiscal
estadias[documentos_fiscais[].entrada_solicitada_emregistrado_em
Data e hora da entradadocumento no estacionamento.fiscal
estadias[documentos_fiscais[].entrada_veiculo_placavalor
PlacaValor do veículodocumento na entradafiscal
estadias[].saida_confirmada_em
Data e hora da saída no estacionamento.
estadias[].parceiro.id
Código do parceiro.
estadias[].parceiro.identificacao
Identificação do parceiro.
estadias[].patio.id
Código do pátio.
estadias[].patio.identificacao
Identificação do pátio.
estadias[documentos_fiscais[].pessoa.id Código da pessoa
estadias[documentos_fiscais[].pessoa.nome Nome da pessoa
estadias[documentos_fiscais[].plano.iddocumento CódigoDocumento doda planopessoa
estadias[documentos_fiscais[].plano.identificacaolote_documento_fiscal.data_em IdentificaçãoData do plano
estadias[].statusStatus da estadia
estadias[].terminal_entrada.id
Código do terminal de entrada.
estadias[].terminal_entrada.identificacao
Identificação do terminal de entrada.
estadias[].via_entrada.id
Código do via de entrada.
estadias[].via_entrada.identificacao
Identificação do via de entrada.
estadias[].terminal_saida.id
Código do terminal de entrada.
estadias[].terminal_saida.identificacao
Identificação do terminal de entrada.
estadias[].via_saida.id
Código do via de entrada.
estadias[].via_saida.identificacao
Identificação do via de entrada.
lote
metadata
Retorno de outras informações sobre a consulta
metadata.page
Página atual.
metadata.per_page
Quantidade de registro 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)

{
    "estadias_faturamentos"documentos_fiscais": [
        {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "localizador"serie_codigo": "1234567890"A",
        "entrada_solicitada_em"serie_contador": "2019-08-30T18:35:25.000000-03:00"0001",
        "entrada_veiculo_placa"valor": "ABC1234"10.0
        "saida_confirmada_em"registrado_em": "2019-08-30T20:49:20.000000-03:00",
        "parceiro": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "PARCEIRO PADRÃO",
        },
        "pessoa": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "FULANO",
          "documento": "012345678901",
        },
        "plano"lote_documento_fiscal": {  
          "id"data_em": "73b4cab7-ea27-426c-b247-bf0f006e0f05"2019-08-30",
          "identificacao": "MENSAL"
        },
        "patio": {          
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "identificacao": "CARRO"
        },
        "status": "saida_confirmada",
        "terminal_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ENTRADA 1"
        },
        "via_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "VIA ENTRADA 1"
        },
        "terminal_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "SAÍDA 1"
        }
        "via_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "VIA SAÍDA 1"
        }
    }, …
    ],
    "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.

Back to top