Endpoints disponíveis

Esta é a visão resumida dos endpoints públicos da API para parceiros do Falcon Finanças.

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.

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

post

Corpo

application/jsontext/jsonapplication/*+json

emailstring · mín: 1Obrigatório

Nome do usuário

passwordstring · mín: 1Obrigatório

Senha do usuário

Respostas

200

OK

text/plainapplication/jsontext/json

successbooleanOpcional

messagestring · anulávelOpcional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

post/api/v1/auth/login

HTTPcURLJavaScriptPython

POST /api/v1/auth/login HTTP/1.1
Host: api.financeiro.app
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "email": "text",
  "password": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "message": "text",
  "data": {
    "accessToken": "text",
    "refreshToken": "text",
    "expiresAt": "2026-08-07T12:35:14.854Z"
  }
}

Retorna os clientes desse parceiro.

get

Autorizações

Bearer

AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de consulta

nomestringOpcional

emailstringOpcional

Respostas

200

OK

text/plainapplication/jsontext/json

successbooleanOpcional

messagestring · anulávelOpcional

401

Unauthorized

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

get/api/v1/parceiros/clientes

HTTPcURLJavaScriptPython

GET /api/v1/parceiros/clientes HTTP/1.1
Host: api.financeiro.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": [
    {
      "id": 1,
      "nome": "text",
      "email": "text"
    }
  ]
}

Retorna o plano do cliente de um parceiro.

get

Autorizações

Bearer

AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de rota

idClienteinteger · int32Obrigatório

ID do cliente

Respostas

200

OK

text/plainapplication/jsontext/json

successbooleanOpcional

messagestring · anulávelOpcional

401

Unauthorized

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

get/api/v1/parceiros/clientes/plano/{idCliente}

HTTPcURLJavaScriptPython

GET /api/v1/parceiros/clientes/plano/{idCliente} HTTP/1.1
Host: api.financeiro.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "idCliente": 1,
    "qtdLancamento": 1,
    "qtdAnexo": 1,
    "qtdFornecedor": 1,
    "qtdUsuario": 1,
    "qtdEmpresa": 1,
    "agenda": "text",
    "recibo": "text",
    "importacao": "text",
    "fluxoCaixa": "text",
    "cartaoCredito": "text",
    "controleAcesso": "text",
    "orcamento": "text",
    "integracao": "text",
    "boleto": "text",
    "dataValidade": "2026-08-07"
  }
}

Atualiza o plano do cliente de um parceiro.

put

Autorizações

Bearer

AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Corpo

application/jsontext/jsonapplication/*+json

idClienteinteger · int32Opcional

qtdLancamentointeger · int32 · anulávelOpcional

qtdAnexointeger · int32 · anulávelOpcional

qtdFornecedorinteger · int32 · anulávelOpcional

qtdUsuariointeger · int32 · anulávelOpcional

qtdEmpresainteger · int32 · anulávelOpcional

agendastring · anulávelOpcional

recibostring · anulávelOpcional

importacaostring · anulávelOpcional

fluxoCaixastring · anulávelOpcional

cartaoCreditostring · anulávelOpcional

controleAcessostring · anulávelOpcional

orcamentostring · anulávelOpcional

integracaostring · anulávelOpcional

boletostring · anulávelOpcional

dataValidadestring · date · anulávelOpcional

Respostas

200

OK

text/plainapplication/jsontext/json

successbooleanOpcional

messagestring · anulávelOpcional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

put/api/v1/parceiros/clientes/plano

HTTPcURLJavaScriptPython

PUT /api/v1/parceiros/clientes/plano HTTP/1.1
Host: api.financeiro.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "idCliente": 1,
  "qtdLancamento": 1,
  "qtdAnexo": 1,
  "qtdFornecedor": 1,
  "qtdUsuario": 1,
  "qtdEmpresa": 1,
  "agenda": "text",
  "recibo": "text",
  "importacao": "text",
  "fluxoCaixa": "text",
  "cartaoCredito": "text",
  "controleAcesso": "text",
  "orcamento": "text",
  "integracao": "text",
  "boleto": "text",
  "dataValidade": "2026-08-07"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "message": "text",
  "data": {
    "idCliente": 1,
    "qtdLancamento": 1,
    "qtdAnexo": 1,
    "qtdFornecedor": 1,
    "qtdUsuario": 1,
    "qtdEmpresa": 1,
    "agenda": "text",
    "recibo": "text",
    "importacao": "text",
    "fluxoCaixa": "text",
    "cartaoCredito": "text",
    "controleAcesso": "text",
    "orcamento": "text",
    "integracao": "text",
    "boleto": "text",
    "dataValidade": "2026-08-07"
  }
}

Inativa o vinculo de um cliente de um parceiro.

delete

Autorizações

Bearer

AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de rota

idClienteinteger · int32Obrigatório

Respostas

200

OK

text/plainapplication/jsontext/json

successbooleanOpcional

messagestring · anulávelOpcional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

delete/api/v1/parceiros/clientes/{idCliente}

HTTPcURLJavaScriptPython

DELETE /api/v1/parceiros/clientes/{idCliente} HTTP/1.1
Host: api.financeiro.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "idCliente": 1,
    "qtdLancamento": 1,
    "qtdAnexo": 1,
    "qtdFornecedor": 1,
    "qtdUsuario": 1,
    "qtdEmpresa": 1,
    "agenda": "text",
    "recibo": "text",
    "importacao": "text",
    "fluxoCaixa": "text",
    "cartaoCredito": "text",
    "controleAcesso": "text",
    "orcamento": "text",
    "integracao": "text",
    "boleto": "text",
    "dataValidade": "2026-08-07"
  }
}