Customer Service (2.34)

Download OpenAPI specification:Download

Customer Service Concepts

Abstract

The purpose of the customer service is to provide the ability to add, modify, look up, and search for customer information contained within the database.

Customer Service Concepts

Lookup vs Search The intent of "Lookup" functionality is to allow the caller to locate a single customer account and to optionally return detailed tabular data related to the account, while the intent of a "Search" is to return a potentially large number of customer accounts along with minimal, non-tabular, i.e., one-to-one, account data. For example, a lookup would be used to access a list of services, features and trouble tickets associated with a particular customer account, while a search would be used for accessing just the basic name and date information for all customers whose last name is Smith. Note that when different search criteria fields are specified, they are "AND"-ed together so that each additional field specified will further limit the search results while multiple values of the same field within the search criteria are "OR"-ed together which will expand the search results.

Lookup

To perform a customer lookup, the caller should specify criteria for identifying the desired customer account, plus one or more response groups to indicate what return data is required.

Note that neither wildcard searches nor partial matches are supported for CustomerLookup key fields. The value entered must exactly match in order for a match to be found.

To indicate which tabular data sets to return with each customer account, specify one or more CustomerLookupResponseGroups. If no CustomerLookupResponseGroups are specified, only the minimum customer lookup data (i.e., AccountNumber, CustomerID, and CustomerName) will be returned. Should multiple response groups mapping to the same return data location be selected (i.e., Services and ActiveServices, or Services and ActiveServicesWithActiveFeatures), the system will act as if only the least restrictive one (i.e., Services or ActiveServicesWithActiveFeatures, respectively) was selected. Each response group has a maximum number of data elements that will be returned.

Search

To perform a customer search, the caller should specify search criteria, data fields desired in the response, how the results should be sorted, and paging information.

The criteria to search by should be specified in the CustomerSearchReq. For StringSearch criteria, the caller may also indicate whether wildcards should be used. For example, if the caller searches for AccountNumber "4567" and sets the corresponding StringSearch.WildCard to false (indicates the system should NOT allow wildcards), the only customer account that will be returned is account 4567. However, if the caller sets the corresponding StringSearch.WildCard to true (indicates that wildcards should be used), searches for AccountNumber "4567" will return any customers with account numbers that contain the sequence 4567, i.e., 4567, 34567, 45678, 345678, etc. Please be aware that, despite the name, special "wildcard" characters such as asterisk should not be included within the search criteria value because they will not be treated as a wildcard characters. In the above example, simply specify an account number of 4567 and the StringSearch.WildCard = true. Do NOT specify a search by account number of "4567". Wildcard searches are not supported at all for numeric (IntSearch) search criteria values.

Data fields desired to be returned in the search results are indicated via CustomerSearchReq.ResponseElements. If no response elements are specified, only the minimum customer search data (i.e., CustomerID) will be returned.

The search results may be sorted by CustomerName or AccountNumber. The caller may indicate his/her choice in CustomerSearchReq.Sort. If no choice is specified, the default sort option is to sort by CustomerName.

To indicate how search result data should be divided into pages, populate CustomerSearchReq.PagingInformationItem. See the Paging section below for details.

The CustomerSearchResult includes PagingDetails, and a collection of CustomerSearchResultItems meeting the search criteria.

CreateCustomer

Used to create a new customer.

Paging

The amount of information retrieved from an operation may require that the resulting response be broken down into smaller sets of data. If this is the case, then a PagingInformationItem can be used to specify which piece of the information the caller wants. For example, a call to a search operation may yield 100 results while the search operation only allows a maximum amount of 10 results to be returned at a time. To retrieve additional records, the caller would need to use the PagingInformationItem to specify the next sequential page to retrieve. This would allow the caller to retrieve the remaining records, one page (i.e., 10 records if a page is defined as 10 records) at a time, until all the data is retrieved or the correct value is found. If no paging information is specified, the caller would only receive the first page of data.

Operations

Calculate Default Market

Provides the ability to determine a default market. [Rev 1.04]

  • Note: CalculateDefaultMarket makes use of the configuration values viewable via MarketAssignmentSetting and corresponding MarketAssignmentAddressses as follows:
    1. If MarketAssignmentSetting EnableAssignmentLogic is false, this method will not even attempt to calculate a default market. No market or DefaultMarketCalculationMethod will be returned. If EnableMarketAssignment is true, the system will begin the search for a default market starting with the provided address, if so configured.
    2. If MarketAssignmentSetting UseProvidedAddress is true, at least a ZipCode or State is set in the CalculateDefaultMarketReq, and a matching City, State and ZipCode combination can be found in MarketAssignmentAddress, the market found in the matching MarketAssignmentAddress will be returned along with a DefaultMarketCalculationMethod of ProvidedAddress. If no matching address is found, or UseProvidedAddress is false, the system will next look to the location market, if so configured. MarketAssignmentAddress is scanned for a matching address as follows:
    • If the provided address contains a City, State and ZipCode, and a MarketAssignmentAddress can be found with the same City, State and ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a ZipCode, and a MarketAssignmentAddress can be found with the same ZipCode, but no City or State, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a City and State, and a MarketAssignmentAddress can be found with the same City and State, but no ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a State, and a MarketAssignmentAddress can be found with the same State, but no City or ZipCode, this MarketAssignmentAddress' default market will be used.
    1. If MarketAssignmentSetting UseLocationMarket is true, a valid LocationID is specified in the CalculateDefaultMarketReq, and the specified LocationID has a market associated with it, the location's market will be returned as the default and a DefaultMarketCalculationMethod of LocationMarket will be returned. If no location is specified, the location does not have a market associated with it, or UseLocationMarket is false, the system will next look to the location contact.
    2. If MarketAssignmentSetting UseLocationContact is true, a valid LocationID is specified in the CalculateDefaultMarketReq, that location has a contact with at least a State and ZipCode, and a matching City, State and ZipCode combination can be found in MarketAssignmentAddress, the market found in the matching MarketAssignmentAddress will be returned along with a DefaultMarketCalculationMethod of LocationContact. If no matching address is found, or UseLocationContact is false, the system will next look to the default market, if so configured. MarketAssignmentAddress is scanned for a matching address as follows:
    • If the location contact address contains a City, State and ZipCode, and a MarketAssignmentAddress can be found with the same City, State and ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a ZipCode, and a MarketAssignmentAddress can be found with the same ZipCode, but no City or State, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a City and State, and a MarketAssignmentAddress can be found with the same City and State, but no ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a State, and a MarketAssignmentAddress can be found with the same State, but no City or ZipCode, this MarketAssignmentAddress' default market will be used. If the default market determination process has gotten here, all other methods have failed. The market value found in MarketAssignmentSetting DefaultMarketID will be returned. A DefaultMarketCalculationMethod of DefaultMarket will be returned whether MarketAssignmentSetting DefaultMarketID has a value or not.
header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CalculateDefaultMarket
Request Body schema: application/soap+xml
required
object (CalculateDefaultMarket)

Provides the ability to determine a default market. [Rev 1.04]

  • Note: CalculateDefaultMarket makes use of the configuration values viewable via MarketAssignmentSetting and corresponding MarketAssignmentAddressses as follows:
    1. If MarketAssignmentSetting EnableAssignmentLogic is false, this method will not even attempt to calculate a default market. No market or DefaultMarketCalculationMethod will be returned. If EnableMarketAssignment is true, the system will begin the search for a default market starting with the provided address, if so configured.
    2. If MarketAssignmentSetting UseProvidedAddress is true, at least a ZipCode or State is set in the CalculateDefaultMarketReq, and a matching City, State and ZipCode combination can be found in MarketAssignmentAddress, the market found in the matching MarketAssignmentAddress will be returned along with a DefaultMarketCalculationMethod of ProvidedAddress. If no matching address is found, or UseProvidedAddress is false, the system will next look to the location market, if so configured. MarketAssignmentAddress is scanned for a matching address as follows:
    • If the provided address contains a City, State and ZipCode, and a MarketAssignmentAddress can be found with the same City, State and ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a ZipCode, and a MarketAssignmentAddress can be found with the same ZipCode, but no City or State, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a City and State, and a MarketAssignmentAddress can be found with the same City and State, but no ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the provided address contains a State, and a MarketAssignmentAddress can be found with the same State, but no City or ZipCode, this MarketAssignmentAddress' default market will be used.
    1. If MarketAssignmentSetting UseLocationMarket is true, a valid LocationID is specified in the CalculateDefaultMarketReq, and the specified LocationID has a market associated with it, the location's market will be returned as the default and a DefaultMarketCalculationMethod of LocationMarket will be returned. If no location is specified, the location does not have a market associated with it, or UseLocationMarket is false, the system will next look to the location contact.
    2. If MarketAssignmentSetting UseLocationContact is true, a valid LocationID is specified in the CalculateDefaultMarketReq, that location has a contact with at least a State and ZipCode, and a matching City, State and ZipCode combination can be found in MarketAssignmentAddress, the market found in the matching MarketAssignmentAddress will be returned along with a DefaultMarketCalculationMethod of LocationContact. If no matching address is found, or UseLocationContact is false, the system will next look to the default market, if so configured. MarketAssignmentAddress is scanned for a matching address as follows:
    • If the location contact address contains a City, State and ZipCode, and a MarketAssignmentAddress can be found with the same City, State and ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a ZipCode, and a MarketAssignmentAddress can be found with the same ZipCode, but no City or State, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a City and State, and a MarketAssignmentAddress can be found with the same City and State, but no ZipCode, this MarketAssignmentAddress' default market will be used.
    • If the location contact address contains a State, and a MarketAssignmentAddress can be found with the same State, but no City or ZipCode, this MarketAssignmentAddress' default market will be used. If the default market determination process has gotten here, all other methods have failed. The market value found in MarketAssignmentSetting DefaultMarketID will be returned. A DefaultMarketCalculationMethod of DefaultMarket will be returned whether MarketAssignmentSetting DefaultMarketID has a value or not.

Responses

Create Adjustment

Provides the ability to create a new adjustment. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreateAdjustment
Request Body schema: application/soap+xml
required
object (CreateAdjustment)

Provides the ability to create a new adjustment. [Rev 1.12]

Responses

Create Customer

Provides the ability to create a new customer.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreateCustomer
Request Body schema: application/soap+xml
required
object (CreateCustomer)

Provides the ability to create a new customer.

Responses

Create Deposit

Provides the ability to modify a Deposit. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreateDeposit
Request Body schema: application/soap+xml
required
object (CreateDeposit)

Provides the ability to modify a Deposit. [Rev 1.12]

Responses

Create Payment

Provides the ability to create a new Payment. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreatePayment
Request Body schema: application/soap+xml
required
object (CreatePayment)

Provides the ability to create a new Payment. [Rev 1.12]

Responses

Create Payment Account Transaction

Provides the ability to create a transaction that applies to an existing payment account. [Rev 1.03]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreatePaymentAccountTransaction
Request Body schema: application/soap+xml
required
object (CreatePaymentAccountTransaction)

Provides the ability to create a transaction that applies to an existing payment account. [Rev 1.03]

Responses

Create Service Address

Provides the ability to create a service address and associate it with zero or more services. [Rev 1.10]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreateServiceAddress
Request Body schema: application/soap+xml
required
object (CreateServiceAddress)

Provides the ability to create a service address and associate it with zero or more services. [Rev 1.10]

Responses

Create User Customer

Provides the ability to create a new user customer. [Rev 1.14]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CreateUserCustomer
Request Body schema: application/soap+xml
required
object (CreateUserCustomer)

Provides the ability to create a new user customer. [Rev 1.14]

Responses

Customer Lookup

Provides the ability to lookup detailed information about a particular customer.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CustomerLookup
Request Body schema: application/soap+xml
required
object (CustomerLookup)

Provides the ability to lookup detailed information about a particular customer.

Responses

Customer Search

Provides the ability to obtain a list of information about all customers that match certain criteria.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/CustomerSearch
Request Body schema: application/soap+xml
required
object (CustomerSearch)

Provides the ability to obtain a list of information about all customers that match certain criteria.

Responses

Invoice Lookup

Provides the ability to look up detailed information about a particular invoice. [Rev 1.02]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/InvoiceLookup
Request Body schema: application/soap+xml
required
object (InvoiceLookup)

Provides the ability to look up detailed information about a particular invoice. [Rev 1.02]

Responses

Modify Adjustment

Provides ability to modify an Adjustment. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyAdjustment
Request Body schema: application/soap+xml
required
object (ModifyAdjustment)

Provides ability to modify an Adjustment. [Rev 1.12]

Responses

Modify Corporate Accounts

Provides the ability to modify a corporate account hierarchy (add, remove, and re-parent customers/corporate accounts), as well as toggle an account's invoice responsibility. [Rev 1.10]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyCorporateAccounts
Request Body schema: application/soap+xml
required
object (ModifyCorporateAccounts)

Provides the ability to modify a corporate account hierarchy (add, remove, and re-parent customers/corporate accounts), as well as toggle an account's invoice responsibility. [Rev 1.10]

Responses

Modify Customer

Provides the ability to modify customer account information. [Rev 1.01]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyCustomer
Request Body schema: application/soap+xml
required
object (ModifyCustomer)

Provides the ability to modify customer account information. [Rev 1.01]

Responses

Modify Deposit

Provides the ability to modify a Deposit. [Rev.1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyDeposit
Request Body schema: application/soap+xml
required
object (ModifyDeposit)

Provides the ability to modify a Deposit. [Rev.1.12]

Responses

Modify Extended Information

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.04]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyExtendedInformation
Request Body schema: application/soap+xml
required
object (ModifyExtendedInformation)

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.04]

Responses

Modify Feature

Provides the ability to modify information on a feature that is associated with a customer account. [Rev 1.05]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyFeature
Request Body schema: application/soap+xml
required
object (ModifyFeature)

A container object for the values needed to call the ModifyFeature operation. [Rev 1.05]

  • Note: Optional values which are strings allow for 3 options throughout:
    1. No value (i.e., null) - No change should be made to this field
    2. An empty string (i.e., whitespace) - Clear out the field to have no value
    3. A non-null non-whitespace value - Specifies a new value for the field

Responses

Modify Payment

Provides the ability to modify a Payment. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyPayment
Request Body schema: application/soap+xml
required
object (ModifyPayment)

Provides the ability to modify a Payment. [Rev 1.12]

Responses

Modify Payment Account Transaction

Provides the ability to modify an existing payment account transaction. [Rev 1.12]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyPaymentAccountTransaction
Request Body schema: application/soap+xml
required
object (ModifyPaymentAccountTransaction)

Provides the ability to modify an existing payment account transaction. [Rev 1.12]

Responses

Modify Port Request Deprecated

'Provides the ability to modify a Port Request. [Rev 1.15]'

Deprecated: Replaced by Update Port Request. [Rev 1.27]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyPortRequest
Request Body schema: application/soap+xml
required
object (ModifyPortRequest)

Provides the ability to modify a Port Request. [Rev 1.15]

Responses

Modify Service

Provides the ability to modify the information on a service that is associated with a customer account. [Rev 1.05]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyService
Request Body schema: application/soap+xml
required
object (ModifyService)

Provides the ability to modify the information on a service that is associated with a customer account. [Rev 1.05]

Responses

Modify Service Address

Provides the ability to modify a service address and add it to or remove it from zero or more services. [Rev 1.10]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyServiceAddress
Request Body schema: application/soap+xml
required
object (ModifyServiceAddress)

Provides the ability to modify a service address and add it to or remove it from zero or more services. [Rev 1.10]

Responses

Modify User Customer

Provides the ability to create a new user customer. [Rev 1.14]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/customer/ModifyUserCustomer
Request Body schema: application/soap+xml
required
object (ModifyUserCustomer)

Provides the ability to create a new user customer. [Rev 1.14]

Responses

Core Data Service

  • Note: The CoreDataService endpoint was added to the Customer service in [Rev 1.02].

Abstract

The purpose of the CoreDataService endpoint is to supply a set of search capabilities that can be used for data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format:

WRAP access_token="<Simple Web Token>"

where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Account Transaction

A list of posted and un-posted customer account transactions. Posted transactions are denoted by an AccountTransactionPostedStatusID of 1 ('Posted'), and will have non-null values for AccountID and AccountTransactionID. Unposted transactions are denoted by an AccountTransactionPostedStatusID of 2 ('Unposted'), and will have a null value for AccountID and AccountTransactionID. [Rev 1.09]

  • Note: AccountTransaction will not return posted records for accounts that have never been posted.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountBalance": 19.72,
  • "AccountID": 388,
  • "AccountTransactionID": 342,
  • "AccountTransactionPostedStatus": "Posted Status Description",
  • "AccountTransactionPostedStatusID": 1,
  • "AccountTransactionType": "Account Transaction Type Description",
  • "AccountTransactionTypeID": 1,
  • "Amount": 19.72,
  • "AppliedToInstallmentPlanFeatureID": 315,
  • "BalanceAccountType": "Balance Account Type Description",
  • "BalanceAccountTypeID": 1,
  • "Charges": 19.72,
  • "Credits": 19.72,
  • "CustomerAccountNumber": "Customer Account Number",
  • "CustomerID": 589367893,
  • "CustomerName": "John William",
  • "Description": "Transaction Description",
  • "DisputeID": 4574,
  • "LastModifiedUser": "Username",
  • "NewBalance": 19.72,
  • "OpenAmount": 19.72,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "ReferenceNumber": 574,
  • "TransactionDate": "2017-09-09T17:35:09.156Z",
  • "TransactionSequenceNumber": 4557
}

Account Transaction Posted Deprecated

A list of all posted customer account transactions. Deleted transactions are excluded.

  • Deprecated: Replaced by AccountTransaction [Rev 1.09]
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountID": 45646,
  • "AccountTransactionID": 46746,
  • "AccountTransactionType": "Account Transaction Type Description",
  • "AccountTransactionTypeID": 1,
  • "Amount": 19.72,
  • "AppliedToInstallmentPlanFeatureID": 35673,
  • "BalanceAccountType": "Balance Account Type Description",
  • "BalanceAccountTypeID": 1,
  • "Charges": 19.72,
  • "Credits": 19.72,
  • "CustomerID": 589367893,
  • "Description": "Transaction Description",
  • "DisputeID": 567854,
  • "NewBalance": 19.72,
  • "OpenAmount": 19.72,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "ReferenceNumber": 457,
  • "TransactionDate": "2017-09-09T17:35:09.156Z",
  • "TransactionSequenceNumber": 456456,
  • "UserID": "Username"
}

Account Transaction Settlement

A list of all settlements against balance accounts in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountID": 3453,
  • "AccountTransactionID": 24626,
  • "AccountTransactionSettlementID": 24626,
  • "AccountTransactionType": "Account Transaction Type Description",
  • "AccountTransactionTypeID": 283482,
  • "Amount": 19.72,
  • "BalanceAccountType": "Balance Account Type Description",
  • "BalanceAccountTypeID": 1,
  • "CustomerAccountNumber": "Customer Account Number",
  • "CustomerID": 283482,
  • "CustomerName": "Adam Tomaselli",
  • "InvoiceCategory": "Invoice Category Description",
  • "InvoiceCategoryID": 283482,
  • "ReferenceNumber": 2452,
  • "SettledByAccountTransactionID": 283482,
  • "SettledByAccountTransactionType": "Transaction Type Description",
  • "SettledByAccountTransactionTypeID": 283482,
  • "SettledByInvoiceCategory": "Invocie Category",
  • "SettledByInvoiceCategoryID": 283482,
  • "SettledByReferenceNumber": 132,
  • "SettledOnDate": "2017-09-09T17:35:09.156Z"
}

