BillingItems

The BillingItems entity describes a billable item in Autotask that has been approved and posted. A billing item may or may not be included in an invoice and billed to the customer. In Autotask, billing items are managed in the Contracts module.

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: BillingItems

Entity Path:

/atservicesrest/v1.0/BillingItems

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.

lineItemFullDescription

lineItemGroupDescription

Conditions and requirements

General

  • If the multi-currency Installed Module is enabled, the following fields will return the relevant Customer Currency values instead of the Internal Currency values: extendedPrice, rate, taxDollars, and totalAmount.
  • The following fields will return the saved Internal Currency values: internalCurrencyExtendedPrice, internalCurrencyRate, internalCurrencytaxDollars, and internalCurrencyTotalAmount.
  • When Organizational Structure is enabled in Autotask, and user is associated with a Line of Business, user can see only items associated with no Line of Business or Line of Business they are assigned to.

Special field attributes

Field Conditions and Requirements
lineItemFullDescription billingItem.lineItemFullDescription contains the description for a billingItem.
lineItemGroupDescription When billingItems are grouped on an invoice, the lineItemGroupDescription contains the description for the grouped items. lineItemFullDescription is also available for billingItems that are grouped.
lineItemID

When multiple billingItems that are associated with the same internalCurrencytaxDollars share the same lineItemID, those items are grouped.

It is possible for a billingItem to have a unique lineItemID and still be "grouped" in a group of one item.To confirm the group status of a billingItem, refer to invoice.invoiceEditorTemplateID and the invoiceTemplate.groupBy value.

ourCost

This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required.

Field definitions

NOTE   The BillingItem entity includes the webServiceDate field that allows the external application to flag the date and time that the object is processed. This field is provided as a convenience for applications that work specifically with the BillingItem entity via the REST API. It does not appear in the Autotask interface.

Field Name Datatype Read-Only Is Required Reference Name Picklist
accountManagerWhenApprovedID integer   Resources  
billingCodeID integer   BillingCodes  

billingItemType

integer

 

companyID integer   Companies  
configurationItemID long   ConfigurationItems  
contractBlockID integer   ContractBlocks  
contractChargeID long   ContractCharges  
contractID integer   Contracts  

contractServiceAdjustmentID

integer

 

 

 

contractServiceBundleAdjustmentID

integer

 

 

 

contractServiceBundleID

integer

 

ContractServiceBundles

 

contractServiceBundlePeriodID

integer

 

 

 

contractServiceID

integer

 

ContractServices

 

contractServicePeriodID

integer

 

 

 

description string (2000)      
expenseItemID integer      
extendedPrice decimal      
id long    
internalCurrencyExtendedPrice (Multi-currency module only) decimal      
internalCurrencyRate (Multi-currency module only) decimal      
internalCurrencytaxDollars integer   Invoices  
internalCurrencytaxDollars (Multi-currency module only) decimal      
internalCurrencytotalAmount (Multi-currency module only) decimal      

invoiceID

integer

 

Invoices

 

itemApproverID integer   Resources  
itemDate datetime      
itemName string (255)      
lineItemFullDescription string (8000)      
lineItemGroupDescription string (8000)      
milestoneID long   ContractMilestones  

nonBillable

integer

 

 

organizationalLevelAssociationID

integer

 

OrganizationalLevelAssociations

 

ourCost decimal      
postedDate datetime      
postedOnTime datetime      
projectChargeID long   ProjectCharges  
projectID integer   Projects  
purchaseOrderNumber string (50)      
quantity decimal      
rate decimal      
roleID integer   Roles  
serviceBundleID long   ServiceBundles  
serviceID long   Services  
sortOrderID long      
subType integer  
taskID integer   Tasks  
taxDollars decimal      
ticketChargeID long   TicketCharges  
ticketID integer   Tickets  
timeEntryID integer   TimeEntries  
totalAmount decimal      
vendorID long   Companies  
webServiceDate datetime        

Additional resources