Cliente | Dados Gerais

Este artigo documenta o processo do cadastro de clientes.

Recurso responsável pelas informações do cadastro dos dados gerais dos clientes.

Listar clientes

Lista de forma paginada a lista de clientes

Requisição
Método	GET
URL	/api/v1/clientes
Formato do conteúdo	application/json

Parâmetros de consulta
`query`	Filtro de pesquisa
`page`	Número da página que será retornada
`size`	Quantidade de registros retornados por página
`sort`	Ordenação dos registros retornados
Exemplo de uso
`/api/v1/clientes`
`/api/v1/clientes?page=0&size=10`
`/api/v1/clientes?page=1&size=10&sort=nome,desc`
`/api/v1/clientes?query=nome=contains=microsys`
`/api/v1/clientes?query=nome=contains=microsys&page=1&size=10&sort=nome,desc`

Estrutura de dados da resposta
Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`id`	Integer	-	Sim	Código identificador
`razaoSocial`	String	60	Sim	Razão social
`cnpj`	String	18	Sim	CNPJ para pessoa jurídica ou CPF para pessoa física
`telefone`	String	20	Sim	Telefone de contato
`email`	String	120	Sim	Endereço de e-mail
`municipio`	Object	-	Sim	Município
`municipio.id`	Integer	-	Sim	Código identificador
`municipio.nome`	String	40	Sim	Nome do município
`municipio.uf`	String	2	Sim	UF do município
`situacao`	String	20	Sim	Situação do cliente ATIVO INATIVO INCOMPLETO INCOMPLETO_WEB BLOQUEADO BLOQUEADO_SERASA BLOQUEADO_PRAZO
`impostoIsento`	String	15	Sim	Cliente é isento de impostos IPI ICMS PIS_COFINS PIS_COFINS_IPI PIS_COFINS_ICMS IPI_ICMS NENHUM
`comissao`	Double	-	Sim	Percentual de comissão
`tabelaPreco`	Integer	-	Não	Tabela de preço do cliente
`tipoVenda`	Object	-	Não	Tipo de venda do cliente
`tipoVenda.id`	Integer	-	Sim	Código identificador
`tipoVenda.nome`	String	30	Sim	Nome
`tipoConsumidor`	String	8	Não	Tipo consumidor CONSUMO REVENDA

Exemplo de resposta

