BillsList bills

List bills

Returns all bills for the authenticated company. Optionally filter by status.

Notes:

  • When status is omitted, all bills are returned.
  • Bills are credit card invoices; amounts are in BRL.
  • id is 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 "Authorization: Bearer YOUR_API_TOKEN"
[
  {
    "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
  }
]
GET
/credit-cards/v1/bills
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN

Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
query
statusstring

Filter bills by status. When omitted, all bills are returned.

Options: CLOSED, OPEN, FUTURE, OVERDUE, EXPIRED
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN

Query Parameters

statusstring

Filter bills by status. When omitted, all bills are returned.

Allowed values:CLOSEDOPENFUTUREOVERDUEEXPIRED

Responses

idstring

Bill identifier. Absent for future/cached bills.

dueDatestring
Required

Bill due date (YYYY-MM-DD).

cutDatestring
Required

Closing (cut) date; used for ordering (YYYY-MM-DD).

totalAmountnumber
Required

Total bill amount (BRL).

amountToPaynumber

Remaining amount to pay (BRL).

statusstring
Required

Bill status. CLOSED awaiting payment; OPEN spending period in progress; FUTURE projected; OVERDUE past due; EXPIRED expired.

Allowed values:CLOSEDOPENFUTUREOVERDUEEXPIRED
paymentStatusstring

Payment status. PARTIAL_PAID is deprecated.

Allowed values:PENDINGPAIDPAID_AT_LEAST_MINIMUMPAID_LESS_THAN_MINIMUMPAID_WITH_INSTALLMENT_PLANEXPIREDPARTIAL_PAID
isFullyPaidboolean

Whether the bill has been fully paid.