example-data.com
Menu
Browse docs and collections

Overview

invoices / #117

invoices #117

fromUserId
Elvis Littel-Vandervort @elvis.littel-vandervort28
toUserId
Sheridan Turcotte @sheridan.turcotte
invoiceNumber
INV-2024-0117
status
paid
issuedAt
dueAt
paidAt
subtotal
19706.33
tax
0
total
19706.33
currency
USD
lineItems
              [
  {
    "description": "Implementation services",
    "quantity": 40,
    "unitPrice": 232.23,
    "lineTotal": 9289.2
  },
  {
    "description": "Documentation",
    "quantity": 29,
    "unitPrice": 69.45,
    "lineTotal": 2014.05
  },
  {
    "description": "Implementation services",
    "quantity": 37,
    "unitPrice": 82.12,
    "lineTotal": 3038.44
  },
  {
    "description": "System integration",
    "quantity": 4,
    "unitPrice": 227.95,
    "lineTotal": 911.8
  },
  {
    "description": "Training session",
    "quantity": 31,
    "unitPrice": 143.64,
    "lineTotal": 4452.84
  }
]
createdAt

Component variants

Related

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 117,
  "fromUserId": 175,
  "toUserId": 153,
  "invoiceNumber": "INV-2024-0117",
  "status": "paid",
  "issuedAt": "2024-12-24T20:17:13.730Z",
  "dueAt": "2025-02-08T20:17:13.730Z",
  "paidAt": "2025-01-04T07:04:51.865Z",
  "subtotal": 19706.33,
  "tax": 0,
  "total": 19706.33,
  "currency": "USD",
  "lineItems": [
    {
      "description": "Implementation services",
      "quantity": 40,
      "unitPrice": 232.23,
      "lineTotal": 9289.2
    },
    {
      "description": "Documentation",
      "quantity": 29,
      "unitPrice": 69.45,
      "lineTotal": 2014.05
    },
    {
      "description": "Implementation services",
      "quantity": 37,
      "unitPrice": 82.12,
      "lineTotal": 3038.44
    },
    {
      "description": "System integration",
      "quantity": 4,
      "unitPrice": 227.95,
      "lineTotal": 911.8
    },
    {
      "description": "Training session",
      "quantity": 31,
      "unitPrice": 143.64,
      "lineTotal": 4452.84
    }
  ],
  "createdAt": "2024-12-24T03:24:30.965Z"
}