> For the complete documentation index, see [llms.txt](https://ajuda.financeiro.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.financeiro.app/api/parceiros/endpoints-disponiveis.md).

# Endpoints disponíveis

Esta é a visão resumida dos endpoints públicos da API para parceiros do [**Falcon Finanças**](https://falcon.financeiro.app).

## Autenticação

| Método | Endpoint             | Descrição                                     |
| ------ | -------------------- | --------------------------------------------- |
| `POST` | `/api/v1/auth/login` | Autentica o parceiro e retorna os tokens JWT. |

## Clientes

| Método   | Endpoint                                 | Descrição                                                              |
| -------- | ---------------------------------------- | ---------------------------------------------------------------------- |
| `GET`    | `/api/v1/parceiros/clientes`             | Lista os clientes vinculados, com filtros opcionais por nome e e-mail. |
| `DELETE` | `/api/v1/parceiros/clientes/{idCliente}` | Inativa o vínculo do cliente com o parceiro.                           |

## Planos

| Método | Endpoint                                       | Descrição                                        |
| ------ | ---------------------------------------------- | ------------------------------------------------ |
| `GET`  | `/api/v1/parceiros/clientes/plano/{idCliente}` | Consulta o plano atribuído ao cliente.           |
| `PUT`  | `/api/v1/parceiros/clientes/plano`             | Atualiza limites e recursos do plano do cliente. |

A referência OpenAPI vinculada ao GitBook apresenta os parâmetros, exemplos, modelos e respostas gerados diretamente pelo contrato publicado.

## POST /api/v1/auth/login

> Realiza o login do usuário e retorna um token JWT.

```json
{"openapi":"3.1.1","info":{"title":"Falcon API para Parceiros","version":"v1"},"tags":[{"name":"Autenticação","description":"Obtenha o token JWT utilizado nas chamadas protegidas."}],"servers":[{"url":"https://api.financeiro.app","description":"Producao"}],"paths":{"/api/v1/auth/login":{"post":{"tags":["Autenticação"],"summary":"Realiza o login do usuário e retorna um token JWT.","operationId":"partnerLogin","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequestDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/LoginRequestDTO"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/LoginRequestDTO"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/LoginResultDTOApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/LoginResultDTOApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/LoginResultDTOApiResultDTO"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}}}}}},"components":{"schemas":{"LoginRequestDTO":{"required":["email","password"],"type":"object","properties":{"email":{"minLength":1,"type":"string","description":"Nome do usuário"},"password":{"minLength":1,"type":"string","description":"Senha do usuário"}},"additionalProperties":false},"LoginResultDTOApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"$ref":"#/components/schemas/LoginResultDTO"}},"additionalProperties":false},"LoginResultDTO":{"type":"object","properties":{"accessToken":{"type":["null","string"],"description":"Token de acesso JWT com validade de 1 hora"},"refreshToken":{"type":["null","string"],"description":"Token de atualização JWT com validade de 7 dias"},"expiresAt":{"type":"string","description":"Data e hora de expiração do token de acesso em UTC","format":"date-time"}},"additionalProperties":false},"StringApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","string"]}},"additionalProperties":false}}}}
```

## GET /api/v1/parceiros/clientes

> Retorna os clientes desse parceiro.

```json
{"openapi":"3.1.1","info":{"title":"Falcon API para Parceiros","version":"v1"},"tags":[{"name":"Clientes","description":"Consulte e administre os clientes vinculados ao parceiro."}],"servers":[{"url":"https://api.financeiro.app","description":"Producao"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Autenticação JWT usando o esquema Bearer. Exemplo: \"Authorization: Bearer {token}\"","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClienteDTOListApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ClienteDTO"}}},"additionalProperties":false},"ClienteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"nome":{"type":["null","string"]},"email":{"type":["null","string"]}},"additionalProperties":false},"StringApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","string"]}},"additionalProperties":false}}},"paths":{"/api/v1/parceiros/clientes":{"get":{"tags":["Clientes"],"summary":"Retorna os clientes desse parceiro.","operationId":"listPartnerClients","parameters":[{"name":"nome","in":"query","schema":{"type":"string"}},{"name":"email","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ClienteDTOListApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/ClienteDTOListApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/ClienteDTOListApiResultDTO"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}}}}}}}
```

## GET /api/v1/parceiros/clientes/plano/{idCliente}

> Retorna o plano do cliente de um parceiro.

```json
{"openapi":"3.1.1","info":{"title":"Falcon API para Parceiros","version":"v1"},"tags":[{"name":"Planos","description":"Consulte e atualize os limites e recursos dos clientes."}],"servers":[{"url":"https://api.financeiro.app","description":"Producao"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Autenticação JWT usando o esquema Bearer. Exemplo: \"Authorization: Bearer {token}\"","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"VinculoPlanoDTOApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"$ref":"#/components/schemas/VinculoPlanoDTO"}},"additionalProperties":false},"VinculoPlanoDTO":{"type":"object","properties":{"idCliente":{"type":"integer","format":"int32"},"qtdLancamento":{"type":["null","integer"],"format":"int32"},"qtdAnexo":{"type":["null","integer"],"format":"int32"},"qtdFornecedor":{"type":["null","integer"],"format":"int32"},"qtdUsuario":{"type":["null","integer"],"format":"int32"},"qtdEmpresa":{"type":["null","integer"],"format":"int32"},"agenda":{"type":["null","string"]},"recibo":{"type":["null","string"]},"importacao":{"type":["null","string"]},"fluxoCaixa":{"type":["null","string"]},"cartaoCredito":{"type":["null","string"]},"controleAcesso":{"type":["null","string"]},"orcamento":{"type":["null","string"]},"integracao":{"type":["null","string"]},"boleto":{"type":["null","string"]},"dataValidade":{"type":["null","string"],"format":"date"}},"additionalProperties":false},"StringApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","string"]}},"additionalProperties":false}}},"paths":{"/api/v1/parceiros/clientes/plano/{idCliente}":{"get":{"tags":["Planos"],"summary":"Retorna o plano do cliente de um parceiro.","operationId":"getPartnerClientPlan","parameters":[{"name":"idCliente","in":"path","description":"ID do cliente","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}}}}}}}
```

## PUT /api/v1/parceiros/clientes/plano

> Atualiza o plano do cliente de um parceiro.

```json
{"openapi":"3.1.1","info":{"title":"Falcon API para Parceiros","version":"v1"},"tags":[{"name":"Planos","description":"Consulte e atualize os limites e recursos dos clientes."}],"servers":[{"url":"https://api.financeiro.app","description":"Producao"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Autenticação JWT usando o esquema Bearer. Exemplo: \"Authorization: Bearer {token}\"","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"VinculoPlanoDTO":{"type":"object","properties":{"idCliente":{"type":"integer","format":"int32"},"qtdLancamento":{"type":["null","integer"],"format":"int32"},"qtdAnexo":{"type":["null","integer"],"format":"int32"},"qtdFornecedor":{"type":["null","integer"],"format":"int32"},"qtdUsuario":{"type":["null","integer"],"format":"int32"},"qtdEmpresa":{"type":["null","integer"],"format":"int32"},"agenda":{"type":["null","string"]},"recibo":{"type":["null","string"]},"importacao":{"type":["null","string"]},"fluxoCaixa":{"type":["null","string"]},"cartaoCredito":{"type":["null","string"]},"controleAcesso":{"type":["null","string"]},"orcamento":{"type":["null","string"]},"integracao":{"type":["null","string"]},"boleto":{"type":["null","string"]},"dataValidade":{"type":["null","string"],"format":"date"}},"additionalProperties":false},"VinculoPlanoDTOApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"$ref":"#/components/schemas/VinculoPlanoDTO"}},"additionalProperties":false},"StringApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","string"]}},"additionalProperties":false}}},"paths":{"/api/v1/parceiros/clientes/plano":{"put":{"tags":["Planos"],"summary":"Atualiza o plano do cliente de um parceiro.","operationId":"updatePartnerClientPlan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTO"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTO"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}}}}}}}
```

## DELETE /api/v1/parceiros/clientes/{idCliente}

> Inativa o vinculo de um cliente de um parceiro.

```json
{"openapi":"3.1.1","info":{"title":"Falcon API para Parceiros","version":"v1"},"tags":[{"name":"Clientes","description":"Consulte e administre os clientes vinculados ao parceiro."}],"servers":[{"url":"https://api.financeiro.app","description":"Producao"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Autenticação JWT usando o esquema Bearer. Exemplo: \"Authorization: Bearer {token}\"","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"VinculoPlanoDTOApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"$ref":"#/components/schemas/VinculoPlanoDTO"}},"additionalProperties":false},"VinculoPlanoDTO":{"type":"object","properties":{"idCliente":{"type":"integer","format":"int32"},"qtdLancamento":{"type":["null","integer"],"format":"int32"},"qtdAnexo":{"type":["null","integer"],"format":"int32"},"qtdFornecedor":{"type":["null","integer"],"format":"int32"},"qtdUsuario":{"type":["null","integer"],"format":"int32"},"qtdEmpresa":{"type":["null","integer"],"format":"int32"},"agenda":{"type":["null","string"]},"recibo":{"type":["null","string"]},"importacao":{"type":["null","string"]},"fluxoCaixa":{"type":["null","string"]},"cartaoCredito":{"type":["null","string"]},"controleAcesso":{"type":["null","string"]},"orcamento":{"type":["null","string"]},"integracao":{"type":["null","string"]},"boleto":{"type":["null","string"]},"dataValidade":{"type":["null","string"],"format":"date"}},"additionalProperties":false},"StringApiResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":["null","string"]},"data":{"type":["null","string"]}},"additionalProperties":false}}},"paths":{"/api/v1/parceiros/clientes/{idCliente}":{"delete":{"tags":["Clientes"],"summary":"Inativa o vinculo de um cliente de um parceiro.","operationId":"deactivatePartnerClient","parameters":[{"name":"idCliente","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/VinculoPlanoDTOApiResultDTO"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/StringApiResultDTO"}}}}}}}}}
```