Invoice

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

The Invoice entity describes an Autotask Invoice. In Autotask, Invoices include billing items that have been approved and posted and are being billed to a customer or presented for information purposes only. They are processed through the Autotask Contracts module (Contracts > Invoices). In the API, invoice line items are described by the BillingItem entity.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Invoice
Can Create:  
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • DueDate
  • TaxGroup

Conditions and requirements

  • Autotask invoice line items are described by the BillingItem entity. To return line items for a specific invoice, query BillingItem where BillingItem.InvoiceID = Invoice.ID.
  • To maintain consistency between data submitted via the API and via the UI, Invoice.PaidDate ignores time stamp information and stores the date only.
  • When using the API with Autotask invoice template variable [Invoice: Number/ID] in HTML output, if Invoice.InvoiceNumber has a value, then that value will display. If Invoice.InvoiceNumber has no value, then the Invoice ID displays.
  • If the Multi-currency Installed Module is enabled, the following fields will return the relevant Customer Currency values instead of the Internal Currency values: InvoiceTotal and TotalTaxValue.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

NOTE  This entity includes the WebServiceDate field. It allows the external application to flag the date and time that the object is processed. The API provides this field as a convenience for applications that work specifically with the Invoice entity via the Web Services API. It appears in the Autotask interface as a column on the Invoice History page and can be cleared from the invoice from that page. If an integration uses the WebServiceDate to flag an invoice as processed, clearing this field may trigger the integration to re-process the invoice.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
AccountID {LT:Account} ID integer   Account  
BatchID Batch ID integer      
Comments Comments string (2000)      
CreateDateTime Create Date Time datetime      
CreatorResourceID Creator Resource ID integer   Resource  
DueDate Due Date datetime      
FromDate From Date datetime      
id Invoice ID long    
InvoiceDateTime Invoice Date Time datetime    
InvoiceEditorTemplateID Invoice Editor Template ID integer   InvoiceTemplate  
InvoiceNumber Invoice Number string (100)        
InvoiceTotal Invoice Total double      
IsVoided Is Voided boolean      
OrderNumber Order Number string (20)      
PaidDate Paid Date datetime        
PaymentTerm Payment Term ID integer    
TaxGroup Tax Group ID integer    
TaxRegionName Tax Region Name string (200)      
ToDate To Date datetime      
TotalTaxValue Total Tax Value double      
VoidedByResourceID Voided By Resource ID integer   Resource  
VoidedDate Voided Date datetime      
WebServiceDate Web Service Use Date datetime