Active Features By Type

The count of features with an active billing status, and a start and end date range including today, by customer and feature CatalogID. For features assigned to a service, only those assigned to a service having an active billing status, and a start and end date range including today, will be counted. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 6356356,
  • "AlternateDescription": "Alternate Feature Type Description",
  • "AlternateInvoiceDescription": "My Alternate Invoice Description",
  • "BillingCycleType": "Billing Cycle Type Description",
  • "BillingCycleTypeID": 1,
  • "CatalogID": 589367893,
  • "Charge": 19.72,
  • "CustomerID": 589367893,
  • "CustomerName": "Geordi La-Forge",
  • "Description": "Catalog Description",
  • "DisplayZeroCharges": true,
  • "TotalActiveAccountLevelFeaturesWithoutParentFeature": 45,
  • "TotalActiveAccountLevelFeaturesWithParentFeature": 34,
  • "TotalActiveServiceLevelFeaturesWithoutParentFeature": 12,
  • "TotalActiveServiceLevelFeaturesWithParentFeature": 34,
  • "WebName": "My User-friendly Name"
}

Active Services By Type Deprecated

The count of services with an active billing status, and a start and end date range including today, by customer and service CatalogID. [Rev 1.03]

  • Deprecated: Replaced by ServiceCatalogOverview. [Rev 1.09]
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 53635,
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "My Alternate Invoice Description",
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Brent Spiner",
  • "Description": "Catalog Description",
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 4634,
  • "TotalActiveServices": 45,
  • "WebName": "My USer-Friendly Name"
}

Adjustment

A list of all Adjustments in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "AccountsReceivableBatchFile": "Accounts Receivable Batch File Name",
  • "AccountsReceivableBatchFileID": 24626,
  • "AccountsReceivableBatchFileRequestID": 24626,
  • "AccountsReceivableBatchNumber": 6789,
  • "AdjustmentDate": "2017-09-09T17:35:09.156Z",
  • "AdjustmentID": 24626,
  • "AdjustmentReason": "Adjustment Reason Description",
  • "AdjustmentReasonID": 24626,
  • "AdjustmentType": "Adjustment Type Description",
  • "AdjustmentTypeID": 24626,
  • "Amount": 19.72,
  • "AppliedToInvoiceCategory": "Invoice Category",
  • "AppliedToInvoiceCategoryID": 24626,
  • "AppliedToInvoiceNumber": 3653,
  • "BillPeriodIDPosted": 283482,
  • "BlockPosting": true,
  • "CheckNumber": 46346343643,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CreditForBillPeriodID": 283482,
  • "CreditForCatalog": "Catalog Description",
  • "CreditForCatalogID": 283482,
  • "CreditForCatalogSKU": "DJD54TY353",
  • "CreditForFeatureID": 589367893,
  • "CreditForFeatureInvoicedAmount": 19.72,
  • "CreditForInAdvanceCharge": false,
  • "CreditForInvoiceNumber": 283482,
  • "CreditForServiceNumber": 77373474,
  • "CreditForUsageRecordCount": 63,
  • "CustomerID": 283482,
  • "CustomerName": "Customer Name",
  • "Description": "Adjustment Description",
  • "InvoiceNumberPosted": 46363,
  • "IsCharge": true,
  • "IsPosted": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "ParentAdjustmentID": 283482,
  • "PaymentAccountTransactionID": 283482,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "ReversalAdjustmentID": 2452494
}

Adjustment Usage Record

A list of usage records associated to an Adjustment created as a credit for usage charges. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 43573457,
  • "AdjustmentID": 24626,
  • "Amount": 19.72,
  • "CDRFileID": 24626,
  • "CDRFileRecordInstanceNumber": 5,
  • "CDRFileRecordNumber": 4,
  • "CreditForBillPeriodID": 24626,
  • "CreditForInvoiceNumber": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Ross"
}

Alert

A list of all customer alerts in the system. [Rev 1.09]

  • Note: CreateDate and CreateUser are new elements. Existing records have no data for these, but because of their non-nullability, "defaults" will be set. CreateDate will be set to the date and time at which the database was upgraded to have the column. CreateUser will be set to an empty string (""). These values will indicate historical records for which the proper values of the elements were never stored.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlertID": 24626,
  • "AlertText": "My Alert Text",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsInternal": true,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Balance Account Type Overview

A list of information for customers' per balance account, including arrears buckets. [Rev 1.09]

  • Note: The system supports up to five arrears buckets. If fewer than five buckets are configured, the values will be zero and the labels will be null for the unconfigured buckets.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountID": 3421,
  • "AccountNumber": 34634,
  • "Arrears1Balance": 19.72,
  • "Arrears1Label": "My Label",
  • "Arrears2Balance": 19.72,
  • "Arrears2Label": "My Label",
  • "Arrears3Balance": 19.72,
  • "Arrears3Label": "My Label",
  • "Arrears4Balance": 19.72,
  • "Arrears4Label": "My Label",
  • "Arrears5Balance": 19.72,
  • "Arrears5Label": "My Label",
  • "BalanceAccountType": "Ballance Account Type Description",
  • "BalanceAccountTypeID": 1,
  • "BalanceValidAsOf": "2017-09-09T17:35:09.156Z",
  • "CurrentBalance": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "TotalBalance": 19.72
}

Balance Summary

A summary of balance information for the Postpaid balance account type of customers. [Rev 1.09]

  • Note: BalanceSummary will not return a record for customers that have never been posted.
  • Note: The system supports up to five arrears buckets. If fewer than five buckets are configured, the values will be zero and the labels will be null for the unconfigured buckets.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "ActiveRecurringEPayAccountCount": 31,
  • "Arrears1Balance": 19.72,
  • "Arrears1Label": "My Label",
  • "Arrears2Balance": 19.72,
  • "Arrears2Label": "My Label",
  • "Arrears3Balance": 19.72,
  • "Arrears3Label": "My Label",
  • "Arrears4Balance": 19.72,
  • "Arrears4Label": "My Label",
  • "Arrears5Balance": 19.72,
  • "Arrears5Label": "My Label",
  • "BalanceValidAsOf": "2017-09-09T17:35:09.156Z",
  • "CurrentBalance": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DaysPastDue": 12,
  • "LastInvoiceDate": "2017-09-09T17:35:09.156Z",
  • "LastInvoiceDueDate": "2017-09-09T17:35:09.156Z",
  • "LastInvoiceNumber": 52,
  • "LastInvoiceTotalAmountDue": 19.72,
  • "LastPayment": 19.72,
  • "LastPaymentDate": "2017-09-09T17:35:09.156Z",
  • "LastPaymentID": 589367893,
  • "PastDueBalance": 19.72,
  • "TotalBalance": 19.72,
  • "UnbilledUsage": 19.72,
  • "WriteOffAmount": 19.72
}

Coincident Credit Transaction

A list of all credit transactions, including Payment Account credit transactions and adjustments, in the system. This aggregation will allow for quickly identifying coincident transactions for a credit to be entered in the system. [Rev 1.12]

  • Note: One of AdjustmentID or PaymentAccountTransactionID will contain the actual value of the unique identifier for the credit transaction, based on which type of credit transaction the record represents. A value of -1 indicates that the credit transaction is not of the type identified by that particular ID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AdjustmentID": 2494,
  • "AdjustmentType": "Adjustment Type Description",
  • "AdjustmentTypeID": 589367893,
  • "Amount": 19.72,
  • "CustomerID": 589367893,
  • "Date": "2017-09-09T17:35:09.156Z",
  • "Description": "Payment Transaction Description",
  • "PaymentAccountID": 2494,
  • "PaymentAccountTransactionID": 2494
}

Coincident Debit Transaction

A list of all payments (non-reversed), including Payment Account transactions and payments on orders, in the system. This aggregation will allow for quickly identifying coincident transactions for a payment to be entered in the system. [Rev 1.12]

  • Note: One of PaymentAccountTransactionID, PaymentID, PaymentInformationItemID will contain the actual value of the unique identifier for the payment transaction, based on which type of payment transaction the record represents. A value of -1 indicates that the payment transaction is not of the type identified by that particular ID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Amount": 19.72,
  • "CustomerID": 589367893,
  • "Date": "2017-09-09T17:35:09.156Z",
  • "Description": "Payment Transaction Description",
  • "PaymentAccountTransactionID": 2494,
  • "PaymentID": 2494,
  • "PaymentInformationItemID": 2494
}

Contact

A list of all the contacts in the system. [Rev 1.11]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ActualValidationType": "My Validation Type",
  • "ActualValidationTypeID": 24626,
  • "AddressValidationID": 24626,
  • "AddressValidationResult": "My Address Validation Result",
  • "AddressValidationResultCode": "My Address Validation Result Code",
  • "AddressValidationResultID": 24626,
  • "BypassUser": "Username",
  • "City": "London",
  • "CompanyName": "My Company",
  • "ContactID": 24626,
  • "ContactType": "Contant Type Name",
  • "ContactTypeID": 589367893,
  • "Country": "United States",
  • "County": "Monroe",
  • "EmailAddress1": "auser@mail.com",
  • "EmailAddress1TypeID": 1,
  • "EmailAddress2": "auser@mail.com",
  • "EmailAddress2TypeID": 24626,
  • "EmailAddress3": "auser@mail.com",
  • "EmailAddress3TypeID": 24626,
  • "ExcludeReasonID": 283482,
  • "FailureCount": 5,
  • "FirstName": "Will",
  • "FullName": "Jim Henson",
  • "HoursOfAccess": 6,
  • "IsPOBox": false,
  • "LastName": "Riker",
  • "Latitude": 19.72,
  • "LocationNumber": 3463,
  • "Longitude": 19.72,
  • "MiddleInitial": "T",
  • "Note": "Contact Notes",
  • "PhoneNumber1": "123-456-7890",
  • "PhoneNumber1TypeID": 24626,
  • "PhoneNumber2": "123-456-7890",
  • "PhoneNumber2TypeID": 24626,
  • "PhoneNumber3": "123-456-7890",
  • "PhoneNumber3TypeID": 24626,
  • "PhoneNumber4": "123-456-7890",
  • "PhoneNumber4TypeID": 24626,
  • "RequiredValidationType": "My Validation Type",
  • "RequiredValidationTypeID": 24626,
  • "State": "New York",
  • "Street1": "9595 Whitney Ontario NY 13343 US",
  • "Street2": "9595 Whitney Ontario NY 13343 US",
  • "Street3": "9595 Whitney Ontario NY 13343 US",
  • "Title": "My Title",
  • "ValidationDate": "2017-09-09T17:35:09.156Z",
  • "ZipCode": 45242
}

Contract Feature

A list of all assigned feature instances in the system which are contracts. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlternateDescription": "Alternate Item Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AutoRenew": true,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Catalog Item Description",
  • "Duration": 4,
  • "DurationType": "Duration Type Description",
  • "DurationTypeID": 1,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "FeatureID": 589367893,
  • "IsReviewed": false,
  • "PenaltyOverrideCount": 3,
  • "PreviousFeatureID": 22494,
  • "RenewableAfterDays": 3,
  • "RenewableBeforeDays": 4,
  • "RootFeatureID": 589367893,
  • "ServiceAgreementID": 52494,
  • "ServiceID": 22494,
  • "ServiceNumber": 6424,
  • "SKU": "SH3WY53H3",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "TermOverrideCount": 2,
  • "WebName": "My User-Friendly Name"
}

Contract Feature Term

A list of all contract feature terms in the system with term override information if overridden. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "BillPeriodsToEvaluate": 4,
  • "CatalogID": 589367893,
  • "ContractDisplay": "Description",
  • "ContractTermAssociationIncludeTypeID": 3,
  • "ContractTermID": 589367893,
  • "ContractTermType": "Contract Term Type",
  • "ContractTermTypeID": 1,
  • "CustomerID": 24626,
  • "CustomerName": "Robert Crescent",
  • "Description": "Contract Description",
  • "FeatureID": 24626,
  • "GraceDays": 5,
  • "IncludeChildren": false,
  • "IsContractTermOverriden": false,
  • "NumberOfUnits": 19.72,
  • "OverrideNumberOfUnits": 19.72,
  • "ProrateUsage": false,
  • "RampUpDays": 30,
  • "ServiceID": 24626,
  • "ServiceNumber": 2425474,
  • "UnitsType": "UnitsType Description",
  • "UnitsTypeID": 1
}

Contract Feature Term Association

A list of features and services that can be associated to a contract term and their association status. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AssociableObject": "Associable Object Description",
  • "AssociableObjectBillingStatus": "Billing Status Description",
  • "AssociableObjectBillingStatusID": 24626,
  • "AssociableObjectCustomerAccountNumber": 84548,
  • "AssociableObjectCustomerID": 24626,
  • "AssociableObjectCustomerName": "Bob Dylan",
  • "AssociableObjectEndDate": "2017-09-09T17:35:09.156Z",
  • "AssociableObjectID": 24626,
  • "AssociableObjectParentServiceID": 47,
  • "AssociableObjectParentServiceNumber": 765474,
  • "AssociableObjectStartDate": "2017-09-09T17:35:09.156Z",
  • "AssociableObjectType": "Associable Object Type",
  • "ContractTermType": "Contract Term Name",
  • "ContractTermTypeID": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "Customer Name",
  • "FeatureCatalog": "Contract Name",
  • "FeatureCatalogDisplay": "My Display Message",
  • "FeatureCatalogID": 24626,
  • "FeatureCatalogSKU": "JGJ7784H79",
  • "FeatureID": 24626,
  • "IsAssociated": false,
  • "IsSelected": true
}

Contract Term Override

A list of all of the contract terms that have been overridden for customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 33418484848,
  • "AlternateDescription": "Alternated Contract Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "ContractTermID": 589367893,
  • "ContractTermType": "Contract Term Type",
  • "ContractTermTypeID": 1,
  • "CustomerID": 589367893,
  • "CustomerName": "Bob Ross",
  • "Description": "Contract Description",
  • "FeatureID": 589367893,
  • "OverrideNumberOfUnits": 19.72,
  • "ServiceID": 452494,
  • "ServiceNumber": 4342
}

Contract Term Penalty Override

A list of all the penalties for contract terms that have been overridden for customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3563558484848,
  • "AlternateDescription": "Alternate Contract Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "ContractTermID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Bob Ross",
  • "Description": "Contract Description",
  • "FeatureID": 589367893,
  • "OverrideAmount": 19.72,
  • "PenaltyCatalogID": 589367893,
  • "ServiceID": 2494,
  • "ServiceNumber": 6363
}

Corporate Account

A list of all corporate accounts in the system. [Rev 1.07]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 565,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CorporateAccountLevel": "Corporate Account Level",
  • "CustomerContactAddress": "9595 Whitney Ontario NY (Wayne) 13343 US",
  • "CustomerID": 24626,
  • "CustomerName": "Bruce Spock",
  • "DisconnectDate": "2017-09-09T17:35:09.156Z",
  • "EstablishDate": "2017-09-09T17:35:09.156Z",
  • "ImmediateParentAccountNumber": 4623,
  • "ImmediateParentCustomerID": 46234,
  • "ImmediateParentCustomerName": "Jean-Luc Picard",
  • "ImmediateParentInvoiceResponsible": false,
  • "InvoiceResponsible": true,
  • "ParentCustomerID": -1,
  • "RootCustomerID": 1354,
  • "TopRootAccountNumber": 56358484848,
  • "TopRootCustomerID": 426,
  • "TopRootCustomerName": "My Customer Name",
  • "TopRootInvoiceResponsible": false,
  • "TotalBalance": 19.72
}

Corporate Account Balance

A list of all corporate accounts and their current balance information. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "BalanceCorporateSummary": 19.72,
  • "CurrentBalance": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DaysPastDue": 3,
  • "ImmediateParentCustomerID": 467,
  • "InvoiceResponsible": false,
  • "InvoiceResponsibleBalance": 19.72,
  • "InvoiceResponsibleUnbilledUsage": 19.72,
  • "ParentCustomerID": -1,
  • "PastDueBalance": 19.72,
  • "RootCustomerID": 674,
  • "TopRootCustomerID": 356,
  • "TotalBalance": 19.72,
  • "UnbilledUsage": 19.72,
  • "UnbilledUsageCorporateSummary": 19.72
}

Customer Account Code

A list of all the account codes in the system with their associated customer account code groups and customer departments. [Rev 1.05]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountCode": 363,
  • "CustomerAccountCodeGroupID": 589367893,
  • "CustomerAccountCodeID": 589367893,
  • "CustomerDepartmentID": 589367893,
  • "DeleteConfirmed": true,
  • "Deleted": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Account Code Name",
  • "Provisioned": true
}

Customer Account Code Group

A list of all the account code groups in the system with their associated customer account. [Rev 1.05]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountCodeGroup": "Account Group Code Label",
  • "AccountCodeLength": 35,
  • "AccountNumber": 424528484848,
  • "CustomerAccountCodeGroupID": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "Michael Warf",
  • "IsVerified": true,
  • "Name": "Account Code Group Name"
}

Customer Billing Information

A list of billing-related information for all customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AccountsReceivableGroup": "Accounts Receivable Group Description",
  • "AccountsReceivableGroupID": 589367893,
  • "AffinityGroup": "Affinity Group Description",
  • "AffinityGroupID": 589367893,
  • "BalanceAgingGroup": "Balance Aging Group Description",
  • "BalanceAgingGroupID": 589367893,
  • "ChildSortOrder": "Child Sort Order Description",
  • "ChildSortOrderID": 1,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DisconnectReason": "Disconnect Reason",
  • "DisconnectReasonDescription": "Disconnect Reason Description",
  • "DisconnectReasonID": 589367893,
  • "FinanceGroup": "Finance Group Description",
  • "FinanceGroupID": 589367893,
  • "HomeRegion": "Home Region Description",
  • "HomeRegionID": 589367893,
  • "IsDirectoryAssistanceChargeExempt": false,
  • "IsDisabled": false,
  • "IsFinanceChargeExempt": false,
  • "IsHearingImpaired": false,
  • "IsLifeline": false,
  • "IsSpeechImpaired": false,
  • "IsVisuallyImpaired": false,
  • "PullInvoice": true,
  • "Region": "Region Description",
  • "RegionID": 589367893,
  • "ReportGroup": "Report Group Description",
  • "ReportGroupID": 589367893,
  • "SuppressInvoicePrint": true,
  • "SuspendReason": "Suspend Reason Description",
  • "SuspendReasonDescription": "Suspend Reason Description",
  • "SuspendReasonID": 589367893,
  • "UsageRoundingOption": "Usage Rounding Option Description",
  • "UsageRoundingOptionID": 1,
  • "UsesTTY": false
}

Customer Contact

