example-data.com
Menu
Browse docs and collections

Overview

invoices / #126

invoices #126

fromUserId
Joseph Nitzsche @joseph_nitzsche
toUserId
Berniece Medhurst @berniece_medhurst
invoiceNumber
INV-2024-0126
status
sent
issuedAt
dueAt
paidAt
—
subtotal
48836.56
tax
3906.92
total
52743.48
currency
GBP
lineItems
              [
  {
    "description": "Legal review",
    "quantity": 15,
    "unitPrice": 362.6,
    "lineTotal": 5439
  },
  {
    "description": "License fee",
    "quantity": 40,
    "unitPrice": 494.14,
    "lineTotal": 19765.6
  },
  {
    "description": "System integration",
    "quantity": 37,
    "unitPrice": 465.48,
    "lineTotal": 17222.76
  },
  {
    "description": "Research services",
    "quantity": 35,
    "unitPrice": 183.12,
    "lineTotal": 6409.2
  }
]
createdAt

Component variants

Related

Request

curl example 

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

JavaScript example 

const res = await fetch(
  "https://example-data.com/api/v1/invoices/126"
);
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/126"
);
const invoice = (await res.json()) as Invoice;

Python example 

import requests

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

Response 

{
  "id": 126,
  "fromUserId": 196,
  "toUserId": 77,
  "invoiceNumber": "INV-2024-0126",
  "status": "sent",
  "issuedAt": "2024-10-21T10:26:13.884Z",
  "dueAt": "2024-11-01T10:26:13.884Z",
  "paidAt": null,
  "subtotal": 48836.56,
  "tax": 3906.92,
  "total": 52743.48,
  "currency": "GBP",
  "lineItems": [
    {
      "description": "Legal review",
      "quantity": 15,
      "unitPrice": 362.6,
      "lineTotal": 5439
    },
    {
      "description": "License fee",
      "quantity": 40,
      "unitPrice": 494.14,
      "lineTotal": 19765.6
    },
    {
      "description": "System integration",
      "quantity": 37,
      "unitPrice": 465.48,
      "lineTotal": 17222.76
    },
    {
      "description": "Research services",
      "quantity": 35,
      "unitPrice": 183.12,
      "lineTotal": 6409.2
    }
  ],
  "createdAt": "2024-10-21T03:34:16.631Z"
}