curl --location 'https://api.stateset.com/v1/invoices/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30' \
--header 'Authorization: Bearer YOUR_API_KEY'
const invoice = await stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
);
invoice = stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
)
{
"id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"object": "invoice",
"invoice_number": "INV-2024-0001",
"status": "sent",
"customer_id": "cust_abc123",
"customer": {
"id": "cust_abc123",
"name": "Acme Corporation",
"email": "billing@acme.com"
},
"issue_date": "2024-01-19",
"due_date": "2024-02-18",
"currency": "USD",
"subtotal": 649500,
"tax_amount": 48000,
"discount_amount": 0,
"total_amount": 697500,
"amount_paid": 0,
"amount_due": 697500,
"line_items": [
{
"id": "li_123456",
"description": "Professional Services - January 2024",
"quantity": 40,
"unit_price": 15000,
"amount": 600000,
"tax_rate": 0.08,
"tax_amount": 48000,
"account_code": "4000"
},
{
"id": "li_123457",
"description": "Software License",
"quantity": 5,
"unit_price": 9900,
"amount": 49500,
"product_id": "prod_xyz789",
"tax_rate": 0,
"tax_amount": 0,
"account_code": "4100"
}
],
"billing_address": {
"line1": "123 Business St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"payment_terms": "Net 30",
"notes": "Thank you for your business!",
"created_at": "2024-01-19T10:00:00Z",
"sent_at": "2024-01-19T10:01:00Z",
"viewed_at": "2024-01-19T14:30:00Z",
"pdf_url": "https://invoices.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30.pdf",
"public_url": "https://pay.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"metadata": {
"po_number": "PO-12345",
"project_code": "PROJ-2024-001"
}
}
Retrieve a specific invoice by ID
GET
/
v1
/
invoices
/
:id
curl --location 'https://api.stateset.com/v1/invoices/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30' \
--header 'Authorization: Bearer YOUR_API_KEY'
const invoice = await stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
);
invoice = stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
)
{
"id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"object": "invoice",
"invoice_number": "INV-2024-0001",
"status": "sent",
"customer_id": "cust_abc123",
"customer": {
"id": "cust_abc123",
"name": "Acme Corporation",
"email": "billing@acme.com"
},
"issue_date": "2024-01-19",
"due_date": "2024-02-18",
"currency": "USD",
"subtotal": 649500,
"tax_amount": 48000,
"discount_amount": 0,
"total_amount": 697500,
"amount_paid": 0,
"amount_due": 697500,
"line_items": [
{
"id": "li_123456",
"description": "Professional Services - January 2024",
"quantity": 40,
"unit_price": 15000,
"amount": 600000,
"tax_rate": 0.08,
"tax_amount": 48000,
"account_code": "4000"
},
{
"id": "li_123457",
"description": "Software License",
"quantity": 5,
"unit_price": 9900,
"amount": 49500,
"product_id": "prod_xyz789",
"tax_rate": 0,
"tax_amount": 0,
"account_code": "4100"
}
],
"billing_address": {
"line1": "123 Business St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"payment_terms": "Net 30",
"notes": "Thank you for your business!",
"created_at": "2024-01-19T10:00:00Z",
"sent_at": "2024-01-19T10:01:00Z",
"viewed_at": "2024-01-19T14:30:00Z",
"pdf_url": "https://invoices.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30.pdf",
"public_url": "https://pay.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"metadata": {
"po_number": "PO-12345",
"project_code": "PROJ-2024-001"
}
}
This endpoint retrieves detailed information about a specific invoice including line items, payments, and status.
Authentication
This endpoint requires a valid API key withinvoices:read permissions.
Authorization: Bearer YOUR_API_KEY
Path Parameters
string
required
The unique identifier of the invoice
Query Parameters
array
Expand related objects. Options: “customer”, “payments”, “credit_notes”, “events”
Response
string
Unique invoice identifier
string
Object type, always “invoice”
string
Human-readable invoice number
string
Invoice status: “draft”, “sent”, “viewed”, “partially_paid”, “paid”, “overdue”, “voided”
integer
Total invoice amount in cents
integer
Outstanding amount in cents
array
Array of invoice line items
curl --location 'https://api.stateset.com/v1/invoices/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30' \
--header 'Authorization: Bearer YOUR_API_KEY'
const invoice = await stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
);
invoice = stateset.invoices.retrieve(
'inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30'
)
{
"id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"object": "invoice",
"invoice_number": "INV-2024-0001",
"status": "sent",
"customer_id": "cust_abc123",
"customer": {
"id": "cust_abc123",
"name": "Acme Corporation",
"email": "billing@acme.com"
},
"issue_date": "2024-01-19",
"due_date": "2024-02-18",
"currency": "USD",
"subtotal": 649500,
"tax_amount": 48000,
"discount_amount": 0,
"total_amount": 697500,
"amount_paid": 0,
"amount_due": 697500,
"line_items": [
{
"id": "li_123456",
"description": "Professional Services - January 2024",
"quantity": 40,
"unit_price": 15000,
"amount": 600000,
"tax_rate": 0.08,
"tax_amount": 48000,
"account_code": "4000"
},
{
"id": "li_123457",
"description": "Software License",
"quantity": 5,
"unit_price": 9900,
"amount": 49500,
"product_id": "prod_xyz789",
"tax_rate": 0,
"tax_amount": 0,
"account_code": "4100"
}
],
"billing_address": {
"line1": "123 Business St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"payment_terms": "Net 30",
"notes": "Thank you for your business!",
"created_at": "2024-01-19T10:00:00Z",
"sent_at": "2024-01-19T10:01:00Z",
"viewed_at": "2024-01-19T14:30:00Z",
"pdf_url": "https://invoices.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30.pdf",
"public_url": "https://pay.stateset.com/inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
"metadata": {
"po_number": "PO-12345",
"project_code": "PROJ-2024-001"
}
}
⌘I