A list of all the contacts in the system that are associated to customer accounts. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 4848,
  • "ActualValidationType": "My Validation Type",
  • "ActualValidationTypeID": 24626,
  • "AddressValidationID": 24626,
  • "AddressValidationResult": "My Address Validation Result",
  • "AddressValidationResultCode": "My Address Validation Result Code",
  • "AddressValidationResultID": 24626,
  • "BypassUser": "Username",
  • "CensusBlockCode": 1010,
  • "CensusCounty": 45,
  • "CensusState": 36,
  • "CensusTract": 9404,
  • "City": "New York City",
  • "CompanyName": "My Company",
  • "ContactID": 24626,
  • "ContactType": "Contant Type Name",
  • "ContactTypeID": 589367893,
  • "Country": "United States",
  • "County": "Monroe",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DisplayName": "Street1, Street2, City, State, ZipCode",
  • "EmailAddress1": "auser@mail.com",
  • "EmailAddress1Type": "auser@mail.com",
  • "EmailAddress1TypeID": 24626,
  • "EmailAddress2": "auser@mail.com",
  • "EmailAddress2Type": "auser@mail.com",
  • "EmailAddress2TypeID": 24626,
  • "EmailAddress3": "auser@mail.com",
  • "EmailAddress3Type": "auser@mail.com",
  • "EmailAddress3TypeID": 24626,
  • "ExcludeReasonID": 283482,
  • "FailureCount": 5,
  • "FirstName": "Will",
  • "FullName": "Jim Henson",
  • "HoursOfAccess": 6,
  • "IsPOBox": true,
  • "LastName": "Riker",
  • "Latitude": 56.123456,
  • "Longitude": -116.654321,
  • "MiddleInitial": "T",
  • "Note": "Contact Notes",
  • "PhoneNumber1": "123-456-7890",
  • "PhoneNumber1Type": "Phone Number Type Name",
  • "PhoneNumber1TypeID": 24626,
  • "PhoneNumber2": "123-456-7890",
  • "PhoneNumber2Type": "Phone Number Type Name",
  • "PhoneNumber2TypeID": 24626,
  • "PhoneNumber3": "123-456-7890",
  • "PhoneNumber3Type": "Phone Number Type Name",
  • "PhoneNumber3TypeID": 24626,
  • "PhoneNumber4": "123-456-7890",
  • "PhoneNumber4Type": "Phone Number Type Name",
  • "PhoneNumber4TypeID": 24626,
  • "RequiredValidationType": "MY Validation Type",
  • "RequiredValidationTypeID": 24626,
  • "State": "New York",
  • "Street1": "9595 Whitney Ontario NY 13343 US",
  • "Street2": "9595 Whitney Ontario NY 13343 US",
  • "Street3": "9595 Whitney Ontario NY 13343 US",
  • "Title": "My Title",
  • "ValidationDate": "2017-09-09T17:35:09.156Z",
  • "ZipCode": 45242
}

Customer Department

A list of all the customer departments in the system. [Rev 1.05]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CustomerDepartmentID": 589367893,
  • "CustomerID": 24626,
  • "Department": "Customer Department Name",
  • "DepartmentNumber": 463
}

Customer Email Address

A list of unique email addresses and contact names for a given Customer _[Rev 1.16._02]

  • Note: Queries should filter on a specific CustomerID .
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 474,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Dylan",
  • "EmailAddress": "auser@mail.com",
  • "EmailAlias": "anAliasUser@email.com"
}

Customer Email Address Rollup

A list of unique EmailAddress1 for a customer's primary and billing contacts. [Rev 1.15]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 43636,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "EmailAddress": "auser@mail.com"
}

Customer Extended Tax Exemption

A list of all extended tax exemptions associated with customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CustomerExtendedTaxExemptionID": 589367893,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Associated Extended Tax Exemption Description",
  • "TaxExemptionCategory": "Tax Exemption Category Description",
  • "TaxExemptionCategoryID": 589367893,
  • "TaxType": "Tax Type Description",
  • "TaxTypeExemptID": 589367893,
  • "TaxTypeID": 589367893
}

Customer Service

A list of all the customer services in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AccountStatus": "Customer Account Status Description",
  • "AccountStatusID": 24626,
  • "AccountType": "Customer Account Type Description",
  • "AccountTypeID": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "CustomerType": "Billable",
  • "CustomerTypeID": 24626,
  • "DisconnectDate": "2017-09-09T17:35:09.156Z",
  • "EstablishDate": "2017-09-09T17:35:09.156Z",
  • "FirstName": "William",
  • "IsLoadable": false,
  • "LastName": "Riker",
  • "Market": "My Market Name",
  • "MarketID": 24626,
  • "ServiceAlternateDescription": "Alternate Service Type Description",
  • "ServiceAlternateInvoiceDescription": "Alternate Invoice Description",
  • "ServiceBillingStatus": "Billing Status Description",
  • "ServiceBillingStatusID": 1,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceCatalogID": 589367893,
  • "ServiceEndDate": "2017-09-09T17:35:09.156Z",
  • "ServiceID": 589367893,
  • "ServiceName": "Service Name",
  • "ServiceNumber": 46622467,
  • "ServiceStartDate": "2017-09-09T17:35:09.156Z",
  • "ServiceStatus": "Active",
  • "ServiceSuspendDate": "2017-09-09T17:35:09.156Z"
}

Customer Summary

A list of all customers in the system. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 56354,
  • "AccountStatus": "Account Status Description",
  • "AccountStatusID": 24626,
  • "AccountType": "Account Type",
  • "AccountTypeID": 24626,
  • "BillCycle": "Bill Cycle Name",
  • "BillCycleID": 6356,
  • "BillingContactAddress": "9595 Whitney Ontario NY (Wayne) 13343 US",
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "ChangeDate": "2017-09-09T17:35:09.156Z",
  • "ChangeReason": "My Change Reason",
  • "ChangeReasonID": 24626,
  • "ChangeType": "Change Type Description",
  • "ChangeTypeID": 24626,
  • "CollectionStatus": "Collection Description Status",
  • "CollectionStatusID": 24626,
  • "CorporateAccountRootCustomerID": 34636,
  • "Currency": "USD",
  • "CurrencyID": 24626,
  • "CustomerAuthenticatedKey": "996A681F453SD6",
  • "CustomerContactAddress": "433 Whitney Ontario NY (Wayne) US",
  • "CustomerID": 24626,
  • "CustomerName": "James Kirk",
  • "CustomerType": "Customer Type Description",
  • "CustomerTypeID": 24626,
  • "DisconnectDate": "2017-09-09T17:35:09.156Z",
  • "EstablishDate": "2017-09-09T17:35:09.156Z",
  • "FirstName": "Beverly",
  • "HasCPNIPIN": true,
  • "IsCollectionExempt": false,
  • "IsCorporateAccount": false,
  • "IsInvoiceResponsible": false,
  • "JournalCount": 43454,
  • "Language": "Italian",
  • "LanguageID": 24626,
  • "LastName": "Crusher",
  • "MainBillingNumber": 536,
  • "Market": "Market Name",
  • "MarketID": 24626,
  • "OpenFollowUpCount": 34,
  • "OpenRedFlagTroubleTicketCount": 46,
  • "OpenRetainedFollowUpCount": 4,
  • "OpenTroubleTicketCount": 3,
  • "OverdueFollowUpCount": 3,
  • "OverdueTroubleTicketCount": 5,
  • "PendingBillCycle": "Pending Bill Cycle Name",
  • "PendingBillCycleID": 6346,
  • "PendingBillCycleStartDate": "2017-09-09T17:35:09.156Z",
  • "PrimaryBillingContactID": 123,
  • "PrimaryCustomerContactID": 234,
  • "ReportGroup": "Report Group Name",
  • "ReportGroupID": 24626,
  • "RetainedFollowUpCount": 3,
  • "RetainedJournalCount": 33,
  • "RetainedTroubleTicketCount": 3,
  • "SalesCode": 4465,
  • "SalesCodeID": 5363,
  • "TotalActiveServices": 56,
  • "TotalCustomerUsers": 5634,
  • "TotalServices": 35,
  • "Zone": "Zone Description",
  • "ZoneID": 24626
}

Customer Tax Information

A list of tax-related information for all customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "IsE911ExemptCity": false,
  • "IsE911ExemptCounty": false,
  • "IsE911ExemptRegional": false,
  • "IsE911ExemptState": false,
  • "IsSurchargeExemptCity": false,
  • "IsSurchargeExemptCounty": false,
  • "IsSurchargeExemptFederal": false,
  • "IsSurchargeExemptRegional": false,
  • "IsSurchargeExemptState": false,
  • "IsTaxExemptCity": false,
  • "IsTaxExemptCounty": false,
  • "IsTaxExemptFederal": false,
  • "IsTaxExemptRegional": false,
  • "IsTaxExemptState": false,
  • "IsUSFExemptCity": false,
  • "IsUSFExemptCounty": false,
  • "IsUSFExemptFederal": true,
  • "IsUSFExemptRegional": false,
  • "IsUSFExemptState": false,
  • "SocialSecurityNumber": "***-***-1313",
  • "TaxExemptIDCity": "City Tax Exemption ID",
  • "TaxExemptIDCounty": "Country Tax Exemption ID",
  • "TaxExemptIDFederal": "Federal Tax Exemption ID",
  • "TaxExemptIDRegional": "Regional Tax Exemption ID",
  • "TaxExemptIDState": "Regional Tax Exemption ID",
  • "TaxJurisdictionOverrideID": 45224,
  • "TaxState": "Florida"
}

Customer Tax Jurisdiction

A list of all of the tax jurisdictions associated with customers in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "City": "Ontario",
  • "County": "Monroe",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Notes": "Tax Jurisdiction Notes",
  • "TaxJurisdictionID": 589367893,
  • "TaxState": "North Dakota"
}

Customer Tax Jurisdiction Override

A list of all customer-level tax jurisdiction overrides in the system. [Rev 1.06]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "City": "Worchester",
  • "County": "Ontario",
  • "CustomerID": 589367893,
  • "CustomerName": "Jim Henson",
  • "Notes": "Tax Jurisdiction Notes",
  • "TaxJurisdictionID": 463,
  • "TaxJurisdictionOverrideID": 283482,
  • "TaxState": "New York"
}

Customer User Deprecated

A list of all the default customers, if any, for users in the system. [Rev 1.03]

  • Deprecated: Replaced by UserCustomer [Rev 1.14]
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34344,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CustomerID": 589367893,
  • "CustomerName": "Will Wheaton",
  • "Email": "auser@mail.com",
  • "UserID": 589367893,
  • "UserNotification": true
}

Deposit

A list of all of the deposits in the system. [Rev 1.12]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 542528484848,
  • "CustomerID": 589367893,
  • "CustomerName": "Bob Ross",
  • "DepositID": 589367893,
  • "DepositInterval": 4,
  • "DepositType": "Deposit Type Description",
  • "DepositTypeID": 589367893,
  • "DepositWaiveType": "Deposit Waive Type Description",
  • "DepositWaiveTypeID": 589367893,
  • "Description": "Deposit Description",
  • "EstimatedAllocationDate": "2017-09-09T17:35:09.156Z",
  • "InterestCalculatedDate": "2017-09-09T17:35:09.156Z",
  • "IsPosted": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LatestAllocationDate": "2017-09-09T17:35:09.156Z",
  • "PrincipalAmount": 19.72,
  • "ReceivedDate": "2017-09-09T17:35:09.156Z",
  • "RequestDate": "2017-09-09T17:35:09.156Z",
  • "WaiveDate": "2017-09-09T17:35:09.156Z"
}

Deposit Allocation

A list of all of the allocations made for deposits in the system. [Rev 1.12]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3535568484848,
  • "Amount": 19.72,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "DepositAllocationDate": "2017-09-09T17:35:09.156Z",
  • "DepositAllocationID": 589367893,
  • "DepositAllocationType": "Deposit Allocation Type Description",
  • "DepositAllocationTypeID": 589367893,
  • "DepositID": 589367893,
  • "Description": "Deposit Allocation Description",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username"
}

Deposit Interest

A list of all interest transactions associated with deposits in the system. [Rev 1.12]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463638484848,
  • "Amount": 19.72,
  • "CustomerID": 589367893,
  • "CustomerName": "Kirk Weiler",
  • "DepositID": 589367893,
  • "DepositInterestDate": "2017-09-09T17:35:09.156Z",
  • "DepositInterestID": 589367893,
  • "DepositInterestRateID": 589367893
}

Deposit Summary

A summary of all of the deposits in the system, including TotalAccruedInterest and TotalAllocatedAmount. [Rev 1.12]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 354678484848,
  • "CustomerID": 589367893,
  • "CustomerName": "Bob Ross",
  • "DepositID": 589367893,
  • "DepositInterval": 3,
  • "DepositType": "Deposit Type Description",
  • "DepositTypeID": 589367893,
  • "DepositWaiveType": "Waive Type Description",
  • "DepositWaiveTypeID": 589367893,
  • "Description": "Deposit Description",
  • "EstimatedAllocationDate": "2017-09-09T17:35:09.156Z",
  • "InterestCalculatedDate": "2017-09-09T17:35:09.156Z",
  • "IsPosted": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LatestAllocationDate": "2017-09-09T17:35:09.156Z",
  • "PrincipalAmount": 19.72,
  • "ReceivedDate": "2017-09-09T17:35:09.156Z",
  • "RequestDate": "2017-09-09T17:35:09.156Z",
  • "TotalAccruedInterest": 19.72,
  • "TotalAllocatedAmount": 19.72,
  • "WaiveDate": "2017-09-09T17:35:09.156Z"
}

Device Deprecated

A list of all devices in the system. [Rev 1.14]

  • Deprecated [Rev 2.00]

  • Use Search Devices in Service and Feature Management.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AlternateSerialNumber": 462365,
  • "AlternateSerialNumberCheckDigit": 34,
  • "CatalogID": 589367893,
  • "DecPseudoESN": 987654,
  • "DeviceID": 589367893,
  • "DisplayName": "User-Friendly Name",
  • "HardwareVersion": "1.0.2",
  • "HexPseudoESN": "My Hexadecimal ESN Number",
  • "MSL": "My MSL",
  • "Name": "Device Description",
  • "OneTimeSL": "My OneTimeSL",
  • "PIN": 5787,
  • "ReferenceNumber": 3755,
  • "SerialNumber": 6747,
  • "SerialNumberType": 6774,
  • "SerialNumberTypeID": "1'",
  • "SID": 4674,
  • "SoftwareVersion": "1.0.2",
  • "SourceCode": "Retail Outlet Description",
  • "SourceCodeID": 24626,
  • "Status": "Device Status",
  • "StatusID": 24626,
  • "TechnologyType": "My Technology Type",
  • "TechnologyTypeID": 1
}

Discount Category Service Affiliation

A list of all services associated by Discount Category with a given ServiceID, BillPeriodID, and DiscountCategoryID. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "BillPeriodID": 24626,
  • "DiscountCategory": "Discount Category Description",
  • "DiscountCategoryID": 24626,
  • "DiscountedServiceDescription": "Catalog Description",
  • "DiscountedServiceID": 589367893,
  • "DiscountedServiceMyOverageCharge": 19.72,
  • "DiscountedServiceMyOverageUnits": 19.72,
  • "DiscountedServiceMyUnits": 19.72,
  • "DiscountedServiceName": "Affiliated Service Name",
  • "DiscountedServiceNumber": 544467,
  • "DiscountedServicePreviouslyDisconnected": true,
  • "DiscountedServiceTypeID": 283482,
  • "DiscountOwnerAccountNumber": 8484848,
  • "DiscountOwnerCustomerID": 589367893,
  • "DiscountOwnerCustomerName": "Bob Dylan",
  • "ServiceCustomerID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 467,
  • "UnitSubType": "Unit Subtype Name",
  • "UnitSubTypeID": 24626
}

Discount Feature

A list of all assigned feature instances in the system which are discounts. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AlternateDescription": "Alternate Feature Type Description",
  • "AlternateInvoiceDescription": "Alternate Feature Type Name",
  • "AssociativeType": "My Associative Type",
  • "AssociativeTypeID": 1,
  • "BillingCycleType": "Charge Cycle Description",
  • "BillingCycleTypeID": 1,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 589367893,
  • "Charge": 19.72,
  • "Configuration": "My Configuration",
  • "CustomerID": 589367893,
  • "Description": "Feature Type Description",
  • "DiscountCategory": "My Discount Category",
  • "DiscountCategoryID": 24626,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "FavoriteNumbersEndUserEditable": true,
  • "FavoriteNumbersEndUserViewable": true,
  • "FeatureID": 589367893,
  • "MaximumAllowedFavoriteNumbers": 32,
  • "ParentFeatureID": 462494,
  • "Quantity": 34,
  • "Registry": "My Discount Type",
  • "RegistryID": 1,
  • "ServiceID": 42494,
  • "ServiceNumber": 42364467,
  • "SKU": "464KK35L2",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "TotalActiveFavoriteNumbers": 74,
  • "UnitsType": "My Measure of Units",
  • "UnitsTypeID": 24626,
  • "WebName": "My User-Friendly Name"
}

Extended Information Item

A list of additional key/value properties associated with any objects of the types shown. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Key": "Extended Property Name",
  • "ObjectID": 589367893,
  • "ObjectType": "Customer",
  • "Value": "My Extended Property Name"
}

Favorite Number

A list of all favorite numbers in the system. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "Favorite Number Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "Note": "Favorite Number Notes",
  • "PhoneNumber": "123-456-7890",
  • "PhoneNumberID": 589367893,
  • "ServiceCatalogID": 589367893,
  • "ServiceDescription": "Catalog Description",
  • "ServiceID": 589367893,
  • "ServiceNumber": 4363467,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Feature

A list of all assigned feature instances in the system.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountCodeGroup": 353253,
  • "AlternateDescription": "Alternate Feature Type Description",
  • "AlternateInvoiceDescription": "My Alternate Invoice Description",
  • "ApplyToServiceCatalog": "Type of Service Description",
  • "ApplyToServiceCatalogID": "Service Catalog ID description",
  • "AttributePropertyDisplay": "My Display Name",
  • "AttributePropertyID": 24626,
  • "BillingCycleType": "Change Cycle Description",
  • "BillingCycleTypeID": 1,
  • "BillingStatus": 1,
  • "BillingStatusID": 1,
  • "CatalogID": 589367893,
  • "Charge": 19.72,
  • "ChargeDefault": 19.72,
  • "ChargeOverridden": true,
  • "Cost": 19.72,
  • "CostDefault": 19.72,
  • "CostOverridden": true,
  • "CustomerAccountCodeGroupID": 24626,
  • "CustomerID": 589367893,
  • "Description": "Feature Type Description",
  • "DisableCreditingInAdvanceCharge": true,
  • "DisableETF": true,
  • "DisplayZeroCharges": true,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExclusiveGroup": "My Exclusive Group",
  • "ExclusiveGroupID": 589367893,
  • "FeatureID": 589367893,
  • "FinalInvoiceDate": "2017-09-09T17:35:09.156Z",
  • "FinalInvoiceNumber": 535,
  • "InvoiceNumberPosted": 5363,
  • "InvoicePostedDate": "2017-09-09T17:35:09.156Z",
  • "IsDynamicCharge": false,
  • "IsOnePrice": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Notes": "Feature Notes",
  • "NumberOfInstallments": 23463,
  • "OriginalStartDate": "2022-02-02T17:35:09.156Z",
  • "ParentFeatureID": 532494,
  • "ParentServiceCatalog": "Assigned Services Parent Service Description",
  • "ParentServiceCatalogID": 472494,
  • "ParentServiceID": 562494,
  • "ParentServiceNumber": "My Service Number",
  • "PayInInstallments": true,
  • "PreviousServiceDate": "2017-09-09T17:35:09.156Z",
  • "ProductCatalogClass": "My Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "ProductSubtype": "Wholesale",
  • "ProductSubtypeID": 1,
  • "ProductType": "My Product Type",
  • "ProductTypeID": 1,
  • "ProtectionPlanD": 99,
  • "ProvisioningCompany": "Provisioning Company Name",
  • "ProvisioningCompanyID": 589367893,
  • "ProvisioningStatus": "Provisioning Status Description",
  • "ProvisioningStatusID": 589367893,
  • "Quantity": 23,
  • "ServiceAgreementID": 4574,
  • "ServiceBillingStatus": "Billing Status Description",
  • "ServiceBillingStatusID": 1,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceCatalogID": 5742494,
  • "ServiceDate": "2017-09-09T17:35:09.156Z",
  • "ServiceEndDate": "2017-09-09T17:35:09.156Z",
  • "ServiceID": 4262494,
  • "ServiceIsPrimary": true,
  • "ServiceNumber": "My Service Number467",
  • "ServiceStartDate": "2017-09-09T17:35:09.156Z",
  • "SKU": "LEV-JN-SL-36-GN",
  • "SOC": "My SOC",
  • "SOCOverridden": true,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "WebName": "My Feature Type Name",
  • "WholesaleCost": 19.72,
  • "WholesaleCostDefault": 19.72,
  • "WholesaleCostOverridden": true
}