{
    "content": [
        {
            "id": 2,
            "razaoSocial": "AVIBRASIL IND E COM DE EQUIP AVICOLAS LT",
            "cnpj": "02.986.723/0001-37",
            "email": "nfe@avioeste.com.br",
            "contato": {
                "email": "nfe@avioeste.com.br"
            },
            "municipio": {
                "id": 421050,
                "nome": "MARAVILHA",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421050,
                    "nome": "MARAVILHA",
                    "uf": "SC"
                }
            },
            "situacao": "BLOQUEADO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 3,
            "razaoSocial": "ADEMIR JOSE ROSSA",
            "cnpj": "637.233.959-53",
            "telefone": "(49) 9 9919 8010",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 9 9919 8010",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 421795,
                "nome": "TIGRINHOS",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421795,
                    "nome": "TIGRINHOS",
                    "uf": "SC"
                }
            },
            "situacao": "BLOQUEADO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 4,
            "razaoSocial": "AUTO ABASTECEDORA KICASA LTDA",
            "cnpj": "01.258.926/0001-44",
            "telefone": "9 9149 4945",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "9 9149 4945",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 420050,
                "nome": "AGUAS DE CHAPECO",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 420050,
                    "nome": "AGUAS DE CHAPECO",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 5,
            "razaoSocial": "ANTONIO LUIS REBELATO",
            "cnpj": "220.335.729-00",
            "telefone": "(49) 3647 1021",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 3647 1021",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 421210,
                "nome": "PALMITOS",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421210,
                    "nome": "PALMITOS",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 6,
            "razaoSocial": "ANTONINHO LORENZATTO - ME",
            "cnpj": "97.348.148/0001-53",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 421100,
                "nome": "MONDAI",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421100,
                    "nome": "MONDAI",
                    "uf": "SC"
                }
            },
            "situacao": "BLOQUEADO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 7,
            "razaoSocial": "ARDUINO GALINA S/A",
            "cnpj": "83.301.937/0001-24",
            "telefone": "(49) 3323 3106",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 3323 3106",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 420420,
                "nome": "CHAPECO",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 420420,
                    "nome": "CHAPECO",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 8,
            "razaoSocial": "ADIR JOSE SCHMITZ",
            "cnpj": "295.315.869-34",
            "telefone": "(49) 3366 1664",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 3366 1664",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 353820,
                "nome": "PINHALZINHO",
                "uf": "SP"
            },
            "endereco": {
                "municipio": {
                    "id": 353820,
                    "nome": "PINHALZINHO",
                    "uf": "SP"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 9,
            "razaoSocial": "ARLINDO BIAZUSSI",
            "cnpj": "256.864.299-87",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 421050,
                "nome": "MARAVILHA",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421050,
                    "nome": "MARAVILHA",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 10,
            "razaoSocial": "AUTO POSTO TIO TITO LTDA",
            "cnpj": "01.990.840/0001-01",
            "telefone": "(49) 3647 0526",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 3647 0526",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 421210,
                "nome": "PALMITOS",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 421210,
                    "nome": "PALMITOS",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        },
        {
            "id": 11,
            "razaoSocial": "TRANS LAR",
            "cnpj": "81.779.480/0001-32",
            "telefone": "(49) 3646 0070",
            "email": "nfsmatriz@rpmpneus.com.br",
            "contato": {
                "telefone": "(49) 3646 0070",
                "email": "nfsmatriz@rpmpneus.com.br"
            },
            "municipio": {
                "id": 420470,
                "nome": "CUNHA PORA",
                "uf": "SC"
            },
            "endereco": {
                "municipio": {
                    "id": 420470,
                    "nome": "CUNHA PORA",
                    "uf": "SC"
                }
            },
            "situacao": "ATIVO",
            "impostoIsento": "NENHUM",
            "comissao": 0.0,
            "tabelaPreco": 1,
            "tipoConsumidor": "CONSUMO"
        }
    ],
    "page": {
        "size": 10,
        "number": 0,
        "totalElements": 28108,
        "totalPages": 2811
    }
}

Consultar cliente

Consulta cliente pelo codigo.

Requisição
Método	GET
URL	/api/v1/clientes/{id}
Formato do conteúdo	application/json

Parâmetro de URL
`codigo`	Código do cliente
Exemplo de uso
`/api/v1/clientes/12345`

