Contratos

https://host/webservice/v1/cliente_contrato

🟢Listar

{
    "qtype" : "cliente_contrato.id",
    "query" : "8903",
    "oper" : "=",
    "page" : "1",
    "rp" : "20",
    "sortname" : "cliente_contrato.id",
    "sortorder" : "desc",
    "grid_param":"[{\"TB\":\"cliente_contrato.data\", \"OP\" : \"BE\", \"P\" : \"10/01/2024\",\"P2\":\"10/01/2024\"}]"
}

🟠Inserir

{
"tipo":"",
"id_cliente":"",
"id_vd_contrato":"",
"contrato":"",
"id_tipo_contrato":"",
"id_modelo":"",
"id_filial":"",
"data":"",
"id_tipo_documento":"",
"id_carteira_cobranca":"",
"id_vendedor":"",
"cc_previsao":"",
"tipo_cobranca":"",
"renovacao_automatica":"",
"base_geracao_tipo_doc":"",
"bloqueio_automatico":"",
"aviso_atraso":"",
//------------------------------------------------------------------------------
"endereco_padrao_cliente":"S"//Se tiver marcado como N, os campos abaixo serão obrigatórios
"condominio_novo":"",//Condomínio (Cliente) //ID do Condomínio (cliente_condominio)
"bloco_novo":"",//Bloco (Cliente)
"apartamento_novo":"",//Apartamento (Cliente)
"cep_novo":"",//CEP (Cliente)
"endereco_novo":"",//Endereço (Cliente)
"numero_novo":"",//Número (Cliente)
"bairro_novo":"",//Bairro (Cliente)
"cidade_novo":"",//Cidade (Cliente) //ID de Cidade (cidade)
"complemento_novo":"",//Complemento (Cliente)
"referencia_novo":"",//Referência (Cliente)
"latitude_novo":"",//Latitude (Cliente)
"longitude_novo":"",//Longitude (Cliente)
}

🔵Editar

Deve ser informado o id do cliente, a ser editado, na URL: https://host/webservice/v1/cliente_contrato/5 Todos os campos devem ser inseridos para realizar uma alteração cadastral.

🔴Deletar

Deve ser informado o id do cliente, a ser excluído, na URL: https://host/webservice/v1/cliente_contrato/5

🔘Botões

Baixar produto de comodato

Botão na interface

Para realizar a baixa de um comodato, utilizando POST, utilize a URL:

https://host/webservice/v1/baixar_comodato_23069

JSON

{
  "id": 111, //id do comodato
  "id_almox": 1, //id do almoxarifado
  "id_almox_label": "Almoxarifado Principal", //id do almoxarifado
  "id_filial_baixa": 1, //id da filial
  "id_filial_baixa_label": "Filial de Teste"
}

cURL

curl --location 'https://host/webservice/v1/baixar_comodato_23069' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTpjM2ZlYmY2ZTI3Y2M0MjZkNDkwNWFiNTRmZjA1N2E5ZDQ3NmU5Yjk2NDBjZTRjM2E3NWQ5N2MyNDlkNGFmNzc2' \
--data '{
  "id": 111,
  "id_almox": 1,
  "id_almox_label": "Almoxarifado Principal",
  "id_filial_baixa": 1,
  "id_filial_baixa_label": "Filial de Teste"
}'
Desbloqueio de confiança

Interface:

URL:

https://host/webservice/v1/desbloqueio_confianca

JSON:

{
"id" : "1"//id contrato
}

cURL:

curl --location 'https://host/webservice/v1/desbloqueio_confianca' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTM0OmM5M2Q4NTRhMzJiMjRhNTU4ODU4YzVmOWE5YWI2OGUzOTYzODA3NmYwZDdjODk4MDY0ODE3NGZjZjMzMGY4ZTM=' \
--header 'Cookie: Path=/; IXC_Session=buab3bvm6bbtgi95i8n8n1k4fd; ixc_cli=ff614e4fc61964042374655a03f2ae2e' \
--data '{
 "id": "2279"
}'
Gerar Financeiro

Na Interface:

JSON

{
    "id_contrato" : "",
    "tipo" : "I",
    "id_cliente" : "8"
}

cURL