Feature Action Summary

A list of all assigned feature instances, including a list of cart/order IDs for any In-Process actions on each feature. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AlternateDescription": "Feature Type Description",
  • "AlternateInvoiceDescription": "Alternate Feature Type Description",
  • "BillingCycleType": "Charge Cycle Description",
  • "BillingCycleTypeID": 1,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CartActions": "Disconnect",
  • "CatalogID": 2462624626,
  • "CustomerID": 24626,
  • "Description": "Feature Type Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "FeatureID": 24626,
  • "ParentFeatureID": 42494,
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "ProductType": "My Product Type",
  • "ProductTypeID": 1,
  • "Quantity": 4244,
  • "ServiceBillingStatus": "Billing Status Description",
  • "ServiceBillingStatusID": 1,
  • "ServiceEndDate": "2017-09-09T17:35:09.156Z",
  • "ServiceID": 542494,
  • "ServiceIsPrimary": true,
  • "ServiceNumber": 424474,
  • "ServiceStartDate": "2017-09-09T17:35:09.156Z",
  • "SKU": "353YG342GGDF",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "WebName": "User-Friendly Name"
}

Feature Catalog Group

A list of all assigned features that are associated to one or more catalog groups.[Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 8484848,
  • "CatalogDisplay": "My Catalog Display Description",
  • "CatalogGroup": "Product Catalog Group",
  • "CatalogGroupID": 5363,
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Feature Type Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "FeatureID": 589367893,
  • "ProductType": "Product",
  • "ProductTypeID": 1,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceCatalogID": 2494,
  • "ServiceID": 2494,
  • "ServiceNumber": 363467,
  • "SKU": "6S7DS7HF8F",
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Feature Catalog Overview

The count of features, including active count, by customer and CatalogID. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 43636,
  • "ActiveCount": 425,
  • "AlternateDescription": "Alternate Feature Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description Name",
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Feature Type Description",
  • "TotalCount": 54
}

Feature Summary

A summary of all assigned feature types by CatalogID, CustomerID, and ServiceID, including active and inactive counts. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 445228484848,
  • "ActiveCount": 544,
  • "AlternateDescription": "Alternate Feature Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "BillingCycleType": "Billing Cycle Type Description",
  • "BillingCycleTypeID": 1,
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Deanna Troi",
  • "Description": "Feature Type Description",
  • "ExclusiveGroup": "My Exclusive Group",
  • "ExclusiveGroupID": 589367893,
  • "InactiveCount": 23,
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "ProductType": "My Product Type",
  • "ProductTypeID": 1,
  • "ServiceBillingStatus": "Service Billing Status Description",
  • "ServiceBillingStatusID": 1,
  • "ServiceEndDate": "2017-09-09T17:35:09.156Z",
  • "ServiceID": 46346,
  • "ServiceIsPrimary": true,
  • "ServiceNumber": 42462467,
  • "ServiceStartDate": "2017-09-09T17:35:09.156Z",
  • "SKU": "KS944RUR",
  • "WebName": "User-Friendly Name"
}

Installment Plan

A list of all installment plans in the system with their respective retail product, if applicable. [Rev 1.08]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AssociatedAccountNumber": 34634,
  • "AssociatedCustomerID": 24626,
  • "AssociatedCustomerName": "Jean-Luc Picard",
  • "BillingOrderID": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DownPaymentAmount": 19.72,
  • "FinalizeDate": "2017-09-09T17:35:09.156Z",
  • "FirstInstallmentIncludedInTransaction": true,
  • "FirstInstallmentIncludedInTransactionAmount": 19.72,
  • "InstallmentAgreementGUID": "6e211313-cada-4e92-a344-7cf030839b9a",
  • "InstallmentAmountNotYetInvoiced": 19.72,
  • "InstallmentAmountTotal": 19.72,
  • "InstallmentPlanDescription": "Installment Plan Description",
  • "InstallmentPlanFeatureAlternateInvoiceDescription": "Installment Plan Feature Alternate Name",
  • "InstallmentPlanFeatureCatalog": "Installment Plan Feature Description",
  • "InstallmentPlanFeatureCatalogID": 24626,
  • "InstallmentPlanFeatureEndDate": "2017-09-09T17:35:09.156Z",
  • "InstallmentPlanFeatureID": 24626,
  • "InstallmentPlanFeatureSKU": "GS5424HDD",
  • "InstallmentPlanFeatureStartDate": "2017-09-09T17:35:09.156Z",
  • "InstallmentPlanFeatureWebName": "User-Friendly Name",
  • "ItemNumber": 42545,
  • "LocationName": "My Location Name",
  • "NumberOfInstallments": 424,
  • "NumberOfInstallmentsRemaining": 46,
  • "OriginatingInstallmentPlanFeatureID": 24625,
  • "ReceiptNumber": 63635,
  • "RetailInstallmentPlanBillingOrderDetailID": 4655,
  • "RetailProductBillingOrderID": 4635,
  • "RetailProductCatalog": "Catalog Description",
  • "RetailProductCatalogID": 3643,
  • "RetailProductDisplay": "Web Name",
  • "RetailProductExtendedPrice": 19.72,
  • "RetailProductID": 24626,
  • "RetailProductQuantity": 462,
  • "RetailProductSalesCode": "858HD9959IDFJ",
  • "RetailProductSalesCodeID": 474,
  • "RetailProductSalesEntityFirstName": "My Sales Entity First Name",
  • "RetailProductSalesEntityLastName": "My Sales Entity Last Name",
  • "RetailProductSerialNumber": "3DTH53YTGEG",
  • "RetailProductSKU": "SGAS4424234",
  • "RetailProductUnitPrice": 19.72,
  • "ServiceID": 24626,
  • "ServiceNumber": 46234467,
  • "TotalAmountDue": 19.72,
  • "TotalDiscountAmount": 19.72,
  • "TotalPriceAdjustmentAmount": 19.72
}

Installment Plan Detail

A list of all the installment plan details (individual installments associated with installment plans) in the system. [Rev 1.08]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Amount": 19.72,
  • "InstallmentDate": "2017-09-09T17:35:09.156Z",
  • "InstallmentPlanDetailID": 24626,
  • "InstallmentPlanFeatureID": 24626
}

Invoice

A list of all invoices in the system.

  • Note: Generally, positive values are debits, or additions to the amount a customer owes and negative values are credits, or subtractions from the amount a customer owes. For example, payments and discounts are normally returned as negative.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Adjustments": 19.72,
  • "AlternateInvoiceNumber": 467666,
  • "AmountOfPreviousInvoice": 19.72,
  • "BillPeriodApprovalDate": "2017-09-09T17:35:09.156Z",
  • "BillPeriodEndDate": "2017-09-09T17:35:09.156Z",
  • "BillPeriodID": 589367893,
  • "BillPeriodStartDate": "2017-09-09T17:35:09.156Z",
  • "CorporateRollupOffset": 19.72,
  • "CustomerID": 589367893,
  • "Discounts": 19.72,
  • "FinanceCharges": 19.72,
  • "InstallmentPlans": 19.72,
  • "InvoiceDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceDocumentIdentifier": "My Invoice Document Identifier",
  • "InvoiceDueDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceNumber": 589367893,
  • "InvoiceResponsible": false,
  • "IsCorporateRollupAvailable": false,
  • "IsInCorporateHierarchy": true,
  • "IsNIRRollUp": false,
  • "IsPrebill": true,
  • "IsTotalRollUp": false,
  • "MonthlyPoints": 10,
  • "MRC": 19.72,
  • "MyTotalAmountDue": 19.72,
  • "MyTotalNewCharge": 19.72,
  • "MyTotalNewChargeExclusive": 10.72,
  • "NRC": 19.72,
  • "Payments": 19.72,
  • "Penalties": 19.72,
  • "RewardPointsBalance": 19.72,
  • "Taxes": 19.72,
  • "TotalAmountDue": 19.72,
  • "TotalNewCharge": 19.72,
  • "Usage": 19.72,
  • "UsageAliasName": "My Usage Alias Name",
  • "UsageArchived": false,
  • "USGFileCreated": 1,
  • "WebViewable": true
}

Invoice Feature

A list of invoice details for product catalog features. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "Amount": 19.72,
  • "BillPeriodID": 589367893,
  • "Catalog": "Catalog Description",
  • "CatalogID": 4623,
  • "ChargeEndDate": "2017-09-09T17:35:09.156Z",
  • "ChargeStartDate": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "FeatureID": 589367893,
  • "InvoiceDetailID": 3452,
  • "InvoiceDetailType": "Invoice Detail Type",
  • "InvoiceDetailTypeID": 10,
  • "InvoiceNumber": 589367893,
  • "IsFinalBilled": false,
  • "IsInAdvanceCharge": true,
  • "Quantity": 454,
  • "ServiceDescription": "Catalog Description",
  • "ServiceID": 589367893,
  • "ServiceName": "Service Name",
  • "ServiceNumber": 4633467,
  • "SKU": "6S7DS7HF8F",
  • "WebName": "My User Friendly Name"
}

Invoice Feature Overview

A list of the total quantity and charges of product catalog features for an invoice per invoice detail type and CatalogID. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AlternateInvoiceNumber": "My Alternate Invoice Number",
  • "BilledInstanceCount": 3456,
  • "BillPeriodID": 589367893,
  • "Catalog": "Catalog Description",
  • "CatalogID": 4623,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "InvoiceDetailType": "Invoice Detail Type",
  • "InvoiceDetailTypeID": 10,
  • "InvoiceNumber": 589367893,
  • "Quantity": 364,
  • "SKU": "6S7DS7HF8F",
  • "TotalCharges": 19.72,
  • "WebName": "My User Friendly Name"
}

Invoice Feature Summary

Summary of all the invoice details for product catalog features and related information. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AlternateInvoiceNumber": "My Alternate Invoice Number",
  • "Amount": 19.72,
  • "BillPeriodID": 589367893,
  • "Catalog": "Catalog Description",
  • "CatalogID": 4623,
  • "ChargeEndDate": "2017-09-09T17:35:09.156Z",
  • "ChargeStartDate": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "FeatureID": 589367893,
  • "InvoiceDetailID": 3452,
  • "InvoiceDetailType": "Invoice Detail Type",
  • "InvoiceDetailTypeID": 10,
  • "InvoiceNumber": 589367893,
  • "IsFinalBilled": false,
  • "IsInAdvanceCharge": false,
  • "Quantity": 454,
  • "ServiceDescription": "Catalog Description",
  • "ServiceID": 589367893,
  • "ServiceName": "Service Name",
  • "ServiceNumber": 4633467,
  • "SKU": "6S7DS7HF8F",
  • "TotalAdjustmentAmount": 19.72,
  • "WebName": "My User Friendly Name"
}

Invoice Insert

A list of all invoice inserts configured in the system. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CustomerID": 24626,
  • "CustomerName": "Jim Henson",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceInsertID": 24626,
  • "InvoiceInsertNumber": 283482,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Invoice Ledger Item

A list of payments and adjustments associated with an invoice. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AlternateInvoiceNumber": "Alternate Invoice Number",
  • "Amount": 19.72,
  • "BillPeriodID": 589367893,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Date": "2017-09-09T17:35:09.156Z",
  • "Description": "Payment Description",
  • "InvoiceNumber": 589367893,
  • "IsChargeAdjustment": true,
  • "LedgerItemID": 589367893,
  • "LedgerItemType": "Ledger Item Type Description",
  • "LedgerItemTypeID": 1,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "Type": "Payment or Adjustment Type Description",
  • "TypeID": 24626
}

Invoice Message

A list of all invoice messages configured in the system. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Dylan",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceMessageID": 24626,
  • "Message": "My Message''",
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Invoice Summary

A summary of all invoices in the system by their detail records. [Rev 1.11.01]

Note

Generally, positive values are debits, or additions to the amount a customer owes and negative values are credits, or subtractions from the amount a customer owes. For example, payments and discounts are normally returned as negative.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/customer/{environment}/api/odataquery?$filter=field1 eq 1"
}

Invoice Summary With Corporate Rollup

A summary of all invoices in the system by their detail records. This includes corporate account roll-up detail records. _[Rev 1.11._01]

  • Note: Generally, positive values are debits, or additions to the amount a customer owes and negative values are credits, or subtractions from the amount a customer owes. For example, payments and discounts are normally returned as negative.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AmountOfPreviousInvoice": 19.72,
  • "BillPeriodApprovalDate": "2017-09-09T17:35:09.156Z",
  • "BillPeriodEndDate": "2017-09-09T17:35:09.156Z",
  • "BillPeriodID": 589367893,
  • "BillPeriodStartDate": "2017-09-09T17:35:09.156Z",
  • "CorporateRollupOffset": 19.72,
  • "CustomerID": 589367893,
  • "InvoiceDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceDocumentIdentifier": "My Invoice Document Identifier",
  • "InvoiceDueDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceNumber": 589367893,
  • "IsCorporateRollupAvailable": false,
  • "IsNIRRollup": false,
  • "IsPrebill": true,
  • "IsTotalRollUp": false,
  • "MonthlyPoints": 56,
  • "MyTotalAmountDue": 19.72,
  • "MyTotalNewCharge": 19.72,
  • "MyTotalNewChargeExclusive": 10.72,
  • "RewardPointsBalance": 19.72,
  • "TotalAdjustments": 19.72,
  • "TotalAmountDue": 19.72,
  • "TotalChargeAdjustments": 0,
  • "TotalCreditAdjustments": 0,
  • "TotalDiscounts": 19.72,
  • "TotalFinanceCharges": 19.72,
  • "TotalInstallmentPlans": 19.72,
  • "TotalMRC": 19.72,
  • "TotalNewCharge": 19.72,
  • "TotalNRC": 19.72,
  • "TotalPayments": 19.72,
  • "TotalPenalties": 19.72,
  • "TotalRollupAdjustments": 19.72,
  • "TotalRollupDiscounts": 19.72,
  • "TotalRollupFinanceCharges": 19.72,
  • "TotalRollupInstallmentPlans": 19.72,
  • "TotalRollupMRC": 19.72,
  • "TotalRollupNRC": 19.72,
  • "TotalRollupPayments": 19.72,
  • "TotalRollupPenalties": 19.72,
  • "TotalRollupTaxes": 19.72,
  • "TotalRollupUsage": 19.72,
  • "TotalTaxes": 19.72,
  • "TotalUsage": 19.72,
  • "UsageAliasName": "My Alias",
  • "UsageArchived": false,
  • "UsageExcluded": false,
  • "USGFileCreated": false,
  • "WebViewable": false
}

Invoice Tax Overview

A list of the total tax due for an invoice per taxid. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "InvoiceDetailType": "Invoice Detail Type",
  • "InvoiceDetailTypeID": 24626,
  • "InvoiceNumber": 589367893,
  • "IsTaxable": false,
  • "TaxAmount": 19.72,
  • "TaxID": 589367893,
  • "TaxName": "Tax Name Description",
  • "TaxPercentage": 19.72
}

Market Assignment Address

Indicates a City, State and ZipCode combination to be used when calculating a default market, and the MarketID associated with it. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "City": "Victor",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Market": "Market Name",
  • "MarketAssignmentAddressID": 589367893,
  • "MarketAssignmentSettingID": 564,
  • "MarketID": 464,
  • "State": "Texas",
  • "ZipCode": 35353
}

Market Assignment Setting

Indicates the configuration to be used by the CalculateDefaultMarket method when determining the default market. If the system is set up properly, there should be at most one MarketAssignmentSetting record. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DefaultMarket": "Market Name",
  • "DefaultMarketID": 589367893,
  • "DisableMarketFieldOnAddCustomer": true,
  • "EnableAssignmentLogic": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "MarketAssignmentSettingID": 589367893,
  • "UseLocationContact": true,
  • "UseLocationMarket": true,
  • "UseProvidedAddress": true
}

NLAD Information

A list of all NLAD-specific (National Lifeline Accountability Database) customer information in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AgentID": 246642,
  • "AgentName": "Agent Name",
  • "BenefitQualifyingPersonFirstName": "John",
  • "BenefitQualifyingPersonLastName": "Smith",
  • "BenefitQualifyingPersonMiddleName": "Henry",
  • "BenefitQualifyingPersonSocialSecurityNumber": 4532,
  • "BenefitQualifyingPersonTribalID": 2325323,
  • "CertificationFlag": true,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DisputeResolutionErrorCode": "My Resolution Error Code",
  • "DisputeResolutionErrorCodeID": 24626,
  • "FullNameDOBCode": "NLADDisputeResolutionErrorCode Description",
  • "FullNameDOBCodeID": 24626,
  • "FullNameLast4SSNCode": "NLADDisputeResolutionErrorCode Description",
  • "FullNameLast4SSNCodeID": 24626,
  • "IndependentEconomicHouseholdCertificationDate": "2017-09-09T17:35:09.156Z",
  • "IndependentEconomicHouseholdRecertificationDate": "2017-09-09T17:35:09.156Z",
  • "IsIndependentEconomicHousehold": false,
  • "IsLifelineProgramTribalBenefit": false,
  • "IsPrimaryAddressRural": false,
  • "IsPrimaryAddressTemporary": false,
  • "IsPrimaryAddressTribal": false,
  • "IsSubscriberInAddressConfidentialityProgram": false,
  • "IsTransfer": false,
  • "LifelineEligibilityProgramCode": "Lifeline Eligibility Program Code",
  • "LifelineEligibilityProgramCodeID": 24626,
  • "LinkUpServiceDate": "2017-09-09T17:35:09.156Z",
  • "NLADServiceType": "NLADServiceType Description",
  • "NLADServiceTypeID": 24626,
  • "NVApplicationID": "Q12345-12345",
  • "ReachByEmail": false,
  • "ReachByMail": false,
  • "ReachByPhone": false,
  • "ReachByText": false,
  • "ServiceInitializationDate": "2017-09-09T17:35:09.156Z",
  • "ServiceReverificationDate": "2017-09-09T17:35:09.156Z",
  • "StudyAreaCode": 4623,
  • "TPIVResolutionRequired": true,
  • "TribalID": 452542
}

Notification Delivery Type

List of notification delivery types in the system. [Rev 1.17]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "Notification Delivery Type",
  • "NotificationDeliveryTypeID": 24626
}

Notification History

List of notifications in the system. [Rev 1.17]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3567,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 24626,
  • "CustomerName": "Kirk James",
  • "Note": "Notification Note",
  • "NotificationBatchID": 24626,
  • "NotificationDate": "2017-09-09T17:35:09.156Z",
  • "NotificationDeliveryType": "My Delivery Type",
  • "NotificationDeliveryTypeID": 24626,
  • "NotificationHistoryID": 24626,
  • "NotificationResult": "My Result Status",
  • "NotificationResultID": 24626,
  • "NotificationTemplate": "Template Name",
  • "NotificationTemplateID": 24626,
  • "ObjectID": 24626,
  • "ObjectType": "Associated Notification Object"
}

