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

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

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.000-03:00",
        "registrado_em": "2019-08-30T20:49:20.000-03:00",
        "saida_ate": "2019-08-30T21:35:25.000-03:00",
        "valor_pago": "5.0",
        "documento_fiscal": {
          "serie_contador": 1233333,
          "serie_codigo": "A"          
        },
        "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.000-03:00",
            "periodo_fim_em": "2019-08-3021:35:25.000-03:00",
          }
        ]
        "modalidades": [
          {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
            "valor": 100.5
          }
        ]
    }, …
    ]
}


OUTROS RETORNOS

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