curl --location 'https://host/webservice/v1/gerar_financeiro_contrato_15314' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzphNTQxZDgzMTQ1YzUxNWRmZDM1ZDBmYTZjZTBkODdiMmQ3ZTgxOGMxNDZkMjZlMzJmODU4ZThlMDc1ZmExZjY4' \
--data '{
    "id_contrato" : "",
    "tipo" : "I",
    "id_cliente" : "8"
}'
Imprimir um contrato

Interface:

URL:

https://HOST/webservice/v1/cliente_contrato_imprimir_contrato_17678

JSON:

{
    "id" : "27"
}

cURL:

curl --location --request GET 'https://HOST/webservice/v1/cliente_contrato_imprimir_contrato_17678' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzU6MDUyYTFlNTM3NWMwNzMzMjRjOTNlYzQ1ZTE1MmViOGU0ZGRiZWU3YmQ0MjU4MzAxOWRkYTBiMjEyNzEzNTE2Nw==' \
--data '{
    "id" : "27"
}'
Liberar (Redução de velocidade)

Botão na interface

Para realizar a liberação da redução de velocidade, utilizando POST, utilize a URL:

https://host/webservice/v1/liberacao_reducao_contrato_29157

JSON

{
"get_id" : "70795"//ID do Contrato
}

cURL

curl --location 'https://host/webservice/v1/liberacao_reducao_contrato_29157' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTpjM2ZlYmY2ZTI3Y2M0MjZkNDkwNWFiNTRmZjA1N2E5ZDQ3NmU5Yjk2NDBjZTRjM2E3NWQ5N2MyNDlkNGFmNzc2' \
--data '{
"get_id" : "70795"
}'

Status do Contrato

Ativar contrato

Localização do botão ativar contrato:

O botão "Ativar" só é exibido para contratos que ainda não estão ativos

Rota: https://host/webservice/v1/cliente_contrato_ativar_cliente

{
"qtype":"cliente_contrato_ativar_cliente.id",
"id_contrato":"30"
}

Exemplo em cURL:

curl --location --request GET 'https://host/webservice/v1/cliente_contrato_ativar_cliente' \
--header 'Content-Type: application/json' \
--data '{
"qtype":"cliente_contrato_ativar_cliente.id",
"id_contrato":"30"
}'

Status de Acesso

Aguardando Assinatura

Interface:

URL:

https://host/webservice/v1/cliente_contrato_29529

JSON:

{
"id_contrato" : "1"
}

cURL:

curl --location 'https://host/webservice/v1/cliente_contrato_29529' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"id_contrato" : "1"
}'
Aviso Atraso (Financeiro em Atraso)

Interface:

URL:

https://host/webservice/v1/cliente_contrato_15463

JSON:

{
"id_contrato" : "1"
}

cURL:

curl --location 'https://host/webservice/v1/cliente_contrato_15463' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTcxOjIwNTYwMGI4OTQwOWViODM5YThlZDdiYmZhMDJkYmFkNjE2ZmE0MmUzYjNjMDQ2YTc0MDRkYTYzY2MzYmVkYmE=' \
--header 'Cookie: Path=/; IXC_Session=buab3bvm6bbtgi95i8n8n1k4fd; ixc_cli=ff614e4fc61964042374655a03f2ae2e' \
--data '    {
        "id_contrato":"2284"
    }'
Bloqueio Manual

Interface:

URL:

https://host/webservice/v1/cliente_contrato_29546

JSON:

{
"id_contrato" : "1"
}

cURL:

curl --location 'https://host/webservice/v1/cliente_contrato_29546' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"id_contrato" : "1"
}'
Liberar Manualmente (Ativar o Status Acesso)

Interface:

URL:

https://host/webservice/v1/cliente_contrato_15464

JSON:

{
"id_contrato" : "1"
}

cURL:

curl --location 'https://host/webservice/v1/cliente_contrato_15464' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTowNWQ3MzBjNmVjN2IyYWFiMTFhNTgyYzBhZmY3NzIzM2U2YTY0YTRjMjRlNTU4OTk3ZWEwOWY2MWY3MzAzOGQ5' \
--data '{
"id_contrato" : "1"
}'

Last updated