Notification Template

List of notification templates in the system. [Rev 1.17]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AllowResubmit": true,
  • "Description": "Notification Template Description",
  • "Name": "Notification Template Name",
  • "NotificationSource": "Notification Source",
  • "NotificationSourceKeyName": 8488,
  • "NotificationTemplateID": 24626,
  • "NotificationTemplateKeyName": "IDI.EPayTransactionNotification.Sample",
  • "ObjectIDField": "CustomerID",
  • "PropertiesProtected": true,
  • "TemplateProtected": true
}

Order Status Overview

An overview showing the number of Orders and BillingOrders in a particular Status for an account. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "Count": 34,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Status": "Order or BillingOrder Status",
  • "StatusID": 589367893,
  • "Type": "Order"
}

Payment

A list of all Payments in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "AccountsReceivableBatchControlled": false,
  • "AccountsReceivableBatchFile": "Accounts Receivabke Batch File Name",
  • "AccountsReceivableBatchFileID": 24626,
  • "AccountsReceivableBatchFileRequestID": 24626,
  • "AccountsReceivableBatchNumber": "My Batch Number",
  • "Amount": 19.72,
  • "AppliedToInstallmentPlanCatalog": "InstallmentPlan Catalog Item Description",
  • "AppliedToInstallmentPlanCatalogID": 24626,
  • "AppliedToInstallmentPlanFeatureID": 24626,
  • "AppliedToInvoiceNumber": 464,
  • "BillPeriodIDPosted": 283482,
  • "BlockPosting": true,
  • "CheckNumber": "My Check Number",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 283482,
  • "CustomerName": "John Smith",
  • "Description": "Payment Description",
  • "InvoiceNumberPosted": 58,
  • "IsPosted": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "OnHold": 1,
  • "OriginalCorporatePaymentID": 283482,
  • "ParentPaymentID": 283482,
  • "PaymentAccountTransactionID": 283482,
  • "PaymentDate": "2017-09-09T17:35:09.156Z",
  • "PaymentID": 24626,
  • "PaymentOverrideCount": 53,
  • "PaymentTrackingID": 766,
  • "PaymentType": "Payment Type Description",
  • "PaymentTypeID": 24626,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "ReversalPaymentID": 42494
}

Payment Account

A list of all customer payment accounts.

  • Note: RemittanceType is in parentheses for fields that are specific to only a certain type.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ABARoutingNumber": 251082615,
  • "ACHLOAFilingDate": "2017-09-09T17:35:09.156Z",
  • "BankAccountNumber": 1234,
  • "BankAccountType": "My Bank Account Type",
  • "BankAccountTypeID": 1,
  • "BankName": "Bank Name",
  • "BankProcessingType": "PPD",
  • "CardNumber": 1234,
  • "ContactID": 283482,
  • "CreditCardType": "Credit Card Type",
  • "CreditCardTypeID": 1,
  • "CustomerID": 283482,
  • "DriversLicenseState": "NY",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "ExpirationNotificationRequestedDate": "2017-09-09T17:35:09.156Z",
  • "IsDeleted": false,
  • "IsTerminated": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "PaymentAccountID": 283482,
  • "RecurringEndDate": "2017-09-09T17:35:09.156Z",
  • "RecurringStartDate": "2017-09-09T17:35:09.156Z",
  • "RecurringStatus": "Recurring",
  • "RemittanceType": 1,
  • "RemittanceTypeID": 4,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "Use5DigitZipCode": true
}

Payment Account Transaction

A list of all transactions made against customer payment accounts. [Rev 1.12]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Amount": 19.72,
  • "ApprovalCode": "My Approval Code",
  • "ApprovalDate": "2017-09-09T17:35:09.156Z",
  • "BankAccountType": "My Bank Account Type",
  • "BankAccountTypeID": 1,
  • "BankName": "My Bank Name",
  • "CreateDate": "2017-09-09T17:35:07.146Z",
  • "CreditCardType": "My Credit Card Type",
  • "CreditCardTypeID": 1,
  • "CustomerAccountNumber": 3567,
  • "CustomerID": 283482,
  • "CustomerName": "Bob Ross",
  • "DeclineCount": 1,
  • "ErrorCode": "My Error Code",
  • "ErrorMessage": "My Error Message",
  • "IsRecurring": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "PaymentAccountID": 283482,
  • "PaymentAccountTransactionDescription": "Transaction Description",
  • "PaymentAccountTransactionDescriptionID": 283482,
  • "PaymentAccountTransactionID": 24626,
  • "PaymentAccountTransactionStatus": "Transaction of Status",
  • "PaymentAccountTransactionStatusID": 283482,
  • "PostedAccountTransactionID": 2494,
  • "ProcessDate": "2017-09-09T17:35:09.156Z",
  • "ProviderAVSResultCode": "AVS result Code",
  • "ProviderDescription": "Payment Provider Description",
  • "ProviderResultCode": "My Result Code",
  • "ProviderTransactionID": "My Payment Provider ID",
  • "RemittanceType": "Payment Account Type",
  • "RemittanceTypeID": "Credit Card",
  • "RootPaymentAccountTransactionID": 12345,
  • "TransactionType": "My Transaction Type",
  • "TransactionTypeID": 1
}

Payment Allocation Override

A list of payment allocation overrides created in the system. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Amount": 19.72,
  • "BillPeriodID": 45,
  • "CustomerID": 283482,
  • "CustomerName": "William Tell",
  • "InvoiceCategory": "Invoice Category",
  • "InvoiceCategoryID": 283482,
  • "InvoiceNumber": 283482,
  • "PaymentAllocationOverrideID": 24626,
  • "PaymentID": 24626
}

Port Activity Deprecated

A list of all the activity on port requests in the system. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Activity Description",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "PortActivityID": 24626,
  • "PortActivityType": "Port Activity Type Description",
  • "PortActivityTypeID": 24626,
  • "PortID": 3653,
  • "PortReasonCode": "Reason Code Description",
  • "PortReasonCodeID": 24626,
  • "PortRequestID": 24626,
  • "PortTimeZone": "My Port Request Time Zone",
  • "Remarks": "My Remarks",
  • "User": "Username"
}

Port Activity Type Deprecated

A list of all port activity types in the system. [Rev 1.15]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "IsPortInActivity": false,
  • "IsPortOutActivity": false,
  • "Name": "Activity Name",
  • "PortActivityTypeID": 283482
}

Port Request Deprecated

A list of all the port requests in the system. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "AssignedUser": "Username",
  • "AuthorizedBy": "Username",
  • "BillAccountNumber": 3436,
  • "BillCompanyName": "My Bill Company Name",
  • "BillFirstName": "My Bill First Name",
  • "BillingOrderID": 24626,
  • "BillLastName": "My Bill Last Name",
  • "BillMiddleInitial": "T",
  • "BillPrefix": "My Bill Prefix",
  • "BillSuffix": "My Bill Prefix",
  • "City": "Rochester",
  • "Country": "United States",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CurrentServiceNumber": 2462467,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "InitiationDate": "2017-09-09T17:35:09.156Z",
  • "LastActivityDate": "2017-09-09T17:35:09.156Z",
  • "LastActivityReasonCode": "Reason Code Description",
  • "LastActivityReasonCodeID": 24626,
  • "LastActivityRemarks": "Activity Remarks",
  • "LastActivityType": "Activity Type Description",
  • "LastActivityTypeID": 24626,
  • "PortID": 4462,
  • "PortMessageID": "My Port Message ID",
  • "PortRequestID": 24626,
  • "PortRequestServiceNumber": 246467,
  • "PortStatus": "Port Status Description",
  • "PortStatusID": 24626,
  • "PortTimeZone": "My Port Request Time Zone",
  • "PortType": "Port Type Description",
  • "PortTypeID": 24626,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceInformationItemID": 24626,
  • "ServiceNumberOwner": "Service Number Owner Description",
  • "ServiceNumberOwnerID": 24626,
  • "State": "New York",
  • "StreetDirection": "North",
  • "StreetName": "543 Whitney Houston Texas US",
  • "StreetNumber": 543,
  • "ZipCode": 68568
}

Service

A list of all assigned service instances in the system containing a great amount of detail.

  • Note: For a more focused set of fields useful for filtering of dropdown menus, use ServiceNumberDetail.
  • Note: It is recommended to not use this OData to search for services. To search for services use the ServicesAndFeatures web service and use Search Services.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ALECount": 19.72,
  • "AllowEquipmentAssignment": true,
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AlternateServiceNumber": "My Alternate Service Number",
  • "AttributePropertyDisplay": "Root Property Display Name",
  • "AttributePropertyID": 24626,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 589367893,
  • "ContactID": 24626,
  • "Contract": "Contract Description",
  • "ContractCatalogID": 5857,
  • "ContractEndDate": "2017-09-09T17:35:09.156Z",
  • "CustomerDepartment": "My Customer Department",
  • "CustomerDepartmentID": 283482,
  • "CustomerID": 589367893,
  • "Description": "Service Type Description",
  • "DisconnectReason": "Disconnect Reason Description",
  • "DisconnectReasonDescription": "Disconnect Reason",
  • "DisconnectReasonID": 589367893,
  • "E911ClassOfService": "E911 Class of Service Name",
  • "E911ClassOfServiceID": 24626,
  • "E911ServiceAddressID": 24626,
  • "E911TypeOfService": "E911 Type Of Service Name",
  • "E911TypeOfServiceID": 24626,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "EstimatedMRC": 19.72,
  • "FirstCallDate": "2017-09-09T17:35:09.156Z",
  • "Handset": "Handset Model Description",
  • "HandsetAlternateDescription": "Alternate Handset Description",
  • "HandsetAlternateInvoiceDescription": "Alternate Handset Name",
  • "HandsetAlternateSerialNumber": "My Alternate Serial Number",
  • "HandsetCatalogID": 357,
  • "HandsetID": 24626,
  • "HandsetSerialNumber": "My Serial Number",
  • "HandsetWebName": "User-friendly Name",
  • "IsCPNIService": false,
  • "IsE911ExemptCity": false,
  • "IsE911ExemptCounty": false,
  • "IsE911ExemptRegional": false,
  • "IsE911ExemptState": false,
  • "IsLoadable": false,
  • "IsPerLineTaxConfigurationOverridden": false,
  • "IsPortOut": true,
  • "IsPrimaryService": false,
  • "LastCallDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Service Name",
  • "NumberOfChildServices": 4,
  • "OverrideEnablePerChannelTaxing": true,
  • "OverrideEnablePerSingleLineTaxing": 1,
  • "OverridePerLineTaxClass": "Tax Class Description",
  • "OverridePerLineTaxClassID": 588422494,
  • "ParentServiceDescription": "My Parent Serevice Description",
  • "ParentServiceID": 24626,
  • "ParentServiceNumber": "My Service Number",
  • "Plan": "Plan Description",
  • "PlanCatalogID": 89484,
  • "PlanCharge": 19.72,
  • "PlanDisplay": "Web Name",
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "RateCenter": "2017-09-09T17:35:09.156Z",
  • "RateCenterID": 24626,
  • "Region": "Region Description",
  • "RegionID": 589367893,
  • "ServiceID": 589367893,
  • "ServiceNumber": 46622467,
  • "ServiceStatus": "Active",
  • "SIMCardID": 24626,
  • "SIMCardSerialNumber": "SIM Serial Number",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "SuspendReason": "Suspend Reason Description",
  • "SuspendReasonDescription": "Suspend Reason Description",
  • "SuspendReasonID": 589367893,
  • "TaxAccountType": "Tax Account Type Description",
  • "TaxAccountTypeID": 1,
  • "TaxJurisdictionOverrideID": 5895689,
  • "TaxServiceAddressID": 72457,
  • "TaxState": "New York",
  • "TechnologyType": "Technology Type",
  • "TechnologyTypeID": 1,
  • "UnbilledUsageCharge": 19.72,
  • "UsageNotificationSendToOption": "My Where to Send Usage Notifications",
  • "UsageNotificationSendToOptionID": 1,
  • "WebName": "My User Friendly Name",
  • "Zone": "Zone Description",
  • "ZoneID": 24626
}

Service Action Summary

A list of all assigned services, including a list of cart/order IDs for any In-Process actions on each service. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AssignmentTemplateID": 24626,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CartActions": "ChangeNumber",
  • "CatalogID": 24626,
  • "ChangeReason": "My Change Reason Description",
  • "ChangeReasonID": 24626,
  • "CustomerID": 24626,
  • "Description": "Service Type Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsPrimaryService": false,
  • "Name": "Service Name",
  • "ParentServiceDescription": "My Parent Serevice Description",
  • "ParentServiceID": 24626,
  • "ParentServiceNumber": 585683474,
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 48484474,
  • "ServiceStatus": "Active",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "WebName": "My User Friendly Name"
}

Service Address By Service

A list of all service addresses in the system paired with information about any services they are tied to. [Rev 1.07]

  • Note: The results will include a single record for each service address defined in the system as well as a record for each service address paired with any services it is associated with.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 45748484848,
  • "ActualValidationType": "My Validation Type",
  • "ActualValidationTypeID": 24626,
  • "AddressValidationID": 24626,
  • "AddressValidationResult": "My Address Validation Result",
  • "AddressValidationResultCode": "My Address Validation Result Code",
  • "AddressValidationResultID": 24626,
  • "BypassUser": "Username",
  • "CatalogID": 589367893,
  • "CensusBlockCode": 1010,
  • "CensusCounty": 45,
  • "CensusState": 36,
  • "CensusTract": 9404,
  • "City": "Rochester",
  • "CustomerID": 3463,
  • "CustomerName": "William Riker",
  • "Designator1": "My Designation Type",
  • "Designator1Value": "My Value",
  • "Designator2": "My Designation Type",
  • "Designator2Value": "My Value''",
  • "Designator3": "My Designation Type",
  • "Designator3Value": "My Value",
  • "ExcludeReasonID": 283482,
  • "FailureCount": 5,
  • "FullAddress": "StreetNumberPrefix StreetNumber StreetNumberSuffix StreetDirectionPrefix StreetName Thoroughfare StreetDirectionSuffix Location Designator1 Designator1Value Designator2 Designator2Value Designator3 Designator3Value City State ZipCode",
  • "IsE911Address": 1,
  • "IsPOBox": true,
  • "Latitude": 19.72,
  • "Location": "My Location",
  • "Longitude": 19.72,
  • "LoopLength": 19.72,
  • "MSAGCommunity": "My MSAG Community",
  • "MSAGCounty": "My MSAG County",
  • "MSAGError": "My MSAG ERRORS",
  • "MSAGProvider": "MSAG Provider Description",
  • "MSAGProviderID": 58936,
  • "MSAGValidated": "2017-09-09T17:35:09.156Z",
  • "Note": "Service Address Note",
  • "RateCenter": "Rate Center Description",
  • "RateCenterID": 589367893,
  • "RequiredValidationType": "MY Validation Type",
  • "RequiredValidationTypeID": 24626,
  • "ServiceAddressID": 589367893,
  • "ServiceDescription": "Service Type Description",
  • "ServiceID": 346,
  • "ServiceNumber": 35635467,
  • "ServiceStatus": "Active",
  • "State": "Service Address State",
  • "Status": "Service Address Status",
  • "StatusID": 589367893,
  • "StreetDirectionPrefix": "N",
  • "StreetDirectionSuffix": "ALLEY",
  • "StreetName": "Whitney",
  • "StreetNumber": 654,
  • "StreetNumberPrefix": 5,
  • "StreetNumberSuffix": 353,
  • "TaxAddressError": "My Tax Address Errors",
  • "TaxAddressValidated": "2017-09-09T17:35:09.156Z",
  • "TaxCounty": "My Tax County",
  • "TaxState": "Florida",
  • "Thoroughfare": "My Thoroughfare",
  • "ValidationDate": "2017-09-09T17:35:09.156Z",
  • "WireCenter": "Wire Center Description",
  • "WireCenterID": 589367893,
  • "ZipCode": 56354
}

Service Address Overview

A list of all service addresses in the system associated to customer accounts with a count of how many services have that address. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 2345248484848,
  • "ActualValidationType": "My Validation Type",
  • "ActualValidationTypeID": 24626,
  • "AddressValidationID": 24626,
  • "AddressValidationResult": "My Address Validation Result",
  • "AddressValidationResultCode": "My Address Validation Result Code",
  • "AddressValidationResultID": 24626,
  • "BypassUser": "Username",
  • "CensusBlockCode": 1010,
  • "CensusCounty": 45,
  • "CensusState": 36,
  • "CensusTract": 9404,
  • "City": "Rochester",
  • "CustomerID": 425,
  • "CustomerName": "Bob Ross",
  • "Designator1": "My Designation Type",
  • "Designator1Value": "My Value",
  • "Designator2": "My Designation Type",
  • "Designator2Value": "My Value",
  • "Designator3": "My Designation Type",
  • "Designator3Value": "My Value",
  • "ExcludeReasonID": 283482,
  • "FailureCount": 5,
  • "FullAddress": "StreetNumberPrefix StreetNumber StreetNumberSuffix StreetDirectionPrefix StreetName Thoroughfare StreetDirectionSuffix Location Designator1 Designator1Value Designator2 Designator2Value Designator3 Designator3Value City State ZipCode",
  • "IsPOBox": true,
  • "Latitude": 19.72,
  • "Location": "My Location",
  • "Longitude": 19.72,
  • "LoopLength": 19.72,
  • "MSAGCommunity": "My MSAG Community",
  • "MSAGCounty": "My MSAG County",
  • "MSAGError": "My MSAG Validation Errors",
  • "MSAGProvider": "MSAG Provider Description",
  • "MSAGProviderID": 589367893,
  • "MSAGValidated": "2017-09-09T17:35:09.156Z",
  • "Note": "Service Address Notes",
  • "RateCenter": "Rate Center Description",
  • "RateCenterID": 589367893,
  • "RequiredValidationType": "MY Validation Type",
  • "RequiredValidationTypeID": 24626,
  • "ServiceAddressID": 589367893,
  • "ServiceCount": 4,
  • "State": "New Jersey",
  • "Status": "Service Address Status",
  • "StatusID": 589367893,
  • "StreetDirectionPrefix": "N",
  • "StreetDirectionSuffix": "Alley",
  • "StreetName": "Whitney",
  • "StreetNumber": 353,
  • "StreetNumberPrefix": 547,
  • "StreetNumberSuffix": "Alley",
  • "TaxAddressError": "My Tax Address Errors",
  • "TaxAddressValidated": "2017-09-09T17:35:09.156Z",
  • "TaxCounty": "My Tax County",
  • "TaxState": "Florida",
  • "Thoroughfare": "My Thoroughfare",
  • "ValidationDate": "2017-09-09T17:35:09.156Z",
  • "WireCenter": "Wire Center Description",
  • "WireCenterID": 589367893,
  • "ZipCode": 63745
}

Service Catalog Overview

