InvoiceTemplates
This entity describes an Autotask Invoice Template that defines the content and appearance of an Autotask Invoice. Invoices include Billing Items that have been approved and posted and are being billed to a customer or presented for information purposes only. The template determines what account, billing item, tax and financial related details the Autotask user wants to include on the invoice, and how the output will be grouped and presented. Invoice templates are added through the UI in the Admin module: Contracts (and Billing) > Invoices > Templates.
NOTE The API provides the information needed for an external application to reproduce all information and content on an Autotask invoice, but not necessarily create an exact visual reproduction of the invoice.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
| Entity Name: | InvoiceTemplates |
|
Entity Path: |
/atservicesrest/v1.0/InvoiceTemplates |
| Can Create: | |
| Can Update: | |
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
Field definitions
About this table
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
NOTE This entity includes the webServiceDate field. It allows the external application to flag the date and time that the object is processed. It does not appear in the Autotask interface. The API provides this field as a convenience for applications that work specifically with the Invoice entity via the REST API.
NOTE currencyNegativeFormat represents the format used for negative currency values on the invoice.
CurrencyPostiveFormat represents the format used for positive currency values on the invoice.
| Field Name | Datatype | Read-Only | Is Re- quired |
Reference Name | Picklist |
|---|---|---|---|---|---|
| coveredByBlockRetainerContractLabel | string (50) |
|
|||
| coveredByRecurringServiceFixedPricePerTicketContractLabel | string (50) |
|
|
||
| currencyNegativeFormat | string (10) |
|
|||
| currencyPositiveFormat | string (10) |
|
|||
| dateFormat | integer |
|
|
||
| displayFixedPriceContractLabor | boolean |
|
|
||
| displayRecurringServiceContractLabor | boolean |
|
|
||
| displaySeparateLineItemForEachTax | boolean |
|
|
||
| displayTaxCategory | boolean |
|
|
||
| displayTaxCategorySuperscripts | boolean |
|
|
||
| displayZeroAmountRecurringServicesAndBundles | boolean |
|
|
|
|
| groupBy | integer |
|
|
||
| id | long |
|
|
||
| itemizeItemsInEachGroup | integer |
|
|
|
|
| ItemizeServicesAndBundles | boolean |
|
|
||
| name | string (50) |
|
|
||
| nonBillableLaborLabel | string (50) |
|
|
||
| numberFormat | integer |
|
|
|
|
| pageLayout | integer |
|
|
|
|
| pageNumberFormat | integer |
|
|
|
|
| paymentTerms | integer |
|
PaymentTerms | ||
| rateCostExpression | string (50) |
|
|||
| showGridHeader | boolean |
|
|
||
| showVerticalGridLines | boolean |
|
|
||
| sortBy | integer |
|
|
|
|
| timeFormat | integer |
|
|
|
