Skip to main content

Consulta faturamentos de estadias com filtros

Lista um ou mais faturamentos de estadias registrados através de filtros de seleção, que limitam o resultado e podem ser zero ou mais dentre período, ticket e tag. Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelo campo registro_datahora. O parâmetro localizador limita o resultado pelo campo localizador. O parâmetro tag limita o resultado pelo campo tag. Caso eles não sejam informados, a resposta é gerada sem a aplicação dos filtros. Para não sobrecarregar as respostas geradas, o sistema faz automaticamente paginação dos dados. Caso os parâmetros page e per_page não sejam informados, os valores 1 e 20 são associados, respectivamente, aos parâmetros.

GET api/estadias_faturamentos

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 dos pagamentos.

 NÃO

per_page

Quantidade de registros por página.

 NÃO

inicio_datahora

Horário inicial do período de consulta.

 NÃO

fim_datahora

Horário final do período de consulta.

 NÃO

localizador

Localizador da estadia.

 NÃO

tag

 Nome e sobrenome do portador, separado por espaço simples. NÃO

terminal_id

 Id do terminal a ser consultado NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO

estadias_faturamentos

Lista de faturamentos de estadias contento, cada entrada, os mesmos campos retornados pelo serviço /estadias_faturamentos/<id>.


CHAVE
 DESCRIÇÃO
id
Identificador único da transação de pagamento.
localizador
Localizador da estadia.
entrada_solicitada_em
Data e hora da entrada no estacionamento.
registrado_em
Data e hora da transação na garagem.
saida_ate
Data e hora para saída da garagem.
valor_pago
Valor pago pela estadia.
documento_fiscal.serie_contador
Número do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
documento_fiscal.serie_codigo
Código do documento fiscal gerado na garagem. Caso a garagem não emita documento fiscal, este parâmetro não é retornado.
documento_fiscal.registrado_em
Data e hora do registro do documento fiscal.
tag_externa
Identificador do integrador.
modalidades
Lista das modalidades utilizadas no faturamento.
modalidades[].id
Código da modalidade de pagamento.
modalidades[].identificacao
Identificação da modalidade de pagamento.
modalidades[].valor
Valor pago através da modalidade de pagamento.
parceiros
Lista dos parceiros utilizados no faturamento.
parceiros[].id
Código do parceiro.
parceiros[].identificacao
Identificação do parceiro.
parceiros[].valor_cliente
Valor pago pelo cliente.
parceiros[].valor_parceiro
Valor a ser cobrando do parceiro.
parceiros[].periodo_inicio_em
Início do período.
parceiros[].periodo_fim_em
Fim do período.
terminal.id
Código do terminal.
terminal.identificacao
Identificação do terminal.
tef.autorizacao
Número de autorização do TEF.
tef.transacao
 Identificacao de transação do TEF.
tef.data_hora
 Data e hora da transação do TEF.

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

{
    "estadias_faturamentos": [
        {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "localizador": "1234567890",
        "entrada_solicitada_em": "2019-08-30T18:35:25.000000-03:00",
        "registrado_em": "2019-08-30T20:49:20.000000-03:00",
        "saida_ate": "2019-08-30T21:35:25.000000-03:00",
        "valor_pago": 5.0,
        "documento_fiscal": {
          "serie_contador": 1233333,
          "serie_codigo": "A",
          "registrado_em": "2019-08-30T18:35:25.000000-03:00"          
        },
        "tag_externa": "ABCDEF0123456789",
        "parceiros": [
          {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
            "valor_cliente": 100.5,
            "valor_parceiro": 10.5,
            "periodo_inicio_em": "2019-08-30T18:35:25.000000-03:00",
            "periodo_fim_em": "2019-08-3021:35:25.000000-03:00",
          }
        ],
        "modalidades": [
          {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
            "valor": 100.5
          }
        ],
        "terminal": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ATM"
        },
        "tef": {
          "autorizacao": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "transacao": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "data_hora": "2019-08-30T18:35:25.000000-03:00"
        }
    }, …
    ]
}

OUTROS RETORNOS

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

Back to top