The count of services that are active, suspended (including hotlined and redirected), future-active, future-disconnected, or disconnected; by customer and service CatalogID. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 43636,
  • "ActiveCount": 34,
  • "AlternateDescription": "Alternate Service Type Description ",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "BillingActiveCount": 45,
  • "BillingInactiveCount": 44,
  • "CatalogID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Catalog Description",
  • "DisconnectedCount": 46,
  • "FutureActiveCount": 46,
  • "FutureDisconnectedCount": 45,
  • "HotlinedCount": 45,
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 536,
  • "RedirectedCount": 32,
  • "SubserviceCount": 12,
  • "SuspendedCount": 21
}

Service Category Overview

An overview per category of unique assignment template IDs that contain the category either on a service or at the account level. [Rev 1.08]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 5564,
  • "AssignmentTemplateIDs": "35635, 5345, 56534, 5353",
  • "Category": "My Overview Record Category",
  • "CategoryID": 589367893,
  • "CustomerID": 589367893,
  • "CustomerName": "Shirley Crescent",
  • "IsAccountLevel": true,
  • "MaximumRequired": 643,
  • "MinimumRequired": 3,
  • "ServiceID": 589367893,
  • "ServiceNumber": 4264674
}

Service Contact

A list of all contacts in the system that are associated to a service. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "CatalogID": 589367893,
  • "City": "Chicago",
  • "CompanyName": "Company Name",
  • "ContactID": 589367893,
  • "ContactType": "Contact Type Name",
  • "ContactTypeID": 589367893,
  • "Country": "Dubai",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Description": "Service Type Description",
  • "EmailAddress1": "auser@mail.com",
  • "EmailAddress1TypeID": 24626,
  • "FirstName": "John",
  • "LastName": "Smith",
  • "MiddleInitial": "T",
  • "PhoneNumber1": "555-555-5555",
  • "PhoneNumber1TypeID": 24626,
  • "ServiceID": 589367893,
  • "ServiceNumber": 46622467,
  • "State": "New Jersey",
  • "Street1": "533 Whitney Ontario NY 35234",
  • "ZipCode": 56555
}

Service History

List of all changes that were made related to a service by reference type. [Rev 1.13]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "Action": "Action Description",
  • "ActionDate": "2017-09-09T17:35:09.156Z",
  • "ActionID": 9,
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 24626,
  • "CustomerID": 24626,
  • "CustomerName": "James Kirk",
  • "Description": "Service Type Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "NewServiceNumber": 66574467,
  • "OldServiceNumber": 746467,
  • "ParentServiceCatalogID": 24626,
  • "ParentServiceDescription": "Parent Service Description",
  • "ParentServiceID": 24626,
  • "ParentServiceNumber": 57475474,
  • "ReferenceID": 24626,
  • "ReferenceType": "Reference Type Description",
  • "ReferenceTypeID": 2,
  • "ServiceID": 24626,
  • "ServiceNumber": 3563474,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "UserID": "Username",
  • "WebName": "User-Friendly Name"
}

Service Number Detail

A list of all assigned services in the system containing a more focused set of fields.

  • Note: This OData is generally useful for filtering of dropdown menus.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AssignmentTemplateID": 589367893,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 56346,
  • "CustomerID": 24626,
  • "Description": "Service Type Description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsCPNIService": false,
  • "IsLoadable": true,
  • "IsPrimaryService": false,
  • "Name": "Service Name",
  • "ParentServiceDescription": "My Parent Serevice Description",
  • "ParentServiceID": 24626,
  • "ParentServiceNumber": 74746474,
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 46622467,
  • "ServiceStatus": "Active",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "WebName": "My User Friendly Name",
  • "Zone": "Zone Description",
  • "ZoneID": 24626
}

Service Number History

A list of all of the changes made on services in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34634,
  • "BillingOrderID": 34635,
  • "ChangeDate": "2017-09-09T17:35:09.156Z",
  • "ChangeType": "Change Type Description",
  • "ChangeTypeID": 1,
  • "ChangeUser": "Username",
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsPortIn": false,
  • "NewBillingNumber": "My Billing Number",
  • "NewDeviceAlternateSerialNumber": "88779SGS9GS",
  • "NewDeviceSerialNumber": "KJSWGKJ84834",
  • "NewServiceNumber": 42425467,
  • "NewSIMCardNumber": 2452452,
  • "OldBillingNumber": "Billing Number",
  • "OldDeviceAlternateSerialNumber": "JSJ9SG99428",
  • "OldDeviceSerialNumber": "JSJ9SG99428",
  • "OldServiceNumber": 34636535467,
  • "OldSIMCardNumber": 5353,
  • "ServiceID": 24626,
  • "ServiceNumber": 353,
  • "ServiceNumberHistoryID": 24626,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "TechnologyType": "Technology Type Description",
  • "TechnologyTypeID": 1
}

Service Summary

A list of all assigned service instances in the system with summary information. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AdvancePayFeatureCount": 1,
  • "ALECount": 19.72,
  • "AllowEquipmentAssignment": false,
  • "AlternateDescription": "Alternate Service Type Description",
  • "AlternateInvoiceDescription": "Alternate Invoice Description",
  • "AlternateServiceNumber": 54353,
  • "AttributePropertyDisplay": "Display Name",
  • "AttributePropertyID": 24626,
  • "BillingStatus": "Billing Status Description",
  • "BillingStatusID": 1,
  • "CatalogID": 589367893,
  • "ContactID": 24626,
  • "Contract": "Contract Description",
  • "ContractCatalogID": 5857,
  • "ContractEndDate": "2017-09-09T17:35:09.156Z",
  • "CustomerDepartment": "Customer Department",
  • "CustomerDepartmentID": 283482,
  • "CustomerID": 589367893,
  • "Description": "Service Type Description",
  • "DisconnectReason": "Disconnect Reason Description",
  • "DisconnectReasonDescription": "Disconnect Reason Description",
  • "DisconnectReasonID": 589367893,
  • "E911ClassOfService": "E911 Class of Service Name",
  • "E911ClassOfServiceID": 24626,
  • "E911ServiceAddressID": 24626,
  • "E911TypeOfService": "E911 Type Of Service Name",
  • "E911TypeOfServiceID": 24626,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "EstimatedMRC": 19.72,
  • "FeatureCount": 36,
  • "FirstCallDate": "2017-09-09T17:35:09.156Z",
  • "Handset": "Handset Model Description",
  • "HandsetAlternateDescription": "Alternate Handset Description",
  • "HandsetAlternateInvoiceDescription": "Alternate Handset Name",
  • "HandsetAlternateSerialNumber": "My Handset Alternate Serial Number",
  • "HandsetCatalogID": 357,
  • "HandsetID": 24626,
  • "HandsetSerialNumber": "463GHT45G5Y",
  • "HandsetWebName": "User-friendly Name",
  • "IsCPNIService": false,
  • "IsE911ExemptCity": false,
  • "IsE911ExemptCounty": false,
  • "IsE911ExemptRegional": false,
  • "IsE911ExemptState": false,
  • "IsPerLineTaxConfigurationOverridden": false,
  • "IsPortOut": true,
  • "IsPrimaryService": false,
  • "LastCallDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Service Name",
  • "OverrideEnablePerChannelTaxing": false,
  • "OverrideEnablePerSingleLineTaxing": false,
  • "OverridePerLineTaxClass": "Tax Class Description",
  • "OverridePerLineTaxClassID": 588422494,
  • "ParentServiceDescription": "My Parent Serevice Description",
  • "ParentServiceID": 24626,
  • "ParentServiceNumber": "My Service Number",
  • "Plan": "Plan Description",
  • "PlanCatalogID": 89484,
  • "PlanCharge": 19.72,
  • "PlanDisplay": "Description",
  • "ProductCatalogClass": "My Product Catalog Class",
  • "ProductCatalogClassID": 24626,
  • "RateCenter": "Rate Center Description",
  • "RateCenterID": 24626,
  • "Region": "Region Description",
  • "RegionID": 589367893,
  • "ServiceID": 589367893,
  • "ServiceNumber": 46622467,
  • "ServiceStatus": "Active",
  • "SIMCardID": 24626,
  • "SIMCardSerialNumber": "543YE5YE35",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SubServiceCount": 4,
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "SuspendReason": "My Suspend Reason Description",
  • "SuspendReasonDescription": "Suspend Reason Description",
  • "SuspendReasonID": 589367893,
  • "SuspendType": "Redirect",
  • "TaxAccountType": "Tax Account Type Description",
  • "TaxAccountTypeID": 1,
  • "TaxJurisdictionOverrideID": 5895689,
  • "TaxServiceAddressID": 72457,
  • "TaxState": "Tax State",
  • "TechnologyType": "Technology Type",
  • "TechnologyTypeID": 1,
  • "UnbilledUsageCharge": 19.72,
  • "UsageNotificationSendToOption": "My Where to Send Usage Notifications",
  • "UsageNotificationSendToOptionID": 3,
  • "WebName": "My User Friendly Name",
  • "Zone": "Zone Description",
  • "ZoneID": 24626
}

Service Tax Channel Override

A list of all of the overridden tax channels for per-line taxing configuration on services in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "IsDataUsageTaxable": false,
  • "IsInboundTaxable": false,
  • "IsOutboundTaxable": false,
  • "IsPerChannel": false,
  • "IsVoiceUsageTaxable": false,
  • "NumberOfChannels": 565,
  • "ServiceID": 589367893,
  • "ServiceNumber": 46622467,
  • "ServiceTaxChannelOverrideID": 589367893
}

Service Tax Jurisdiction

A list of all of the tax jurisdictions associated with services in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "City": "New City",
  • "County": "Wayne",
  • "Notes": "Tax Jurisdiction Notes",
  • "ServiceID": 589367893,
  • "ServiceNumber": 46622467,
  • "TaxJurisdictionID": 589367893,
  • "TaxState": "California"
}

Service Tax Jurisdiction Override

A list of all service-level tax jurisdiction overrides in the system. [Rev 1.06]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "City": "Rochester",
  • "County": "Wayne",
  • "Notes": "Tax Juridiction Notes",
  • "ServiceID": 24626,
  • "ServiceNumber": 52345467,
  • "TaxJurisdictionID": 6346,
  • "TaxJurisdictionOverrideID": 283482,
  • "TaxState": "New Jersey"
}

SIM Card Deprecated

A list of all SIM Cards in the system. [Rev 1.14]

  • Deprecated [Rev 2.00]

  • Use Search SIM in Service and Feature Management.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "IMSI": "My IMSI",
  • "PIN1": 5656,
  • "PIN2": 3456,
  • "PUK1": 2645,
  • "PUK2": 3475,
  • "SIMCardID": 24626,
  • "SIMCardNumber": 5373573
}

Tax Allocation

A list of all of the feature tax allocations defined in the system. [Rev 1.20]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "FeatureID": 24626,
  • "IsTaxExemptCity": false,
  • "IsTaxExemptCounty": false,
  • "IsTaxExemptFederal": false,
  • "IsTaxExemptRegional": false,
  • "IsTaxExemptState": false,
  • "TaxAllocationID": 24626,
  • "TaxCountry": "Country Description",
  • "TaxCountryID": 24626,
  • "TaxFraction": 19.72,
  • "TaxJurisdictionCity": "Rochester",
  • "TaxJurisdictionCounty": "Monroe",
  • "TaxJurisdictionID": 24626,
  • "TaxJurisdictionZipCode": 14267,
  • "TaxState": "Maine"
}

Usage Per Shared Grant Discount Summary

A list of all usage in the system per shared grant, grouped by bill period, discount category, and unit sub-type. [Rev2.21]

  • Note: Queries should filter on a specific CustomerID and/or ServiceID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 2542458484848,
  • "AssignedServiceCatalog": "Service Type Description",
  • "AssignedServiceCatalogID": 57,
  • "AssignedServiceID": 24626,
  • "AssignedServiceName": "Service Name Description",
  • "AssignedServiceNumber": 46622467,
  • "Balance": 19.72,
  • "BillPeriodID": 24626,
  • "CarryoverUnits": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Discount": "My Discount Feature Instance Description",
  • "DiscountCategory": "Discount Category Description",
  • "DiscountCategoryID": 24626,
  • "DiscountID": 24626,
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "ExpiredUnits": 19.72,
  • "IsUnlimited": true,
  • "NewUnits": 19.72,
  • "OverageCharge": 19.72,
  • "OverageUnits": 19.72,
  • "PercentageUsed": 19.72,
  • "TotalUnits": 19.72,
  • "UnitSubType": "Unit Subtype Name",
  • "UnitSubTypeID": 24626,
  • "UnitsUsed": 19.72
}

Usage Service Charge

A list of all services and any usage charges associated with them for a particular bill period. [Rev 1.09]

  • Note: Queries should filter on a specific CustomerID and/or ServiceID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 426424628484848,
  • "BillPeriodID": 30,
  • "Charge": 19.72,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "IsActive": false,
  • "IsLoadable": false,
  • "PostedDate": "2017-09-09T17:35:09.156Z",
  • "ServiceEndDate": "2017-09-09T17:35:09.156Z",
  • "ServiceID": 4624,
  • "ServiceNumber": 24624,
  • "ServiceStartDate": "2017-09-09T17:35:09.156Z"
}

Usage Shared Grant Discount

A list of all usage in the system tied to a discount. [Rev 1.09]

  • Note: Queries should filter on a specific CustomerID and/or ServiceID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 2542458484848,
  • "BillPeriodEndDate": "2017-09-09T17:35:09.156Z",
  • "BillPeriodID": 24626,
  • "BillPeriodStartDate": "2017-09-09T17:35:09.156Z",
  • "ChildCustomerID": 589367893,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Discount": "Feature Instance Description",
  • "DiscountCategory": "Discount Category Description",
  • "DiscountCategoryID": 24626,
  • "DiscountID": 24626,
  • "IsCarryover": false,
  • "IsShared": false,
  • "IsUnlimited": false,
  • "MyOverageCharge": 19.72,
  • "MyOverageUnits": 19.72,
  • "MyUnits": 19.72,
  • "OverageCharge": 19.72,
  • "OverageUnits": 19.72,
  • "ServiceID": 24626,
  • "ServiceNumber": 46622467,
  • "StartingNumberOfUnits": 19.72,
  • "UnitsExpired": 19.72,
  • "UnitSubtype": "Unit Subtype Name",
  • "UnitSubtypeID": 24626,
  • "UnitsUsed": 19.72,
  • "UnitType": "Unit Type Name",
  • "UnitTypeID": 24626,
  • "UsageSharedGrantID": 24626
}

Usage Shared Grant Discount Detail Summary

A list of all usage in the system, grouped by service, bill period, discount, and unit sub-type. [Rev 1.14]

  • Note: Queries should filter on a specific CustomerID and/or ServiceID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Balance": 19.72,
  • "BillPeriodID": 24626,
  • "CarryoverUnits": 19.72,
  • "ChildCustomerID": 589367893,
  • "CustomerID": 24626,
  • "CustomerName": "Jean-Luc Picard",
  • "Discount": "My Discount Feature Instance Description",
  • "DiscountCategory": "Discount Category Description",
  • "DiscountCategoryID": 24626,
  • "DiscountID": 24626,
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "ExpiredUnits": 19.72,
  • "IsShared": true,
  • "IsUnlimited": true,
  • "MyOverageCharge": 19.72,
  • "MyOverageUnits": 19.72,
  • "MyUnits": 19.72,
  • "NewUnits": 19.72,
  • "OverageCharge": 19.72,
  • "OverageUnits": 19.72,
  • "PercentageUsed": 19.72,
  • "PreviouslyDisconnected": 1,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceCatalogID": 57,
  • "ServiceID": 24626,
  • "ServiceName": "Service Name Description",
  • "ServiceNumber": 46622467,
  • "TotalUnits": 19.72,
  • "UnitSubType": "Unit Subtype Name",
  • "UnitSubTypeID": 24626,
  • "UnitsUsed": 19.72
}

Usage Shared Grant Discount Summary

A list of all usage in the system, grouped by service, bill period, discount category, and unit sub-type.

  • Note: Queries should filter on a specific CustomerID and/or ServiceID.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Balance": 19.72,
  • "BillPeriodID": 24626,
  • "CarryoverUnits": 19.72,
  • "ChildCustomerID": 589367893,
  • "CustomerID": 24626,
  • "DiscountCategory": "Discount Category Description",
  • "DiscountCategoryID": 24626,
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "ExpiredUnits": 19.72,
  • "IsUnlimited": true,
  • "MyOverageCharge": 19.72,
  • "MyOverageUnits": 19.72,
  • "MyUnits": 19.72,
  • "NewUnits": 19.72,
  • "OverageCharge": 19.72,
  • "OverageUnits": 19.72,
  • "PercentageUsed": 19.72,
  • "ServiceID": 24626,
  • "ServiceNumber": 46622467,
  • "ThresholdPercentage": 56,
  • "TotalUnits": 19.72,
  • "UnitSubtype": "Unit Subtype Name",
  • "UnitSubtypeID": 24626,
  • "UnitsUsed": 19.72
}

User Customer

A list of all user customers in the system. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 43636,
  • "CustomerID": 589367893,
  • "CustomerName": "Jean-Luc Picard",
  • "Email": "auser@email.com",
  • "UserCustomerID": 589367893,
  • "UserID": 589367893,
  • "UserNotification": true,
  • "UserType": "My UserType",
  • "UserTypeID": 1
}

Usage Data Service

  • Note: The UsageDataService endpoint was added to the Customer service in [Rev 1.02].

Abstract

The purpose of the UsageDataService endpoint is to supply a set of search capabilities that can be used for usage data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format:

WRAP access_token="<Simple Web Token>"

where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Required Headers: Additionally for the Usage Data service, a "UsageAliasName" header is required in each request with a string value (i.e., name of the database connection). Other headers may also be required, as specified in items below (with their format).

Customer Service Type Overview

An overview of ServiceTypes by Customer. [Rev 1.26]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "UsageTypeServiceType": "Cellular Airtime",
  • "UsageTypeServiceTypeID": 12
}

Customer Service Type Unit Type Overview

An overview of usage for each Customer by usage type service type, grouped by unit type. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. [Rev 1.26]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 5,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 4,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Customer Unit Type Overview Snapshot

An overview snapshot of UnitTypes by Customer. _[Rev 2.19]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 6356356,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 589367893,
  • "CustomerName": "John William",
  • "PreDiscountChargedUnits": 5,
  • "UnitType": "Unit Type Description",
  • "UnitTypeID": 589367893,
  • "UnitSubType": "Unit Subtype Name",
  • "UnitSubTypeID": 24626,
  • "UsageCount": 3
}

Customer Usage Type Overview

An overview of UsageTypes by Customer. _[Rev 1.16._02]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626
}

Invoice Service Tax Overview

A list of the tax amount due for a tax on an invoice per service. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CustomerID": 24626,
  • "CustomerName": "Vahn Pembroke",
  • "InvoiceNumber": 24626,
  • "ServiceCatalog": "Service Type Description",
  • "ServiceID": 24626,
  • "ServiceName": "Service Name",
  • "ServiceNumber": 474,
  • "TaxAmount": 19.72,
  • "TaxID": 24626
}

Service Catalog Usage Overview Snapshot

An snapshot of usage for each customer by ServiceCatalog, UsageTypeServiceType, and UnitType/SubType. [Rev 1.09]

  • Note: Snapshot queries run against summarized Rating and Billing data and may not reflect current usage counts.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "BaseServiceCatalog": "My ServiceCatalog",
  • "BaseServiceCatalogID": 24626,
  • "Charge": 19.72,
  • "ChargedUnits": 30,
  • "CustomerID": 24626,
  • "CustomerName": "Brian Sullivan",
  • "ServiceCatalog": "My Service Catalog",
  • "ServiceCatalogID": 24626,
  • "ServiceWithUsageCount": 4,
  • "TotalServiceCount": 4,
  • "UnitSubType": "My Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My UnitType",
  • "UnitTypeID": 1,
  • "UsageCount": 5,
  • "UsageTypeServiceType": "My Service Type",
  • "UsageTypeServiceTypeID": 24626
}

