List bills
Returns all bills for the authenticated company. Optionally filter by status.
Notes:
- When
statusis omitted, all bills are returned. - Bills are credit card invoices; amounts are in BRL.
idis absent for future/projected bills.
curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/bills?status=CLOSED" \
-H "Content-Type: application/json" \
-H "Signature-Input: example_string" \
-H "Signature: example_string" \
-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",
"Signature-Input": "example_string",
"Signature": "example_string",
"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",
"Signature-Input": "example_string",
"Signature": "example_string",
"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("Signature-Input", "example_string")
req.Header.Set("Signature", "example_string")
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['Signature-Input'] = 'example_string'
request['Signature'] = 'example_string'
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.
Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
Bearer TOKENFilter bills by status. When omitted, all bills are returned.
What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.
The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
Query Parameters
Filter bills by status. When omitted, all bills are returned.
CLOSEDOPENFUTUREOVERDUEEXPIREDHeaders
What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.
The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.
Responses
Bill identifier. Absent for future/cached bills.
Bill due date (YYYY-MM-DD).
Closing (cut) date; used for ordering (YYYY-MM-DD).
Total bill amount (BRL).
Remaining amount to pay (BRL).
Bill status. CLOSED awaiting payment; OPEN spending period in progress; FUTURE projected; OVERDUE past due; EXPIRED expired.
CLOSEDOPENFUTUREOVERDUEEXPIREDPayment status. PARTIAL_PAID is deprecated.
PENDINGPAIDPAID_AT_LEAST_MINIMUMPAID_LESS_THAN_MINIMUMPAID_WITH_INSTALLMENT_PLANEXPIREDPARTIAL_PAIDWhether the bill has been fully paid.