The Invoice object
Create, customize, and send a Kitchen.co-hosted invoices. Add line items, tax rates, and discounts to your invoices. Accept payments through platforms like Stripe, PayPal, and more.
Attributes
archived_at
nullable string
Time at which the invoice was archived.
amount
nullable number
The amount in to be charged.
billing_profile
nullable string
ID of the invoice billing profile.
charge_automatically
boolean
Whether the invoice will charge the customer automatically when it is due.
client
nullable string
ID of the invoice client user.
created_at
string
Time at which the invoice was created.
creator
string
ID of the invoice creator user.
currency
string
Three-letter ISO currency code.
discount_amount
number
Total discount amount of the invoice.
discounts
associative array
Discounts applied to the invoice.
due_date
nullable string
Time at which the invoice is due.
due_date_in_days
nullable number
The days in which the invoice will be due after it is finalized.
due_reminder_message
nullable string
Message that will be sent with the due reminder.
due_reminder_send_date
nullable string
Time at which the due reminder will be sent.
due_reminder_send_days
nullable string
Number of days indicating how many days before or after the invoice due is the reminder sent.
due_reminder_sent_at
nullable string
Time at which the due reminder has been sent.
file
nullable string
URL of the file when invoice is external.
finalized_at
nullable string
Time at which the invoice has been finalized.
footer_notes
nullable string
Footer notes of the invoice.
id
string
Unique identifier for the invoice.
is_external
boolean
Whether the invoice is external.
issue_date
nullable string
Time at which the invoice was issued.
items
associative array
Line items of the invoice
language
string
Language of the invoice.
marked_uncollectible_at
nullable string
Time at which the invoice was marked as uncollectible.
memo
nullable string
Memo of the invoice.
meta
nullable string
Meta info of the invoice.
number
string
The unique invoice number.
paid_at
nullable string
Time at which the invoice was paid.
payment_gateways
enum
Payment gateways which will be available as payment options on checkout screen. Will be displayed only if configured. One of
credit_card, stripe_ach, paypal, bank.recurring_invoice
nullable string
When created from recurring invoice, this is the unique identifier.
status
enum
The status of the invoice. One of
draft, open, paid, void, outstanding, uncollectible.tax_items
associative array
Tax items of the invoice
tax_amount
number
Total tax amount of the invoice.
total_amount
number
Total amount of the invoice.
type
enum
The type of the invoice. One of
invoice, recurring.updated_at
string
Time at which the invoice was last updated.
voided_at
nullable string
Time at which the invoice was voided.
visibility
enum
Visibility of the conversation. One of
private, internal, shared.The Invoice object
{
"archived_at": null,
"amount": 675.65,
"billing_profile": "bp_0123bc88a70c86ed9d1feb73",
"charge_automatically": false,
"client": "u_62988d0392da49247a831d35",
"created_at": "2024-03-13T09:16:53+00:00",
"creator": "u_c13cc0aee4b5af7a42951898",
"currency": "USD",
"discount_amount": 341.47,
"discounts": [
{
"amount": 50.54,
"currency": "USD",
"id": "invti_81c4288ef04117d38e29b22c",
"title": "The discount item title",
"type": "percentage"
}
],
"due_date": "2024-07-20T23:59:59+00:00",
"due_date_in_days": 8,
"due_reminder_message": "The reminder message",
"due_reminder_send_date": "1982-07-22T00:00:00+00:00",
"due_reminder_send_days": 2,
"due_reminder_sent_at": null,
"file": null,
"finalized_at": null,
"footer_notes": null,
"id": "in_31d435a7f94fd8d87c36ecfd",
"is_external": false,
"issue_date": "2024-07-12T00:00:00+00:00",
"items": [
{
"amount": 675.65,
"currency": "USD",
"description": "The invoice item description",
"id": "invi_ac3074df0d1c309d12624399",
"quantity": "1.00",
"title": "The invoice item title"
}
],
"language": "en_US",
"marked_uncollectible_at": null,
"memo": null,
"meta": null,
"number": "PREFIX-00018",
"paid_at": null,
"payment_gateways": [],
"recurring_invoice": null,
"status": "paid",
"tax_items": [
{
"amount": 46.3,
"currency": "USD",
"id": "invti_e5d2b8e5d9a4017b84c95b47",
"title": "The tax item title"
}
],
"tax_amount": 154.73,
"total_amount": 488.91,
"type": "invoice",
"updated_at": "2024-03-13T09:16:53+00:00",
"voided_at": null,
"visibility": "shared"
}