⚪Cliente
https://host/webservice/v1/cliente
🟢Listar
{
"qtype": "cliente.id",
"query": "",
"oper": "=",
"page": "1",
"rp": "1000",
"sortname": "cliente.id",
"sortorder": "desc",
"grid_param":""
}curl --location --request GET 'https://HOST/webservice/v1/cliente' \
--header 'ixcsoft: listar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MTA1OjlmMmYwNjEzTAyZGE1ZjQ3YjU3ZTAwMWI1ZjI1ZTZkYjFhNmVkMjMxYjc5MjVlMjc2YjBlMWI5MTNhNDI=' \
--data '{
"qtype": "cliente.id",
"query": "",
"oper": "=",
"page": "1",
"rp": "1000",
"sortname": "cliente.id",
"sortorder": "desc",
"grid_param":""
}'🟠Inserir
{
"ativo":"",
"tipo_pessoa":"",
"razao":"",
"cnpj_cpf":"",
"contribuinte_icms":"",
"tipo_assinante":"",
"cep":"",
"endereco":"",
"numero":"",
"bairro":"",
"cidade":"",
"tipo_localidade":"",
"iss_classificacao_padrao":""
}{
"senha": "",
"acesso_automatico_central": "",
"alterar_senha_primeiro_acesso": "",
"senha_hotsite_md5": "",
"dica_imposto_retido_cliente": "",
"indicado_por": "",
"ativo": "",
"grau_satisfacao": "",
"razao": "",
"fantasia": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_cadastro": "",//nao editavel
"uf": "",
"crm": "",
"endereco": "",
"cidade": "",
"cond_pagamento": "",
"bairro": "",
"fone": "",
"numero": "",
"cep": "",
"filial_id": "",
"contato": "",
"latitude": "",
"longitude": "",
"id_conta": "",
"hotsite_email": "",
"email": "",
"obs": "",
"id_tipo_cliente": "",
"id_candato_tipo": "",
"tipo_pessoa": "",
"telefone_comercial": "",
"telefone_celular": "",
"referencia": "",
"complemento": "",
"id_condominio": "",
"ramal": "",
"data_nascimento": "DD/MM/AAAA",
"participa_cobranca": "",
"num_dias_cob": "",
"tabela_preco": "",
"id_vendedor": "",
"bloco": "",
"isuf": "",
"apartamento": "",
"tipo_assinante": "",
"idx": "",
"skype": "",
"whatsapp": "",
"id_perfil": "",
"id_concorrente": "",
"hotsite_acesso": "",
"responsavel": "",
"status_prospeccao": "",
"estado_civil": "",
"crm_data_vencemos": "DD/MM/AAAA",
"ativo_serasa": "",
"iss_classificacao_padrao": "",
"rg_orgao_emissor": "",
"ultima_atualizacao": "",//nao editavel
"nacionalidade": "",
"deb_automatico": "",
"deb_agencia": "",
"deb_conta": "",
"alerta": "",
"endereco_cob": "",
"numero_cob": "",
"bairro_cob": "",
"cidade_cob": "",
"uf_cob": "",
"cep_cob": "",
"referencia_cob": "",
"complemento_cob": "",
"profissao": "",
"id_operadora_celular": "",
"participa_pre_cobranca": "",
"cob_envia_email": "",
"cob_envia_sms": "",
"contribuinte_icms": "",
"Sexo": "",
"nome_pai": "",
"nome_mae": "",
"quantidade_dependentes": "",
"nome_conjuge": "",
"fone_conjuge": "",
"cpf_conjuge": "",
"rg_conjuge": "",
"data_nascimento_conjuge": "DD/MM/AAAA",
"moradia": "",
"nome_contador": "",
"telefone_contador": "",
"ref_com_empresa1": "",
"ref_com_empresa2": "",
"ref_com_fone1": "",
"ref_com_fone2": "",
"ref_pes_nome1": "",
"ref_pes_nome2": "",
"ref_pes_fone1": "",
"ref_pes_fone2": "",
"emp_empresa": "",
"emp_cnpj": "",
"emp_cep": "",
"emp_endereco": "",
"emp_cidade": "",
"emp_fone": "",
"emp_cargo": "",
"emp_remuneracao": "",
"emp_data_admissao": "DD/MM/AAAA",
"website": "",
"orgao_publico": "",
"pipe_id_organizacao": "",
"im": "",
"cif": "",
"tipo_cliente_scm": "",
"pis_retem": "",
"cofins_retem": "",
"csll_retem": "",
"irrf_retem": "",
"nascimento_mae": "",
"nascimento_pai": "",
"identidade_mae": "",
"identidade_pai": "",
"cpf_mae": "",
"cpf_pai": "",
"inscricao_municipal": "",
"nome_representante_1": "",
"nome_representante_2": "",
"cpf_representante_1": "",
"cpf_representante_2": "",
"identidade_representante_1": "",
"identidade_representante_2": "",
"codigo_operacao": "",
"convert_cliente_forn": "",
"tipo_pessoa_titular_conta": "",
"cnpj_cpf_titular_conta": "",
"crm_data_perdemos": "DD/MM/AAAA",
"crm_data_sem_viabilidade": "DD/MM/AAAA",
"crm_data_sem_porta_disponivel": "DD/MM/AAAA",
"crm_data_abortamos": "DD/MM/AAAA",
"crm_data_negociando": "DD/MM/AAAA",
"crm_data_apresentando": "DD/MM/AAAA",
"crm_data_sondagem": "DD/MM/AAAA",
"crm_data_novo": "DD/MM/AAAA",
"atualizar_cadastro_galaxPay": "",
"foto_cartao": "",
"cli_desconta_iss_retido_total": "",
"cidade_naturalidade": "",
"cadastrado_via_viabilidade": "",
"tipo_localidade": "",
"facebook": ""
}curl --location 'https://host/webservice/v1/cliente' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=44437aokk9ou9dgoplc2d38ibp' \
--data '{
"senha": "",
"acesso_automatico_central": "",
"alterar_senha_primeiro_acesso": "",
"senha_hotsite_md5": "",
"dica_imposto_retido_cliente": "",
"indicado_por": "",
"ativo": "",
"grau_satisfacao": "",
"razao": "",
"fantasia": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_cadastro": "",
"uf": "",
"crm": "",
"endereco": "",
"cidade": "",
"cond_pagamento": "",
"bairro": "",
"fone": "",
"numero": "",
"cep": "",
"filial_id": "",
"contato": "",
"latitude": "",
"longitude": "",
"id_conta": "",
"hotsite_email": "",
"email": "",
"obs": "",
"id_tipo_cliente": "",
"id_candato_tipo": "",
"tipo_pessoa": "",
"telefone_comercial": "",
"telefone_celular": "",
"referencia": "",
"complemento": "",
"id_condominio": "",
"ramal": "",
"data_nascimento": "",
"participa_cobranca": "",
"num_dias_cob": "",
"tabela_preco": "",
"id_vendedor": "",
"bloco": "",
"isuf": "",
"apartamento": "",
"tipo_assinante": "",
"idx": "",
"skype": "",
"whatsapp": "",
"id_perfil": "",
"id_concorrente": "",
"hotsite_acesso": "",
"responsavel": "",
"status_prospeccao": "",
"estado_civil": "",
"crm_data_vencemos": "0",
"ativo_serasa": "",
"iss_classificacao_padrao": "",
"rg_orgao_emissor": "",
"ultima_atualizacao": "",
"nacionalidade": "",
"deb_automatico": "",
"deb_agencia": "",
"deb_conta": "",
"alerta": "",
"endereco_cob": "",
"numero_cob": "",
"bairro_cob": "",
"cidade_cob": "",
"uf_cob": "",
"cep_cob": "",
"referencia_cob": "",
"complemento_cob": "",
"profissao": "",
"id_operadora_celular": "",
"participa_pre_cobranca": "",
"cob_envia_email": "",
"cob_envia_sms": "",
"contribuinte_icms": "",
"Sexo": "",
"nome_pai": "",
"nome_mae": "",
"quantidade_dependentes": "",
"nome_conjuge": "",
"fone_conjuge": "",
"cpf_conjuge": "",
"rg_conjuge": "",
"data_nascimento_conjuge": "",
"moradia": "",
"nome_contador": "",
"telefone_contador": "",
"ref_com_empresa1": "",
"ref_com_empresa2": "",
"ref_com_fone1": "",
"ref_com_fone2": "",
"ref_pes_nome1": "",
"ref_pes_nome2": "",
"ref_pes_fone1": "",
"ref_pes_fone2": "",
"emp_empresa": "",
"emp_cnpj": "",
"emp_cep": "",
"emp_endereco": "",
"emp_cidade": "",
"emp_fone": "",
"emp_cargo": "",
"emp_remuneracao": "",
"emp_data_admissao": "",
"website": "",
"orgao_publico": "",
"pipe_id_organizacao": "",
"im": "",
"cif": "",
"tipo_cliente_scm": "",
"pis_retem": "",
"cofins_retem": "",
"csll_retem": "",
"irrf_retem": "",
"nascimento_mae": "",
"nascimento_pai": "",
"identidade_mae": "",
"identidade_pai": "",
"cpf_mae": "",
"cpf_pai": "",
"inscricao_municipal": "",
"nome_representante_1": "",
"nome_representante_2": "",
"cpf_representante_1": "",
"cpf_representante_2": "",
"identidade_representante_1": "",
"identidade_representante_2": "",
"codigo_operacao": "",
"convert_cliente_forn": "",
"tipo_pessoa_titular_conta": "",
"cnpj_cpf_titular_conta": "",
"crm_data_perdemos": "",
"crm_data_sem_viabilidade": "",
"crm_data_sem_porta_disponivel": "",
"crm_data_abortamos": "",
"crm_data_negociando": "",
"crm_data_apresentando": "",
"crm_data_sondagem": "",
"crm_data_novo": "",
"atualizar_cadastro_galaxPay": "",
"foto_cartao": "",
"cli_desconta_iss_retido_total": "",
"cidade_naturalidade": "",
"cadastrado_via_viabilidade": "",
"tipo_localidade": "",
"facebook": ""
}'{
//ID do Cliente
"id":"",//ID
//Ativo
"ativo":"S",//Sim
"ativo":"N",//Nao
//Tipo Cliente - Fiscal
"tipo_cliente_scm":"01",//01 - Comercial
"tipo_cliente_scm":"02",//02 - Industrial
"tipo_cliente_scm":"03",//03 - Residencial/Pessoa Física
"tipo_cliente_scm":"04",//04 - Produtor Rural
"tipo_cliente_scm":"05",//05 - Órgão da administração pública estadual direta e suas fundações e autarquias, quando mantidas pelo poder público estadual e regidas por normas de direito público, termos do Convênio ICMS 107/95
"tipo_cliente_scm":"06",//06 - Prestador de serviço de telecomunicação responsável pelo recolhimento do imposto incidente sobre a cessão dos meios de rede do prestador do serviço ao usuário final, termos do Convênio ICMS 17/13
"tipo_cliente_scm":"07",//07 - Missões Diplomáticas, Repartições Consulares e Organismos Internacionais, nos termos do Convênio ICMS 158/94
"tipo_cliente_scm":"08",//08 - Igrejas e Templos de qualquer natureza
"tipo_cliente_scm":"99",//99 - Outros não especificados anteriormente
//Tipo Pessoa
"tipo_pessoa":"F",//Fisica
"tipo_pessoa":"J",//Juridica
"tipo_pessoa":"E",//Estrangeiro
//Razão social/Nome
"razao":"",
//Nome fantasia
"fantasia":"",
//CNPJ/CPF
"cnpj_cpf":"",
//IE/RG
"ie_identidade":"",
//Contribuinte ICMS
"contribuinte_icms":"S",//Sim
"contribuinte_icms":"N",//Nao
"contribuinte_icms":"I",//Isento
//RG orgão emissor
"rg_orgao_emissor":"",
//Nacionalidade
"nacionalidade":"",
//Naturalidade
"cidade_naturalidade":"",//ID da Cidade (cidade)
//Estado de Nascimento
"estado_nascimento":"",//ID da UF (uf)
//Data de nascimento
"data_nascimento":"DD/MM/AAAA",
//Data da Fundação (Somente se o Tipo pessoa for J)
"data_nascimento":"DD/MM/AAAA",
//Sexo
"Sexo":"F",//Feminino
"Sexo":"M",//Masculino
//Profissão
"profissao":"",
//Estado civil
"estado_civil":"",//---
"estado_civil":"Casado",//Casado
"estado_civil":"Divorciado",//Divorciado
"estado_civil":"Solteiro",//Solteiro
"estado_civil":"Viúvo",//Viúvo
//Inscrição Municipal
"inscricao_municipal":"",
//Inscrição na SUFRAMA
"isuf":"",
//------------------- Outras informações -------------------//
//Tipo de Assinante
"tipo_assinante":"1",//Comercial/Industrial
"tipo_assinante":"6",//Outros
"tipo_assinante":"2",//Poder Público
"tipo_assinante":"4",//Público
"tipo_assinante":"3",//Residencial/Pessoa física
"tipo_assinante":"5",//Semi-Público
//Filial
"filial_id":"",//ID da filial (filial)
//Validar Filial
"filtra_filial":"S",//Sim
"filtra_filial":"N",//Nao
//ID Externo
"idx":"",
//Data Cadastro (Preenchido automaticamente em inserções)
"data_cadastro":"DD/MM/AAAA",//Manter a Orginal, em caso de alteração, no formato correto
// Grau de satisfação
"grau_satisfacao":"1",//Nada satisfeito
"grau_satisfacao":"2",//Pouco satisfeito
"grau_satisfacao":"3",//Satisfeito
"grau_satisfacao":"4",//Muito satisfeito
"grau_satisfacao":"5",//Completamente satisfeito
//Negativacao Ativa
"ativo_serasa":"1",//Sim
"ativo_serasa":"2",//Nao
//Atualizar cadastro galaxpay (campo oculto)
"atualizar_cadastro_galaxPay":"S",//Valor padrão S
//------------------- Endereço Principal -------------------//
//Condomínio
"id_condominio":"",//ID do condomínio (cliente_condominio)
//Bloco
"bloco":"",
//Apartamento
"apartamento":"",
//CEP
"cep":"01234-567",
//CIF
"cif":"",
//Endereço
"endereco":"",
//Número
"numero":"",
//Complemento
"complemento":"",
//Bairro
"bairro":"",
//Cidade
"cidade":"",//ID da Cidade (cidade)
//Referencia
"referencia":"",
//UF (campo oculto)
"uf":"",//ID da UF (uf)
//Moradia
"moradia":"P",//Propria
"moradia":"A",//Alugada
//Tipo de localidade
"tipo_localidade":"R",//Zona Rural
"tipo_localidade":"U",//Zona Urbana
//------------------- Localização Geográfica -------------------//
//Latitude
"latitude":"",
//Longitude
"longitude":"",
//------------------- Endereço de cobrança -------------------//
//CEP cob.
"cep_cob":"",
//Endereço cob.
"endereco_cob":"",
//Número cob.
"numero_cob":"",
//Bairro cob.
"bairro_cob":"",
//Cidade cob.
"cidade_cob":"",//ID da cidade (cidade)
//Complemento cob.
"complemento_cob":"",
//Referência cob.
"referencia_cob":"",
//UF cob. (campo oculto)
"uf_cob":"",//ID de UF (uf)
//Telefone Residencial
"fone":"",
//Telefone Comercial
"telefone_comercial":"",
//Ramal
"ramal":"",
//Operadora de celular
"id_operadora_celular":"",//ID da operadora de telefonia (operadora_telefonia)
//Telefone celular
"telefone_celular":"",
//WhatsApp
"whatsapp":"",
//E-mail principal
"email":"",
//Contato
"contato":"",
//Website
"website":"",
//Skype
"skype":"",
//Facebook
"facebook":"",
//------------------- Central do assinante -------------------//
//Login (central do assinante)
"hotsite_email":"",
//Senha (central do assinante)
"senha":"",
//Permitir acesso automatico
"acesso_automatico_central":"S",//Sim
"acesso_automatico_central":"N",//Nao
"acesso_automatico_central":"P",//Padrao
// Obrigar alterar senha do primeiro acesso
"alterar_senha_primeiro_acesso":"S",//Sim
"alterar_senha_primeiro_acesso":"N",//Nao
"alterar_senha_primeiro_acesso":"P",//Padrao
//Senha codificada
"senha_hotsite_md5":"S",//Sim
"senha_hotsite_md5":"N",//Nao
//Tipo de permissão (campo oculto)
"hotsite_acesso":"",//Valor Padrão 2
//Prospecção
"crm":"S",//Sim
"crm":"N",//Nao
//Canal de Venda
"id_candato_tipo":"",//ID de Canal de Venda (crm_tipo_candidato)
//Campanha
"id_campanha":"",//ID de Campanha (crm_campanha)
//Concorrente
"id_concorrente":"",//ID de Concorrente (crm_concorrente)
//Perfil
"id_perfil":"",//ID de Perfil (crm_perfil)
//Responsável
"responsavel":"",//ID de Colaboradores (funcionarios)
//Indicado por
"indicado_por":"",//ID de outro Cliente (cliente)
//Cadastro via viabilidade
"cadastrado_via_viabilidade":"S",//Sim
"cadastrado_via_viabilidade":"N",//Não
// Status da Prospecção
"status_prospeccao":"C",//Novo
"status_prospeccao":"S",//Sondagem
"status_prospeccao":"A",//Apresentando
"status_prospeccao":"N",//Negociando
"status_prospeccao":"V",//Vencemos
"status_prospeccao":"P",//Perdemos
"status_prospeccao":"AB",//Abortamos
"status_prospeccao":"SV",//Sem viabilidade
"status_prospeccao":"SP",//Sem porta disponível
//Data novo
"crm_data_novo":"DD/MM/AAAA",
//Data sondagem
"crm_data_sondagem":"DD/MM/AAAA",
//Data apresentando
"crm_data_apresentando":"DD/MM/AAAA",
//Data negociando
"crm_data_negociando":"DD/MM/AAAA",
//Data vencemos
"crm_data_vencemos":"DD/MM/AAAA",
//Data perdemos
"crm_data_perdemos":"DD/MM/AAAA",
//Data abortamos
"crm_data_abortamos":"DD/MM/AAAA",
//Data sem porta disponível
"crm_data_sem_porta_disponivel":"DD/MM/AAAA",
//Data sem viabilidade
"crm_data_sem_viabilidade":"DD/MM/AAAA",
//Pipedrive ID organização (campo oculto)
"pipe_id_organizacao":"",
//Foto cartão
"foto_cartao":"",
//------------------- Cobrança -------------------//
//Considera na cobranca autmatizada
"participa_cobranca":"S",//Marcado
"participa_cobranca":"",//Desmarcado
//Número de dias de atraso para entrar na cobrança automatizada
"num_dias_cob":"",
//Enviar lembrete (pre-cobranca)
"participa_pre_cobranca":"S",//Sim
"participa_pre_cobranca":"N",//Nao
//Envia e-mails
"cob_envia_email":"S",//Sim
"cob_envia_email":"N",//Nao
//Envia SMS
"cob_envia_sms":"S",//Sim
"cob_envia_sms":"N",//Nao
//Planejamento analítico
"id_conta":"",//ID de Planejamento Analítico (planejamento_analitico)
//Condição de pagamento
"cond_pagamento":"",//ID de Condições de pagamento (condicoes_pagamento)
//Vendedor padrão
"id_vendedor":"",//ID do Vendedor (vendedor)
//Tabela preço
"tabela_preco":"",//ID da tabela preços (tabela_precos)
//Cód. Débito em conta
"deb_automatico":"",
//Agência para débito
"deb_agencia":"",
//Conta para débito
"deb_conta":"",
// Código operação
"codigo_operacao":"",
//------------------- Titular da conta -------------------//
//Tipo pessoa titular
"participa_cobranca":"F",//Fisica
"participa_cobranca":"J",//Juridica
//CNPJ/CPF titular
"cnpj_cpf_titular_conta":"",
//Última atualização
"ultima_atualizacao":"CURRENT_TIMESTAMP",//Não alterável
//------------------- Informações Pessoais -------------------//
//Nome pai
"nome_pai":"",
//CPF pai
"cpf_pai":"",
//RG pai
"identidade_pai":"",
//Data nascimento mãe
"nascimento_pai":"",
//Nome mãe
"nome_mae":"",
//CPF mãe
"cpf_mae":"",
//RG mãe
"identidade_mae":"",
//Data nascimento mãe
"nascimento_mae":"",
//Quantidade dependentes
"quantidade_dependentes":"",
//Nome cônjuge
"nome_conjuge":"",
//Fone cônjuge
"fone_conjuge":"",
//CPF cônjuge
"cpf_conjuge":"",
//RG cônjuge
"rg_conjuge":"",
//Data nascimento cônjuge
"data_nascimento_conjuge":"",
//------------------- Informações Adicionais -------------------//
//Nome contador
"nome_contador":"",
//Telefone contador
"telefone_contador":"",
//Orgao Publico
"orgao_publico":"S",//Sim
"orgao_publico":"N",//Nao
//Inscrição municipal contador
"im":"",
//------------------- Informações Representantes -------------------//
// Nome representante legal 1
"nome_representante_1":"",
// CPF representante legal 1
"cpf_representante_1":"",
//RG representante legal 1
"identidade_representante_1":"",
//Nome representante legal 2
"nome_representante_2":"",
//CPF representante legal 2
"cpf_representante_2":"",
//RG representante legal 2
"identidade_representante_2":"",
//Classificao de ISS
"iss_classificacao_padrao":"",//---
"iss_classificacao_padrao":"00",//00 - Normal
"iss_classificacao_padrao":"01",//01 - Retido
"iss_classificacao_padrao":"02",//02 - Substituta
"iss_classificacao_padrao":"03",//03 - Isento
"iss_classificacao_padrao":"99",//99 - Padrão
//PIS
"pis_retem":"",//Desmarcado
"pis_retem":"S",//Marcado
//COFINS
"cofins_retem":"",//Desmarcado
"cofins_retem":"S",//Marcado
//CSLL
"csll_retem":"",//Desmarcado
"csll_retem":"S",//Marcado
//IRRF
"irrf_retem":"",//Desmarcado
"irrf_retem":"S",//Marcado
//Descontar IRRF e CSLL de valor inferior a R$10,00
"desconto_irrf_valor_inferior":"S",//Sim
"desconto_irrf_valor_inferior":"N",//Nao
//ISS
"cli_desconta_iss_retido_total":"",//Desmarcado
"cli_desconta_iss_retido_total":"S",//Marcado
//------------------- Referência comercial -------------------//
//Empresa 1
"ref_com_empresa1":"",
//Telefone emp. 1
"ref_com_fone1":"",
//Empresa 2
"ref_com_empresa2":"",
//Telefone emp. 2
"ref_com_fone2":"",
//------------------- Referência pessoal -------------------//
//Nome 1
"ref_pes_nome1":"",
//Telefone ref. 1
"ref_pes_fone1":"",
//Nome 2
"ref_pes_nome2":"",
//Telefone ref. 2
"ref_pes_fone2":"",
//Observações
"obs":"",
//Alerta
"alerta":"",
}🔵Editar
Deve ser informado o id do cliente, a ser editado, na URL: https://host/webservice/v1/cliente/5
Todos os campos devem ser inseridos para realizar uma alteração cadastral.
{
"senha": "",
"acesso_automatico_central": "",
"alterar_senha_primeiro_acesso": "",
"senha_hotsite_md5": "",
"dica_imposto_retido_cliente": "",
"indicado_por": "",
"ativo": "",
"grau_satisfacao": "",
"razao": "",
"fantasia": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_cadastro": "",//nao editavel
"uf": "",
"crm": "",
"endereco": "",
"cidade": "",
"cond_pagamento": "",
"bairro": "",
"fone": "",
"numero": "",
"cep": "",
"filial_id": "",
"contato": "",
"latitude": "",
"longitude": "",
"id_conta": "",
"hotsite_email": "",
"email": "",
"obs": "",
"id_tipo_cliente": "",
"id_candato_tipo": "",
"tipo_pessoa": "",
"telefone_comercial": "",
"telefone_celular": "",
"referencia": "",
"complemento": "",
"id_condominio": "",
"ramal": "",
"data_nascimento": "DD/MM/AAAA",
"participa_cobranca": "",
"num_dias_cob": "",
"tabela_preco": "",
"id_vendedor": "",
"bloco": "",
"isuf": "",
"apartamento": "",
"tipo_assinante": "",
"idx": "",
"skype": "",
"whatsapp": "",
"id_perfil": "",
"id_concorrente": "",
"hotsite_acesso": "",
"responsavel": "",
"status_prospeccao": "",
"estado_civil": "",
"crm_data_vencemos": "DD/MM/AAAA",
"ativo_serasa": "",
"iss_classificacao_padrao": "",
"rg_orgao_emissor": "",
"ultima_atualizacao": "",//nao editavel
"nacionalidade": "",
"deb_automatico": "",
"deb_agencia": "",
"deb_conta": "",
"alerta": "",
"endereco_cob": "",
"numero_cob": "",
"bairro_cob": "",
"cidade_cob": "",
"uf_cob": "",
"cep_cob": "",
"referencia_cob": "",
"complemento_cob": "",
"profissao": "",
"id_operadora_celular": "",
"participa_pre_cobranca": "",
"cob_envia_email": "",
"cob_envia_sms": "",
"contribuinte_icms": "",
"Sexo": "",
"nome_pai": "",
"nome_mae": "",
"quantidade_dependentes": "",
"nome_conjuge": "",
"fone_conjuge": "",
"cpf_conjuge": "",
"rg_conjuge": "",
"data_nascimento_conjuge": "DD/MM/AAAA",
"moradia": "",
"nome_contador": "",
"telefone_contador": "",
"ref_com_empresa1": "",
"ref_com_empresa2": "",
"ref_com_fone1": "",
"ref_com_fone2": "",
"ref_pes_nome1": "",
"ref_pes_nome2": "",
"ref_pes_fone1": "",
"ref_pes_fone2": "",
"emp_empresa": "",
"emp_cnpj": "",
"emp_cep": "",
"emp_endereco": "",
"emp_cidade": "",
"emp_fone": "",
"emp_cargo": "",
"emp_remuneracao": "",
"emp_data_admissao": "DD/MM/AAAA",
"website": "",
"orgao_publico": "",
"pipe_id_organizacao": "",
"im": "",
"cif": "",
"tipo_cliente_scm": "",
"pis_retem": "",
"cofins_retem": "",
"csll_retem": "",
"irrf_retem": "",
"nascimento_mae": "",
"nascimento_pai": "",
"identidade_mae": "",
"identidade_pai": "",
"cpf_mae": "",
"cpf_pai": "",
"inscricao_municipal": "",
"nome_representante_1": "",
"nome_representante_2": "",
"cpf_representante_1": "",
"cpf_representante_2": "",
"identidade_representante_1": "",
"identidade_representante_2": "",
"codigo_operacao": "",
"convert_cliente_forn": "",
"tipo_pessoa_titular_conta": "",
"cnpj_cpf_titular_conta": "",
"crm_data_perdemos": "DD/MM/AAAA",
"crm_data_sem_viabilidade": "DD/MM/AAAA",
"crm_data_sem_porta_disponivel": "DD/MM/AAAA",
"crm_data_abortamos": "DD/MM/AAAA",
"crm_data_negociando": "DD/MM/AAAA",
"crm_data_apresentando": "DD/MM/AAAA",
"crm_data_sondagem": "DD/MM/AAAA",
"crm_data_novo": "DD/MM/AAAA",
"atualizar_cadastro_galaxPay": "",
"foto_cartao": "",
"cli_desconta_iss_retido_total": "",
"cidade_naturalidade": "",
"cadastrado_via_viabilidade": "",
"tipo_localidade": "",
"facebook": ""
}curl --location --request PUT 'https://host/webservice/v1/cliente/5' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=44437aokk9ou9dgoplc2d38ibp' \
--data '{
"senha": "",
"acesso_automatico_central": "",
"alterar_senha_primeiro_acesso": "",
"senha_hotsite_md5": "",
"dica_imposto_retido_cliente": "",
"indicado_por": "",
"ativo": "",
"grau_satisfacao": "",
"razao": "",
"fantasia": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_cadastro": "",
"uf": "",
"crm": "",
"endereco": "",
"cidade": "",
"cond_pagamento": "",
"bairro": "",
"fone": "",
"numero": "",
"cep": "",
"filial_id": "",
"contato": "",
"latitude": "",
"longitude": "",
"id_conta": "",
"hotsite_email": "",
"email": "",
"obs": "",
"id_tipo_cliente": "",
"id_candato_tipo": "",
"tipo_pessoa": "",
"telefone_comercial": "",
"telefone_celular": "",
"referencia": "",
"complemento": "",
"id_condominio": "",
"ramal": "",
"data_nascimento": "",
"participa_cobranca": "",
"num_dias_cob": "",
"tabela_preco": "",
"id_vendedor": "",
"bloco": "",
"isuf": "",
"apartamento": "",
"tipo_assinante": "",
"idx": "",
"skype": "",
"whatsapp": "",
"id_perfil": "",
"id_concorrente": "",
"hotsite_acesso": "",
"responsavel": "",
"status_prospeccao": "",
"estado_civil": "",
"crm_data_vencemos": "0",
"ativo_serasa": "",
"iss_classificacao_padrao": "",
"rg_orgao_emissor": "",
"ultima_atualizacao": "",
"nacionalidade": "",
"deb_automatico": "",
"deb_agencia": "",
"deb_conta": "",
"alerta": "",
"endereco_cob": "",
"numero_cob": "",
"bairro_cob": "",
"cidade_cob": "",
"uf_cob": "",
"cep_cob": "",
"referencia_cob": "",
"complemento_cob": "",
"profissao": "",
"id_operadora_celular": "",
"participa_pre_cobranca": "",
"cob_envia_email": "",
"cob_envia_sms": "",
"contribuinte_icms": "",
"Sexo": "",
"nome_pai": "",
"nome_mae": "",
"quantidade_dependentes": "",
"nome_conjuge": "",
"fone_conjuge": "",
"cpf_conjuge": "",
"rg_conjuge": "",
"data_nascimento_conjuge": "",
"moradia": "",
"nome_contador": "",
"telefone_contador": "",
"ref_com_empresa1": "",
"ref_com_empresa2": "",
"ref_com_fone1": "",
"ref_com_fone2": "",
"ref_pes_nome1": "",
"ref_pes_nome2": "",
"ref_pes_fone1": "",
"ref_pes_fone2": "",
"emp_empresa": "",
"emp_cnpj": "",
"emp_cep": "",
"emp_endereco": "",
"emp_cidade": "",
"emp_fone": "",
"emp_cargo": "",
"emp_remuneracao": "",
"emp_data_admissao": "",
"website": "",
"orgao_publico": "",
"pipe_id_organizacao": "",
"im": "",
"cif": "",
"tipo_cliente_scm": "",
"pis_retem": "",
"cofins_retem": "",
"csll_retem": "",
"irrf_retem": "",
"nascimento_mae": "",
"nascimento_pai": "",
"identidade_mae": "",
"identidade_pai": "",
"cpf_mae": "",
"cpf_pai": "",
"inscricao_municipal": "",
"nome_representante_1": "",
"nome_representante_2": "",
"cpf_representante_1": "",
"cpf_representante_2": "",
"identidade_representante_1": "",
"identidade_representante_2": "",
"codigo_operacao": "",
"convert_cliente_forn": "",
"tipo_pessoa_titular_conta": "",
"cnpj_cpf_titular_conta": "",
"crm_data_perdemos": "",
"crm_data_sem_viabilidade": "",
"crm_data_sem_porta_disponivel": "",
"crm_data_abortamos": "",
"crm_data_negociando": "",
"crm_data_apresentando": "",
"crm_data_sondagem": "",
"crm_data_novo": "",
"atualizar_cadastro_galaxPay": "",
"foto_cartao": "",
"cli_desconta_iss_retido_total": "",
"cidade_naturalidade": "",
"cadastrado_via_viabilidade": "",
"tipo_localidade": "",
"facebook": ""
}'{
//ID do Cliente
"id":"",//ID
//Ativo
"ativo":"S",//Sim
"ativo":"N",//Nao
//Tipo Cliente - Fiscal
"tipo_cliente_scm":"01",//01 - Comercial
"tipo_cliente_scm":"02",//02 - Industrial
"tipo_cliente_scm":"03",//03 - Residencial/Pessoa Física
"tipo_cliente_scm":"04",//04 - Produtor Rural
"tipo_cliente_scm":"05",//05 - Órgão da administração pública estadual direta e suas fundações e autarquias, quando mantidas pelo poder público estadual e regidas por normas de direito público, termos do Convênio ICMS 107/95
"tipo_cliente_scm":"06",//06 - Prestador de serviço de telecomunicação responsável pelo recolhimento do imposto incidente sobre a cessão dos meios de rede do prestador do serviço ao usuário final, termos do Convênio ICMS 17/13
"tipo_cliente_scm":"07",//07 - Missões Diplomáticas, Repartições Consulares e Organismos Internacionais, nos termos do Convênio ICMS 158/94
"tipo_cliente_scm":"08",//08 - Igrejas e Templos de qualquer natureza
"tipo_cliente_scm":"99",//99 - Outros não especificados anteriormente
//Tipo Pessoa
"tipo_pessoa":"F",//Fisica
"tipo_pessoa":"J",//Juridica
"tipo_pessoa":"E",//Estrangeiro
//Razão social/Nome
"razao":"",
//Nome fantasia
"fantasia":"",
//CNPJ/CPF
"cnpj_cpf":"",
//IE/RG
"ie_identidade":"",
//Contribuinte ICMS
"contribuinte_icms":"S",//Sim
"contribuinte_icms":"N",//Nao
"contribuinte_icms":"I",//Isento
//RG orgão emissor
"rg_orgao_emissor":"",
//Nacionalidade
"nacionalidade":"",
//Naturalidade
"cidade_naturalidade":"",//ID da Cidade (cidade)
//Estado de Nascimento
"estado_nascimento":"",//ID da UF (uf)
//Data de nascimento
"data_nascimento":"DD/MM/AAAA",
//Data da Fundação (Somente se o Tipo pessoa for J)
"data_nascimento":"DD/MM/AAAA",
//Sexo
"Sexo":"F",//Feminino
"Sexo":"M",//Masculino
//Profissão
"profissao":"",
//Estado civil
"estado_civil":"",//---
"estado_civil":"Casado",//Casado
"estado_civil":"Divorciado",//Divorciado
"estado_civil":"Solteiro",//Solteiro
"estado_civil":"Viúvo",//Viúvo
//Inscrição Municipal
"inscricao_municipal":"",
//Inscrição na SUFRAMA
"isuf":"",
//------------------- Outras informações -------------------//
//Tipo de Assinante
"tipo_assinante":"1",//Comercial/Industrial
"tipo_assinante":"6",//Outros
"tipo_assinante":"2",//Poder Público
"tipo_assinante":"4",//Público
"tipo_assinante":"3",//Residencial/Pessoa física
"tipo_assinante":"5",//Semi-Público
//Filial
"filial_id":"",//ID da filial (filial)
//Validar Filial
"filtra_filial":"S",//Sim
"filtra_filial":"N",//Nao
//ID Externo
"idx":"",
//Data Cadastro (Preenchido automaticamente em inserções)
"data_cadastro":"DD/MM/AAAA",//Manter a Orginal, em caso de alteração, no formato correto
// Grau de satisfação
"grau_satisfacao":"1",//Nada satisfeito
"grau_satisfacao":"2",//Pouco satisfeito
"grau_satisfacao":"3",//Satisfeito
"grau_satisfacao":"4",//Muito satisfeito
"grau_satisfacao":"5",//Completamente satisfeito
//Negativacao Ativa
"ativo_serasa":"1",//Sim
"ativo_serasa":"2",//Nao
//Atualizar cadastro galaxpay (campo oculto)
"atualizar_cadastro_galaxPay":"S",//Valor padrão S
//------------------- Endereço Principal -------------------//
//Condomínio
"id_condominio":"",//ID do condomínio (cliente_condominio)
//Bloco
"bloco":"",
//Apartamento
"apartamento":"",
//CEP
"cep":"01234-567",
//CIF
"cif":"",
//Endereço
"endereco":"",
//Número
"numero":"",
//Complemento
"complemento":"",
//Bairro
"bairro":"",
//Cidade
"cidade":"",//ID da Cidade (cidade)
//Referencia
"referencia":"",
//UF (campo oculto)
"uf":"",//ID da UF (uf)
//Moradia
"moradia":"P",//Propria
"moradia":"A",//Alugada
//Tipo de localidade
"tipo_localidade":"R",//Zona Rural
"tipo_localidade":"U",//Zona Urbana
//------------------- Localização Geográfica -------------------//
//Latitude
"latitude":"",
//Longitude
"longitude":"",
//------------------- Endereço de cobrança -------------------//
//CEP cob.
"cep_cob":"",
//Endereço cob.
"endereco_cob":"",
//Número cob.
"numero_cob":"",
//Bairro cob.
"bairro_cob":"",
//Cidade cob.
"cidade_cob":"",//ID da cidade (cidade)
//Complemento cob.
"complemento_cob":"",
//Referência cob.
"referencia_cob":"",
//UF cob. (campo oculto)
"uf_cob":"",//ID de UF (uf)
//Telefone Residencial
"fone":"",
//Telefone Comercial
"telefone_comercial":"",
//Ramal
"ramal":"",
//Operadora de celular
"id_operadora_celular":"",//ID da operadora de telefonia (operadora_telefonia)
//Telefone celular
"telefone_celular":"",
//WhatsApp
"whatsapp":"",
//E-mail principal
"email":"",
//Contato
"contato":"",
//Website
"website":"",
//Skype
"skype":"",
//Facebook
"facebook":"",
//------------------- Central do assinante -------------------//
//Login (central do assinante)
"hotsite_email":"",
//Senha (central do assinante)
"senha":"",
//Permitir acesso automatico
"acesso_automatico_central":"S",//Sim
"acesso_automatico_central":"N",//Nao
"acesso_automatico_central":"P",//Padrao
// Obrigar alterar senha do primeiro acesso
"alterar_senha_primeiro_acesso":"S",//Sim
"alterar_senha_primeiro_acesso":"N",//Nao
"alterar_senha_primeiro_acesso":"P",//Padrao
//Senha codificada
"senha_hotsite_md5":"S",//Sim
"senha_hotsite_md5":"N",//Nao
//Tipo de permissão (campo oculto)
"hotsite_acesso":"",//Valor Padrão 2
//Prospecção
"crm":"S",//Sim
"crm":"N",//Nao
//Canal de Venda
"id_candato_tipo":"",//ID de Canal de Venda (crm_tipo_candidato)
//Campanha
"id_campanha":"",//ID de Campanha (crm_campanha)
//Concorrente
"id_concorrente":"",//ID de Concorrente (crm_concorrente)
//Perfil
"id_perfil":"",//ID de Perfil (crm_perfil)
//Responsável
"responsavel":"",//ID de Colaboradores (funcionarios)
//Indicado por
"indicado_por":"",//ID de outro Cliente (cliente)
//Cadastro via viabilidade
"cadastrado_via_viabilidade":"S",//Sim
"cadastrado_via_viabilidade":"N",//Não
// Status da Prospecção
"status_prospeccao":"C",//Novo
"status_prospeccao":"S",//Sondagem
"status_prospeccao":"A",//Apresentando
"status_prospeccao":"N",//Negociando
"status_prospeccao":"V",//Vencemos
"status_prospeccao":"P",//Perdemos
"status_prospeccao":"AB",//Abortamos
"status_prospeccao":"SV",//Sem viabilidade
"status_prospeccao":"SP",//Sem porta disponível
//Data novo
"crm_data_novo":"DD/MM/AAAA",
//Data sondagem
"crm_data_sondagem":"DD/MM/AAAA",
//Data apresentando
"crm_data_apresentando":"DD/MM/AAAA",
//Data negociando
"crm_data_negociando":"DD/MM/AAAA",
//Data vencemos
"crm_data_vencemos":"DD/MM/AAAA",
//Data perdemos
"crm_data_perdemos":"DD/MM/AAAA",
//Data abortamos
"crm_data_abortamos":"DD/MM/AAAA",
//Data sem porta disponível
"crm_data_sem_porta_disponivel":"DD/MM/AAAA",
//Data sem viabilidade
"crm_data_sem_viabilidade":"DD/MM/AAAA",
//Pipedrive ID organização (campo oculto)
"pipe_id_organizacao":"",
//Foto cartão
"foto_cartao":"",
//------------------- Cobrança -------------------//
//Considera na cobranca autmatizada
"participa_cobranca":"S",//Marcado
"participa_cobranca":"",//Desmarcado
//Número de dias de atraso para entrar na cobrança automatizada
"num_dias_cob":"",
//Enviar lembrete (pre-cobranca)
"participa_pre_cobranca":"S",//Sim
"participa_pre_cobranca":"N",//Nao
//Envia e-mails
"cob_envia_email":"S",//Sim
"cob_envia_email":"N",//Nao
//Envia SMS
"cob_envia_sms":"S",//Sim
"cob_envia_sms":"N",//Nao
//Planejamento analítico
"id_conta":"",//ID de Planejamento Analítico (planejamento_analitico)
//Condição de pagamento
"cond_pagamento":"",//ID de Condições de pagamento (condicoes_pagamento)
//Vendedor padrão
"id_vendedor":"",//ID do Vendedor (vendedor)
//Tabela preço
"tabela_preco":"",//ID da tabela preços (tabela_precos)
//Cód. Débito em conta
"deb_automatico":"",
//Agência para débito
"deb_agencia":"",
//Conta para débito
"deb_conta":"",
// Código operação
"codigo_operacao":"",
//------------------- Titular da conta -------------------//
//Tipo pessoa titular
"participa_cobranca":"F",//Fisica
"participa_cobranca":"J",//Juridica
//CNPJ/CPF titular
"cnpj_cpf_titular_conta":"",
//Última atualização
"ultima_atualizacao":"CURRENT_TIMESTAMP",//Não alterável
//------------------- Informações Pessoais -------------------//
//Nome pai
"nome_pai":"",
//CPF pai
"cpf_pai":"",
//RG pai
"identidade_pai":"",
//Data nascimento mãe
"nascimento_pai":"",
//Nome mãe
"nome_mae":"",
//CPF mãe
"cpf_mae":"",
//RG mãe
"identidade_mae":"",
//Data nascimento mãe
"nascimento_mae":"",
//Quantidade dependentes
"quantidade_dependentes":"",
//Nome cônjuge
"nome_conjuge":"",
//Fone cônjuge
"fone_conjuge":"",
//CPF cônjuge
"cpf_conjuge":"",
//RG cônjuge
"rg_conjuge":"",
//Data nascimento cônjuge
"data_nascimento_conjuge":"",
//------------------- Informações Adicionais -------------------//
//Nome contador
"nome_contador":"",
//Telefone contador
"telefone_contador":"",
//Orgao Publico
"orgao_publico":"S",//Sim
"orgao_publico":"N",//Nao
//Inscrição municipal contador
"im":"",
//------------------- Informações Representantes -------------------//
// Nome representante legal 1
"nome_representante_1":"",
// CPF representante legal 1
"cpf_representante_1":"",
//RG representante legal 1
"identidade_representante_1":"",
//Nome representante legal 2
"nome_representante_2":"",
//CPF representante legal 2
"cpf_representante_2":"",
//RG representante legal 2
"identidade_representante_2":"",
//Classificao de ISS
"iss_classificacao_padrao":"",//---
"iss_classificacao_padrao":"00",//00 - Normal
"iss_classificacao_padrao":"01",//01 - Retido
"iss_classificacao_padrao":"02",//02 - Substituta
"iss_classificacao_padrao":"03",//03 - Isento
"iss_classificacao_padrao":"99",//99 - Padrão
//PIS
"pis_retem":"",//Desmarcado
"pis_retem":"S",//Marcado
//COFINS
"cofins_retem":"",//Desmarcado
"cofins_retem":"S",//Marcado
//CSLL
"csll_retem":"",//Desmarcado
"csll_retem":"S",//Marcado
//IRRF
"irrf_retem":"",//Desmarcado
"irrf_retem":"S",//Marcado
//Descontar IRRF e CSLL de valor inferior a R$10,00
"desconto_irrf_valor_inferior":"S",//Sim
"desconto_irrf_valor_inferior":"N",//Nao
//ISS
"cli_desconta_iss_retido_total":"",//Desmarcado
"cli_desconta_iss_retido_total":"S",//Marcado
//------------------- Referência comercial -------------------//
//Empresa 1
"ref_com_empresa1":"",
//Telefone emp. 1
"ref_com_fone1":"",
//Empresa 2
"ref_com_empresa2":"",
//Telefone emp. 2
"ref_com_fone2":"",
//------------------- Referência pessoal -------------------//
//Nome 1
"ref_pes_nome1":"",
//Telefone ref. 1
"ref_pes_fone1":"",
//Nome 2
"ref_pes_nome2":"",
//Telefone ref. 2
"ref_pes_fone2":"",
//Observações
"obs":"",
//Alerta
"alerta":"",
}🔴Deletar
Deve ser informado o id do cliente, a ser excluído, na URL: https://host/webservice/v1/cliente/5
curl --location --request DELETE 'https://host/webservice/v1/cliente/id_cliente' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=44437aokk9ou9dgoplc2d38ibp' \
--data ''🔘Botões
Enviar notificação push
URL:
https://host/webservice/v1/botaoAjax_22282Interface:
JSON
{
"celular": "4992137742",
"id_gateway": "1",
"mensagem": "Teste Api",
"remetente": "",
"id_cliente": "1"
}cURL:
curl --location --request GET 'https://HOST/webservice/v1/botaoAjax_22282' \
--header 'ixcsoft: listar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MjpmNjU0MjA4MzM3ODVkYzExNDY1MGQ1YWZjOTNhYWY3YjZhOTk1OWUyMzYzMGNjZmRjMmY0ODMwMzNkZDA1NDM0' \
--data '{
"celular": "4992137742",
"id_gateway": "1",
"mensagem": "Teste Api",
"remetente": "",
"id_cliente": "1"
}'Last updated