Skip to main content

Consulta valor do contrato de plano

Consulta valor dado mensalidadecontrato de plano através do credenciado, de acordo com os parâmetros do tipo de mensalidade e vencimento configurados na garagem.cpf/cnpj.

Em ambiente de desenvolvimento, todos códigosdocumentos de credenciados,(cpf/cnpj), com exceção daqueles iniciados pelo dígito “9”, serão encontrados e possuirão valor gerado aleatoriamente.aleatoriamente, mas é necessário enviar um documento válido. As requisições com códigos de credenciadosdocumentos iniciados pelo dígito “9” retornarão código de erro 404 (not found).

GET api/integradores/credenciados/planos_contratos?documento=<credenciado_iddocumento>/pagamentos/new

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
documentocpf/cnpj válidoSIM

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
credenciado_id
id

Código do credenciadocontrato de plano gerado na garagem.

valor

pessoa_id

Valor

Código da mensalidadepessoa.

a ser pago.
validade_datahora

pessoa_nome

Data e hora de validade

Nome da mensalidade.pessoa.

vencimento_datahora

pessoa_documento

Documento da pessoa.

qtd_vagas

Quantidade de vagas do credenciado.

valido_de

Data e hora do próximoinício do contrato de plano.

valido_ate

Data e hora do fim do contrato de plano.

vencimento

Data e hora do vencimento dado mensalidade.contrato de plano.

plano_id

Código do plano.

plano_identificacao

Identificação do plano

valor

Valor a ser pago pelo contrato de plano

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

{
    "credenciado_pagamento"plano_contrato": {
        "credenciado_id"id": "123456"73b4cab7-ea27-426c-b247-bf0f006e0f05"",
        "pessoa_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
        "pessoa_nome": "MARIA VITÓRIA OLIVEIRA",
        "pessoa_documento": "64454846626",
        "qtd_vagas": 1,
        "valido_de": "2019-08-30T18:35:25.000-03:00",
        "valido_ate": "2019-08-30T18:35:25.000-03:00",
        "vencimento": "2019-09-30T18:35:25.000-03:00",
        "plano_id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
        "plano_identificao": "PLANO MENSAL",
        "valor": 100.5,
		"validade_datahora": "2021-08-20T23:59:59-03:00",
		"vencimento_datahora": "2021-08-20T23:59:59-03:00"40.50
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
DESCRIÇÃO
401
Caso as credenciais sejam inválidas.
404 Caso o códigodocumento doda credenciadopessoa não seja encontrado como contrato de plano na garagem.
502 Caso não seja possível realizarcalcular comunicaçãoo com a automação da garagem.valor.