Estrutura de dados da resposta
Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`id`	Integer	-	Sim	Código identificador
`razaoSocial`	String	60	Sim	Razão social
`nomeFantasia`	String	60	Sim	Nome fantazia
`tipoPagamento`	String	20	Sim	Tipo de pagamento: A_VISTA A_VISTA_E_A_PRAZO
`tipoPessoa`	String	8	Sim	FISICA ou JURIDICA
`cnpj`	String	18	Sim	CNPJ para pessoa jurídica ou CPF para pessoa física
`inscricaoEstadual`	String	18	Sim	Número da inscrição ou a palavra ISENTO
`indicadorInscricaoEstadual`	String	30	Sim	Indicação de IE: NAO_CONTRIBUINTE CONTRIBUINTE CONTRIBUINTE_ISENTO
`inicioAtividades`	Date	-	Não	Data de início das ativades no formato AAAA-MM-DD
`regimeTributario`	String	20	Sim	Regime tributário: SIMPLES_NACIONAL REGIME_NACIONAL REGIME_NORMAL
`serasa`	String	3	Sim	Desconsidera serasa: SIM NAO
`suframa`	String	20	Não	Suframa do cliente
`observacoes`	String	100	Não	Observação do cliente
`situacao`	String	20	Sim	Situação do cliente ATIVO INATIVO INCOMPLETO INCOMPLETO_WEB BLOQUEADO BLOQUEADO_SERASA BLOQUEADO_PRAZO
`impostoIsento`	String	15	Sim	Cliente é isento de impostos IPI ICMS PIS_COFINS PIS_COFINS_IPI PIS_COFINS_ICMS IPI_ICMS NENHUM
`contato`	Object	-	Não	Contato
`contato.telefone`	String	20	Sim	Telefone de contato
`contato.ramal`	Integer	-	Não	Número do ramal
`contato.celular`	String	20	Não	Número do celular
`contato.fax`	String	20	Não	Número do fax
`contato.email`	String	120	Sim	Endereço de e-mail
`contato.emailNfe`	String	120	Sim	Endereço de e-mail Nfe
`contato.nacionalidade`	String	15	Sim	NACIONAL INTERNACIONAL
`contato.pessoaContato`	String	40	Não	Pessoa de contato
`ramoAtividade`	Object		Não	Rede de atividade
`ramoAtividade.id`	Integer	-	Sim	Código identificador
`ramoAtividade.descricao`	String	60	Sim	Descrição ramo da atividade
`endereco`	Object	-	Sim	Endereço
`endereco.logradouro`	String	60	Sim	Logradouro
`endereco.numeroImovel`	String	10	Sim	Número do imóvel
`endereco.bairro`	String	25	Sim	Bairro
`endereco.cep`	String	9	Sim	Cep
`endereco.municipio`	Object	-	Sim	Município
`endereco.municipio.id`	Integer	-	Sim	Código identificador
`endereco.municipio.nome`	String	40	Sim	Nome do município
`representante`	Object	-	Não	Representante
`representante.id`	Integer	-	Sim	Código identificador
`representante.nome`	String	40	Sim	Nome do representate
`enderecoCobranca`	Object	-	Não	Endereço de cobrança
`enderecoCobranca.nome`	String	50	Não	Nome
`enderecoCobranca.logradouro`	String	40	Não	Logradouro
`enderecoCobranca.bairro`	String	25	Não	Bairro
`enderecoCobranca.cep`	String	9	Não	Cep
`enderecoCobranca.telefone`	String	20	Não	Telefone
`enderecoCobranca.cnpj`	String	20	Não	CNPJ
`enderecoCobranca.inscricaoEstadual`	String	20	Não	Inscrição estadual
`enderecoCobranca.observacao`	String	50	Não	Observação
`enderecoCobranca.municipio`	Object	-	Não	Município
`enderecoCobranca.municipio.id`	Integer	-	Sim	Código identificador
`enderecoCobranca.municipio.nome`	String	40	Sim	Nome do município
`enderecoEntrega`	Object	-	Não	Endereço de entrega
`enderecoEntrega.nome`	String	50	Não	Nome
`enderecoEntrega.logradouro`	String	40	Não	Logradouro
`enderecoEntrega.bairro`	String	25	Não	Bairro
`enderecoEntrega.cep`	String	9	Não	Cep
`enderecoEntrega.telefone`	String	20	Não	Telefone
`enderecoEntrega.cnpj`	String	20	Não	CNPJ
`enderecoEntrega.inscricaoEstadual`	String	20	Não	Inscrição estadual
`enderecoEntrega.observacao`	String	40	Não	Observação
`enderecoEntrega.municipio`	Object	-	Não	Município
`enderecoEntrega.municipio.id`	Integer	-	Sim	Código identificador
`enderecoEntrega.municipio.nome`	String	40	Sim	Nome do município
`contatos`	Array	-	Não	Lista de contatos
`contatos.item`	Integer	-	Sim	Identificador do contato
`contatos.nome`	String	40	Não	Nome
`contatos.endereco`	String	40	Não	Endereço
`contatos.bairro`	String	25	Não	Bairro
`contatos.cep`	String	9	Não	Cep
`contatos.municipio`	Object	-	Não	Município do contato
`contatos.municipio.id`	Integer	-	Sim	Código do municópio
`contatos.municipio.nome`	String	40	Sim	Nome do município
`contatos.telefone`	String	20	Não	Telefone
`contatos.celular`	String	20	Não	Celular
`contatos.email`	String	60	Não	E-mail
`contatos.departamento`	String	60	Não	Departamento
`contatos.funcao`	String	25	Não	Função
`contatos.observacao`	String	200	Não	Observação
`referenciasComerciais`	Array	-	Não	Rereferências comercias
`referenciasComerciais.item`	Integer	-	Sim	Item sequencial
`referenciasComerciais.razaoSocial`	String	60	Sim	Razão social
`referenciasComerciais.cnpj`	String	18	Não	CNPJ
`referenciasComerciais.contato`	String	60	Não	Nome do contato
`referenciasComerciais.telefone`	String	20	Sim	Número telefone
`referenciasComerciais.email`	String	100	Não	E-mail
`referenciasComerciais.inscricaoEstadual`	String	20	Não	Número da inscrição ou a palavra ISENTO
`referenciasComerciais.localizacao`	String	60	Não	Localização
`referenciasComerciais.observacao`	String	200	Não	Observação
`referenciasBancarias`	Array	-	Não	Rereferências bancárias
`referenciasBancarias.item`	Integer	-	Sim	Item sequencial
`referenciasBancarias.banco`	String	60	Sim	Banco
`referenciasBancarias.agencia`	String	10	Não	Agência
`referenciasBancarias.conta`	String	10	Não	Número da conta
`referenciasBancarias.telefone`	String	20	Sim	Telefone
`referenciasBancarias.contato`	String	30	Não	Nome para contato
`referenciasBancarias.clienteDesde`	Date	-	Não	Cliente desde no formato AAAA-MM-DD
`referenciasBancarias.observacao`	String	200	Não	Observação
`atividades`	Array	-	Não	Lista de atividades
`atividades.item`	Integer	-	Sim	Item sequencial
`atividades.nomeEmpresa`	String	60	Sim	Nome da empresa
`atividades.contato`	String	100	Não	Contato
`atividades.telefone`	String	15	Não	Telefone
`atividades.municipio`	Object	-	Não	Município
`atividades.municipio.id`	Integer	-	Sim	Código do município
`atividades.municipio.nome`	String	40	Sim	Nome do município
`atividades.tipo`	Object	-	Sim	Tipo da atidade
`atividades.tipo.id`	Integer	-	Sim	Código do tipo da atividade
`atividades.tipo.nome`	String	30	Sim	Nome do tipo da atividade
`atividades.atividadePrincipal`	String	3	Sim	Atividade principal SIM NAO
`atividades.unidadeMedida`	Object	-	Sim	Unidade fornecida
`atividades.unidadeMedida.id`	Integer	-	Sim	Código da unidade de medida
`atividades.unidadeMedida.nome`	String	30	Sim	Nome da unidade de medida
`atividades.quantidade`	Double	-	Não	Quantidade
`atividades.anosFornecimento`	Integer	-	Não	Anos de fornecimento
`atividades.mesesFornecimento`	Integer	-	Não	Meses de fornecimento
`atividades.renda`	Double	-	Sim	Renda
`atividades.previsaoAumento`	Double	-	Não	Previsão aumento
`atividades.periodicidadeRenda`	String	10	Não	Periodicidade de renda ANUAL SEMESTRAL TRIMESTRAL BIMESTRAL MENSAL SEMANAL DIARIO
`atividades.observacoes`	String	120	Não	Observações
`bens`	Array	-	Não	Lista de bens
`bens.item`	Integer	-	Sim	Item sequencial
`bens.descricao`	String	100	Não	Descrição do bem
`bens.localizacao`	String	100	Não	Localização do bem
`bens.valor`	Double		Não	Valor do bem
`bens.observacao`	String	100	Não	Observação
`bens.tipo`	String	10	Sim	Tipo do bem MOVEL IMOVEL
`bens.condicao`	String	10	Não	Condição do bem PROPRIO ALUGADO CEDIDO
`bens.anosAquisicao`	Integer	-	Não	Anos da aquisição
`bens.mesesAquisicao`	Integer	-	Não	Meses da aquisição
`bens.areaTotal`	Double	-	Não	Área total do bem
`bens.areaReservada`	Double	-	Não	Área reservada do bem
`bens.alienado`	String	3	Sim	Alienado SIM NAO
`socios`	Array	-	Não	Lista de sócios
`socios.item`	Integer	-	Sim	Item sequencial
`socios.nome`	String	60	Não	Nome do sócio
`socios.responsavel`	String	3	Sim	Responsável SIM NAO
`socios.cpf`	String	14	Não	CPF do sócio
`socios.rg`	String	20	Não	RG do sócio
`socios.telefone`	String	20	Não	Telefone do sócio
`socios.celular`	String	20	Não	Celular do sócio
`socios.endereco`	String	60	Não	Endereço do sócio
`socios.numero`	String	10	Não	Número da residência
`socios.bairro`	String	30	Não	Bairro da residência
`socios.municipio`	Object	-	Não	Município
`socios.municipio.id`	Integer	-	Sim	Código do município
`socios.municipio.nome`	String	40	Sim	Nome do município
`socios.cep`	String	9	Não	Cep do municípo
`socios.email`	String	100	Não	E-mail do sócio
`socios.observacao`	String	100	Não	observação
`socios.nacionalidade`	String	15	Sim	Nacionalidade NACIONAL INTERNACIONAL
`socios.serasa`	String	3	Sim	Desconsidera serasa: SIM NAO
`fiadores`	Array	-	Não	Lista de fiadores
`fiadores.item`	Integer	-	Sim	Item sequencial
`fiadores.nome`	String	60	Não	Nome do fiador
`fiadores.fiador`	String	3	Sim	Fiador SIM NAO
`fiadores.responsavel`	String	3	Sim	Responsável SIM NAO
`fiadores.cpf`	String	14	Não	CPF do fiador
`fiadores.rg`	String	20	Não	RG do fiador
`fiadores.telefone`	String	20	Não	Telefone do fiador
`fiadores.celular`	String	20	Não	Celular do fiador
`fiadores.endereco`	String	60	Não	Endereço do fiador
`fiadores.numero`	String	10	Não	Número da residência
`fiadores.bairro`	String	30	Não	Bairro da residência
`fiadores.municipio`	Object	-	Não	Município
`fiadores.municipio.id`	Integer	-	Sim	Código do município
`fiadores.municipio.nome`	String	40	Sim	Nome do município
`fiadores.cep`	String	9	Não	Cep do município
`fiadores.email`	String	100	Não	E-mail do fiador
`fiadores.estadoCivil`	String	15	Sim	Estado civil SOLTEIRO CASADO DIVORCIADO VIUVO
`fiadores.nascimento`	Date	-	Não	Data de nascimento no formato AAAA-MM-DD
`fiadores.admissao`	Date	-	Não	Data de admissão no formato AAAA-MM-DD
`fiadores.ocupacao`	Object	-	Não	Ocupação
`fiadores.ocupacao.id`	Integer	_	Sim	Código da ocupação
`fiadores.ocupacao.descricao`	String	200	Sim	Descrição da ocupação

