An invoice is a document that outlines the details of a transaction between a seller and a buyer. It serves as a formal demand for payment and offers proof of the goods or services that the seller has given to the buyer. Invoices contain invoice items and details about the customer.
With the Invoicing module, you can create and send Speed-hosted invoices directly from the Speed web application or via APIs. This allows you to efficiently manage your invoicing process and collect timely payments from your customers.
{
"id": "in_ll0k8b5omWWyn8",
"object": "invoices",
"currency": "USD",
"customer_id": "cus_ll0k8b4wobOHLF",
"description": null,
"hosted_invoice_url": null,
"status": "DRAFT",
"invoice_amount": 500,
"invoice_amount_paid": 0,
"invoice_due_date": null,
"invoice_pdf": null,
"invoice_number": "INV-DRAFT",
"invoice_emails_cc": [],
"statement_descriptor": null,
"footer": null,
"status_transition": {
"finalized_at": null,
"paid_at": null,
"uncollectible_at": null,
"voided_at": null
},
"invoice_line_items": [
{
"id": "il_ll0k8b7qBN2icu",
"created": 1691393855101,
"modified": 1691393855101,
"name": "Iphone 14",
"currency": null,
"price_id": null,
"quantity": 1,
"unit_amount": 500,
"row_total_amount": 500,
"product_id": null,
"product_images": [],
"type": "custom_line_item"
}
],
"customer": {
"name": "John",
"email": null,
"currency": null,
"billing": {
"address": {
"line1": null,
"line2": null,
"city": null,
"state": null,
"country": null,
"zipcode": null
},
"email": null,
"email_cc": []
},
"shipping": {
"address": {
"line1": null,
"line2": null,
"city": null,
"state": null,
"country": null,
"zipcode": null
},
"name": null,
"email": null,
"phone": null,
"calling_code": null
},
"phone": null,
"calling_code": null
},
"created": 1691393855092,
"modified": 1691393855092
}
Attributes
id string
Unique identifier for the object.
object string
The type of the object indicates to which entity this response belongs.
currency string
This represents the currency of the invoice.
customer_id string
This attribute represents the ID of the customer to which the invoice belongs.
description string
This attribute represents additional information about the invoice.
hosted_invoice_url string
This attribute represents the URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
status string
This attribute indicates the status of the invoice. The invoice is created with draft status by default. Invoice has other statuses such as open, paid and void.
invoice_amount decimal
This attribute represents the amount of the invoice.
invoice_amount_paid decimal
This attribute represents the amount that has been paid for the invoice.
invoice_due_date timestamp
This attribute represents the date when the invoice is due for payment. It is null if no due date is set in the invoice settings.
invoice_pdf string
The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
invoice_number string
This attribute has default value “INV-DRAFT”. It is formed by appending invoice prefix with the sequence number.
invoice_line_items list
The line items that make up the invoice.
customer object
The details of the customer to whom the invoice belongs.
created timestamp
Time at which the invoice was created.
modified timestamp
Time at which the last modification was made.