invoices
invoices
Page 9 of 13.
Overview
Request
curl example
curl -sS \ "https://example-data.com/api/v1/invoices?limit=25"
JavaScript example
const res = await fetch(
"https://example-data.com/api/v1/invoices?limit=25"
);
const { data, meta } = await res.json(); TypeScript example
// Download once: mkdir -p types && curl -o types/invoices.d.ts https://example-data.com/types/invoices.d.ts
import type { Invoice, ListEnvelope } from "./types/invoices";
const res = await fetch(
"https://example-data.com/api/v1/invoices?limit=25"
);
const { data, meta } = (await res.json()) as ListEnvelope<Invoice>; Python example
import requests
res = requests.get(
"https://example-data.com/api/v1/invoices",
params={"limit": 25},
)
data = res.json() Response
{
"data": [
{
"id": 193,
"fromUserId": 249,
"toUserId": 126,
"invoiceNumber": "INV-2025-0193",
"status": "sent",
"issuedAt": "2025-12-15T02:40:35.736Z",
"dueAt": "2026-02-06T02:40:35.736Z",
"paidAt": null,
"subtotal": 20916.2,
"tax": 1045.81,
"total": 21962.01,
"currency": "GBP",
"lineItems": [
{
"description": "Hardware supply",
"quantity": 37,
"unitPrice": 195.87,
"lineTotal": 7247.19
},
{
"description": "Training session",
"quantity": 9,
"unitPrice": 389.93,
"lineTotal": 3509.37
},
{
"description": "Hardware supply",
"quantity": 38,
"unitPrice": 247.36,
"lineTotal": 9399.68
},
{
"description": "Software development",
"quantity": 6,
"unitPrice": 126.66,
"lineTotal": 759.96
}
],
"createdAt": "2025-12-15T00:49:39.539Z"
},
{
"id": 194,
"fromUserId": 170,
"toUserId": 13,
"invoiceNumber": "INV-2024-0194",
"status": "paid",
"issuedAt": "2024-06-30T17:15:01.591Z",
"dueAt": "2024-07-11T17:15:01.591Z",
"paidAt": "2024-07-04T03:08:30.521Z",
"subtotal": 26549.04,
"tax": 2123.92,
"total": 28672.96,
"currency": "AUD",
"lineItems": [
{
"description": "Documentation",
"quantity": 27,
"unitPrice": 108.01,
"lineTotal": 2916.27
},
{
"description": "Research services",
"quantity": 6,
"unitPrice": 190.51,
"lineTotal": 1143.06
},
{
"description": "Consulting services",
"quantity": 12,
"unitPrice": 335.19,
"lineTotal": 4022.28
},
{
"description": "Data analysis",
"quantity": 19,
"unitPrice": 155.84,
"lineTotal": 2960.96
},
{
"description": "Maintenance contract",
"quantity": 28,
"unitPrice": 37.15,
"lineTotal": 1040.2
},
{
"description": "Technical support",
"quantity": 39,
"unitPrice": 370.93,
"lineTotal": 14466.27
}
],
"createdAt": "2024-06-29T22:51:27.312Z"
},
{
"id": 195,
"fromUserId": 72,
"toUserId": 183,
"invoiceNumber": "INV-2024-0195",
"status": "viewed",
"issuedAt": "2024-11-20T20:31:40.904Z",
"dueAt": "2024-12-17T20:31:40.904Z",
"paidAt": null,
"subtotal": 35596.83,
"tax": 1779.84,
"total": 37376.67,
"currency": "AUD",
"lineItems": [
{
"description": "Training session",
"quantity": 22,
"unitPrice": 466.66,
"lineTotal": 10266.52
},
{
"description": "Design work",
"quantity": 38,
"unitPrice": 293.65,
"lineTotal": 11158.7
},
{
"description": "Technical support",
"quantity": 1,
"unitPrice": 440.53,
"lineTotal": 440.53
},
{
"description": "Training session",
"quantity": 40,
"unitPrice": 72.77,
"lineTotal": 2910.8
},
{
"description": "Project management",
"quantity": 4,
"unitPrice": 338.72,
"lineTotal": 1354.88
},
{
"description": "Accounting services",
"quantity": 20,
"unitPrice": 473.27,
"lineTotal": 9465.4
}
],
"createdAt": "2024-11-20T00:01:00.546Z"
}
],
"meta": {
"page": 9,
"limit": 24,
"total": 300,
"totalPages": 13
},
"links": {
"self": "/api/v1/invoices?page=9&limit=24",
"first": "/api/v1/invoices?page=1&limit=24",
"last": "/api/v1/invoices?page=13&limit=24",
"next": "/api/v1/invoices?page=10&limit=24",
"prev": "/api/v1/invoices?page=8&limit=24"
}
}