example-data.com
Menu
Browse docs and collections

Overview

invoices / #256

invoices #256

fromUserId
Jensen Bashirian @jensen_bashirian
toUserId
Douglas Frami @douglas.frami
invoiceNumber
INV-2024-0256
status
overdue
issuedAt
dueAt
paidAt
subtotal
15844.68
tax
1584.47
total
17429.15
currency
EUR
lineItems
              [
  {
    "description": "Documentation",
    "quantity": 39,
    "unitPrice": 401.94,
    "lineTotal": 15675.66
  },
  {
    "description": "Training session",
    "quantity": 3,
    "unitPrice": 56.34,
    "lineTotal": 169.02
  }
]
            
createdAt

Component variants

Related

Request

curl example

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

JavaScript example

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

Python example

import requests

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

Response

{
  "id": 256,
  "fromUserId": 29,
  "toUserId": 148,
  "invoiceNumber": "INV-2024-0256",
  "status": "overdue",
  "issuedAt": "2024-11-22T05:13:44.969Z",
  "dueAt": "2024-12-11T05:13:44.969Z",
  "paidAt": null,
  "subtotal": 15844.68,
  "tax": 1584.47,
  "total": 17429.15,
  "currency": "EUR",
  "lineItems": [
    {
      "description": "Documentation",
      "quantity": 39,
      "unitPrice": 401.94,
      "lineTotal": 15675.66
    },
    {
      "description": "Training session",
      "quantity": 3,
      "unitPrice": 56.34,
      "lineTotal": 169.02
    }
  ],
  "createdAt": "2024-11-21T17:40:51.844Z"
}