Extrai dados de pagamentos

Extrai do banco de dados da garagem, os dados de pagamentos dos veículos, a partir de uma determinada data ou número de documento. Para não sobrecarregar o servidor da garagem, cada requisição de extração contém, no máximo, 1.000 registros. A partir da segunda requisição, o parâmetro 'inicio_datahora' deve conter o horário de pagamento do registro mais recente, que foi retornado na requisição anterior. Isso garante que todos registros são retornados em requisições subsequentes. 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/extratores/pagamentos

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
inicio_datahora	Horário inicial do período de consulta.	NÃO
page	Número da página da listagem.	NÃO
per_page	Quantidade de registros por página.	NÃO
forma_pagamento_id	Código da forma de pagamento.	NÃO
convenio_id	Código do convênio	NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE	DESCRIÇÃO
documento	Número do documento único, gerado automaticamente pela automação.
tipo	Classificação do tipo do cliente. "AUT" para autorizado, "MEN" para mensalista, "HOR" para horista, "EXT" para tickets extraviados e "PER" para clientes controlados por períodos.
patio_codigo	Código do pátio em que o cliente estacionou.
datahora	Horário local de pagamento do veículo na garagem.
terminal	Terminal por onde o pagamento foi efetuado.
cpf_cnpj	CPF ou CNPJ declarado pelo cliente no momento da emissão do RPS. Contém o valor null nos casos em que o cliente não declarou o CPF ou CNPJ.
forma_pagamento	Forma de pagamento utilizada no pagamento.
convenio	Convênio utilizado no pagamento.
qtde_selos	Quantidade de selos utilizado.

RETORNO EM CASO DE SUCESSO DE CONSULTA

{
    "pagamentos": [
        {
            "documento": "2101000001",
            "tipo": "HOR",
            "patio_codigo": "01",
            "datahora": "2021-01-02T10:00:00+03:00",
            "terminal": "M001",
            "cpf_cnpj": "73048114718",
            "forma_pagamento": "APP3",
            "convenio": "APPGEN",
            "qtde_selos": 1
        },
        {
            "documento": "2101000001",
            "tipo": "MEN",
            "patio_codigo": "01",
            "datahora": "2021-01-02T10:30:00+03:00",
            "terminal": "M002",
            "cpf_cnpj": null,
            "forma_pagamento": "PIX",
            "convenio": "GEN1B",
            "qtde_selos": 1
        },...
    ]
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
401	Caso as credenciais sejam inválidas.
404	Caso o ticket ou placa não seja encontrado no pátio