Get invoice lines

GET

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

GET

/api/v2/invoices/:id/lines

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.getInvoiceLines("id", {});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "invline-9f8b7c6d5a4e3f21",
5       "orderId": "order-1234567890abcdef",
6       "orderLineId": "line-0987654321fedcba",
7       "orderLineAttributeId": "attr-1122334455667788",
8       "startDate": "2024-01-15T09:30:00Z",
9       "endDate": "2024-01-15T09:30:00Z",
10       "paymentStatus": "pending",
11       "quantity": 3,
12       "totalPriceBeforeTax": 150,
13       "tax": 22.5,
14       "taxRate": 0.15,
15       "totalPriceAfterTax": 172.5,
16       "currency": "USD",
17       "description": "Consulting services for January 2024",
18       "balanceAmount": 172.5,
19       "creditedAmount": 0,
20       "createdAt": "2024-01-10T14:00:00Z",
21       "updatedAt": "2024-01-12T16:45:00Z"
22     }
23   ],
24   "pagination": {
25     "limit": 10,
26     "offset": 0,
27     "total": 1,
28     "hasMore": false
29   }
30 }

Get the invoice lines for an invoice by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

Response

200

datalist of objects

paginationobject

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error