Skip to main content
GET
/
tools
/
api
/
get-bills
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/get-bills \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "bill_123",
      "userId": "usr_123",
      "itemId": "itm_123",
      "accountId": "acc_abc",
      "dueDate": "2024-05-10T00:00:00.000Z",
      "totalAmount": 1523.75,
      "totalAmountCurrencyCode": "BRL",
      "minimumPaymentAmount": 230.00,
      "allowsInstallments": true,
      "createdAt": "2024-05-01T00:00:00.000Z",
      "updatedAt": "2024-05-01T00:00:00.000Z"
    }
  ],
  "count": 1,
  "filters": { "accountId": null, "onlyPastDue": true },
  "timestamp": "2024-05-15T10:30:00Z"
}
Este endpoint retorna faturas de cartão de crédito vencidas (apenas faturas já fechadas e com vencimento passado) do usuário autenticado. É possível filtrar por conta específica usando o parâmetro accountId.

​
Descrição

O endpoint GET /tools/api/get-bills retorna as faturas de cartão de crédito já vencidas. Se accountId for fornecido, retorna apenas as faturas daquela conta; caso contrário, retorna todas as faturas vencidas do usuário.

​
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

​
accountId
string
required
ID da conta de cartão de crédito para filtrar as faturas (opcional)

​
Resposta

​
Sucesso (200)

{
  "success": true,
  "data": [
    {
      "id": "bill_123",
      "userId": "usr_123",
      "itemId": "itm_123",
      "accountId": "acc_abc",
      "dueDate": "2024-05-10T00:00:00.000Z",
      "totalAmount": 1523.75,
      "totalAmountCurrencyCode": "BRL",
      "minimumPaymentAmount": 230.00,
      "allowsInstallments": true,
      "createdAt": "2024-05-01T00:00:00.000Z",
      "updatedAt": "2024-05-01T00:00:00.000Z"
    }
  ],
  "count": 1,
  "filters": { "accountId": null, "onlyPastDue": true },
  "timestamp": "2024-05-15T10:30:00Z"
}

​
Erro de Autenticação/Assinatura (401)

{
  "error": "Invalid or inactive API key",
  "type": "invalid_api_key"
}

​
Erro Interno (500)

{
  "error": "Internal server error"
}

​
Campos da Resposta

​
success
boolean
required
Indica se a requisição foi bem-sucedida
​
data
array
required
Lista de faturas de cartão de crédito vencidas
​
count
number
required
Número de faturas retornadas
​
filters
object
required
Filtros aplicados na consulta
​
timestamp
string
required
Timestamp da requisição em formato ISO 8601

​
Exemplos de Uso

​
cURL

# Todas as faturas vencidas do usuário
curl -X GET 'https://www.pierre.finance/tools/api/get-bills' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Faturas vencidas de uma conta específica
curl -X GET 'https://www.pierre.finance/tools/api/get-bills?accountId=acc_abc' \
  -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 getBills(accountId) {
  const params = new URLSearchParams();
  if (accountId) params.set('accountId', accountId);

  const response = await fetch(`${BASE_URL}/get-bills?${params}`, {
    headers: {
      Authorization: `Bearer ${API_KEY}`,
    },
  });
  return await response.json();
}

// Uso
await getBills();
await getBills('acc_abc');

​
Python

import requests

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

headers = {
    'Authorization': f'Bearer {API_KEY}',
}

def get_bills(account_id=None):
    params = {}
    if account_id:
        params['accountId'] = account_id
    response = requests.get(f'{BASE_URL}/get-bills', headers=headers, params=params)
    return response.json()

# Uso
get_bills()
get_bills('acc_abc')

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
accountId
string

ID da conta de cartão de crédito para filtrar as faturas (opcional)

Response

Lista de faturas de cartão de crédito vencidas

​
success
boolean

Indica se a requisição foi bem-sucedida

Example:

true

​
data
any[]

Lista de faturas de cartão de crédito vencidas

​
count
number

Número de faturas retornadas

Example:

1

​
filters
object

Filtros aplicados na consulta

​
timestamp
string<date-time>

Timestamp da requisição em formato ISO 8601

Example:

"2024-05-15T10:30:00Z"