BillingCodes
The BillingCodes entity describes an Autotask Allocation Code (called Billing Code in the UI). An allocation code represents a billing item category. There are six types of allocation codes: Work Types, Material, Internal Time, Expense Categories, Recurring Contract Service, and Milestone. Administrators add and manage allocation codes through the Admin module (Admin >Site Setup > Billing Codes).
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: | BillingCodes |
Entity Path: |
/atservicesrest/v1.0/BillingCodes |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
General
In addition to fields that are always read-only, the following fields on the RMA [RMA] system material code are not editable via the API:
- isActive
- department
- description
- isExcludedFromNewContracts
- markupRate
- type
- unitCost
- unitPrice
- useType
Special field attributes
Field | Conditions and Requirements |
---|---|
afterHoursWorkType | This field contains the ID of the BillingCode that is set as this BillingCode's after-hours work type. It may never contain a value for BillingCodes of Types other than 1 (work types). |
GeneralLedgerCode | GeneralLedgerCode returns the GeneralLedgerCode picklist value and label value (GeneralLedgerCode name). |
Field definitions
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.
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
afterHoursWorkType | integer | BillingCodes | |||
billingCodeType | integer | ||||
department | integer | ||||
description | string (500) | ||||
externalNumber | string (100) | ||||
generalLedgerAccount | integer | ||||
id | long | ||||
isActive | boolean | ||||
isExcludedFromNewContracts | boolean | ||||
markupRate | decimal | ||||
name | string (200) | ||||
taxCategoryID | integer | TaxCategories | |||
unitCost | decimal | ||||
unitPrice | decimal | ||||
useType | integer |
BillingCode use types
The following table describes the values in the useType field picklist. These values determine how an BillingCode entity can be used in Autotask.
NOTE If your company has enabled the Autotask System Setting that requires a Work Type on a Ticket, the Type 1 BillingCode is required to create or update a ticket