BillingItem
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 BillingItem 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.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | BillingItem |
| 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 Total Amount.
- The following fields will return the saved Internal Currency values: InternalCurrencyExtendedPrice, InternalCurrencyRate, InternalCurrencyTaxDollars, and InternalCurrencyTotal Amount.
- 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 InvoiceID 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. |
BillingItem type and sub-type SOAP to REST mapping
The type and sub-type picklist values for the BillingItem(s) endpoint differ between the Autotask SOAP and REST APIs. The following tables detail these changes.
Billing type mapping
| SOAP ID & billing type name | REST ID & billing type name |
|---|---|
|
1. Labor |
1. Labor |
|
1. Labor |
2. Labor Adjustment |
|
2. Project Cost |
3. Cost (ticket, project, contract) |
|
3. Ticket Cost |
3. Cost (ticket, project, contract) |
|
4. Expense |
4. Expense |
|
5. Subscription |
5. Subscription |
|
6. Setup Fee |
7. Recurring Contract Setup Fee |
|
7. Recurring Services |
6. Recurring Service/Bundle |
|
8. Recurring Services Adjustment |
6. Recurring Service/Bundle |
|
9. Recurring Service Bundle |
6. Recurring Service/Bundle |
|
10. Recurring Service Bundle Adjustment |
6. Recurring Service/Bundle |
|
11. Milestone |
8. Milestone |
|
12. Contract Block |
3. Cost (ticket, project, contract) |
|
13. Contract Retainer |
3. Cost (ticket, project, contract) |
|
14. Contract Cost |
3. Cost (ticket, project, contract) |
|
15. Contract Incident |
3. Cost (ticket, project, contract) |
Billing sub-type mapping
| SOAP ID & billing sub-type name | REST ID & billing sub-type name |
|---|---|
|
1. Labor |
1. Ticket Labor |
|
1. Labor |
2. Task Labor |
|
2. Milestone Labor |
3. Fixed Price Ticket Labor |
|
2. Milestone Labor |
4. Fixed Price Task Labor |
|
1. Labor |
5. Ticket Labor Adjustment |
|
1. Labor |
6. Task Labor Adjustment |
|
5. Ticket Cost Deductions |
7. Service Desk Ticket Cost |
|
6. Ticket Cost |
7. Service Desk Ticket Cost |
|
3. Project Cost Deductions |
8. Project Cost |
|
4. Project Cost |
8. Project Cost |
|
5. Ticket Cost Deductions |
9. Contract Cost |
|
7. Expense |
10. Expense |
|
8. Expense Deductions |
10. Expense |
|
9. Subscription |
11. Subscription |
|
10. Subscription Cost |
11. Subscription |
|
12. Recurring Services |
12. Recurring Services |
|
13. Recurring Services Adjustment |
13. Recurring Services Adjustment |
|
14. Recurring Service Bundle |
14. Recurring Service Bundle |
|
15. Recurring Service Bundle Adjustment |
15. Recurring Service Bundle Adjustment |
|
11. Setup Fee |
16. Setup Fee |
|
16. Milestones |
17. Milestone |
|
17. Block Purchase |
18. Block Purchase |
|
18. Retainer Purchase |
19. Retainer Purchase |
|
19. Ticket Purchase |
20. Ticket Purchase |
|
No SOAP Mapping |
21. Per Contact Cost |
|
No SOAP Mapping |
22. Per Installed Product Cost |
Field definitions
About this table
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 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 Web Services API. It does not appear in the Autotask interface.
| Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| ApprovedDateTime | Approved Date Time | datetime |
|
|||
| AccountID | {LT:Account} | integer |
|
Account | ||
| AccountManagerWhenApprovedID | Account Manager When Approved ID | integer |
|
Resource | ||
| AllocationCodeID | AllocationCodeID | integer |
|
AllocationCode | ||
| BusinessDivisionSubdivisionID | Business Division Subdivision ID | integer |
|
BusinessDivisionSubdivision | ||
| ContractCostID | Contract Cost | long |
|
ContractCost | ||
| ContractID | ContractID | integer |
|
Contract | ||
|
ContractServiceAdjustmentID |
Contract Service Adjustment ID | integer |
|
|
|
|
|
ContractServiceBundleAdjustmentID |
Contract Service Bundle Adjustment ID | integer |
|
|
|
|
|
ContractServiceBundleID |
Contract Service Bundle ID | integer |
|
|
|
|
|
ContractServiceBundlePeriodID |
Contract Service Bundle Period ID | integer |
|
|
|
|
|
ContractServiceID |
Contract Service ID | integer |
|
|
|
|
|
ContractServicePeriodID |
Contract Service Period ID | integer |
|
|
|
|
| Description | Description | string (2000) |
|
|||
| ExpenseItemID | Expense Item | integer |
|
|||
| ExtendedPrice | Extended Price | double |
|
|||
| id | id | long |
|
|
||
| InstalledProductID | Asset ID | long |
|
InstalledProduct | ||
| InternalCurrencyExtendedPrice (Multi-currency module only) | InternalCurrency ExtendedPrice | double |
|
|||
| InternalCurrencyRate (Multi-currency module only) | InternalCurrencyRate | double |
|
|||
| InternalCurrencyTaxDollars (Multi-currency module only) | InternalCurrencyTaxDollars | double |
|
|||
| InternalCurrencyTotalAmount (Multi-currency module only) | InternalCurrency TotalAmount |
double |
|
|||
| InvoiceID | InvoiceID | integer |
|
Invoice | ||
| ItemApproverID | ItemApproverID | integer |
|
Resource | ||
| ItemDate | ItemDate | datetime |
|
|||
| ItemName | ItemName | string (255) |
|
|||
| LineItemFullDescription | Line Item Full Description | string (8000) |
|
|||
| LineItemGroupDescription | Line Item Group Description | string (8000) |
|
|||
| LineItemID | Invoice Line Item ID | long |
|
|||
| MilestoneID | Milestone ID | long |
|
ContractMilestone | ||
| NonBillable | NonBillable | integer |
|
|
||
| OurCost | OurCost | double |
|
|||
| PostedDate | Posted Date | datetime |
|
|||
| PostedOnTime | Posted On Time | datetime |
|
|||
| ProjectCostID | Project Cost | long |
|
ProjectCost | ||
| ProjectID | ProjectID | integer |
|
Project | ||
| PurchaseOrderNumber | Purchase Order Number | string (50) |
|
|||
| Quantity | Quantity | double |
|
|||
| Rate | Rate | double |
|
|||
| RoleID | RoleID | integer |
|
Role | ||
| ServiceBundleID | Service Bundle ID | long |
|
ServiceBundle | ||
| ServiceID | Service ID | long |
|
Service | ||
| SubType | Sub Type | integer |
|
|
|
|
| TaskID | TaskID | integer |
|
Task | ||
| TaxDollars | TaxDollars | double |
|
|||
| TicketCostID | Ticket Cost | long |
|
TicketCost | ||
| TicketID | TicketID | integer |
|
Ticket | ||
| TimeEntryID | TimeEntryID | integer |
|
TimeEntry | ||
| TotalAmount | TotalAmount | double |
|
|||
| Type | Type | integer |
|
|
|
|
| VendorID | Vendor ID | long |
|
Account | ||
| WebServiceDate | WebServiceDate | datetime |
