Skip to main content

Consulta faturamento de estadia por ID

Consulta um faturamento de estadia realizado.

GET api/estadias_faturamentos/<id>

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
id

Identificador único do faturamento de estadia.

SIM

RETORNO EM CASO DE SUCESSO (200 – OK)

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

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

{
    "estadia_faturamento": {
        "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
400

Caso não seja recebido o parâmetro <id>.

401

Caso as credenciais sejam inválidas.

404

Caso o id da transação não seja encontrado.