Invoice
The invoice object contains information held against an invoice record. This includes credit notes, too.
Invoice records in Current include both invoices and credits. Use the type
object to determine whether you’re working with an invoice or credit.
Invoices and credit notes can be created manually, from an opportunity, or from a project. The link between an invoice and its sources is created on each invoice item.
Document layouts
The invoice
object can be accessed in document layouts created against the following modules:
Invoice
Opportunity
Returns invoices linked to a particular opportunity.
Member
Returns invoices linked to a particular organization.
Returns active invoices linked to a particular organization.
Discussion templates
The invoice
object can be accessed in discussion templates created against the following modules:
Invoice
Opportunity
Returns invoices linked to a particular opportunity.
Organization
Returns invoices linked to a particular organization.
Returns active invoices linked to a particular organization.
balance
balance
Returns the invoice balance, i.e. the invoice charge total including tax after any payments or refunds.
Payments logged in Xero, QuickBooks Online, or Sage are not included. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Input
Output
billing_address
billing_address
Returns the invoice billing address.
Input
Output
billing_address_detail
billing_address_detail
Returns address objects for the billing address against the invoice.
Input
Ouput
billing_address_name
billing_address_name
Returns the name of the billing address against the invoice.
Input
Output
charge_excluding_tax_total
charge_excluding_tax_total
Returns the invoice charge total excluding tax.
Input
Output
charge_including_tax_total
charge_including_tax_total
Returns the invoice charge total including tax.
Input
Output
charge_total
charge_total
Returns the invoice charge total.
This may be including or excluding tax depending on the value of the “Catalog Prices” setting in System Preferences.
Input
Output
combined_discount_total
combined_discount_total
Returns the total discount from deal pricing and percentage discounting on the invoice.
Input
Output
deal_discount_total
deal_discount_total
Returns the total discount from deal pricing on the invoice.
Input
Output
delivery_address
delivery_address
Returns the invoice delivery address.
Input
Output
delivery_address_detail
delivery_address_detail
Returns address objects for the delivery address against the invoice.
Input
Ouput
delivery_address_name
delivery_address_name
Returns the name of the delivery address against the invoice.
You may also use the venue object (below).
Input
Output
description
description
Returns the invoice (internal) description.
Input
Output
discount_total
discount_total
Returns the total discount from percentage discounting on the invoice.
Input
Output
due_at
due_at
Returns the date and time that the invoice is due at.
Input
Output
external_description
external_description
Returns the invoice external description.
Input
Output
has_discount?
has_discount?
Returns true
if the invoice has percentage based discounts; false
otherwise.
Input
Output
id
id
Returns the invoice ID.
The ID is an internal reference for a record. It's not exposed in our web interface and shouldn't be confused with the invoice number (below).
Input
Output
invoiced_at
invoiced_at
Returns the date entered in the invoice “Document Date” field.
Input
Output
is_paid?
is_paid?
Returns true
if the invoice has the status “Paid”; false
otherwise.
Invoices posted to Xero, QuickBooks Online, or Sage have the status “Posted”. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Input
Output
is_posted?
is_posted?
Returns true
if the invoice has the status “Posted”; false
otherwise.
An integration with Xero or QuickBooks Online is required for an invoice to be posted.
Input
Output
items
items
Returns invoice item objects for items on the invoice.
Input
Output
name
name
Returns the invoice subject.
Input
Output
number
number
Returns the invoice number.
Issue an invoice to give it a number.
Input
Output
payment_total
payment_total
Returns the total of any payments logged against the invoice.
Payments logged in Xero, QuickBooks Online, or Sage are not included. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Input
Output
payments
payments
Returns invoice transaction objects for payments logged against the invoice.
Input
Output
reference
reference
Returns the value of the invoice customer reference.
Input
Output
refunds
refunds
Returns invoice transaction objects for refunds logged against the invoice.
Input
Output
sources
sources
Returns opportunity or project objects for the invoice sources.
Sources are set against invoice items rather than the invoice itself.
When an invoice is raised from an opportunity, it will generally have one source: the originating opportunity.
When an invoice is raised from a project, it will have sources for each of the invoiced opportunities in the project.
When a part invoice is created for a project, the project will be source.
A manual invoice may have no sources.
Input
Output
status
status
Returns the invoice status code.
Invoices posted to Xero, QuickBooks Online, or Sage have the status “Posted”. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Code | Status name |
| Open |
| Issued |
| Paid |
| Posted |
| Voided |
Input
Output
status_name
status_name
Returns the invoice status name.
Status names are in the language set against your user profile.
Open
Issued
Paid
Posted
Voided
Invoices posted to Xero, QuickBooks Online, or Sage have the status “Posted”. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Input
Output
tax_class_name
tax_class_name
Returns the invoice tax class.
This may differ from the organization tax class.
Input
Output
tax_total
tax_total
Returns the invoice tax total.
Input
Output
taxes
taxes
Returns invoice tax objects for taxes on the invoice.
Input
Output
transaction_total
transaction_total
Returns the total of any transactions logged against the invoice.
This includes both payments and refunds.
Payments logged in Xero, QuickBooks Online, or Sage are not included. We can't access payment information from linked accounting solutions in document layouts or discussion templates.
Input
Output
transactions
transactions
Returns invoice transaction objects for transactions logged against the invoice.
This includes both payments and refunds.
Input
Output
type
type
Returns the invoice type ID.
ID | Type name |
| Invoice |
| Credit note |
Input
Output
type_name
type_name
Returns the invoice type name.
Type names are in the language set against your user profile.
Invoice
Credit Note
Input
Output
venue
venue
Returns venue objects for the venue against the invoice.
An invoice delivery address can be a venue, but a venue might not always be an invoice's delivery address. If you don't choose a venue when creating an invoice, using {{ invoice.venue.name }}
won't return the same as {{ invoice.delivery_address_name }}
.
Input
Output
Last updated