Skip to main content

Cadastro de contrato de plano

Adiciona registro de contrato de plano na garagem.

POST api/planos_contratos

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 (BODY)

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO

nome

Nome a pessoa ou razão social da emrpesa, até 50 caracteres.

 SIM

documento

 CPF/CNPJ do credenciado SIM

qtd_vagas

Quantidade de vagas que o contrato de plano tem direito de utilizar simultaneamente. Caso o parâmetro não seja informado, será cadastrado o valor 1.

NÃO

valido_de

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

NÃO

vencimento

Data e hora do vencimento do contrato de plano.

NÃO

plano_id

Código do plano, esse valor de ser consultado na chamada api/planos, caso não seja informado, iremos cadastrar com o valor padrão cadastrado para a garagem.

NÃO

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

Data e hora do início do cálculo do contrato de plano.

calculo.valido_ate

Data e hora do fim do cálculo do contrato de plano.

calculo.vencimento

Data e hora do vencimento do cálculo do contrato de plano.

calculo.valor

Valor do cálculo.

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

{
    "plano_contrato": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "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",
        "chaves": ["12344"],
        "pessoa" : {  
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "MARIA VITÓRIA OLIVEIRA",
          "documento": "64454846626",
        },
        "plano": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "identificao": "PLANO MENSAL"
        },
        "calculo": {          
          "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",
          "valor": 100.5
        }
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
400
 Caso os parâmetros passados estejam incorretos.
401
 Caso as credenciais sejam inválidas.

502

Caso não seja possível realizar comunicação com a automação da garagem.

Back to top