Listar faturas
Lista todas as faturas da empresa autenticada. Filtro opcional por status.
Observações:
- Quando
statusé omitido, retorna todas as faturas. - As faturas são faturas de cartão de crédito; os valores estão em BRL.
- O campo
idé ausente para faturas futuras/em cache.
curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
[
{
"id": "9f1c2b34-1234-4a8e-9c0a-7b1d2e3f4a5b",
"dueDate": "2024-10-22",
"cutDate": "2024-10-15",
"totalAmount": 1280.55,
"amountToPay": 1280.55,
"status": "OPEN",
"paymentStatus": "PENDING",
"isFullyPaid": false
}
]
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/credit-cards/v1/bills
Target server for requests. Edit to use your own host.
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Bearer TOKENFiltra as faturas pelo status. Quando omitido, retorna todas as faturas.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Query Parameters
Filtra as faturas pelo status. Quando omitido, retorna todas as faturas.
CLOSEDOPENFUTUREOVERDUEEXPIREDResponses
Identificador da fatura. Ausente para faturas futuras/em cache.
Data de vencimento da fatura (YYYY-MM-DD).
Data de corte; usada para ordenação (YYYY-MM-DD).
Valor total da fatura (BRL).
Valor restante a pagar (BRL).
Status da fatura. CLOSED aguardando pagamento; OPEN período de gastos em curso; FUTURE projeção; OVERDUE em atraso; EXPIRED expirada.
CLOSEDOPENFUTUREOVERDUEEXPIREDStatus do pagamento. PARTIAL_PAID está deprecated.
PENDINGPAIDPAID_AT_LEAST_MINIMUMPAID_LESS_THAN_MINIMUMPAID_WITH_INSTALLMENT_PLANEXPIREDPARTIAL_PAIDIndica se a fatura foi totalmente paga.