Clientes

cliente

Obter Listagem de Clientes

get

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

situacaostringOpcional

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

continuationTokenstringOpcional

Identificador da Paginação da Consulta

campoFiltroDinamicostringOpcional

Campo para filtrar dinamicamente no SQL

valorFiltroDinamicostringOpcional

Valor para filtrar dinamicamente no SQL

paginacaointegerOpcional

Quantidade de itens na paginação de retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

continuationTokenstringOpcional

Identificador da Paginação da Consulta

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/cliente

HTTPcURLJavaScriptPython

GET /cadastrosgerais/v10/cliente HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codEmpresa": 1,
      "codCliente": 1,
      "cpfCnpj": "text",
      "nome": "text",
      "codRepresentante": 1,
      "codRepresentante2": 1,
      "codRepresentante3": 1,
      "inscEstadual": "text",
      "inscSuframa": "text",
      "contatoCompras": "text",
      "situacao": 1,
      "nomeFantasia": "text",
      "codRamoAtividade": 1,
      "codSetorVenda": 1,
      "consumidorFinal": 0,
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "codIbge": "text",
      "email": "text",
      "emailNfe": "text",
      "telefone": "text",
      "telefoneCobranca": "text",
      "fax": "text",
      "telexCelular": "text",
      "observacao": "text",
      "aliqIcms": "text",
      "percAliqICMS": 1,
      "valorLimiteCredito": 1,
      "valorMaiorAcumulo": 1,
      "dataMaiorFatura": "2026-05-08",
      "dataPrimeiraCompra": "2026-05-08",
      "dataCadastro": "2026-05-08",
      "valorTotalFaturado": 1,
      "prazoMedioVendas": "text",
      "clienteCentralizador": 1,
      "cnpjClienteCentralizador": "text",
      "codSubRamoAtiv": 1,
      "codBacen": 1,
      "enderecoEntrega": [
        {
          "sequencia": 1,
          "localEntrega": "text",
          "endereco": "text",
          "bairro": "text",
          "numero": "text",
          "cep": "text",
          "cidade": "text",
          "estado": "text",
          "complemento": "text",
          "cpfCnpjEntrega": "text",
          "inscEstadual": "text",
          "horario": "text",
          "telefone": "text",
          "email": "text"
        }
      ],
      "dadosCobranca": [
        {
          "codPortador": "text",
          "codTipoCobranca": "text",
          "codCondicaoPagamento": "text"
        }
      ],
      "clienteCompradorPrincipal": [
        {
          "nomeCompraPrincipal": "text",
          "cargoCompraPrincipal": "text",
          "hobbyCompraPrincipal": "text",
          "nascimentoCompraPrincipal": "2026-05-08",
          "familiaProdutoCompraPrincipal": "text",
          "emailCompraPrincipal": "text",
          "telefoneCompraPrincipal": "text",
          "faxCompraPrincipal": "text",
          "celularCompraPrincipal": "text"
        }
      ],
      "clienteCompradores": [
        {
          "sequenciaComprador": 1,
          "nomeComprador": "text",
          "cargoComprador": "text",
          "hobbyComprador": "text",
          "nascimentoComprador": "2026-05-08",
          "familiaProduto": "text",
          "emailComprador": "text",
          "telefoneComprador": "text",
          "faxComprador": "text",
          "celularComprador": "text",
          "numWhatsAppComprador": "text"
        }
      ],
      "informacoesComplementares": [
        {
          "codAtendente": "text",
          "nomeAtendente": "text"
        }
      ],
      "estruturaComercial": [
        {
          "mascara": "text"
        }
      ],
      "grupoComercial": [
        {
          "clienteAgrupador": 1,
          "clientesAgrupados": [
            {
              "clienteAgrupado": 1
            }
          ]
        }
      ],
      "grupoCNPJ": [
        {
          "clienteAgrupado": 1,
          "cnpjAgrupado": "text"
        }
      ],
      "lucroPresIRPJ": 0,
      "simplesNacional": 0,
      "clienteEquipContri": 0,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar um Cliente