Exemplo de resposta

{
  "id": 1,
  "razaoSocial": "Microsys",
  "nomeFantasia": "Microsys",
  "tipoPagamento": "A_VISTA",
  "tipoPessoa": "JURIDICA",
  "cnpj": "00.000.000/000-01",
  "inscricaoEstadual": "ISENTO",
  "indicadorInscricaoEstadual": "NAO_CONTRIBUINTE",
  "inicioAtividades": "2022-08-15",
  "regimeTributario": "SIMPLES_NACIONAL",
  "serasa": "NAO",
  "suframa": "",
  "observacoes": "Documentação",
  "situacao": "ATIVO",
  "impostoIsento": "IPI",
  "contato": {
    "telefone": "(49) 3664-5000",
    "ramal": 100,
    "celular": "(49) 98888-9999",
    "fax": "(49) 3664-5000",
    "email": "teste@microsys.inf.br",
    "emailNfe": "teste@microsys.inf.br",
    "nacionalidade": "NACIONAL",
    "pessoaContato": "Microsys"
  },
  "ramoAtividade": {
    "id": 1,
    "descricao": "Desenvolvimento"
  },
  "endereco": {
    "logradouro": "BR 282",
    "numeroImovel": "123",
    "bairro": "Industrial",
    "cep": "89874-000",
    "municipio": {
      "id": 123,
      "nome": "Maravilha"
    }
  },
  "representante": {
    "id": 1,
    "nome": "Representante A"
  },
  "enderecoCobranca": {
    "Nome": "Descrição do endereço de cobrança",
    "logradouro": "BR 282",
    "bairro": "Industrial",
    "cep": "89874-000",
    "telefone": "(49) 0000-0000",
    "cnpj": "00.000.000/000-01",
    "inscricaoEstadual": "ISENTO",
    "observacao": "Observação de cobrança",
    "municipio": {
      "id": 123,
      "nome": "Maravilha"
    }
  },
  "enderecoEntrega": {
    "Nome": "Descrição do endereço de entrega",
    "logradouro": "BR 282",
    "bairro": "Industrial",
    "cep": "89874-000",
    "telefone": "(49) 0000-0000",
    "cnpj": "00.000.000/000-01",
    "inscricaoEstadual": "ISENTO",
    "observacao": "Na esquina da rua A",
    "municipio": {
      "id": 456,
      "nome": "Maravilha"
    }
  },
  "contatos": [
    {
      "item": 1,
      "nome": "Contato 1",
      "endereco": "Rua 5",
      "bairro": "Centro",
      "cep": "89874-000",
      "municipio": {
        "id": 1,
        "nome": "Maravilha"
      },
      "telefone": "(49) 0000-0000",
      "celular": "(49) 00000-0000",
      "email": "teste@teste.com.br",
      "departamento": "TI",
      "funcao": "Analisa",
      "observacao": "Observação do contato"
    }
  ],
  "referenciasComerciais": [
    {
      "item": 1,
      "razaoSocial": "Referencia comercial",
      "cnpj": "00.000.000/000-01",
      "contato": "Pessoa de contato",
      "telefone": "(49) 0000-0000",
      "email": "teste@teste.com.br",
      "inscricaoEstadual": "ISENTO",
      "localizacao": "Maravilha",
      "observacao": "Observações"
    }
  ],
  "referenciasBancarias": [
    {
      "item": 1,
      "banco": "Banco C6",
      "agencia": "10",
      "conta": "1000",
      "telefone": "(49) 0000-0000",
      "contato": "Gerente",
      "clienteDesde": "2020-10-01",
      "observacao": "Observações"
    }
  ],
  "atividades": [
    {
      "item": 1,
      "nomeEmpresa": "Teste",
      "contato": "Contato atividade",
      "telefone": "(49) 0000-0000",
      "municipio": {
        "id": 1,
        "nome": "Maravilha"
      },
      "tipo": {
        "id": 1,
        "nome": "Leiteira"
      },
      "atividadePrincipal": "NAO",
      "unidadeMedida": {
        "id": "LT",
        "nome": "Litros"
      },
      "quantidade": 67.5,
      "anosFornecimento": 1,
      "mesesFornecimento": 2,
      "renda": 10,
      "previsaoAumento": 10,
      "periodicidadeRenda": "DIARIO",
      "observacoes": "Obs atividade"
    }
  ],
  "bens": [
    {
      "item": 1,
      "descricao": "Teste",
      "localizacao": "maravilha",
      "valor": 2556888.00,
      "obsevacao": "Obs bem",
      "tipo": "IMOVEL",
      "condicao": "ALUGADO",
      "anosAquisicao": 2, 
      "mesesAquisicao": 6,
      "areaTotal": 256.5,
      "areaReservada": 2.56,
      "alienado": "SIM"
    }
  ],
  "socios": [
    {
      "item": 1,
      "nome": "Teste",
      "responsavel": "SIM",
      "cpf": "000.000.000-88",
      "rg": "0.000.000",
      "telefone": "0000-0000",
      "celular": "(49) 00000-0000",
      "endereco": "Rua teste",
      "numero": "10",
      "bairro": "teste",
      "municipio": {
        "id": 1,
        "nome": "Maravilha"
      },
      "cep": "89874-000",
      "email": "teste@teste.com.br",
      "observacao": "obs socio",
      "nacionalidade": "NACIONAL",
      "serasa": "NAO"
    }
  ],
   "fiadores": [
    {
      "item": 1,
      "nome": "Teste",
      "fiador": "SIM",
      "responsavel": "NAO",
      "cpf": "000.000.000-77",
      "rg": "0.000.000",
      "telefone": "0000-0000",
      "celular": "(49) 00000-0000",
      "endereco": "Rua teste",
      "numero": "10",
      "bairro": "teste",
      "municipio": {
        "id": 1,
        "nome": "Maravilha"
      },
      "cep": "89874-000",
      "email": "teste@teste.com.br",
      "estadoCivil": "SOLTEIRO",
      "nascimento": "1999-10-04",
      "admissao": "2005-09-10",
      "ocupacao": {
        "id": 1,
        "descricao": "Oficial da marinha"
      }
    }
  ]
}

