> 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/portador.md).

# Portador

portador

## GET /portador

> Obter Listagem de Portadores

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"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":{"ListaPortadores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador":{"get":{"tags":["Portador"],"summary":"Obter Listagem de Portadores","operationId":"ObterPortadores","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/ListaPortadores"}}}},"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 /portador

> Cadastrar um Portador

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"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":{"PortadorPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador":{"put":{"tags":["Portador"],"summary":"Cadastrar um Portador","operationId":"CadastrarPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Portador","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortadorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"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 /portador/{id}

> Obter um Portador

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"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":{"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador/{id}":{"get":{"tags":["Portador"],"summary":"Obter um Portador","operationId":"ObterPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"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 /portador/{id}

> Atualizar um Portador

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"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":{"PortadorPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador/{id}":{"put":{"tags":["Portador"],"summary":"Atualizar um Portador","operationId":"AtualizarPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Portador","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortadorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"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 /portador/{id}

> Excluir um Portador

```json
{"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"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":{"/portador/{id}":{"delete":{"tags":["Portador"],"summary":"Excluir um Portador","operationId":"ExcluirPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","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
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/portador.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.