# Representante

representante

## GET /representante

> Obter listagem de Representantes

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRepresentantes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Representante"}}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (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)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante":{"get":{"tags":["Representante"],"summary":"Obter listagem de Representantes","operationId":"ObterRepresentantes","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situações do Representante (1-Fisica, 2-Juridica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRepresentantes"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## PUT /representante

> Cadastrar um Representante

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RepresentantePut":{"required":["bairro","cep","cpfCnpj","dataAdmissao","endereco","nome","situacao","tipoComissao"],"type":"object","properties":{"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante (1 / 124 / 45)"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Representante (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Representante (Rua / Logradouro)"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Representante"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"CEP do Representante (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Representante"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Representante"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Representante"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Representante"},"contato":{"maxLength":30,"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"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)","enum":[1,2,3,4,5,6]},"percComissao":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante (5.00%)"},"email":{"maxLength":60,"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante (YYYY-MM-DD)","format":"date"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (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)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante":{"put":{"tags":["Representante"],"summary":"Cadastrar um Representante","operationId":"CadastrarRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Representante","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentantePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## GET /representante/{id}

> Obter um Representante

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (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)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"get":{"tags":["Representante"],"summary":"Obter um Representante","operationId":"ObterRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## PUT /representante/{id}

> Atualizar um Representante

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RepresentantePut":{"required":["bairro","cep","cpfCnpj","dataAdmissao","endereco","nome","situacao","tipoComissao"],"type":"object","properties":{"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante (1 / 124 / 45)"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Representante (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Representante (Rua / Logradouro)"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Representante"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"CEP do Representante (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Representante"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Representante"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Representante"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Representante"},"contato":{"maxLength":30,"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"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)","enum":[1,2,3,4,5,6]},"percComissao":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante (5.00%)"},"email":{"maxLength":60,"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante (YYYY-MM-DD)","format":"date"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (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)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"put":{"tags":["Representante"],"summary":"Atualizar um Representante","operationId":"AtualizarRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Representante","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentantePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```

## DELETE /representante/{id}

> Excluir um Representante

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"delete":{"tags":["Representante"],"summary":"Excluir um Representante","operationId":"ExcluirRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/cadastros-gerais-v1.0/representante.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.