Inserir cliente

Insere um cliente novo na base de dados.

Requisição
Método	POST
URL	`/api/v1/clientes`
Formato do conteúdo	application/json

Estrutura de dados da requisição
Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`filial`	Integer	-	Sim	Código da filial
`razaoSocial`	String	60	Sim	Razão social
`nomeFantasia`	String	60	Sim	Nome fantazia
`tipoPagamento`	String	20	Sim	Tipo de pagamento: A_VISTA A_VISTA_E_A_PRAZO
`tipoPessoa`	String	8	Sim	FISICA ou JURIDICA
`cnpj`	String	18	Sim	CNPJ para pessoa jurídica ou CPF para pessoa física
`inscricaoEstadual`	String	18	Sim	Número da inscrição ou a palavra ISENTO
`indicadorInscricaoEstadual`	String	30	Sim	Indicação de IE: NAO_CONTRIBUINTE CONTRIBUINTE CONTRIBUINTE_ISENTO
`inicioAtividades`	Date	-	Não	Data de início das ativades no formato AAAA-MM-DD
`regimeTributario`	String	20	Sim	Regime tributário: SIMPLES_NACIONAL REGIME_NACIONAL REGIME_NORMAL
`serasa`	String	3	Sim	Desconsidera serasa: SIM NAO
`suframa`	String	20	Não	Suframa do cliente
`observacoes`	String	100	Não	Observação do cliente
`contato`	Object	-	Sim	Contato
`contato.telefone`	String	20	Sim	Telefone de contato
`contato.ramal`	Integer	-	Não	Número do ramal
`contato.celular`	String	20	Não	Número do celular
`contato.fax`	String	20	Não	Número do fax
`contato.email`	String	120	Sim	Endereço de e-mail
`contato.emailNfe`	String	120	Sim	Endereço de e-mail Nfe
`contato.nacionalidade`	String	15	Sim	NACIONAL INTERNACIONAL
`contato.pessoaContato`	String	40	Não	Pessoa de contato
`ramoAtividade`	Object		Não	Rade de atividade
`ramoAtividade.id`	Integer	-	Sim	Código identificador
`endereco`	Object	-	Sim	Endereço
`endereco.logradouro`	String	60	Sim	Logradouro
`endereco.numeroImovel`	String	10	Sim	Número do imóvel
`endereco.bairro`	String	25	Sim	Bairro
`endereco.cep`	String	9	Sim	Cep
`endereco.municipio`	Object	-	Sim	Município
`endereco.municipio.id`	Integer	-	Sim	Código identificador
`representante`	Object	-	Sim	Representante
`representante.id`	Integer	-	Sim	Código identificador