Service Service Type Overview

An overview of usage for each Service by usage type service type. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 5,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UsageCount": 4,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Service Service Type Unit Type Overview

An overview of usage for each Service by usage type service type, grouped by unit type. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. _[Rev 1.17._02]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 5,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 4,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Service Usage Charge Summary

A summary of usage charged by service. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UsageCount": 60
}

Service Usage Charge Summary Snapshot

A summary of usage charged by service. [Rev 1.14]

  • Note: Snapshot queries run against summarized Rating and Billing data and may not reflect current usage counts.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "BaseServiceCatalogID": 589367893,
  • "Charge": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UsageCount": 60
}

Service Usage Type Distance Type Overview

An overview of usage for each Service by UsageType and DistanceType. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose
CustomerID
required
integer
Example: 12345
UsageAliasName
required
string
Example: Default

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 4,
  • "Cost": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Jaquelyn Courtney",
  • "DistanceType": "My Distance Type Name",
  • "DistanceTypeID": 24626,
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 4,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 3,
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626,
  • "WholesaleCost": 19.72
}

Service Usage Type Distance Type Overview Snapshot

An snapshot of usage for each Service by UsageType and DistanceType. [Rev 1.09]

  • Note: Snapshot queries run against summarized Rating and Billing data and may not reflect current usage counts.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "DistanceType": "Distance Type Name",
  • "DistanceTypeID": 24626,
  • "PreDiscountChargedUnits": 5,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 3,
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Service Usage Type Overview

An overview of usage for each Service by UsageType. This OData runs against raw UsageRecords, summarizing data as it is currently loaded. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 5,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 3,
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Service Usage Type Overview Snapshot

An snapshot of usage for each Service by UsageType. [Rev 1.14]

  • Note: Snapshot queries run against summarized Rating and Billing data and may not reflect current usage counts.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargedUnits": 5,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountChargedUnits": 6,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceName": "My Service Name",
  • "ServiceNumber": 474,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type",
  • "UnitTypeID": 1,
  • "UsageCount": 3,
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626,
  • "UsageTypeServiceType": "Usage Type Service Type Description",
  • "UsageTypeServiceTypeID": 24626
}

Usage Detail

Details of usage information for a customer.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose
CustomerID
required
integer
Example: 12345
UsageAliasName
required
string
Example: Default

Responses

Response samples

Content type
application/json
{
  • "AirtimeCharge": 19.72,
  • "CallStartTime": "2017-09-09T17:35:09.156Z",
  • "CDRFileID": 24626,
  • "CDRFileRecordInstanceNumber": 6426,
  • "CDRFileRecordNumber": 1,
  • "CustomerID": 589367893,
  • "DistanceType": "Rating Distance Description",
  • "DistanceTypeID": 283482,
  • "EventDirection": "Direction Description",
  • "EventDirectionID": 1,
  • "EventType": "Type of Event Description",
  • "EventTypeID": 1,
  • "IsIncluded": true,
  • "IsMobileToMobile": true,
  • "IsOverage": true,
  • "IsRegional": true,
  • "IsRoaming": true,
  • "OrigCountryCode": 1,
  • "OrigCountryName": "United States",
  • "OrigNumber": "123-456-7890",
  • "OrigPlace": "Atlanta",
  • "OrigState": "GA",
  • "OrigTrunkGroup": "Group of Trunks Name",
  • "OtherCharge": 19.72,
  • "OtherPartyCountryCode": 1,
  • "OtherPartyNumber": 1,
  • "PrimaryUsageType": "First Usage Type Name",
  • "PrimaryUsageTypeID": 24626,
  • "PrimaryUsageTypeServiceType": "Cellular Airtime",
  • "PrimaryUsageTypeServiceTypeID": 12,
  • "RatePeriod": "RatePeriod Name",
  • "RatePeriodID": 5,
  • "RoamingCharge": 19.72,
  • "ServiceID": 589367893,
  • "ServiceNumber": 467,
  • "TermCountryCode": 1,
  • "TermCountryName": "United States",
  • "TermNumber": "123-456-7890",
  • "TermPlace": "Atlanta",
  • "TermState": "GA",
  • "TermTrunkGroup": "Group of Trunks Name",
  • "TollCharge": 19.72,
  • "TotalCharge": 19.72,
  • "TotalChargedUnits": 56,
  • "TotalCost": 19.72,
  • "TotalPreDiscountCharge": 19.72,
  • "TotalPreDiscountChargedUnits": 4,
  • "TotalWholesaleCost": 19.72,
  • "UnitSubType": "My Unit Subtype",
  • "UnitSubTypeID": 1,
  • "UnitType": "UnitType Description",
  • "UnitTypeID": 1,
  • "UsageDescription": "Event Descriptor",
  • "UsageRecordID": 589367893
}

Usage Record

A list of UsageRecords and associated detail. _[Rev 1.09]_\n* Required Header: CustomerID (int)"

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountCode": 5747,
  • "AccountNumber": 3463,
  • "CallStartTime": "2017-09-09T17:35:09.156Z",
  • "CDRFileFormat": "My CDRFileFormat",
  • "CDRFileID": 24626,
  • "CDRFileInstanceNumber": 5735,
  • "CDRFileRecordNumber": 3,
  • "ConferenceID": 338898,
  • "CustomerID": 24626,
  • "CustomerName": "Steve Rogers",
  • "DialedDigits": "123-456-7890",
  • "DistanceType": "My Distance Type Name",
  • "DistanceTypeID": 24626,
  • "EventDirection": "My Event Direction",
  • "EventDirectionID": 1,
  • "EventType": "CDREvent Description",
  • "EventTypeID": 1,
  • "ExtensibilityData": "My Extensibility Data",
  • "FileName": "My Filename",
  • "OriginatingCountry": "My Originating Country Description",
  • "OriginatingCountryCode": 1,
  • "OriginatingLata": 315,
  • "OriginatingNPA": 2,
  • "OriginatingNumber": "123-456-7890",
  • "OriginatingOCN": "123-456-7890",
  • "OriginatingPlace": "Atlanta",
  • "OriginatingState": "Georgia",
  • "OriginatingTrunkGroup": "Trunk Group Name",
  • "ProcessedDate": "2017-09-09T17:35:09.156Z",
  • "ProcessingFlags": 1,
  • "ProvisioningCompany": "My Provisioning Company Name",
  • "ProvisioningCompanyID": 24626,
  • "ServiceCatalog": "Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "TerminatingCIC": "My TerminatingCIC",
  • "TerminatingCountry": "My Terminiating Country Code Description",
  • "TerminatingCountryCode": 1,
  • "TerminatingLata": 7806699257,
  • "TerminatingNPA": 315,
  • "TerminatingNumber": "123-456-7890",
  • "TerminatingOCN": "123-456-7890",
  • "TerminatingPlace": "Atlanta",
  • "TerminatingState": "Grorgia",
  • "TerminatingTrunkGroup": "Trunk Group Name",
  • "UnbillableRuleCode": "My Error Code",
  • "UsageDescription": "My UsageRecord Description",
  • "UsageRecordID": 24626,
  • "UTCOffset": 30
}

Usage Record CDMA

A list of CDMA details for usage records. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CustomerID": 24626,
  • "CustomerName": "Warner Huntington",
  • "HomeSID": 5,
  • "MDN": "My MDN",
  • "MIN": "My MIN",
  • "SerialNumber": "HGHS94984H",
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "UsageRecordID": 24626
}

Usage Record Data

A list of GSM details for usage records. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccessPointName": "My Gateway",
  • "AccountNumber": 3463,
  • "ChargingID": 8248288,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "DataTransferDuration": 34,
  • "DownloadAmount": 55,
  • "GGSNAddress": "My GGSNAddress",
  • "PDPAddress": "My PDPAddress",
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "SGSNAddress": "My SGSNAddress",
  • "UploadAmount": 30,
  • "UsageRecordID": 24626
}

Usage Record GSM

A list of GSM details for usage records. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CallReferenceNumber": "My Identifier",
  • "CAMELDestination": 2454,
  • "CAMELServiceKey": 1,
  • "CAMELServiceLevel": 4,
  • "CustomerID": 24626,
  • "CustomerName": "Warner Huntington",
  • "DefaultCallHandling": 1,
  • "HomePMN": 341,
  • "IMEI": "My IMEI",
  • "IMSI": "My IMSI",
  • "MSISDN": "My MSISDN",
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "ServingLAC": "My Serving LAC",
  • "ServingPMN": 45,
  • "UsageRecordID": 24626
}

Usage Record Rate Overview

A list of all rates associated with a UsageRecord by SequenceNumber. [Rev 1.09]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "Charge": 19.72,
  • "ChargeableUnits": 65,
  • "ChargedUnits": 4,
  • "Cost": 19.72,
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "PreDiscountCharge": 19.72,
  • "PreDiscountChargedUnits": 5,
  • "PricingPlanCatalog": "My Pricing Plan Name",
  • "ProcessedDate": "2017-09-09T17:35:09.156Z",
  • "RatePeriod": "Rate Period Name",
  • "RatePeriodID": 4,
  • "RatePlanDetailID": 24626,
  • "RatingFlags": 1,
  • "SequenceNumber": 283482,
  • "Surcharge": 19.72,
  • "UnbillableRuleCode": 48934789,
  • "UnitSubType": "My Subtype of Units",
  • "UnitSubTypeID": 1,
  • "UnitType": "My UnitType",
  • "UnitTypeID": 1,
  • "UsageRecordID": 24626,
  • "UsageType": "UsageType Name",
  • "UsageTypeID": 24626,
  • "UsageTypeServiceType": "Service Type Name",
  • "UsageTypeServiceTypeID": 24626,
  • "WholesaleCost": 19.72
}

Usage Record Shared Grant Discount

A list of discount details for usage records. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CustomerID": 24626,
  • "CustomerName": "Warner Huntington",
  • "DiscountID": 24626,
  • "OverageUnits": 19.72,
  • "SequenceNumber": 283482,
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "UnitsTypeID": 1,
  • "UnitSubType": "My Unit Sub Type",
  • "UnitSubTypeID": 1,
  • "UnitsUsed": 19.72,
  • "UnitType": "My Unit Type Description",
  • "UsageRecordID": 24626,
  • "UsageSharedGrantID": 24626
}

Usage Record Shared Grant Discount Summary

A summary of discount details with rating information for usage records. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CallStartTime": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "Discount": "My Feature Instance Name",
  • "DiscountID": 24626,
  • "OverageUnits": 19.72,
  • "SequenceNumber": 283482,
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "TotalCharge": 19.72,
  • "TotalChargeUnits": 4,
  • "TotalPreDiscountCharge": 19.72,
  • "TotalPreDiscountChargeUnits": 5,
  • "TotalUnitsUsed": 19.72,
  • "UnitsTypeID": 1,
  • "UnitSubType": "My UnitSubType",
  • "UnitSubTypeID": 1,
  • "UnitType": "My Unit Type Description",
  • "UsageRecordID": 24626,
  • "UsageType": "My Usage Type Name",
  • "UsageTypeID": 24626
}

Usage Record Wireless

A list of all Usage Records and their wireless details. [Rev 1.14]

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3463,
  • "CellSiteLookupValue": "My Lookup Value",
  • "CustomerID": 24626,
  • "CustomerName": "Bob Doran",
  • "InitialCellSiteID": 5,
  • "NetworkTypeID": 1,
  • "QCI": 1,
  • "ServiceCatalog": "My Service Catalog Name",
  • "ServiceCatalogID": 24626,
  • "ServiceID": 24626,
  • "ServiceNumber": 474,
  • "ServingCountry": "United States",
  • "ServingPlace": "My Service Place",
  • "ServingSID": 632,
  • "ServingState": "My Service State",
  • "UsageRecordID": 24626,
  • "WirelessFlags": 1
}

Usage Summary By Service Type

Summarizes usage information for a customer, grouped by the type of service.

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CatalogID": 634,
  • "CustomerID": 589367893,
  • "FirstUsageTime": "2017-09-09T17:35:09.156Z",
  • "LastUsageTime": "2017-09-09T17:35:09.156Z",
  • "ServiceType": "Service Type Description",
  • "TotalCharge": 19.72,
  • "TotalUnits": 56,
  • "UsageCount": 57
}

Usage Summary By Usage Type

Summarizes usage information for a customer, grouped by the type of usage.

  • Required Header: CustomerID (int)
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CustomerID": 589367893,
  • "FirstUsageTime": "2017-09-09T17:35:09.156Z",
  • "LastUsageTime": "2017-09-09T17:35:09.156Z",
  • "TotalCharge": 19.72,
  • "TotalUnits": 34,
  • "UnitType": "Unit Type Description",
  • "UnitTypeID": 589367893,
  • "UsageCount": 3,
  • "UsageType": "Usage Type Description",
  • "UsageTypeID": 589367893
}

Release Notes

Latest WSDL

Release Notes 2.34

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.33

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.32

Release Notes 2.31

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.30

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.29

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.28

Release Notes 2.27

Release Notes 2.26

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.25

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.24

Release Notes 2.23

Release Notes 2.22

Release Notes 2.21

Release Notes 2.20

Release Notes 2.19

Release Notes 2.18

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.17

Release Notes 2.16

  • WSDL
  • Added AddressValidationInformation and AddressValidationID to CreateServiceAddress and ModifyServiceAddress
  • Added the following to ServiceAddressByService and ServiceAddreessOverview
    • ActualValidationType
    • ActualValidationTypeID
    • AddressValidationID
    • AddressValidationResult
    • AddressValidationResultCode
    • AddressValidationResultID
    • BypassUser
    • ExcludeReasonID
    • FailureCount
    • IsPOBox
    • RequiredValidationType
    • RequiredValidationTypeID
    • TaxAddressError
    • TaxAddressValidated
    • TaxState
    • ValidationDate

Release Notes 2.15

  • WSDL
  • Added requirement notes to MSAGCommunity, MSAGCounty, and MSAGProviderID fields under ModifyServiceAddressReq and CreateServiceAddressReq
  • Added MSAGError, and MSAGValidated, fields under ModifyServiceAddressReq and CreateServiceAddressReq

Release Notes 2.14

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.13

Release Notes 2.12

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

Release Notes 2.07

Release Notes 2.06

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

Release Notes 2.04

Release Notes 2.03

Release Notes 2.02

Release Notes 2.01

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

Release Notes 1.50

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.49

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.48

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.47

Release Notes 1.46

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.45

Release Notes 1.44

Release Notes 1.43

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.42

Release Notes 1.41

  • WSDL
  • Added DeclineCount and RootPaymentAccountTransactionID to PaymentAccountTransaction
  • Corrected oData query string parameters to use $inlineCount instead of $count

Release Notes 1.40

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.39

Release Notes 1.38

Release Notes 1.37

Release Notes 1.36

Release Notes 1.35

Release Notes 1.34

Release Notes 1.33

  • WSDL
  • Changed validation logic for creating/modifying a Bank Account Payment account to now only look at the 'Allow ACH Export' setting when storing the bank account number.

Release Notes 1.32

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.31

Release Notes 1.30

  • WSDL
  • Added AssociatedAccountNumber, AssociatedCustomerID, AssociatedCustomerName, and OriginatingInstallmentPlanFeatureID to InstallmentPlan

Release Notes 1.29

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.28

Release Notes 1.27

Release Notes 1.26

Release Notes 1.25

  • WSDL
  • Added AgentDOB, ReachByEmail, ReachByMail, ReachByPhone, ReachByText
  • Added ReachByEmail, ReachByMail, ReachByPhone, ReachByText

Release Notes 1.24

  • WSDL
  • Added PastDueBalance

Release Notes 1.23

  • WSDL
  • Added CurrencyID, EstablishDate, LanguageID
  • Added OriginatingPaymentAccountTransactionID
  • Added Currency, CurrencyID, Language, LanguageID
  • Added FinalInvoiceDate, InvoicePostedDate, NumberOfInstallments, PayInInstallments

Release Notes 1.22

  • WSDL
  • Added IsCollectionExempt
  • Added AlternateSerialNumberCheckDigit

Release Notes 1.21

  • WSDL
  • Added IsCollectionExempt
  • Added ProductSubType, ProductSubTypeID, WholesaleCost, WholesaleCostDefault, WholesaleCostOverriden
  • Added WholesaleCostOverride
  • Added NotificationSource, NotificationSourceKeyName

Release Notes 1.20

  • WSDL
  • Added TaxAllocation
  • Added TaxAllocations
  • Added AlternateInvoiceNumber
  • Added TaxAllocations
  • Added TaxAllocation

Release Notes 1.19

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.18

  • WSDL
  • Added ServiceAgreementID

Release Notes 1.17.03

  • WSDL
  • Added OrigTrunkGroup and TermTrunkGroup
  • Added OriginatingTrunkGroup and TerminatingTrunkGroup

Release Notes 1.17.02

  • WSDL
  • Added a note to ApplyToInstallmentPlanFeatureID
  • Added ServiceServiceTypeUnitTypeOverview

Release Notes 1.17.01

  • WSDL
  • Added AdjustmentTypeUserLink
  • Added ObjectWorkflowInstanceLinks
  • Added ObjectWorkflowInstanceLink enum.

Release Notes 1.17.00

  • WSDL
  • Added note in AccountTransactionTypeID for 'Corporate Rollup'
  • Added CorporateRollupOffset, IsNIRRollup
  • Added NotificationDeliveryType, NotificationHistory, NotificationTemplate
  • Added PendingBillCycle, PendingBillCycleID, and PendingBillCycleStartDate

Release Notes 1.16.03

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16.02

  • WSDL
  • Added CustomerEmailAddress
  • Added IsTaxable
  • Added CustomerUsageTypeOverview

Release Notes 1.16.01

  • WSDL
  • Added SuppressInvoicePrint

Release Notes 1.16.00

  • WSDL
  • Added AllowEquipmentAssignment.

Release Notes 1.15

  • WSDL
  • Added Latitude and Longitude.
  • Added CustomerEmailAddressRollup, PortActivityType
  • Added OpenRetainedFollowUpCount
  • Added PortRequestAction, PortTimeZoneType
  • Added IsDynamicCharge
  • Added ModifyPortRequestResult, ModifyPortRequestReq, PortRequest
  • Added ModifyPortRequest

Release Notes 1.14.03

  • WSDL
  • Added NLADServiceType
  • Added InvoiceResponsible
  • Added AgentID, AgentName, CertificationFlag, FullNameDOBCode, FullNameLast4SSNCode, NLADServiceType
  • Added AgentID, AgentName, CertificationFlag, FullNameDOBCode, FullNameDOBCodeID, FullNameLast4SSNCode, FullNameLast4SSNCodeID, NLADServiceType, NLADServiceTypeID.

Release Notes 1.14.02

  • WSDL
  • Added DiscountCategoryServiceAffiliation
  • Added PreviouslyDisconnected

