List invoices

GET

https://api.agentpaid.io/api/v2/invoices/

GET

/api/v2/invoices/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.invoices.listInvoices({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "inv_9f8b7c6d5e4a3b2c1d0e",
5       "customerId": "cust_0987654321fedcba",
6       "status": "posted",
7       "paymentStatus": "partiallyPaid",
8       "source": "order_based",
9       "startDate": "2024-01-01T00:00:00Z",
10       "issueDate": "2024-02-01T10:00:00Z",
11       "currency": "USD",
12       "taxAmount": 15.75,
13       "taxRate": 7.5,
14       "taxStatus": "calculated",
15       "invoiceTotalExcludingTax": 210,
16       "invoiceTotal": 225.75,
17       "amountDue": 75.75,
18       "amountPaid": 150,
19       "amountRemaining": 75.75,
20       "creditNotesTotal": 0,
21       "createdAt": "2024-01-15T09:30:00Z",
22       "updatedAt": "2024-02-05T14:45:00Z",
23       "taxExempt": false,
24       "displayNumber": "INV-2024-00123",
25       "orderId": "ord_1234567890abcdef",
26       "endDate": "2024-01-31T23:59:59Z",
27       "postedDate": "2024-02-02T12:00:00Z",
28       "dueDate": "2024-02-15T23:59:59Z",
29       "metadata": {
30         "project": "Website Redesign",
31         "notes": "Partial payment received"
32       },
33       "paymentLink": "https://pay.agentpaid.io/invoice/inv_9f8b7c6d5e4a3b2c1d0e/pay",
34       "disputeLink": "https://support.agentpaid.io/disputes/inv_9f8b7c6d5e4a3b2c1d0e",
35       "publicUrlToken": "a1b2c3d4e5f6g7h8i9j0",
36       "billingContactId": "contact_abcdef1234567890"
37     }
38   ],
39   "pagination": {
40     "limit": 10,
41     "offset": 0,
42     "total": 125,
43     "hasMore": true
44   }
45 }

Get a list of invoices for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error