API features and limitations

The API is platform-neutral and supports a subset of Smile functionality. The Smile API consists of endpoints that let you perform the following tasks:

• account—get account and transaction information, raise adjustments and reimbursements, manage other account charges, download activity statements, update accounts and manage bonds
• accounts receivable—get information about item descriptions
• authentication—authenticate credentials passed to Smile by a trusted application
• CAT—retrieve and email CAT user password details
• contracts—get service and subscription contract information, and add, update and terminate subscription contracts
• credit card payments—validate credit card details
• CRM—create and retrieve tickets, update tickets and get appointment availability
• invoice grouping—get, create and delete invoice groups
• managed plans—get managed plan information and change managed plans and groups
• orders—reserve usernames, get order forms, order and approve accounts and subscriptions and manage order groups
• number pools—get, create and remove number pool reservations
• plan change—get service and subscription plans, propose and commit plan changes
• prepaid subscriptions—validate and redeem vouchers, provide quotes and add prepaid blocks to subscriptions
• provisioning—update the status of provisioning requests
• recurring charge—get information about recurring charges and add and update recurring charges
• services—qualify services and get service information
• spend management—get information about the state of value pools, usage alert groups and spend limits
• subscriptions—update subscriptions, change a subscription's plan and get subscription information, including data from custom fields, and manage pool and IP range reservations
• subservice—get subservice information, and add, update and remove subservices

However, the API does not support all the functionality you can access in Smile, including:

• entering payments (except adjustments)
• creating packages and plans
• managing workflows or helpdesk tickets
• creating reports