FaturasListar faturas

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"
[
  {
    "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

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
query
statusstring

Filtra as faturas pelo status. Quando omitido, retorna todas as faturas.

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

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Query Parameters

statusstring

Filtra as faturas pelo status. Quando omitido, retorna todas as faturas.

Allowed values:CLOSEDOPENFUTUREOVERDUEEXPIRED

Responses

idstring

Identificador da fatura. Ausente para faturas futuras/em cache.

dueDatestring
Required

Data de vencimento da fatura (YYYY-MM-DD).

cutDatestring
Required

Data de corte; usada para ordenação (YYYY-MM-DD).

totalAmountnumber
Required

Valor total da fatura (BRL).

amountToPaynumber

Valor restante a pagar (BRL).

statusstring
Required

Status da fatura. CLOSED aguardando pagamento; OPEN período de gastos em curso; FUTURE projeção; OVERDUE em atraso; EXPIRED expirada.

Allowed values:CLOSEDOPENFUTUREOVERDUEEXPIRED
paymentStatusstring

Status do pagamento. PARTIAL_PAID está deprecated.

Allowed values:PENDINGPAIDPAID_AT_LEAST_MINIMUMPAID_LESS_THAN_MINIMUMPAID_WITH_INSTALLMENT_PLANEXPIREDPARTIAL_PAID
isFullyPaidboolean

Indica se a fatura foi totalmente paga.