Exemplo de conteúdo da requisição

{
  "filial": 1,
  "razaoSocial": "Novo Cliente",
  "nomeFantasia": "Novo Cliente",
  "tipoPagamento": "A_VISTA",
  "tipoPessoa": "JURIDICA",
  "cnpj": "00.000.000/000-01",
  "inscricaoEstadual": "ISENTO",
  "indicadorInscricaoEstadual": "NAO_CONTRIBUINTE",
  "inicioAtividades": "2022-08-15",
  "regimeTributario": "SIMPLES_NACIONAL",
  "serasa": "NAO",
  "suframa": "",
  "observacoes": "Observação do cliente",
  "contato": {
    "telefone": "(49) 3664-5000",
    "ramal": 100,
    "celular": "(49) 98888-9999",
    "fax": "(49) 3664-5000",
    "email": "teste@microsys.inf.br",
    "emailNfe": "teste@microsys.inf.br",
    "nacionalidade": "NACIONAL",
    "pessoaContato": "Microsys"
  },
  "ramoAtividade": {
    "id": 1
  },
  "endereco": {
    "logradouro": "BR 282",
    "numeroImovel": "123",
    "bairro": "Industrial",
    "cep": "89874-000",
    "municipio": {
      "id": 123
    }
  },
  "representante": {
    "id": 30
  }
}

