ContractTicketPurchases
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.
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: | ContractTicketPurchases |
Entity Path: |
/atservicesrest/v1.0/ContractTicketPurchases |
Parent Entity: |
|
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
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 |
---|---|---|---|---|---|
contractID | long | Contracts | |||
datePurchased | datetime | ||||
endDate | datetime | ||||
id | long | ||||
invoiceNumber | string (50) | ||||
isPaid | boolean | ||||
paymentNumber | string (50) | ||||
paymentType | integer | ||||
perTicketRate | decimal | ||||
startDate | datetime | ||||
status | integer | ||||
ticketsPurchased | decimal | ||||
ticketsUsed | decimal |