Representante

representante

Obter listagem de Representantes

get

/representante

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

situacaointeger[]Opcional

Situações do Representante (1-Fisica, 2-Juridica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)

continuationTokenstringOpcional

Identificador da paginação da consulta

paginacaointegerOpcional

Quantidade de itens na paginação de retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/representante

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

{
  "continuationToken": "text",
  "data": [
    {
      "codEmpresa": 1,
      "codRepresentante": 1,
      "cpfCnpj": "text",
      "nome": "text",
      "situacao": 1,
      "endereco": "text",
      "bairro": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "codIbge": "text",
      "telefone": "text",
      "telefoneCelular": "text",
      "contato": "text",
      "tipoComissao": 1,
      "percComissao": 1,
      "email": "text",
      "dataAdmissao": "text",
      "dataDesligamento": "text",
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar um Representante

put

/representante

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codRepresentanteinteger · máx: 9999Opcional

Código do Representante (1 / 124 / 45)

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

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

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

Nome do Representante

situacaointeger · enumObrigatório

Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)

Valores possíveis:

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

Endereço do Representante (Rua / Logradouro)

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

Bairro do Representante

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

CEP do Representante (sem formatação)

cidadestring · máx: 60Opcional

Cidade do Representante

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

Estado do Representante

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

Código do IBGE do Representante

telefonestring · máx: 20Opcional

Telefone do Representante

telefoneCelularstring · máx: 20Opcional

Telefone Celular do Representante

contatostring · máx: 30Opcional

Contato do Representante

tipoComissaointeger · enumObrigatório

Código do Tipo de Comissão (1-Produto, 2-Representante, 3-Condição de Venda 1 Sequencia, 4-Condição de Venda 2 Sequencia, 5-Condição de Venda 3 Sequencia, 6-Tabela de Preço)

Valores possíveis:

percComissaonumber · máx: 99.99Opcional

Percentual de Comissão do Representante (5.00%)

emailstring · máx: 60Opcional

E-mail do Representante

dataAdmissaostring · dateObrigatório

Data de Admissão do Representante (YYYY-MM-DD)

dataDesligamentostring · dateOpcional

Data de Desligamento do Representante (YYYY-MM-DD)

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/representante

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

{
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "situacao": 1,
  "endereco": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "telefone": "text",
  "telefoneCelular": "text",
  "contato": "text",
  "tipoComissao": 1,
  "percComissao": 1,
  "email": "text",
  "dataAdmissao": "2025-11-28",
  "dataDesligamento": "2025-11-28",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "situacao": 1,
  "endereco": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "telefone": "text",
  "telefoneCelular": "text",
  "contato": "text",
  "tipoComissao": 1,
  "percComissao": 1,
  "email": "text",
  "dataAdmissao": "text",
  "dataDesligamento": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter um Representante

get

/representante/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Representante

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/representante/{id}

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

{
  "codEmpresa": 1,
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "situacao": 1,
  "endereco": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "telefone": "text",
  "telefoneCelular": "text",
  "contato": "text",
  "tipoComissao": 1,
  "percComissao": 1,
  "email": "text",
  "dataAdmissao": "text",
  "dataDesligamento": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualizar um Representante

put

/representante/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Representante

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codRepresentanteinteger · máx: 9999Opcional

Código do Representante (1 / 124 / 45)

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

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

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

Nome do Representante

situacaointeger · enumObrigatório

Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)

Valores possíveis:

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

Endereço do Representante (Rua / Logradouro)

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

Bairro do Representante

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

CEP do Representante (sem formatação)

cidadestring · máx: 60Opcional

Cidade do Representante

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

Estado do Representante

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

Código do IBGE do Representante

telefonestring · máx: 20Opcional

Telefone do Representante

telefoneCelularstring · máx: 20Opcional

Telefone Celular do Representante

contatostring · máx: 30Opcional

Contato do Representante

tipoComissaointeger · enumObrigatório

Código do Tipo de Comissão (1-Produto, 2-Representante, 3-Condição de Venda 1 Sequencia, 4-Condição de Venda 2 Sequencia, 5-Condição de Venda 3 Sequencia, 6-Tabela de Preço)

Valores possíveis:

percComissaonumber · máx: 99.99Opcional

Percentual de Comissão do Representante (5.00%)

emailstring · máx: 60Opcional

E-mail do Representante

dataAdmissaostring · dateObrigatório

Data de Admissão do Representante (YYYY-MM-DD)

dataDesligamentostring · dateOpcional

Data de Desligamento do Representante (YYYY-MM-DD)

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/representante/{id}

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

{
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "situacao": 1,
  "endereco": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "telefone": "text",
  "telefoneCelular": "text",
  "contato": "text",
  "tipoComissao": 1,
  "percComissao": 1,
  "email": "text",
  "dataAdmissao": "2025-11-28",
  "dataDesligamento": "2025-11-28",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "situacao": 1,
  "endereco": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "telefone": "text",
  "telefoneCelular": "text",
  "contato": "text",
  "tipoComissao": 1,
  "percComissao": 1,
  "email": "text",
  "dataAdmissao": "text",
  "dataDesligamento": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir um Representante

delete

/representante/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Representante

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/representante/{id}

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

Sem conteúdo

AnteriorEmpresa PróximoClientes

Atualizado há 1 hora

Boa noite

Obter listagem de Representantes

Cadastrar um Representante

Obter um Representante

Atualizar um Representante

Excluir um Representante