WebgexERP API
  1. Clientes
WebgexERP API
  • Introdução
  • Padrão de Response
  • Endpoints
    • Cadastros
      • Organização
        • Unidades
          • Unidades
        • Centros de Resultado
          • Centros de Resultado
        • Armazens
          • Armazéns
        • Plano de Contas
          • Plano de Contas
        • Naturezas Financeiras
          • Naturezas Financeiras
        • Itens Contábeis
          • Itens Contábeis
        • Classificações Contábeis
          • Classificações Contábeis
        • Códigos de Remuneração
          • Códigos de Remuneração
      • Pessoas Físicas/Jurídicas
        • Clientes
          • Clientes
            GET
        • Fornecedores
          • Fornecedores
          • Detalhes do Fornecedor
        • Parceiros
          • Parceiros
          • Detalhes do Parceiro
        • Empregados
          • Empregados
          • Detalhes do Empregado
        • Grupos Empresariais
          • Grupos Empresariais
      • Produtos e Serviços
        • Categorias
          • Categorias
        • Produtos
          • Produtos
        • Serviços
          • Serviços
          • Detalhes do Serviço
        • Materiais
          • Materiais
          • Detalhes do Material
        • Produtos Base
          • Produtos Base
          • Detalhes do Produto Base
        • Produtos Variantes
          • Produtos Variantes
        • Kits e Composições
          • Kits e Composições
        • Preços
          • Preços
    • Lançamentos
      • Despesas
        • Despesas
        • Detalhes da Despesa
        • Criar Despesa
        • Folha de Pagamento
      • Documentos Fiscais
        • Notas Fiscais Emitidas
          • Notas Fiscais Emitidas
          • Detalhes da Nota Fiscal Emitida
        • Notas Fiscais ao Consumidor Emitidas
          • Notas Fiscais ao Consumidor Emitidas
          • Detalhes da nota fiscal ao consumidor emitida
        • Cupons Fiscais Emitidos
          • Cupons Fiscais Emitidos
          • Detalhes do Cupom Fiscal Emitido
        • Notas Fiscais de Serviço Emitidas
          • Notas Fiscais de Serviço Emitidas
          • Detalhes da Nota Fiscal de Serviço Emitidas
        • Notas Fiscais de Entrada
          • Notas Fiscais Recebidas
          • Detalhes da Nota fiscal de Entrada
    • Controladoria
      • Contabilidade
        • Lançamentos Contábeis
          • Lançamentos Contábeis
        • Saldos Contábeis
          • Saldos Contábeis
      • Orçamento
        • Orçamento
          • Orçamento
      • Imobilizado
        • Itens de Imobilizado
          • Itens de Imobilizado
    • Financeiro
      • Tesouraria
        • Contas, Caixas e Cartões
          • Contas, Caixas e Cartões
        • Saldos das Contas
          • Saldos das Contas
      • Contas a Pagar
        • Contas a Pagar
          • Contas a Pagar*
      • Contas a Receber
        • Contas a Receber
          • Contas a Receber*
    • Operacional
      • Controle de Estoque
        • Posição de Estoque
          • Posição de Estoque
      • Compras
        • Carteira Pedidos de Compra
          • Carteira Pedidos de Compra
        • Histórico de Compras
          • Histórico de Compras
      • Projetos e Contratos
        • Projetos
          • Projetos
        • Gestão de Projetos
          • Gestão de Projetos
      • Serviços
        • Veículos
          • Veículos
        • Ordens de Serviço Automotivo
          • Ordens de Serviço Automotivo
        • Histórico de Serviços
          • Histórico de Veículos
    • Relatórios
      • Relatórios de Vendas
        • Vendas Detalhadas
    • Configuração
      • Acessos e Auditoria
        • Utilizadores
          • Utilizadores
      • Parametrização
        • Transações
          • Transações*
  1. Clientes

Clientes

GET
/erp-clientes
Recupera os clientes disponíveis no WebgexERP.

Requisição

Authorization
Adicionar parâmetro em header
WGX-API-KEY
Exemplo:
WGX-API-KEY: ********************
Parâmetros de Consulta

Respostas

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/erp-clientes' \
--header 'WGX-API-KEY: <api-key>'
Response Response Example
{
    "status": "OK",
    "date": "2025-08-20T09:20:25.643637",
    "contentType": "application/json",
    "content": [
        {
            "codigo_cliente": 3005,
            "cpf_cnpj": "041.935.493-05",
            "nome_completo": "ANDRE CANTIDIO",
            "nome_fantasia": "ANDRE CANTIDIO",
            "natureza_juridica": "PF",
            "incricao_estadual": "ISENTO",
            "incricao_municipal": "ISENTO",
            "suframa": "",
            "contribuinte_icms": "S",
            "cnae_principal": "",
            "data_nascimento": "1993-08-13",
            "desconto_venda": 0.0,
            "forma_pgto": "",
            "prazo": "1X",
            "codigo_crm1": "",
            "crm1": null,
            "codigo_crm2": "",
            "crm2": null,
            "codigo_crm3": "",
            "crm3": null,
            "codigo_crm4": "",
            "crm4": null,
            "codigo_crm5": "",
            "crm5": null,
            "codigo_crm6": "",
            "crm6": null,
            "rota": "",
            "seq_rota": "0",
            "codigo_vendedor": 0,
            "status": "PD",
            "codigo_pais": "1058",
            "endereco_legal": {
                "cep": "37.640-000",
                "logradouro": "ROD FERNAO DIAS",
                "numero": "SN",
                "complemento": "KM 947 AREA B1",
                "bairro": "DOS PIRES",
                "municipio": "Extrema",
                "estado": "MG",
                "codigo_ibge": "",
                "codigo_pais": "1058"
            },
            "endereco_cobranca": {
                "cep": "37.640-000",
                "logradouro": "ROD FERNAO DIAS",
                "numero": "SN",
                "complemento": "KM 947 AREA B1",
                "bairro": "DOS PIRES",
                "municipio": "Extrema",
                "estado": "MG",
                "codigo_ibge": "",
                "codigo_pais": "1058"
            }
        }
    ],
    "pageNumber": 1,
    "size": 100,
    "totalElements": 1,
    "totalPages": 1,
    "first": true,
    "last": true,
    "success": true
}
Modificado em 2025-08-23 17:06:25
Página anterior
Códigos de Remuneração
Próxima página
Fornecedores
Built with