Resposta

A API retornará o código do novo cliente cadastrado.

Estrutura de dados do resposta
Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`id`	Integer	-	Sim	Código identificador do cliente

Exemplo de resposta

{
  "id": 123456
}

Editar cliente

Atualiza o cadastro de um cliente na base de dados.

Requisição
Método	PUT
URL	`/api/v1/clientes/{id}`
Formato do conteúdo	application/json

Parâmetro de URL
`id`	Código identificador do cliente
Exemplo de uso
`/api/v1/clientes/123456`

Estrutura de dados da requisição
Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`razaoSocial`	String	60	Sim	Razão social
`nomeFantasia`	String	60	Sim	Nome fantazia
`tipoPagamento`	String	20	Sim	Tipo de pagamento: A_VISTA A_VISTA_E_A_PRAZO
`tipoPessoa`	String	8	Sim	FISICA ou JURIDICA
`cnpj`	String	18	Sim	CNPJ para pessoa jurídica ou CPF para pessoa física
`inscricaoEstadual`	String	18	Sim	Número da inscrição ou a palavra ISENTO
`indicadorInscricaoEstadual`	String	30	Sim	Indicação de IE: NAO_CONTRIBUINTE CONTRIBUINTE CONTRIBUINTE_ISENTO
`inicioAtividades`	Date	-	Não	Data de início das ativades no formato AAAA-MM-DD
`regimeTributario`	String	20	Sim	Regime tributário: SIMPLES_NACIONAL REGIME_NACIONAL REGIME_NORMAL
`serasa`	String	3	Sim	Desconsidera serasa: SIM NAO
`suframa`	String	20	Não	Suframa do cliente
`observacoes`	String	100	Não	Observação do cliente
`contato`	Object	-	Sim	Contato
`contato.telefone`	String	20	Sim	Telefone de contato
`contato.ramal`	Integer	-	Não	Número do ramal
`contato.celular`	String	20	Não	Número do celular
`contato.fax`	String	20	Não	Número do fax
`contato.email`	String	120	Sim	Endereço de e-mail
`contato.emailNfe`	String	120	Sim	Endereço de e-mail Nfe
`contato.nacionalidade`	String	15	Sim	NACIONAL INTERNACIONAL
`contato.pessoaContato`	String	40	Não	Pessoa de contato
`ramoAtividade`	Object		Não	Rade de atividade
`ramoAtividade.id`	Integer	-	Sim	Código identificador
`endereco`	Object	-	Sim	Endereço
`endereco.logradouro`	String	60	Sim	Logradouro
`endereco.numeroImovel`	String	10	Sim	Número do imóvel
`endereco.bairro`	String	25	Sim	Bairro
`endereco.cep`	String	9	Sim	Cep
`endereco.municipio`	Object	-	Sim	Município
`endereco.municipio.id`	Integer	-	Sim	Código identificador
`representante`	Object	-	Sim	Representante
`representante.id`	Integer	-	Sim	Código identificador