Release Notes 1.14.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.14.00

  • WSDL
  • Added CreateUser.
  • Added StartDate,EndDate, and IsInternal,
  • Added RenewableAfterDays, RenewableBeforeDays
  • Added Device , FeatureCatalogGroup, SIMCard, UsageSharedGrantDiscountDetailSummary, UserCustomer
  • Deprecated CustomerUser
  • Added PrimaryServiceID
  • Added UserCustomerType
  • Added BillingOrderID, InstallmentAgreementGUID
  • Added ServiceName
  • Added Alert enum.
  • Added UsageNotificationSendToOptionID
  • Added CreateUserCustomerReq, ModifyUserCustomerReq, UserCustomer, UserCustomerResult
  • Added CreateUserCustomer, ModifyUserCustomer
  • Added HandsetID, SIMCardID, TechnologyType, TechnologyTypeID, UsageNotificationSendToOptionID
  • Added ServiceName
  • Added PreDiscountChargedUnits, ServiceName
  • Added ServiceServceTypeOverview , ServiceUsageChargeSummary ,ServiceUsageChargeSummarySnapshot, ServiceUsageTypeOverview, ServiceUsageTypeOverviewSnapshot, UsageRecordData, UsageRecordCDMA , UsageRecordGSM, UsageRecordWireless, UsageRecordSharedGrantDiscount , UsageRecordSharedGrantDiscountSummary, UsageSummaryByServiceType
  • Added Filename, ProvisioningCompany, ProvisioningCompanyID,
  • Added ExpirationDate,ThresholdPercentage

Release Notes 1.13

  • WSDL
  • Added ApplyToInvoiceCategoryID, ApplyToInvoiceNumber
  • Added CreditForCatalogSKU, CreditForFeatureInvoicedAmount
  • Added AdjustmentUsageRecord, ContractFeatureTerm, ContractFeatureTermAssociation, FeatureCatalogOverview, InvoiceFeatureSummary, InvoiceInsert, InvoiceMessage, PortActivity, PortRequest, ServiceHistory
  • Added ImmediateParentAccountNumber, ImmediateParentCustomerName, ImmediateParentInvoiceResponsible, TopRootAccountNumber, TopRootCustomerName, TopRootInvoiceResponsible
  • Added CPNIPINAction.
  • Added ApplyToInvoiceCategoryID, ApplyToInvoiceNumber
  • Added DUNSNumber
  • Added HasCPNIPIN
  • Added CPNIPINActionType.
  • Added ChargeDefault, CostDefault, DisableCreditingInAdvanceCharge, DisableETF, ParentServiceCatalog, ParentServiceCatalogID, ParentServiceID, ParentServiceNumber, ServiceCatalog, ServiceCatalogID
  • Added RetailProductDisplay
  • Added TotalAdjustmentCredits
  • Added ApplyToInvoiceCategoryID, ApplyToInvoiceNumber
  • Added DateOfBirth, DriversLicenseNumber, DriversLicenseState, DUNSNumber, SocialSecurityNumber, TaxIDNumber Updated note on CPNIInformation
  • Added ContractDetail, FeatureDetail, PackageDetail, ProductDetail
  • Added TaxExemptFlagsE911
  • Added AllowRecurringConflictRemoval
  • Added ALECount, E911ClassOfService, E911ClassOfServiceID, E911ServiceAddressID, E911TypeOfService, E911TypeOfServiceID, FirstCallDate, IsE911ExemptCity, IsE911ExemptCounty, IsE911ExemptRegional, IsE911ExemptState, LastCallDate, PlanDisplay, RateCenter, RateCenterID, UsageNotificationSendToOption, UsageNotificationSendToOptionID
  • Added ALECount, ContractRenewableDate, E911ClassOfService, E911ClassOfServiceID, E911ServiceAddressID, E911TypeOfService, E911TypeOfServiceID, FirstCallDate, IsE911ExemptCity, IsE911ExemptCounty, IsE911ExemptRegional, IsE911ExemptState, IsPortOut, LastCallDate, PlanDisplay, RateCenter, RateCenterID, UsageNotificationSendToOption, UsageNotificationSendToOptionID
  • Added SubserviceCount
  • Added CDRFileID, CDRFileRecordInstanceNumber and CDRFileRecordNumber
  • Added TerminatingCIC

Release Notes 1.12.01

  • Updated note on CPNIInformation

Release Notes 1.12.00

  • Added AccountBalance
  • Added ReversalAdjustmentID
  • The AuthenticatedKey property is no longer used as the sole authorization of a user for a resource. Instead "limit-to" functionality will be enforced on every access call. Users who are not authorized for a resource but have a valid authorization key will no longer be allowed access to the resource and will need to be given appropriate access. Only the ID property will still be used.
  • Added CoincidentCreditTransaction, CoincidentDebitTransaction, Deposit, DepositAllocation, DepositInterest, DepositSummary, PaymentAccountTransaction
  • Added PaymentAccountLogs
  • Added ProcessDate, TransactionStatus Noted PaymentAccountID change
  • Deprecated CustomerID
  • Added AlertDetails, PaymentAccountLogIDs
  • Deprecated CustomerAuthenticatedKey
  • Added PaymentAccountLogRequestCode, PaymentAccountTransactionLogRequestCode PaymentProviderLogResponseCode, TransactionStatus
  • Noted FeatureID change.
  • Noted ServiceAgreementID change.
  • Noted CustomerID and InvoiceNumber change.
  • Noted InvoiceNumber change.
  • Added PaymentAccountTransaction, PaymentProviderLog
  • Added Alerts, PaymentAccountLogs Noted CustomerID change.
  • Deprecated AuthenticatedKey
  • Noted FeatureID change
  • Added Adjustment, AdjustmentUsageRecord, Alert, AlertDetail, CreateAdjustmentReq, CreateAdjustmentResult, CreateDepositReq, CreateDepositResult CreatePaymentReq,CreatePaymentResult, Deposit,DepositAllocation, ModifyAdjustmentReq, ModifyAdjustmentResult, ModifyDepositReq, ModifyDepositResult ModifyPaymentAccountTransactionReq, ModifyPaymentAccountTransactionResult, ModifyPaymentReq, ModifyPaymentResult, Payment, PaymentAccountLog, PaymentAccountTransactionLog, PaymentAllocationOverride, PaymentProviderLog
  • Added CreateAdjustment,CreateDeposit, CreatePayment, ModifyAdjustment, ModifyDeposit, ModifyPayment, ModifyPaymentAccountTransaction
  • Added ReversalPaymentID
  • Added IsDeleted, IsTerminated, TemporaryPaymentAccountID
  • Added Terminate
  • Added ApprovalCode, ApprovalDate, ErrorCode, ErrorMessage, PaymentAccountTransactionLogID, ProcessDate, ProviderAVSResultCode, ProviderResultCode, ProviderTransactionID, TransactionStatus Noted PaymentAccountID change
  • Noted ServiceID change
  • Added IsLoadable
  • Added Credit
  • Added ChildCustomerID, MyOverageCharge, MyOverageUnits, MyUnits, OverageCharge, OverageUnits

Release Notes 1.11.02

  • Added EmailAddress1Type, EmailAddress2Type, EmailAddress3Type, PhoneNumber1Type, PhoneNumber2Type, PhoneNumber3Type, PhoneNumber4Type

Release Notes 1.11.01

  • Added InvoiceSummaryWithCorporateRollup, InvoiceSummary
  • Added IsCorporateRollupAvailable, TotalAmountDue, TotalNewCharge Deprecated Adjustments, Discounts, FinanceCharges, InstallmentPlans, MRC, NRC, Payments, Penalties, Taxes, Usage

Release Notes 1.11.00

  • Added Contact
  • Added DisplayName

Release Notes 1.10.01

  • Added BusinessChecking, BusinessSavings
  • Added TaxIDNumber

Release Notes 1.10.00

  • Added AffinityGroupID, ChildSortOrder, CPNIOptIn, FinanceChargeExempt, HomeRegionID, IsDAExempt, IsDisabled, IsHearingImpaired, IsLifeline, IsSpeechImpaired, IsVisuallyImpaired, PullInvoice, RegionID, TaxExemptFlags, TaxExemptFlagsE911, TaxExemptFlagsSurcharge, TaxExemptFlagsUSF, TaxExemptIDCity, TaxExemptIDCounty, TaxExemptIDFederal, TaxExemptIDRegional, TaxExemptIDState, UsageRoundingOption, UsesTTY
  • Added ContractFeature, ContractTermOverride, ContractTermPenaltyOverride, CorporateAccountBalance, CustomerBillingInformation, CustomerExtendedTaxExemption, CustomerTaxInformation, CustomerTaxJurisdiction, OrderStatusOverview, ServiceContact, ServiceNumberHistory, ServiceSummary, ServiceTaxChannelOverride, ServiceTaxJurisdiction, ServiceAddressOverview
  • Added BillingStatus, BillingStatusID, CustomerContactAddress, DisconnectDate, EstablishDate
  • Added AffinityGroup, AffinityGroupID, ChildSortOrder, CPNIOptIn, FinanceChargeExempt, HomeRegion HomeRegionID, IsDAExempt, IsDisabled, IsHearingImpaired, IsLifeline, IsSpeechImpaired, IsVisuallyImpaired, PullInvoice, Region, RegionID, TaxExemptFlags, TaxExemptIDCity, TaxExemptIDCounty, TaxExemptIDFederal, TaxExemptIDRegional, TaxExemptIDState, UsageRoundingOption, UsesTTY
  • Added CorporateAccountRootCustomerID, RetainedFollowUpCount, RetainedJournalCount, RetainedTroubleTicketCount
  • Added City, County, Notes
  • Added RoundToPennyType, ServiceAddressStatus, StreetDirectionAffix
  • Added IsOnePrice, SOC, SOCOverridden
  • Added AffinityGroupID, ChildSortOrder, CPNIOptIn, FinanceChargeExempt, HomeRegionID, IsDAExempt, IsDisabled, IsHearingImpaired, IsLifeline, IsSpeechImpaired, IsVisuallyImpaired, PullInvoice, RegionID, TaxExemptFlags, TaxExemptFlagsE911, TaxExemptFlagsSurcharge, TaxExemptFlagsUSF, TaxExemptIDCity, TaxExemptIDCounty, TaxExemptIDFederal, TaxExemptIDRegional, TaxExemptIDState, UsageRoundingOption, UsesTTY
  • Added EnablePerChannelTaxing, EnablePerSingleLineTaxing, IsPortOut, OverridePerLineTaxConfiguration, PerLineTaxClassID, RegionID, ServiceServiceAddress, TaxChannelOverrides, TaxServiceAddressID, ZoneID
  • Added CorporateAccount, CreateServiceAddressReq, CreateServiceAddressResult, CustomerTaxTypeExempt ModifyCorporateAccountsReq, ModifyCorporateAccountsResult, ModifyServiceAddressReq, ModifyServiceAddressResult, ServiceAddress, ServiceAddressService, ServiceServiceAddress, TaxChannel, TaxExemptFlags,
  • Added CreateServiceAddress, ModifyCorporateAccounts, ModifyServiceAddress
  • Added EnablePerChannelTaxing, EnablePerSingleLineTaxing, IsPortOut, OverridePerLineTaxConfiguration, PerLineTaxClassID, RegionID, ServiceServiceAddress, TaxChannelOverrides, TaxServiceAddressID, ZoneID
  • Added DisconnectReason, DisconnectReasonDescription, DisconnectReasonID, IsPerLineTaxConfigurationOverridden, IsPortOut, OverrideEnablePerChannelTaxing, OverridePerLineTaxClass, OverridePerLineTaxClassID, OverrideEnablePerSingleLineTaxing, Region, RegionID, SuspendReason, SuspendReasonDescription, SuspendReasonID, TaxJurisdictionOverrideID, TaxState
  • Added CatalogID, ServiceDescription
  • Added City, County, Notes

Release Notes 1.09

  • Added AccountTransaction, AccountTransactionSettlement, Adjustment, Alert, BalanceAccountTypeOverview, BalanceSummary, CustomerContact, CustomerService, InvoiceFeature, InvoiceFeatureOverview, InvoiceLedgerItem, InvoiceTaxOverview, NLADInformation, Payment, PaymentAllocationOverride, ServiceCatalogOverview, UsageServiceCharge, UsageSharedGrantDiscount, Deprecated AccountTransactionPosted, ActiveServicesByType
  • Added NLADInformation
  • Added BillCycle, BillCycleID, ChangeDate, ChangeType, ChangeTypeID, CollectionStatus, CollectionStatusID, IsCorporateAccount, IsInvoiceResponsible, JournalCount, OpenFollowUpCount, OpenRedFlagTroubleTicketCount, OpenTroubleTicketCount, OverdueFollowUpCount, OverdueTroubleTicketCount
  • Added NLADDisputeResolutionErrorCode, NLADLifelineEligibilityProgramCode
  • Added InstallmentPlans, MyTotalNewCharge, USGFileCreated
  • Added NLADBenefitQualifyingPerson, NLADInformation
  • Added InvoiceServiceTaxOverview, ServiceCatalogUsageOverviewSnapshot, ServiceUsageTypeDistanceTypeOverview, ServiceUsageTypeDistanceTypeOverviewSnapshot, UsageRecord, UsageRecordRateOverview
  • Added DistanceType, DistanceTypeID, OtherPartyCountryCode, OtherPartyNumber, PrimaryUsageType, PrimaryUsageTypeID, UnitSubType and UnitSubTypeID

Release Notes 1.08

  • Added AppliedToInstallmentPlanFeatureID
  • Added Charge, DisplayZeroCharges
  • Added PhoneNumber
  • Added InstallmentPlan, InstallmentPlanDetail, ServiceCategoryOverview
  • Added DisplayZeroCharges
  • Added HandsetAlternateSerialNumber, HandsetSerialNumber, SIMCardSerialNumber

Release Notes 1.07

  • Added CorporateAccount, ServiceAddressByService
  • Added CustomerContactAddress, TotalActiveServices, TotalServices
  • Added NumberOfChildServices, TaxServiceAddressID, Zone, ZoneID
  • Added Zone, ZoneID

Release Notes 1.06

  • Added CustomerTaxJurisdictionOverride, ServiceTaxJurisdictionOverride
  • Added CustomerDepartments, TaxJurisdictionOverride
  • Added ChargeOverridden, Cost, CostOverridden, Notes, PreviousServiceDate, ServiceDate
  • Added CustomerDepartment
  • Added CustomerDepartments, TaxJurisdictionOverride
  • Added AlternateServiceNumber, ChangeDescription, CustomerDepartmentID, EndDate, ReasonID, ServiceNumber, StartDate, TaxJurisdictionOverride
  • Added ChangeDescription, CustomerDepartmentID, ReasonID, TaxJurisdictionOverride
  • Added CatalogID, CustomerDepartment, CustomerDepartmentID, ParentServiceDescription, ParentServiceNumber
  • Added ParentServiceDescription, ParentServiceNumber

Release Notes 1.05

  • Added 'Reward Points' to 2 type fields
  • Added RewardPointsBalance
  • Added Note
  • Added CustomerAccountCode, CustomerAccountCodeGroup, CustomerDepartment
  • Added Remove
  • Added ReportGroupID, SalesCodeID, and ZoneID
  • Added CustomerAuthenticatedKey, ReportGroup, ReportGroupID, SalesCode, SalesCodeID, Zone, ZoneID
  • Added TaxAccountType
  • Added MonthlyPoints, RewardPointsBalance
  • Added Feature, Service
  • Added ReportGroupID, SalesCodeID, and ZoneID
  • Added Feature, ModifyFeatureReq, ModifyFeatureResult, ModifyServiceReq, ModifyServiceResult, Service
  • Added ModifyFeature, ModifyService

Release Notes 1.04

  • Added ExtendedInformationItem, FeatureActionSummary, MarketAssignmentAddress, MarketAssignmentSetting, ServiceActionSummary
  • Added AttributePropertyDisplay, AttributePropertyID
  • Added ExtendedInformation
  • Added CustomerExtendedInformation
  • Added AccountStatus, AccountStatusID, AccountType, AccountTypeID, BillingContactAddress, ChangeReason, ChangeReasonID, CustomerType, CustomerTypeID, DisconnectDate, EstablishDate, FirstName, LastName, MainBillingNumber, Market, MarketID
  • Added DefaultMarketCalculationMethod, ObjectType
  • Added AttributePropertyDisplay, AttributePropertyID
  • Added ExtendedInformationItem
  • Added CalculateDefaultMarketReq, CalculateDefaultMarketResult, ExtendedInformationItem, ModifyExtendedInformationReq, ModifyExtendedInformationResult
  • Added CalculateDefaultMarket, ModifyExtendedInformation
  • Added AttributePropertyDisplay, AttributePropertyID, ParentServiceID
  • Added ParentServiceID

Release Notes 1.03

  • Added ActiveFeaturesByType, ActiveServicesByType, CustomerSummary, CustomerUser, DiscountFeature, FavoriteNumber, FavoriteNumberDiscountLink, FeatureSummary
  • Added PhoneNumberItems
  • Added PhoneNumberItemType, TransactionSource, TransactionType
  • Added ServiceBillingStatus, ServiceBillingStatusID, ServiceEndDate, ServiceNumber, ServiceStartDate
  • Added PhoneNumberItem
  • Added CreatePaymentAccountTransactionReq, CreatePaymentAccountTransactionResult, DateTimeString, PaymentAccountTransactionDetail, PhoneNumberItem, PhoneNumberItemDiscount
  • Added CreatePaymentAccountTransaction
  • Added AssignmentTemplateID, CatalogID

Release Notes 1.02

  • Added AuthorizedUserID
  • Renamed MostRectentInvoiceDueDate toLastInvoiceDueDate. Added LastInvoiceTotalAmountDue.
  • Added note to City, CompanyName, Country, County, FirstName, MiddleInitial, LastName, State, Street1, Street2, Street3
  • Core Data Endpoint added to Customer service
  • Added ExternalMarketing, InternalMarketing, SecurityQuestionID, SMSServiceID
  • Added CPNIInformation, PaymentAccounts, SuppressInvoice Print
  • Added BillPeriodEndDate, BillPeriodID, BillPeriodStartDate, IsInvoiceResponsible, SuppressInvoicePrint, UsageAliasName
  • Added PaymentAccountDetails
  • Updated CustomerID (see Note).
  • Added CustomerServiceSummaries, IncludePackageChildren, PaymentAccountDetails
  • Added CustomerServiceSummaries
  • Added note to Email about all capitalization
  • Added BankAccountType, BankProcessingType, BillingCycleType, BillingStatus, CreditCardType, ProductCatalogClass, ProductType, RemittancType
  • Added AlternateInvoiceDescription, BillingCycleType, BillingStatus, ProdcutCatalogClass, ProductType, Quantity, WebName
  • Added to Customer Service
  • Added Invoice, InvoiceSummary
  • Added PaymentAccount
  • Added AccountReceivableGroupID, BalanceAgingGroupID, BillCycleID, Contacts, ConverToBillableCustomer, CPNIInformation, FinanceGroupID, PaymentAccounts, SuppressInvoicePrint
  • Added AuthorizedUserInformationItem, CPNIInformation, CustomerServiceSummary, DateOnlyString, IntString, Invoice, InvoiceLookupReq, InvoiceLookupResult, InvoiceSummary, PaymentAccount, PamentAccountBankAccount, PaymentAccountCreditCard, PaymentAccountDetail, PaymentAccountRecurring, PaymentAccountRecurringDetail
  • Added InvoiceLookup
  • PaymentAccountRecurring
  • Added InvoiceLookupResponseGroup
  • Added AlternateDescription, AlternateInvoiceDescription, BillingStatus, ContractEndDate, ProductCatalogClass, WebName
  • Usage Data endpoint added to Customer Service

Release Notes 1.01

  • Added ServiceAgreementID
  • Added ModifyCustomer