Endpoint responsável por listar cobranças com resposta resumida, utilizando filtros de consulta.

Essa chamada permite recuperar cobranças já criadas e aplicar filtros por cliente, status, forma de pagamento, período e outros critérios operacionais.

Parâmetros principais da requisição

Alguns filtros são especialmente úteis para rotinas de consulta e conciliação:

• offset: Elemento inicial da lista paginada.

• limit: Quantidade máxima de elementos retornados por página. O valor máximo permitido é 100.

• customer: Filtra pelo identificador único do cliente.

• customerGroupName: Filtra pelo nome do grupo de clientes.

• billingType: Filtra pela forma de pagamento:

  • UNDEFINED
  • BOLETO
  • CREDIT_CARD
  • PIX

• status: Filtra pelo status da cobrança.

• subscription: Filtra pelo identificador da assinatura vinculada.

• installment: Filtra pelo identificador do parcelamento.

• externalReference: Filtra pelo identificador da cobrança no seu sistema.

• paymentDate: Filtra pela data de pagamento.

• invoiceStatus: Filtra cobranças de acordo com o status da nota fiscal vinculada. Os valores possíveis incluem:

  • SCHEDULED
  • AUTHORIZED
  • PROCESSING_CANCELLATION
  • CANCELED
  • CANCELLATION_DENIED
  • ERROR

• estimatedCreditDate: Filtra pela data estimada de crédito.

• pixQrCodeId: Filtra cobranças originadas de um QR Code estático.

• anticipated: Filtra cobranças antecipadas ou não.

• anticipable: Filtra cobranças antecipáveis ou não.

• dateCreated[ge] / dateCreated[le]: Intervalo de data de criação.

• paymentDate[ge] / paymentDate[le]: Intervalo de data de pagamento.

• estimatedCreditDate[ge] / estimatedCreditDate[le]: Intervalo de data estimada de crédito.

• dueDate[ge] / dueDate[le]: Intervalo de data de vencimento.

• user: Filtra pelo e-mail do usuário que criou a cobrança.

• checkoutSession: Filtra pelo identificador único do checkout.

Comportamento da listagem

• O retorno é paginado.
• A consulta pode ser usada tanto para busca operacional quanto para relatórios.
• Requisições GET não devem conter body.

Quando utilizar

Utilize este endpoint quando for necessário:

• listar cobranças com resposta resumida
• consultar cobranças por cliente, status ou período
• implementar telas administrativas, filtros e rotinas de conciliação

Próximo passo no fluxo

Após localizar a cobrança desejada, sua aplicação pode:

• recuperar uma cobrança específica
• atualizar a cobrança
• excluir ou restaurar registros, quando aplicável
• executar ações específicas como confirmação manual de pagamento