example-data.com
Menu
Browse docs and collections

Overview

invoices / #144

invoices #144

fromUserId
Antoinette Greenfelder @antoinette_greenfelder61
toUserId
Amari Koch @amari.koch
invoiceNumber
INV-2024-0144
status
sent
issuedAt
dueAt
paidAt
—
subtotal
26039.52
tax
2083.16
total
28122.68
currency
AUD
lineItems
              [
  {
    "description": "Marketing services",
    "quantity": 33,
    "unitPrice": 120.95,
    "lineTotal": 3991.35
  },
  {
    "description": "Design work",
    "quantity": 23,
    "unitPrice": 115.26,
    "lineTotal": 2650.98
  },
  {
    "description": "Implementation services",
    "quantity": 30,
    "unitPrice": 448.24,
    "lineTotal": 13447.2
  },
  {
    "description": "Research services",
    "quantity": 31,
    "unitPrice": 120.81,
    "lineTotal": 3745.11
  },
  {
    "description": "Documentation",
    "quantity": 12,
    "unitPrice": 183.74,
    "lineTotal": 2204.88
  }
]
createdAt

Component variants

Related

Request

curl example 

curl -sS \
  "https://example-data.com/api/v1/invoices/144" \
  -H "Accept: application/json"

JavaScript example 

const res = await fetch(
  "https://example-data.com/api/v1/invoices/144"
);
const invoice = 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 } from "./types/invoices";

const res = await fetch(
  "https://example-data.com/api/v1/invoices/144"
);
const invoice = (await res.json()) as Invoice;

Python example 

import requests

res = requests.get(
    "https://example-data.com/api/v1/invoices/144"
)
invoice = res.json()

Response 

{
  "id": 144,
  "fromUserId": 22,
  "toUserId": 130,
  "invoiceNumber": "INV-2024-0144",
  "status": "sent",
  "issuedAt": "2024-07-26T02:51:17.146Z",
  "dueAt": "2024-08-18T02:51:17.146Z",
  "paidAt": null,
  "subtotal": 26039.52,
  "tax": 2083.16,
  "total": 28122.68,
  "currency": "AUD",
  "lineItems": [
    {
      "description": "Marketing services",
      "quantity": 33,
      "unitPrice": 120.95,
      "lineTotal": 3991.35
    },
    {
      "description": "Design work",
      "quantity": 23,
      "unitPrice": 115.26,
      "lineTotal": 2650.98
    },
    {
      "description": "Implementation services",
      "quantity": 30,
      "unitPrice": 448.24,
      "lineTotal": 13447.2
    },
    {
      "description": "Research services",
      "quantity": 31,
      "unitPrice": 120.81,
      "lineTotal": 3745.11
    },
    {
      "description": "Documentation",
      "quantity": 12,
      "unitPrice": 183.74,
      "lineTotal": 2204.88
    }
  ],
  "createdAt": "2024-07-25T22:10:28.307Z"
}