Skip to main content
GET
/
tools
/
api
/
get-installments
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/get-installments \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "summary": {
      "totalAmount": 5000.00,
      "totalInstallments": 12,
      "totalPurchases": 3,
      "installmentDistribution": [
        {
          "totalInstallments": 12,
          "count": 1,
          "totalAmount": 3000.00
        },
        {
          "totalInstallments": 6,
          "count": 2,
          "totalAmount": 2000.00
        }
      ]
    },
    "purchases": [
      {
        "purchaseDate": "2024-01-10",
        "totalAmount": 3000.00,
        "installments": [
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 1,
            "totalInstallments": 12,
            "dueDate": "2024-02-10",
            "category": "Eletrônicos",
            "status": "POSTED"
          },
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 2,
            "totalInstallments": 12,
            "dueDate": "2024-03-10",
            "category": "Eletrônicos",
            "status": "PENDING"
          }
        ]
      },
      {
        "purchaseDate": "2024-01-15",
        "totalAmount": 1200.00,
        "installments": [
          {
            "description": "Compra parcelada - Roupas",
            "amount": 200.00,
            "installmentNumber": 1,
            "totalInstallments": 6,
            "dueDate": "2024-02-15",
            "category": "Roupas",
            "status": "POSTED"
          }
        ]
      }
    ]
  },
  "summary": {
    "totalAmount": 5000.00,
    "totalInstallments": 12,
    "totalPurchases": 3,
    "installmentDistribution": [
      {
        "totalInstallments": 12,
        "count": 1,
        "totalAmount": 3000.00
      },
      {
        "totalInstallments": 6,
        "count": 2,
        "totalAmount": 2000.00
      }
    ]
  },
  "dateRange": {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
Este endpoint retorna informações sobre compras parceladas do usuário autenticado.

​
Descrição

O endpoint GET /tools/api/get-installments retorna informações detalhadas sobre compras parceladas do usuário autenticado. Busca TODAS as parcelas (passadas, atuais e futuras) para compras realizadas dentro do período especificado, incluindo cronograma de pagamentos, valores das parcelas e datas de vencimento.

​
Autenticação

Este endpoint requer autenticação via Bearer token e assinatura ativa.
​
Authorization
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

​
Parâmetros de Query

​
startDate
string
required
Data inicial para filtrar compras parceladas (formato YYYY-MM-DD). Se não fornecido, usa o primeiro dia de 3 meses atrás como padrão.
​
endDate
string
required
Data final para filtrar compras parceladas (formato YYYY-MM-DD). Se não fornecido, usa o último dia do mês atual como padrão.

​
Resposta

​
Sucesso (200)

{
  "success": true,
  "data": {
    "summary": {
      "totalAmount": 5000.00,
      "totalInstallments": 12,
      "totalPurchases": 3,
      "installmentDistribution": [
        {
          "totalInstallments": 12,
          "count": 1,
          "totalAmount": 3000.00
        },
        {
          "totalInstallments": 6,
          "count": 2,
          "totalAmount": 2000.00
        }
      ]
    },
    "purchases": [
      {
        "purchaseDate": "2024-01-10",
        "totalAmount": 3000.00,
        "installments": [
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 1,
            "totalInstallments": 12,
            "dueDate": "2024-02-10",
            "category": "Eletrônicos",
            "status": "POSTED"
          },
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 2,
            "totalInstallments": 12,
            "dueDate": "2024-03-10",
            "category": "Eletrônicos",
            "status": "PENDING"
          }
        ]
      },
      {
        "purchaseDate": "2024-01-15",
        "totalAmount": 1200.00,
        "installments": [
          {
            "description": "Compra parcelada - Roupas",
            "amount": 200.00,
            "installmentNumber": 1,
            "totalInstallments": 6,
            "dueDate": "2024-02-15",
            "category": "Roupas",
            "status": "POSTED"
          }
        ]
      }
    ]
  },
  "summary": {
    "totalAmount": 5000.00,
    "totalInstallments": 12,
    "totalPurchases": 3,
    "installmentDistribution": [
      {
        "totalInstallments": 12,
        "count": 1,
        "totalAmount": 3000.00
      },
      {
        "totalInstallments": 6,
        "count": 2,
        "totalAmount": 2000.00
      }
    ]
  },
  "dateRange": {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Erro de Autenticação (401)

{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}

​
Campos da Resposta

​
success
boolean
required
Indica se a requisição foi bem-sucedida
​
data
object
required
Objeto com os dados das compras parceladas
​
summary
object
required
Resumo geral das compras parceladas (mesmo objeto do data.summary)
​
dateRange
object
required
Período dos dados retornados
​
timestamp
string
required
Timestamp da requisição em formato ISO 8601

​
Exemplos de Uso

​
cURL

# Obter todas as compras parceladas
curl -X GET 'https://www.pierre.finance/tools/api/get-installments' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Obter compras parceladas de um período específico
curl -X GET 'https://www.pierre.finance/tools/api/get-installments?startDate=2024-01-01&endDate=2024-12-31' \
  -H 'Authorization: Bearer sk-your-api-key-here'

​
JavaScript

const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';

async function getInstallments(filters = {}) {
  const params = new URLSearchParams(filters);
  const response = await fetch(`${BASE_URL}/get-installments?${params}`, {
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    }
  });
  
  return await response.json();
}

// Exemplos de uso
getInstallments();
getInstallments({ startDate: '2024-01-01', endDate: '2024-12-31' });

​
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 get_installments(filters=None):
    if filters is None:
        filters = {}
    
    response = requests.get(f'{BASE_URL}/get-installments', 
                          headers=headers, params=filters)
    return response.json()

# Exemplos de uso
installments = get_installments()
installments = get_installments({
    'startDate': '2024-01-01',
    'endDate': '2024-12-31'
})

​
Códigos de Status

  • 200: Sucesso - Dados das compras parceladas retornados
  • 401: Erro de autenticação ou assinatura
  • 500: Erro interno do servidor
Este endpoint retorna TODAS as parcelas (passadas, atuais e futuras) para compras realizadas no período especificado. Para dados mais recentes, use o endpoint de sincronização manual.

Authorizations

​
Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Query Parameters

​
startDate
string<date>

Start date for filtering. Defaults to first day 3 months ago if not provided. Start date for filtering (YYYY-MM-DD format)

​
endDate
string<date>

End date for filtering. Defaults to last day of current month if not provided. End date for filtering (YYYY-MM-DD format)

Response

Installments data and statistics

​
success
boolean
Example:

true

​
data
any
​
summary
any
​
purchases
any[]
​
dateRange
object
​
timestamp
string<date-time>