🧾 Listar Cobranças

Retorna uma lista paginada de todas as cobranças do sistema, permitindo filtragem avançada por cliente, status e datas.

Endpoint: GET /backoffice/charges

---

📥 Parâmetros de Entrada (Query)

Campo	Tipo	Descrição	Exemplo
search	string	Busca por código, cliente (nome/email/doc) ou descrição.	JOÃO SILVA
status_id	integer	Filtra pelo ID do status da cobrança.	1
account_id	integer	Filtra por uma conta bancária específica.	456
client_id	integer	Filtra por um cliente específico.	12
created_from	date	Data inicial de criação (YYYY-MM-DD).	2024-01-01
created_to	date	Data final de criação (YYYY-MM-DD).	2024-01-31
due_from	date	Data inicial de vencimento (YYYY-MM-DD).	2024-05-01
due_to	date	Data final de vencimento (YYYY-MM-DD).	2024-05-31
payment_from	date	Data inicial de pagamento (YYYY-MM-DD).	2024-04-01
payment_to	date	Data final de pagamento (YYYY-MM-DD).	2024-04-30
per_page	integer	Quantidade de registros por página (padrão: 15).	50
payment_method	string	Filtra por método de pagamento (PIX, BOLETO, etc).	PIX
order_by	string	Coluna para ordenação (created_at, due_date, payment_date).	due_date
order_dir	string	Direção da ordenação (asc ou desc).	asc

---

📊 Colunas Disponíveis (Charge Object)

Abaixo estão os principais campos retornados no objeto de cobrança.

Campo	Tipo	Descrição
id	integer	ID único da cobrança no sistema.
value	decimal	Valor original da cobrança.
amount_paid	decimal	Valor total pago (incluindo juros/taxas se houver).
due_date	timestamp	Data de vencimento da cobrança.
payment_date	timestamp	Data em que o pagamento foi confirmado.
payment_method	string	Método de pagamento utilizado ou disponível.
status	object	Status atual (id, title, description).
client	object	Dados do cliente (id, name, document, email).
account	object	Conta bancária favorecida (id, name).
created_at	timestamp	Data de geração da cobrança.
updated_at	timestamp	Data da última alteração de status ou dados.

---

📤 Retorno de Sucesso (200 OK)

{
    "data": [
        {
            "id": 1,
            "value": 150.00,
            "amount_paid": 0.00,
            "due_date": "2024-05-10 23:59:59",
            "payment_date": null,
            "payment_method": "PIX",
            "status": {
                "id": 1,
                "title": "PENDENTE",
                "description": "Aguardando pagamento"
            },
            "client": {
                "id": 10,
                "name": "João da Silva",
                "document": "12345678901",
                "email": "joao@email.com"
            },
            "account": {
                "id": 5,
                "name": "Conta Principal"
            },
            "created_at": "2024-04-17 14:00:00",
            "updated_at": "2024-04-17 14:00:00"
        }
    ],
    "summary": [
        {
            "status": "PAGO",
            "count": 80,
            "total_value": 38000.00,
            "total_paid": 38000.00
        },
        {
            "status": "PENDENTE",
            "count": 40,
            "total_value": 7000.00,
            "total_paid": 0.00
        }
    ]
}

---

❌ Erros Comuns

Código	Descrição
401	Não Autorizado: Token ausente ou inválido.
403	Proibido: Usuário não tem permissão de backoffice.