Skip to main content

Consulta valor do contrato de plano através do código do contrato de plano

Consulta valor do contrato de plano através do código

GET api/planos_contratos/<plano_contrato_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

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
id

Código do contrato de plano gerado na garagem.

pessoa_id

Código da pessoa.

pessoa_nome

Nome da pessoa.

pessoa_documento

Documento da pessoa.

qtd_vagas

Quantidade de vagas do credenciado.

valido_de

Data e hora do início do contrato de plano.

valido_ate

Data e hora do fim do contrato de plano.

vencimento

Data e hora do vencimento do contrato de plano.

plano_id

Código do plano.

plano_identificacao

Identificação do plano.

calculo

JSON de cálculo com as datas e valores para o próximo período.

calculo.valor

Valor a ser pago pelo contrato de plano para o próximo período.

calculo.valido_de

Data e hora do início do contrato de plano para o próximo período.

calculo.valido_ate

Data e hora do fim do contrato de plano para o próximo período.

calculo.vencimento

Data e hora do vencimento do contrato de plano para o próximo período.

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

{
    "plano_contrato": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "pessoa": {
          id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "MARIA VITÓRIA OLIVEIRA",
          "documento": "64454846626"
        },
        "qtd_vagas": 1,
        "valido_de": "2019-08-30T18:35:25.000-03:00",
        "valido_ate": "2019-09-30T18:35:25.000-03:00",
        "vencimento": "2019-08-30T18:35:25.000-03:00",
        "plano": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
          "identificao": "PLANO MENSAL"
        },
        "calculo": { 
          "valor": 40.50,
          "valido_de": "2019-09-30T18:35:25.000-03:00",
          "valido_ate": "2019-10-30T18:35:25.000-03:00",
          "vencimento": "2019-09-30T18:35:25.000-03:00",
        }
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
401
 Caso as credenciais sejam inválidas.
404 Caso o código não seja encontrado como contrato de plano na garagem.
502 Caso não seja possível calcular o valor.


Back to top