example-data.com
Menu
Browse docs and collections

Overview

invoices / #238

invoices #238

fromUserId
Sheridan Turcotte @sheridan.turcotte
toUserId
Colby Kovacek @colby_kovacek40
invoiceNumber
INV-2024-0238
status
paid
issuedAt
dueAt
paidAt
subtotal
29672.46
tax
5934.49
total
35606.95
currency
CAD
lineItems
              [
  {
    "description": "Design work",
    "quantity": 2,
    "unitPrice": 142.81,
    "lineTotal": 285.62
  },
  {
    "description": "Research services",
    "quantity": 29,
    "unitPrice": 149.23,
    "lineTotal": 4327.67
  },
  {
    "description": "Quality assurance",
    "quantity": 2,
    "unitPrice": 453.95,
    "lineTotal": 907.9
  },
  {
    "description": "System integration",
    "quantity": 19,
    "unitPrice": 62.32,
    "lineTotal": 1184.08
  },
  {
    "description": "Design work",
    "quantity": 34,
    "unitPrice": 336.87,
    "lineTotal": 11453.58
  },
  {
    "description": "Marketing services",
    "quantity": 27,
    "unitPrice": 426.43,
    "lineTotal": 11513.61
  }
]
createdAt

Component variants

Related

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 238,
  "fromUserId": 153,
  "toUserId": 85,
  "invoiceNumber": "INV-2024-0238",
  "status": "paid",
  "issuedAt": "2024-09-29T02:27:03.488Z",
  "dueAt": "2024-11-20T02:27:03.488Z",
  "paidAt": "2024-10-16T17:37:25.190Z",
  "subtotal": 29672.46,
  "tax": 5934.49,
  "total": 35606.95,
  "currency": "CAD",
  "lineItems": [
    {
      "description": "Design work",
      "quantity": 2,
      "unitPrice": 142.81,
      "lineTotal": 285.62
    },
    {
      "description": "Research services",
      "quantity": 29,
      "unitPrice": 149.23,
      "lineTotal": 4327.67
    },
    {
      "description": "Quality assurance",
      "quantity": 2,
      "unitPrice": 453.95,
      "lineTotal": 907.9
    },
    {
      "description": "System integration",
      "quantity": 19,
      "unitPrice": 62.32,
      "lineTotal": 1184.08
    },
    {
      "description": "Design work",
      "quantity": 34,
      "unitPrice": 336.87,
      "lineTotal": 11453.58
    },
    {
      "description": "Marketing services",
      "quantity": 27,
      "unitPrice": 426.43,
      "lineTotal": 11513.61
    }
  ],
  "createdAt": "2024-09-28T07:22:13.962Z"
}