{
  "razaoSocial": "Editar Cliente",
  "nomeFantasia": "Editar Cliente",
  "tipoPagamento": "A_VISTA",
  "tipoPessoa": "JURIDICA",
  "cnpj": "00.000.000/000-01",
  "inscricaoEstadual": "ISENTO",
  "indicadorInscricaoEstadual": "NAO_CONTRIBUINTE",
  "inicioAtividades": "2022-08-15",
  "regimeTributario": "SIMPLES_NACIONAL",
  "serasa": "NAO",
  "suframa": "",
  "observacoes": "Observação do cliente",
  "contato": {
    "telefone": "(49) 3664-5000",
    "ramal": 100,
    "celular": "(49) 98888-9999",
    "fax": "(49) 3664-5000",
    "email": "teste@microsys.inf.br",
    "emailNfe": "teste@microsys.inf.br",
    "nacionalidade": "NACIONAL",
    "pessoaContato": "Microsys"
  },
  "ramoAtividade": {
    "id": 1
  },
  "endereco": {
    "logradouro": "BR 282",
    "numeroImovel": "123",
    "bairro": "Industrial",
    "cep": "89874-000",
    "municipio": {
      "id": 123
    }
  },
  "representante": {
    "id": 30
  }
}

Excluir cliente

Exclui um cliente.

Requisição
Método	DELETE
URL	`/api/v1/clientes/{id}`

Parâmetro de URL
`id`	Código identificador do cliente
Exemplo de uso
`/api/v1/clientes/12345`

Page Navigation

Details

Book Navigation

Cliente | Dados Gerais

Listar clientes

Consultar cliente

Inserir cliente

Editar cliente

Excluir cliente

An Error Occurred

An unknown error occurred