> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/cadastros-gerais-v1.0/ramo-de-atividade.md).

# Ramo De Atividade

ramoAtividade

## GET /ramoAtividade

> Obter Listagem de Ramos de Atividade

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"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":{"ListaRamosAtividades":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RamoAtividade"}}}},"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"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":{"/ramoAtividade":{"get":{"tags":["Ramo de Atividade"],"summary":"Obter Listagem de Ramos de Atividade","operationId":"ObterRamosAtividades","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRamosAtividades"}}}},"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 /ramoAtividade

> Cadastrar um Ramo de Atividade

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"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":{"RamoAtividadePut":{"required":["nome"],"type":"object","properties":{"codRamoAtiv":{"type":"integer","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ramoAtividade":{"put":{"tags":["Ramo de Atividade"],"summary":"Cadastrar um Ramo de Atividade","operationId":"CadastrarRamoAtividade","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Ramo de Atividade","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividadePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividade"}}}},"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 /ramoAtividade/{codigo}

> Obter um Ramo de Atividade

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"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":{"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"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":{"/ramoAtividade/{codigo}":{"get":{"tags":["Ramo de Atividade"],"summary":"Obter um Ramo de Atividade","operationId":"ObterRamoAtividade","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codigo","in":"path","description":"Código do Ramo de Atividade","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividade"}}}},"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"}}}}}}}}}
```

## POST /ramoAtividade/{codigo}

> Atualizar um Ramo de Atividade

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"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":{"RamoAtividadePost":{"required":["nome"],"type":"object","properties":{"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"codFinalidade":{"type":"integer","description":"Finalidade do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ramoAtividade/{codigo}":{"post":{"tags":["Ramo de Atividade"],"summary":"Atualizar um Ramo de Atividade","operationId":"AtualizarRamoAtividade","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codigo","in":"path","description":"Código do Ramo de Atividade","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Dados do Ramo de Atividade","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividadePost"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividade"}}}},"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 /ramoAtividade/{codigo}

> Excluir Ramo de Atividade

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"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":{"/ramoAtividade/{codigo}":{"delete":{"tags":["Ramo de Atividade"],"summary":"Excluir Ramo de Atividade","operationId":"ExcluirRamoAtividade","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codigo","in":"path","description":"Código do Ramo de Atividade","required":true,"schema":{"type":"integer"}}],"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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/cadastros-gerais-v1.0/ramo-de-atividade.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.