# List Invoices Retrieve a paginated list of invoices with optional filtering and sorting. ## Request ### Headers ### Query Parameters ## Response ### Success (200 OK) ```json { "success": true, "data": { "items": [ { "invoiceId": "inv_a1b2c3d4e5f6g7h8", "invoiceNumber": "INV-2024-0001", "customerId": "cust_a1b2c3d4e5f6g7h8", "customerEmail": "john@example.com", "customerName": "John Doe", "currency": "USD", "status": "SENT", "issueDate": "2024-01-15T00:00:00.000Z", "dueDate": "2024-02-15T00:00:00.000Z", "totalAmount": 275.00, "amountPaid": 0, "amountDue": 275.00, "createdAt": "2024-01-15T10:30:00.000Z", "updatedAt": "2024-01-15T10:30:00.000Z" } ], "total": 1, "page": 1, "limit": 20, "totalPages": 1 }, "message": "Invoices retrieved successfully", "error": null, "meta": { "request_id": "req_xxxxx", "timestamp": "2024-01-15T10:30:00.000Z", "processing_time_ms": 40, "api_version": "v1", "endpoint": "GET /invoices", "user_type": "merchant" } } ``` ### Error Responses ## Examples ```bash curl -X GET "https://api.zenpayz.com/merchant/api/v1/invoices?status=SENT&page=1&limit=20" \ -H "Authorization: Bearer zp_test_xxxxx" \ -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \ -H "X-Signature: a1b2c3d4e5f6..." \ -H "X-Secret-Salt: your_secret_salt" \ -H "Content-Type: application/json" ``` ```javascript const params = new URLSearchParams({ status: 'SENT', page: '1', limit: '20', }); const response = await fetch(`https://api.zenpayz.com/merchant/api/v1/invoices?${params}`, { method: 'GET', headers: { 'Authorization': `Bearer ${apiKey}`, 'X-Timestamp': timestamp, 'X-Signature': signature, 'X-Secret-Salt': secretSalt, 'Content-Type': 'application/json', }, }); const result = await response.json(); console.log(result.data.items); // Array of invoices console.log(result.data.total); // Total count ``` ```javascript const invoices = await zenpays.invoices.list({ status: 'SENT', page: 1, limit: 20, }); console.log(invoices.items); // Array of invoices console.log(invoices.total); // Total count ``` ## Related Endpoints - [Create Invoice](/docs/rest-api/endpoints/billing/invoices/create-invoice) - [Get Invoice](/docs/rest-api/endpoints/billing/invoices/get-invoice) - [Invoice Analytics](/docs/rest-api/endpoints/billing/invoices/invoice-analytics)