put

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codClienteinteger · máx: 9999999Opcional

Código do Cliente

cpfCnpjstring · mín: 1 · máx: 14Obrigatório

Código do CPF ou CNPJ do Cliente (sem formatação)

nomestring · mín: 1 · máx: 60Obrigatório

Nome do Cliente

codRepresentanteinteger · mín: 1 · máx: 9999Obrigatório

Código do Primeiro Representante

codRepresentante2integer · máx: 9999Opcional

Código do Segundo Representante

codRepresentante3integer · máx: 9999Opcional

Código do Terceiro Representante

codSetorVendainteger · mín: 1 · máx: 999Opcional

Código do Setor de Vendas do Cliente

inscEstadualstring · máx: 17Opcional

Código da Inscrição Estadual do Cliente (sem formatação)

inscSuframastring · máx: 9Opcional

Código da Inscrição Suframa do Cliente (sem formatação)

situacaointeger · enumObrigatório

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Equipara Cliente Contribuinte (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

nomeFantasiastring · máx: 30Opcional

Nome Fantasia do Cliente

codRamoAtividadeinteger · mín: 1 · máx: 99Obrigatório

Código do Ramo de Atividade do Cliente

consumidorFinalinteger · enumObrigatório

Cliente é Consumidor Final? (0-Não, 1-Sim)

Valores possíveis:

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço do Cliente

numerostring · mín: 1 · máx: 10Obrigatório

Número do Endereço do Cliente

complementostring · máx: 30Opcional

Complemento do Endereço do Cliente

bairrostring · mín: 1 · máx: 60Obrigatório

Bairro do Cliente

parecerCreditostring · máx: 9999Opcional

Parecer de Crédito/Cobrança

qualificacaoClientestring · máx: 2Opcional

Qualificação do Cliente

cepstring · mín: 1 · máx: 8Obrigatório

Código do CEP do Cliente (sem formatação)

cidadestring · máx: 60Opcional

Cidade do Cliente

estadostring · mín: 2 · máx: 2Opcional

Estado do Cliente

codIbgestring · mín: 7 · máx: 7Opcional

Código do IBGE do Cliente

emailstring · máx: 100Opcional

E-mail do Cliente ([email protected])

emailNfestring · máx: 100Opcional

E-mail do Cliente para Nota Fiscal Eletrônica ([email protected])

telefonestring · máx: 20Opcional

Telefone do Cliente

faxstring · máx: 20Opcional

Fax do Cliente

telexCelularstring · máx: 20Opcional

Telefone Celular do Cliente

telefoneCobrancastring · máx: 20Opcional

Telefone Cobranca (whatsapp) do Cliente

codSubRamoAtivinteger · máx: 999Opcional

Código do Sub Ramo de Atividade

observacaostring · máx: 70Opcional

Observação do Cadastro do Cliente

Respostas

200

OK

application/json

codEmpresaintegerOpcional

Código da Empresa do Cliente

codClienteintegerOpcional

Código do Cliente

cpfCnpjstringOpcional

Código do CPF ou CNPJ do Cliente

nomestringOpcional

Nome do Cliente

codRepresentanteintegerOpcional

Código do Primeiro Representante

codRepresentante2integerOpcional

Código do Segundo Representante

codRepresentante3integerOpcional

Código do Terceiro Representante

inscEstadualstringOpcional

Código da Inscrição Estadual do Representante

inscSuframastringOpcional

Código da Inscrição Suframa Representante

contatoComprasstringOpcional

Contato de Compras do Cliente

situacaointeger · enumOpcional

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

nomeFantasiastringOpcional

Nome Fantasia do Cliente

codRamoAtividadeintegerOpcional

Código do Ramo de Atividade do Cliente

codSetorVendaintegerOpcional

Código do Setor de venda do Cliente

consumidorFinalinteger · enumOpcional

Cliente é Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

enderecostringOpcional

Endereço do Cliente

numerostringOpcional

Número do Endereço do Cliente

complementostringOpcional

Complemento do Endereço do Cliente

bairrostringOpcional

Bairro do Cliente

cepstringOpcional

Código do CEP do Cliente

cidadestringOpcional

Cidade do Cliente

estadostringOpcional

Estado do Cliente

codIbgestringOpcional

Código do IBGE do Cliente

emailstringOpcional

E-mail do Cliente

emailNfestringOpcional

E-mail do Cliente para envio da Nota Fiscal Eletrônica

telefonestringOpcional

Telefone do Cliente

telefoneCobrancastringOpcional

Telefone de Cobrança do Cliente

faxstringOpcional

Fax do Cliente

telexCelularstringOpcional

Telefone Celular do Cliente

observacaostringOpcional

Observação do Cadastro do Cliente

aliqIcmsstringOpcional

Aliquota de ICMS da UF do Cliente [Deprecado]

percAliqICMSnumberOpcional

Aliquota de ICMS da UF do Cliente

valorLimiteCreditonumberOpcional

Valor do Limite de Crédito do Cliente

valorMaiorAcumulonumberOpcional

Valor Maior Acumulado do Cliente

dataMaiorFaturastring · dateOpcional

Data da Maior Fatura do Cliente

dataPrimeiraComprastring · dateOpcional

Data da Primeira Compra do Cliente

dataCadastrostring · dateOpcional

Data do Cadastro do Cliente

valorTotalFaturadonumberOpcional

Valor Total já Faturado do Cliente

prazoMedioVendasstringOpcional

Prazo médio de Vendas do Cliente

clienteCentralizadorintegerOpcional

Código do Cliente Centralizador

cnpjClienteCentralizadorstringOpcional

Código do CNPJ do Cliente Centralizador

codSubRamoAtivintegerOpcional

Sub Ramo de Atividade

codBacenintegerOpcional

Código do Bacen

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/cliente

HTTPcURLJavaScriptPython

PUT /cadastrosgerais/v10/cliente HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1644

{
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "codSetorVenda": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "situacao": 1,
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "parecerCredito": "text",
  "qualificacaoCliente": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "fax": "text",
  "telexCelular": "text",
  "telefoneCobranca": "text",
  "codSubRamoAtiv": 1,
  "observacao": "text",
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "contatoCompras": "text",
  "situacao": 1,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "codSetorVenda": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "telefoneCobranca": "text",
  "fax": "text",
  "telexCelular": "text",
  "observacao": "text",
  "aliqIcms": "text",
  "percAliqICMS": 1,
  "valorLimiteCredito": 1,
  "valorMaiorAcumulo": 1,
  "dataMaiorFatura": "2026-05-08",
  "dataPrimeiraCompra": "2026-05-08",
  "dataCadastro": "2026-05-08",
  "valorTotalFaturado": 1,
  "prazoMedioVendas": "text",
  "clienteCentralizador": 1,
  "cnpjClienteCentralizador": "text",
  "codSubRamoAtiv": 1,
  "codBacen": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "dadosCobranca": [
    {
      "codPortador": "text",
      "codTipoCobranca": "text",
      "codCondicaoPagamento": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "informacoesComplementares": [
    {
      "codAtendente": "text",
      "nomeAtendente": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "grupoComercial": [
    {
      "clienteAgrupador": 1,
      "clientesAgrupados": [
        {
          "clienteAgrupado": 1
        }
      ]
    }
  ],
  "grupoCNPJ": [
    {
      "clienteAgrupado": 1,
      "cnpjAgrupado": "text"
    }
  ],
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter um Cliente

get

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

codEmpresaintegerOpcional

Código da Empresa do Cliente

codClienteintegerOpcional

Código do Cliente

cpfCnpjstringOpcional

Código do CPF ou CNPJ do Cliente

nomestringOpcional

Nome do Cliente

codRepresentanteintegerOpcional

Código do Primeiro Representante

codRepresentante2integerOpcional

Código do Segundo Representante

codRepresentante3integerOpcional

Código do Terceiro Representante

inscEstadualstringOpcional

Código da Inscrição Estadual do Representante

inscSuframastringOpcional

Código da Inscrição Suframa Representante

contatoComprasstringOpcional

Contato de Compras do Cliente

situacaointeger · enumOpcional

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

nomeFantasiastringOpcional

Nome Fantasia do Cliente

codRamoAtividadeintegerOpcional

Código do Ramo de Atividade do Cliente

codSetorVendaintegerOpcional

Código do Setor de venda do Cliente

consumidorFinalinteger · enumOpcional

Cliente é Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

enderecostringOpcional

Endereço do Cliente

numerostringOpcional

Número do Endereço do Cliente

complementostringOpcional

Complemento do Endereço do Cliente

bairrostringOpcional

Bairro do Cliente

cepstringOpcional

Código do CEP do Cliente

cidadestringOpcional

Cidade do Cliente

estadostringOpcional

Estado do Cliente

codIbgestringOpcional

Código do IBGE do Cliente

emailstringOpcional

E-mail do Cliente

emailNfestringOpcional

E-mail do Cliente para envio da Nota Fiscal Eletrônica

telefonestringOpcional

Telefone do Cliente

telefoneCobrancastringOpcional

Telefone de Cobrança do Cliente

faxstringOpcional

Fax do Cliente

telexCelularstringOpcional

Telefone Celular do Cliente

observacaostringOpcional

Observação do Cadastro do Cliente

aliqIcmsstringOpcional

Aliquota de ICMS da UF do Cliente [Deprecado]

percAliqICMSnumberOpcional

Aliquota de ICMS da UF do Cliente

valorLimiteCreditonumberOpcional

Valor do Limite de Crédito do Cliente

valorMaiorAcumulonumberOpcional

Valor Maior Acumulado do Cliente

dataMaiorFaturastring · dateOpcional

Data da Maior Fatura do Cliente

dataPrimeiraComprastring · dateOpcional

Data da Primeira Compra do Cliente

dataCadastrostring · dateOpcional

Data do Cadastro do Cliente

valorTotalFaturadonumberOpcional

Valor Total já Faturado do Cliente

prazoMedioVendasstringOpcional

Prazo médio de Vendas do Cliente

clienteCentralizadorintegerOpcional

Código do Cliente Centralizador

cnpjClienteCentralizadorstringOpcional

Código do CNPJ do Cliente Centralizador

codSubRamoAtivintegerOpcional

Sub Ramo de Atividade

codBacenintegerOpcional

Código do Bacen

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/cliente/{id}

HTTPcURLJavaScriptPython

GET /cadastrosgerais/v10/cliente/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codEmpresa": 1,
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "contatoCompras": "text",
  "situacao": 1,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "codSetorVenda": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "telefoneCobranca": "text",
  "fax": "text",
  "telexCelular": "text",
  "observacao": "text",
  "aliqIcms": "text",
  "percAliqICMS": 1,
  "valorLimiteCredito": 1,
  "valorMaiorAcumulo": 1,
  "dataMaiorFatura": "2026-05-08",
  "dataPrimeiraCompra": "2026-05-08",
  "dataCadastro": "2026-05-08",
  "valorTotalFaturado": 1,
  "prazoMedioVendas": "text",
  "clienteCentralizador": 1,
  "cnpjClienteCentralizador": "text",
  "codSubRamoAtiv": 1,
  "codBacen": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "dadosCobranca": [
    {
      "codPortador": "text",
      "codTipoCobranca": "text",
      "codCondicaoPagamento": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "informacoesComplementares": [
    {
      "codAtendente": "text",
      "nomeAtendente": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "grupoComercial": [
    {
      "clienteAgrupador": 1,
      "clientesAgrupados": [
        {
          "clienteAgrupado": 1
        }
      ]
    }
  ],
  "grupoCNPJ": [
    {
      "clienteAgrupado": 1,
      "cnpjAgrupado": "text"
    }
  ],
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualizar um Cliente

put

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codClienteinteger · máx: 9999999Opcional

Código do Cliente

cpfCnpjstring · mín: 1 · máx: 14Obrigatório

Código do CPF ou CNPJ do Cliente (sem formatação)

nomestring · mín: 1 · máx: 60Obrigatório

Nome do Cliente

codRepresentanteinteger · mín: 1 · máx: 9999Obrigatório

Código do Primeiro Representante

codRepresentante2integer · máx: 9999Opcional

Código do Segundo Representante

codRepresentante3integer · máx: 9999Opcional

Código do Terceiro Representante

codSetorVendainteger · mín: 1 · máx: 999Opcional

Código do Setor de Vendas do Cliente

inscEstadualstring · máx: 17Opcional

Código da Inscrição Estadual do Cliente (sem formatação)

inscSuframastring · máx: 9Opcional

Código da Inscrição Suframa do Cliente (sem formatação)

situacaointeger · enumObrigatório

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Equipara Cliente Contribuinte (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

nomeFantasiastring · máx: 30Opcional

Nome Fantasia do Cliente

codRamoAtividadeinteger · mín: 1 · máx: 99Obrigatório

Código do Ramo de Atividade do Cliente

consumidorFinalinteger · enumObrigatório

Cliente é Consumidor Final? (0-Não, 1-Sim)

Valores possíveis:

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço do Cliente

numerostring · mín: 1 · máx: 10Obrigatório

Número do Endereço do Cliente

complementostring · máx: 30Opcional

Complemento do Endereço do Cliente

bairrostring · mín: 1 · máx: 60Obrigatório

Bairro do Cliente

parecerCreditostring · máx: 9999Opcional

Parecer de Crédito/Cobrança

qualificacaoClientestring · máx: 2Opcional

Qualificação do Cliente

cepstring · mín: 1 · máx: 8Obrigatório

Código do CEP do Cliente (sem formatação)

cidadestring · máx: 60Opcional

Cidade do Cliente

estadostring · mín: 2 · máx: 2Opcional

Estado do Cliente

codIbgestring · mín: 7 · máx: 7Opcional

Código do IBGE do Cliente

emailstring · máx: 100Opcional

E-mail do Cliente ([email protected])

emailNfestring · máx: 100Opcional

E-mail do Cliente para Nota Fiscal Eletrônica ([email protected])

telefonestring · máx: 20Opcional

Telefone do Cliente

faxstring · máx: 20Opcional

Fax do Cliente

telexCelularstring · máx: 20Opcional

Telefone Celular do Cliente

telefoneCobrancastring · máx: 20Opcional

Telefone Cobranca (whatsapp) do Cliente

codSubRamoAtivinteger · máx: 999Opcional

Código do Sub Ramo de Atividade

observacaostring · máx: 70Opcional

Observação do Cadastro do Cliente

Respostas

200

OK

application/json

codEmpresaintegerOpcional

Código da Empresa do Cliente

codClienteintegerOpcional

Código do Cliente

cpfCnpjstringOpcional

Código do CPF ou CNPJ do Cliente

nomestringOpcional

Nome do Cliente

codRepresentanteintegerOpcional

Código do Primeiro Representante

codRepresentante2integerOpcional

Código do Segundo Representante

codRepresentante3integerOpcional

Código do Terceiro Representante

inscEstadualstringOpcional

Código da Inscrição Estadual do Representante

inscSuframastringOpcional

Código da Inscrição Suframa Representante

contatoComprasstringOpcional

Contato de Compras do Cliente

situacaointeger · enumOpcional

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

nomeFantasiastringOpcional

Nome Fantasia do Cliente

codRamoAtividadeintegerOpcional

Código do Ramo de Atividade do Cliente

codSetorVendaintegerOpcional

Código do Setor de venda do Cliente

consumidorFinalinteger · enumOpcional

Cliente é Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

enderecostringOpcional

Endereço do Cliente

numerostringOpcional

Número do Endereço do Cliente

complementostringOpcional

Complemento do Endereço do Cliente

bairrostringOpcional

Bairro do Cliente

cepstringOpcional

Código do CEP do Cliente

cidadestringOpcional

Cidade do Cliente

estadostringOpcional

Estado do Cliente

codIbgestringOpcional

Código do IBGE do Cliente

emailstringOpcional

E-mail do Cliente

emailNfestringOpcional

E-mail do Cliente para envio da Nota Fiscal Eletrônica

telefonestringOpcional

Telefone do Cliente

telefoneCobrancastringOpcional

Telefone de Cobrança do Cliente

faxstringOpcional

Fax do Cliente

telexCelularstringOpcional

Telefone Celular do Cliente

observacaostringOpcional

Observação do Cadastro do Cliente

aliqIcmsstringOpcional

Aliquota de ICMS da UF do Cliente [Deprecado]

percAliqICMSnumberOpcional

Aliquota de ICMS da UF do Cliente

valorLimiteCreditonumberOpcional

Valor do Limite de Crédito do Cliente

valorMaiorAcumulonumberOpcional

Valor Maior Acumulado do Cliente

dataMaiorFaturastring · dateOpcional

Data da Maior Fatura do Cliente

dataPrimeiraComprastring · dateOpcional

Data da Primeira Compra do Cliente

dataCadastrostring · dateOpcional

Data do Cadastro do Cliente

valorTotalFaturadonumberOpcional

Valor Total já Faturado do Cliente

prazoMedioVendasstringOpcional

Prazo médio de Vendas do Cliente

clienteCentralizadorintegerOpcional

Código do Cliente Centralizador

cnpjClienteCentralizadorstringOpcional

Código do CNPJ do Cliente Centralizador

codSubRamoAtivintegerOpcional

Sub Ramo de Atividade

codBacenintegerOpcional

Código do Bacen

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/cliente/{id}

HTTPcURLJavaScriptPython

PUT /cadastrosgerais/v10/cliente/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1644

{
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "codSetorVenda": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "situacao": 1,
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "parecerCredito": "text",
  "qualificacaoCliente": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "fax": "text",
  "telexCelular": "text",
  "telefoneCobranca": "text",
  "codSubRamoAtiv": 1,
  "observacao": "text",
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "contatoCompras": "text",
  "situacao": 1,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "codSetorVenda": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "telefoneCobranca": "text",
  "fax": "text",
  "telexCelular": "text",
  "observacao": "text",
  "aliqIcms": "text",
  "percAliqICMS": 1,
  "valorLimiteCredito": 1,
  "valorMaiorAcumulo": 1,
  "dataMaiorFatura": "2026-05-08",
  "dataPrimeiraCompra": "2026-05-08",
  "dataCadastro": "2026-05-08",
  "valorTotalFaturado": 1,
  "prazoMedioVendas": "text",
  "clienteCentralizador": 1,
  "cnpjClienteCentralizador": "text",
  "codSubRamoAtiv": 1,
  "codBacen": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "dadosCobranca": [
    {
      "codPortador": "text",
      "codTipoCobranca": "text",
      "codCondicaoPagamento": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "informacoesComplementares": [
    {
      "codAtendente": "text",
      "nomeAtendente": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "grupoComercial": [
    {
      "clienteAgrupador": 1,
      "clientesAgrupados": [
        {
          "clienteAgrupado": 1
        }
      ]
    }
  ],
  "grupoCNPJ": [
    {
      "clienteAgrupado": 1,
      "cnpjAgrupado": "text"
    }
  ],
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir um Cliente

delete

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/cliente/{id}

HTTPcURLJavaScriptPython

DELETE /cadastrosgerais/v10/cliente/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Automação de Limite de Crédito de Cliente

post

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/cliente/limite

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

cnpjCpfstringObrigatório

Código do CPF/CNPJ

valorLimiteCreditonumberOpcional

Valor do Limite de Crédito

usuariostringOpcional

Código do Usuário do Limite

dataVencimentostring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

Respostas

200

OK

401

Unauthorized

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/cliente/limite

HTTPcURLJavaScriptPython

POST /cadastrosgerais/v10/cliente/limite HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "cnpjCpf": "text",
  "valorLimiteCredito": 1,
  "usuario": "text",
  "dataVencimento": "2026-05-08",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Sem conteúdo