{
"success": true,
"data": {
"id": "limit_123456789",
"userId": "user_abc123",
"category": "Alimentação",
"limitAmount": 1000.00,
"period": "monthly",
"isActive": true,
"isRecurring": false,
"periodStart": null,
"createdAt": "2024-11-04T15:30:00Z",
"updatedAt": "2024-11-04T15:30:00Z"
},
"message": "Spending limit created successfully for Alimentação",
"timestamp": "2024-11-04T15:30:00Z"
}
Spending Limits
Create Spending Limit
Cria um novo limite de gastos personalizado para uma categoria específica. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano (Basic: 0 limites, Pro: 2 limites, Premium: 5 limites).
POST
/
tools
/
api
/
create-spending-limit
{
"success": true,
"data": {
"id": "limit_123456789",
"userId": "user_abc123",
"category": "Alimentação",
"limitAmount": 1000.00,
"period": "monthly",
"isActive": true,
"isRecurring": false,
"periodStart": null,
"createdAt": "2024-11-04T15:30:00Z",
"updatedAt": "2024-11-04T15:30:00Z"
},
"message": "Spending limit created successfully for Alimentação",
"timestamp": "2024-11-04T15:30:00Z"
}
Este endpoint cria um novo alerta de gastos para monitorar uma categoria específica em um período definido.
Descrição
O endpointPOST /tools/api/create-spending-limit permite criar alertas de gastos personalizados para categorias específicas. O usuário será notificado quando atingir 50%, 75% e 100% do limite configurado.
Autenticação
Este endpoint requer autenticação via Bearer token.string
required
Bearer token com a API key do usuário. Formato:
Bearer sk-your-api-key-hereParâmetros de Query
string
required
Parâmetro interno para indicar requisições via MCP. Use
s=s para requisições MCP.Body Parameters
string
required
Nome da categoria a ser monitorada (ex: “Alimentação”, “Transporte”, “Lazer”)
number
required
Valor limite em BRL. Deve ser um número positivo.
string
required
Período do alerta. Valores válidos:
daily, weekly, biweekly, monthlyResposta
Sucesso (200)
{
"success": true,
"data": {
"id": "limit_123456789",
"userId": "user_abc123",
"category": "Alimentação",
"limitAmount": 1000.00,
"period": "monthly",
"isActive": true,
"isRecurring": false,
"periodStart": null,
"createdAt": "2024-11-04T15:30:00Z",
"updatedAt": "2024-11-04T15:30:00Z"
},
"message": "Spending limit created successfully for Alimentação",
"timestamp": "2024-11-04T15:30:00Z"
}
Erro de Validação (400)
{
"error": "Invalid or missing category",
"message": "Category must be a non-empty string"
}
{
"error": "Invalid or missing limitAmount",
"message": "limitAmount must be a positive number"
}
{
"error": "Invalid or missing period",
"message": "period must be one of: daily, weekly, monthly"
}
Erro de Autenticação (401)
{
"error": "Invalid or inactive API key",
"message": "Please check your API key and try again",
"type": "invalid_api_key"
}
Erro de Quota Excedida (403)
{
"error": "Quota exceeded",
"message": "Plano FREE: 3/3 alertas utilizados. Limite atingido! Faça upgrade para criar mais alertas.",
"success": false
}
Campos da Resposta
boolean
required
Indica se a requisição foi bem-sucedida
object
required
Objeto com os dados do alerta criado
Show Spending Limit Object
Show Spending Limit Object
string
required
Identificador único do alerta criado
string
required
ID do usuário proprietário do alerta
string
required
Categoria de gasto monitorada
number
required
Valor limite configurado em BRL
string
required
Período do alerta:
daily, weekly, biweekly, ou monthlyboolean
required
Se o alerta está ativo (sempre
true na criação)boolean
required
Se o alerta se renova automaticamente
string
Data de início do período (null se começar imediatamente)
string
required
Data de criação do alerta (ISO 8601)
string
required
Data da última atualização (ISO 8601)
string
required
Mensagem de confirmação da criação
string
required
Timestamp da requisição em formato ISO 8601
Exemplos de Uso
cURL
# Criar alerta mensal para Alimentação
curl -X POST 'https://www.pierre.finance/tools/api/create-spending-limit' \
-H 'Authorization: Bearer sk-your-api-key-here' \
-H 'Content-Type: application/json' \
-d '{
"category": "Alimentação",
"limitAmount": 1000,
"period": "monthly"
}'
# Criar alerta semanal para Transporte
curl -X POST 'https://www.pierre.finance/tools/api/create-spending-limit' \
-H 'Authorization: Bearer sk-your-api-key-here' \
-H 'Content-Type: application/json' \
-d '{
"category": "Transporte",
"limitAmount": 300,
"period": "weekly"
}'
JavaScript
const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';
async function createSpendingLimit(category, limitAmount, period) {
const response = await fetch(`${BASE_URL}/create-spending-limit`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({ category, limitAmount, period })
});
return await response.json();
}
// Exemplos de uso
createSpendingLimit('Alimentação', 1000, 'monthly');
createSpendingLimit('Transporte', 300, 'weekly');
createSpendingLimit('Lazer', 500, 'biweekly');
Python
import requests
API_KEY = 'sk-your-api-key-here'
BASE_URL = 'https://www.pierre.finance/tools/api'
headers = {
'Authorization': f'Bearer {API_KEY}',
'Content-Type': 'application/json'
}
def create_spending_limit(category, limit_amount, period):
data = {
'category': category,
'limitAmount': limit_amount,
'period': period
}
response = requests.post(f'{BASE_URL}/create-spending-limit',
headers=headers, json=data)
return response.json()
# Exemplos de uso
limit = create_spending_limit('Alimentação', 1000, 'monthly')
limit = create_spending_limit('Transporte', 300, 'weekly')
limit = create_spending_limit('Lazer', 500, 'biweekly')
Códigos de Status
200: Sucesso - Alerta criado400: Parâmetros inválidos401: Erro de autenticação ou assinatura403: Quota excedida - limite de alertas atingido500: Erro interno do servidor
Períodos Disponíveis
daily: Alerta renovado diariamente às 00:00 UTCweekly: Alerta renovado semanalmente às segundas-feiras 00:00 UTCbiweekly: Alerta renovado a cada duas semanasmonthly: Alerta renovado mensalmente no dia 1º às 00:00 UTC
Limites por Plano
- FREE: 3 alertas de gastos
- PRO: 10 alertas de gastos
- PREMIUM: 30 alertas de gastos
Os alertas enviam notificações automáticas quando você atinge 50%, 75% e 100% do limite configurado. Use categorias consistentes com as suas transações para melhor precisão.
Para criar alertas que começam no próximo período (e não imediatamente), use o endpoint
confirm-spending-limit com o parâmetro startNextPeriod.Authorizations
API key in Bearer token format. Example: Bearer sk-your-api-key-here
Body
application/json
The body is of type any.