ContractTicketPurchase
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.
This entity describes a payment amount applied to the purchase of (or pre-payment for ) one or more Service Desk Tickets through a Per Ticket Contract. With a Per Ticket contract, a customers pre-pays for a set of Service Desk tickets, and each ticket completed under that contract consumes one ticket purchase, no matter how much labor is required to resolve the issue. The contract maintains the balance of unconsumed ticket purchases.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | ContractTicketPurchase |
| 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.
- TicketsUsed
Conditions and requirements
General
- Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
- Note that ContractTicketPurchase entity does not automatically create a new contract cost when a new contract ticket purchase is created.
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| ContractID | ContractID must reference a Per Ticket type Contract. |
| PerTicketRate |
If the Multi-currency Installed Module is enabled, the following fields will return the relevant Customer Currency values instead of the Internal Currency values: PerTicketRate. PerTicketRate must be >= 0. |
| StartDate, EndDate |
StartDate must be < EndDate. ContractTicketPurchase.StartDate and ContractTicketPurchase.EndDate must be within the StartDate and EndDate of the contract referenced by ContractTicketPurchase.ContractID; that is, in Autotask the Contract Ticket Purchase must start and end within the Contract start and end dates. StartDate and EndDate only support date values. The API will not store non-date values (such as time) in these fields. |
| TicketsPurchased | On update(), TicketsPurchased must be >= TicketsUsed |
| TicketsPurchased | TicketsPurchased must be >= 0 |
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.
| Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| ContractID | Contract ID | long |
|
Contract | ||
| DatePurchased | Date Purchased | datetime |
|
|||
| EndDate | End Date | datetime |
|
|||
| id | id | long |
|
|
||
| InvoiceNumber | Invoice Number | string (50) | ||||
| IsPaid | Paid | boolean |
|
|
||
| PaymentNumber | Payment Number | string (50) | ||||
| PaymentType | Payment Type | integer |
|
|||
| PerTicketRate | Rate | double |
|
|||
| StartDate | Start Date | datetime |
|
|||
| Status | Status | integer |
|
|||
| TicketsPurchased | Tickets Purchased | double |
|
|||
| TicketsUsed | Tickets Used | double |
|
