logo
API docs by Redocly

Data Service (2.15)

Data Service Concepts

Document Lookup Handler

Note The DocumentLookup endpoint was added to the Data service in [Rev 1.01].

Abstract

The purpose of the DocumentLookup endpoint is to supply a set of lookup capabilities that can be used for retrieval of various types of documents.

Authorization [Rev 1.05]

In order to retrieve information from the Document Lookup Handler, 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. The Security Token will first need to be decrypted using the IDI SaaS Web Services certificate before the claim can be found. Once found, the Simple Web Token must be submitted with each request in an HTTP request "Authorization" header with a value in exactly the following format WRAP access_token="" where between double quotes is replaced with the SWT claim string value between double quotes.

Details

The Document Lookup handler can be requested using either a HTTP GET or HTTP POST request. For HTTP GET, include the required parameters in the query string of the URL. For HTTP POST, include the required parameters in the body of the HTTP request. In addition, set the ContentType header to "application/x-www-form-urlencoded", and the ContentLength header equal to the total number of bytes in your UTF-8-encoded byte array of desired parameters as described in the table below.

Multiple parameters are separated by '&' and each one is formatted as "name=value", for example "type=invoice&id=123&key=xyz". To send the HTTP POST request, get the request stream from the Http Web Request and write the byte array of desired parameters to it. Also flush and close the stream. To receive the response from either the HTTP GET or HTTP POST request, get the Web Response from the Http Web Request, then get the response stream from the Web Response and read to the end of the stream.

Note

  • Request parameter validation errors are not unexpected and do NOT throw exceptions. Their messages are simply returned with a ContentType of "text/plain". When there is an unexpected web service exception, then getting the Web Response will throw a Web Exception, though a Web Response may still be available from within the Web Exception.

Request Parameters (All required except as noted)

Name Description
id The unique ID for the document being requested.
key The system-generated authenticated key for the document ID based on the type parameter described below.
Note: Type 'Invoice' uses the authenticated key from the customer ID that the invoice is associated with.
Deprecated: This value no longer needs to be supplied. Instead authorization to the resource will be determined server side based on the supplied token. [Rev 1.09]
type Defines the type of document being requested, each with a Web Response ContentType as shown.
Valid Values (not case-sensitive) and returned ContentTypes
Document: "application/pdf"
Invoice: "application/pdf" [Rev 1.01]
NetworkReceipt: "text/html"
Quote: "text/html"
ServiceAgreement: "application/pdf"
USGFile: "application/zip"
registerid Determines location information for obtaining the document template.
Note: Only applicable for Network Receipts and Quotes. Field is required.
reprint If specified as "True" or "Yes", the document title is marked as a "Reprint".
*Note: Only applicable for Network Receipts. Not a required field.

Operations

Attribute Definition Lookup

Provides the ability to look up information, such as valid value choices, for a particular attribute property and all of its descendants. [Rev 1.03]

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

Provides the ability to look up information, such as valid value choices, for a particular attribute property and all of its descendants. [Rev 1.03]

Responses

Create Attached Document

Provides the ability to create a document. [Rev 1.06]

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

A request container for the values needed to call CreateAttachedDocument. [Rev 1.06]

Responses

Data Search

Provides the ability to obtain a list of information about various types of data based on the provided search criteria.

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

Provides the ability to obtain a list of information about various types of data based on the provided search criteria.

Responses

Modify Attached Document

Provides the ability to update an attached document. [Rev 1.06]

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

A response object that contains the result of a call to ModifyAttachedDocument. [Rev 1.06]

Responses

Payment Gateway Lookup

Provides the ability to look up unencrypted payment gateway information for a particular register policy and tender type. [Rev 1.02]

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

Provides the ability to look up unencrypted payment gateway information for a particular register policy and tender type. [Rev 1.02]

Responses

Set User Customer

Provides the ability to set the default Customer for lookups, etc., along with notification information for a given user in the security system. [Rev 1.01]

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

Provides the ability to set the default Customer for lookups, etc., along with notification information for a given user in the security system. [Rev 1.01]

Responses

Backbone Data Service

Note

The BackboneDataService endpoint was added to the Data service in [Rev 1.04].

Abstract

The purpose of the BackboneDataService 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.

Configuration Node

A list of all configuration nodes in the system. [Rev 1.04]

Note

Results are filtered by the environment of the user that the request was authorized for.

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "EntityID": 357,
  • "EnvironmentName": "My Environment Name",
  • "IsEncrypted": false,
  • "LinkedEnvironmentName": "My Linked Environment Name",
  • "ModuleName": "My Module Name",
  • "NodeData": "My Node Data",
  • "NodeID": 5734,
  • "NodeName": "My Node Name",
  • "NodePath": "My Node Path",
  • "NodeTypeID": 357,
  • "NodeTypeName": "My Node Type Name"
}

Core Data Service

Note

The CoreDataService endpoint was added to the Data service in [Rev 1.01].

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.

Accounts Receivable Batch Summary

A list of all the accounts receivable batches configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccountsReceivableBatchID": 75357,
  • "BatchNumber": 457,
  • "BatchStatus": "My Batch Status",
  • "BatchStatusID": 1,
  • "BatchType": "My Batch Type",
  • "BatchTypeID": 1,
  • "CloseDate": "2017-09-09T17:35:09.156Z",
  • "HoldUntilClose": true,
  • "ItemCount": 5,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "OpenDate": "2017-09-09T17:35:09.156Z",
  • "PostedItemCount": 63,
  • "TotalAmount": 5.5
}

Accounts Receivable Group

A list of all the accounts receivable groups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccountsReceivableAllocationMethod": "My allocation method description",
  • "AccountsReceivableAllocationMethodID": 2,
  • "AccountsReceivableGroupID": 56,
  • "Description": "My description"
}

Account Status

A list of all the account statuses configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccountStatusID": 5478,
  • "AllowAddFeatures": true,
  • "BillingStatus": "My billing status description",
  • "BillingStatusID": 0,
  • "Description": "My account status description",
  • "KeyName": "My Unique Name"
}

Account Type

A list of all the account types configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccountTypeID": 30,
  • "AttributePropertyDisplay": "My Attribute Property Display Name",
  • "AttributePropertyID": 346,
  • "CPNIRequired": true,
  • "Description": "My account type description",
  • "HasAccountSpendingLimit": false,
  • "KeyName": "My Key Name",
  • "ReconnectThreshold": 30,
  • "TaxAccountType": "My Tax Account Type description",
  • "TaxAccountTypeID": 1
}

Adjustment Reason

A list of all of the adjustment reasons 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AdjustmentReasonID": 563,
  • "Description": "My adjustment reason description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Adjustment Type

A list of all the adjustment types configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AdjustmentTypeID": 2364,
  • "Description": "My adjustment type description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsCharge": false,
  • "IsLecBilled": false,
  • "IsWriteOff": true,
  • "KeyName": "My Key Name",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "TaxClass": "My tax class description",
  • "TaxClassID": 357
}

Affinity Group

A list of all of the affinity groups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AffinityGroupID": 457,
  • "ContributionPercent": 0.05,
  • "Name": "My Affinity Group Name",
  • "Note": "MY personalized text message",
  • "TotalToDate": 15.5
}

Attached Document

A response object containing information about a document that may be attached to one or more objects. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Account Number",
  • "AttachedDocumentID": 573,
  • "Category": "My Category Name",
  • "Confidential": true,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 56,
  • "CustomerName": "My Customer Name",
  • "DocumentStorageExternalID": "My Document Storage External ID ",
  • "Environment": "My Environment",
  • "Extension": ".doc",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "MarkedForDelete": false,
  • "Name": "My Document Name",
  • "Notes": "My document description",
  • "ObjectDisplayName": "My Object Display Name",
  • "ObjectID": 474,
  • "ObjectType": "My Object Type",
  • "ReferenceMarkedForDelete": false,
  • "Size": 15
}

Attached Document Category Overview

An overview by Category for all documents attached to a specific ObjectType and ObjectID. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Account Number",
  • "AttachedDocumentCount": 13,
  • "Category": "My Category Name",
  • "CustomerID": 357,
  • "CustomerName": "My Customer Name",
  • "MarkedForDeletionCount": 14,
  • "ObjectID": 468,
  • "ObjectType": "My Object Type"
}

Attached Document Object Type

A list of object types that documents may be attached to. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AttachedDocumentObjectTypeID": 345,
  • "Name": "My Object Type Name",
  • "RequiresCustomerID": false
}

Attached Document Object Type Overview

A list of all documents and the counts of different object types to which they have been attached. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Account Number",
  • "AttachedDocumentID": 458,
  • "Category": "My Category Name",
  • "Confidential": true,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": -1,
  • "CustomerName": "My Customer Name",
  • "DocumentStorageExternalID": "My unique identifier",
  • "Environment": "My Environment",
  • "Extension": ".doc",
  • "FirstObjectDisplayName": "My First Object Display Name description",
  • "FirstObjectID": 4684,
  • "FirstObjectType": "My First Object Type description",
  • "FirstObjectTypeID": 547,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "MarkedForDelete": false,
  • "Name": "My Document Name",
  • "Notes": "My document description",
  • "ObjectType": "My Object Type",
  • "ObjectTypeID": 246,
  • "ReferenceCount": 5,
  • "ReferenceMarkedForDeleteCount": 13,
  • "Size": 15
}

Attribute Definition Tree

A list of details about attribute properties within attribute definition objects by category, including their hierarchical relationship to other attribute properties. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "Category": "My Category Name",
  • "CategoryID": -1,
  • "DataLength": 12,
  • "DataPrecision": 3,
  • "DataType": "My Data Type",
  • "DataTypeID": 13,
  • "DefaultValue": "My Default Value",
  • "DisplayName": "My Display Name",
  • "DomainSource": "My Domain Source",
  • "DomainType": "My Domain Type",
  • "DomainTypeID": 2,
  • "DoNotCache": false,
  • "FormatString": "My Format String",
  • "IsEnabled": true,
  • "IsRequired": false,
  • "IsVisible": true,
  • "Name": "My Attribute Property Name",
  • "ParentProperty": "My Parent Property Name",
  • "ParentPropertyDisplay": "My Parent Property Display Name",
  • "ParentPropertyID": 23,
  • "PermissionPath": "My permission required description",
  • "PropertyID": 357,
  • "PropertyType": "My Property Type Name",
  • "PropertyTypeID": 537,
  • "RootProperty": "My Root Property Name",
  • "RootPropertyDisplay": "My Attribute Property Name",
  • "RootPropertyID": 2,
  • "SequenceNumber": 8,
  • "ValidateScript": "My Validate Script"
}

Backdating Closed Through Date

Returns the first instant available for backdating, based on the current backdating control.

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "referenceDate": "2007-04-03T02:23:57.000Z"
}

Balance Aging Group

A list of all the balance aging groups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "BalanceAgingGroupID": 457,
  • "Description": "My description"
}

Bank

A list of all the banks configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": 122105155,
  • "BankName": "Bank of America"
}

Bill Cycle

A list of all the bill cycles configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "BillCycleID": 346,
  • "BillingCycleClass": "My billing cycle class description",
  • "BillingCycleClassID": 4,
  • "BillingCycleType": "My charge cycle description",
  • "BillingCycleTypeID": 7,
  • "DayOfMonth": 21,
  • "Description": "My bill cycle description",
  • "Name": "My Bill Cycle Name"
}

Carrier

A list of all the carriers configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CarrierID": 3463,
  • "Name": "My Carrier Name"
}

Change Reason

A list of all the change reasons configured in the system. [Rev 1.02]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "ChangeReasonID": 465,
  • "ChangeType": "My Change Type",
  • "ChangeTypeID": 6,
  • "Description": "My change reason description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "NLADDeEnrollType": "My reason for de-enrollment description",
  • "NLADDeEnrollTypeID": 2,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Communication Script

A list of all of the communication scripts in the system. Communication scripts are used to prompt customer service representatives with actions to complete or items to present to the customer during account modifications. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CommunicationScriptAction": "My Communication Script Action description",
  • "CommunicationScriptActionID": 7,
  • "CommunicationScriptID": 568,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Script": "My communication script text"
}

Configuration Value

A list of all configuration values 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "ConfigurationValueID": 634,
  • "KeyName": "My Key Name",
  • "Value": "My Configuration Value"
}

Contact Type

A list of all the contact types used 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AddressValidationType": "My AddressValidationType description",
  • "AddressValidationTypeID": 5,
  • "ContactTypeID": 457,
  • "Description": "My contact type description",
  • "IsWebEditable": true,
  • "IsWebViewable": false
}

CostGuard Server TimeZone

Returns a single row indicating the time zone of the CostGuard server instance. These values can be used to convert string values returned from APIs to arbitrary time zones. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CostGuardTzID": "My tz database time zone name",
  • "CostGuardWindowsTimeZoneKey": "My Windows Time Zone Key"
}

CPNI Configuration

The CPNI Configuration options configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccountPasswordRequired": true,
  • "AuthorizedUserPasswordRequired": false,
  • "AuthorizedUsersRequired": false,
  • "ConfirmAccountChangeNotifications": false,
  • "CPNIConfigurationID": 346,
  • "PasswordMaxLength": 18,
  • "PasswordMinLength": 12,
  • "SecurityQuestionAnswerRequired": true
}

CPNI Security Question

A list of all the CPNI security questions configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CPNISecurityQuestionID": 3457,
  • "CPNISecurityQuestionOwnerType": "My owner type description",
  • "CPNISecurityQuestionOwnerTypeID": 1,
  • "Enabled": false,
  • "Question": "My security question description"
}

Credit Class

A list of all the credit classes 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CreditClassID": 4574,
  • "DoNotAllowInstallmentPlan": false,
  • "Name": "My credit class name"
}

Currency

A list of all the currencies configured in the system. [Rev 1.16]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CurrencyID": 34573,
  • "Name": "Colónes"
}

Deposit Allocation Type

A list of all of the deposit allocation types 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "DepositAllocationTypeID": 42,
  • "Description": "My deposit allocation type"
}

Deposit Type

A list of all of the deposit types 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "DepositTypeID": 4564,
  • "Description": "My deposit type description"
}

Deposit Waive Type

A list of all of the deposit waive types 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "DepositWaiveTypeID": 674,
  • "Description": "My deposit waive type description"
}

Distance Type

List of distance classification types that can be assigned to usage for rating. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "DistanceTypeID": 357,
  • "Name": "My Distance Type Name"
}

E911 Class Of Service

A list of all of the E911 classes of service 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "E911ClassOfServiceID": 344,
  • "IsExcluded": false,
  • "Name": "My E911 Class Of Service Name"
}

E911 Type Of Service

A list of all of the E911 types of service 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "E911TypeOfServiceID": 8568,
  • "IsExcluded": false,
  • "Name": "My E911 Type Of Service Name"
}

Extended Tax Exemption

A list of all of the extended tax exemptions 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "Tax - Federal Excise Tax",
  • "DescriptionExtended": "[Federal, Tax] Tax - Federal Excise Tax",
  • "ExtendedTaxExemptionID": 324,
  • "TaxExemptionCategory": "Tax",
  • "TaxExemptionCategoryID": 47,
  • "TaxType": "Federal",
  • "TaxTypeID": 357
}

Finance Group

A list of all the finance groups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My finance group description",
  • "FinanceGroupID": 457,
  • "FinanceMethod": "My finance method description",
  • "FinanceMethodID": 2
}

Inventory Status

A list of all inventory statuses configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My inventory status description",
  • "InventoryClass": "My Inventory Class Name",
  • "InventoryClassID": 3546,
  • "InventoryStatusID": 573
}

Journal

A list of all the journals in the system, including follow-ups and trouble tickets as noted. [Rev 1.04]

  • Deprecated: Replaced by JournalItem in the Journal service, CoreDataService. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Account Number",
  • "CloseDate": "2017-09-09T17:35:09.156Z",
  • "CreationDate": "2017-09-09T17:35:09.156Z",
  • "CreationUser": "Username",
  • "CustomerID": 574,
  • "CustomerName": "My Customer Name",
  • "Description": "My journal description",
  • "Internal": false,
  • "JournalClass": "Trouble",
  • "JournalID": 467,
  • "JournalStatus": "My Journal Status",
  • "JournalStatusID": 3,
  • "JournalType": "My journal type name",
  • "JournalTypeID": 245,
  • "ReferenceToItemID": 24,
  • "ReferenceToItemType": "My Reference To Item Type",
  • "WebViewable": false
}

Language

A list of all the languages configured in the system. [Rev 1.16]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "LanguageID": 467,
  • "Name": "Italian",
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Location Information

A list of all the locations in the system. [Rev 1.02]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "Abbreviation": "N37",
  • "AllowEpayCreditCard": true,
  • "AllowSaleOfDiscontinuedItem": false,
  • "DefaultServiceAlternateDescription": "My Default Service Alternate Description",
  • "DefaultServiceAlternateInvoiceDescription": "My Default Service Alternate Invoice Description",
  • "DefaultServiceCatalogID": 568,
  • "DefaultServiceDescription": "My Default Service Description",
  • "DefaultServiceWebName": "My Default Service WebName",
  • "InventoryGroup": "My inventory group description",
  • "InventoryGroupID": 478,
  • "Location": "My location description",
  • "LocationID": 357,
  • "PromptForTaxableAddress": false,
  • "RequireCustomerForBlindReturns": false,
  • "RequireCustomerForReturns": false,
  • "RequireReturnReason": false
}

Location Register Policy

A list of all the register policies in the system with their associated locations and store types. [Rev 1.02]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AddCashLevel": 50,
  • "AutomaticallyCreateFloatWhenNeeded": true,
  • "AutoReconcile": true,
  • "ForceDailyReconciliation": false,
  • "ForceExactReconciliation": false,
  • "InitialFloat": 100,
  • "Location": "My location description",
  • "LocationID": 4687,
  • "LocationStoreType": "My store type description",
  • "LocationStoreTypeID": 3557,
  • "MaxReconcileOverage": 1,
  • "MaxReconcileShortage": 1,
  • "OfferNoRefundAfterMaxRefundDays": true,
  • "RegisterPolicyID": 684,
  • "RequireCVVCode": true,
  • "RequireZipCode": false,
  • "ShowSystemTotals": false,
  • "SkimCashLevel": 1000
}

Location Sales Request Information

A list of all locations in the system with associated sales request configuration information. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AllowDeliveryFromDifferentLocation": true,
  • "AllowDeliveryFromSameLocation": true,
  • "AllowPickupFromDifferentLocation": false,
  • "AllowPickupFromSameLocation": true,
  • "CanFulfillDeliveryRequests": false,
  • "CanFulfillPickupRequests": false,
  • "Location": "My location description",
  • "LocationID": 357,
  • "LocationType": "My location type description",
  • "LocationTypeID": 467
}

Mailbox Configuration

A list of all the mailboxes configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "EmailAlias": "My alternate email name",
  • "EmailLocalAddress": "auser",
  • "MailboxConfigurationID": 3457,
  • "Object": "My Object Name"
}

Market

A list of all the markets 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AssignmentTemplate": "My Assignment Template",
  • "AssignmentTemplateID": 457,
  • "CalledNumberMask": "My Called Number Mask",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "MarketCode": "MARK123",
  • "MarketID": 537,
  • "Name": "My Market Name",
  • "Note": "My Market Note",
  • "PhoneNumber": "533-351-1231",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "InvoiceFooterSupplementalText": "Footer Supplemental Text 1",
  • "InvoiceRemittanceSupplementalText": "Remittance Supplemental Text 1"
}

MSAG Community

A list of all the MSAG Communities 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CountyID": "My County ID",
  • "MSAGProvider": "My Provider",
  • "MSAGProviderID": 1,
  • "Name": "My MSAG Community Name"
}

MSAG County

A list of all of the distinct MSAG Counties in the system. [Rev 1.18]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "CountyID": "My County ID"
}

MSAG Provider

A list of all the MSAG providers 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "E911Provider": "My E911 Provider",
  • "E911ProviderID": 462,
  • "MSAGProviderID": 346,
  • "Name": "My MSAG Provider Name"
}

NLAD Dispute Resolution Error Code

A list of all resolution error codes needed to complete the dispute resolution process. These codes reference specific NLAD failures relating to third party identity verification, address and subscriber's age. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My resolution error code description",
  • "ErrorCode": "My resolution error code.",
  • "IsFullNameDobTCode": true,
  • "IsFullNameLast4ssnTCode": true,
  • "NLADDisputeResolutionErrorCodeID": 684
}

NLAD Lifeline Eligibility Program Code

A list of codes representing the program through which a subscriber is eligible for Lifeline Program benefits. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My program code description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "NLADLifelineEligibilityProgramCodeID": 687956,
  • "ProgramCode": "My Program Code"
}

NLAD Service Type

A list of names representing the service types available to Lifeline subscribers. [Rev 1.11.02]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My NLAD service type description",
  • "Name": "My NLAD service type well known name",
  • "NLADServiceTypeID": 457
}

Order Hold Reason

A list of all the reasons for putting an order on hold configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My order hold reason description",
  • "OrderHoldReasonID": 468
}

Order Type

A list of all the order types configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AttributePropertyDisplay": "My AttributePropertyDisplay Name",
  • "AttributePropertyID": 346,
  • "Description": "My order type description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "KeyName": "My KeyName",
  • "OrderClass": "My OrderClass description",
  • "OrderClassID": 579,
  • "OrderTypeID": 8568,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Payment Account Transaction Description

List of the PaymentAccountTransactionDescriptions configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My PaymentAccount Transaction Description",
  • "PaymentAccountTransactionDescriptionID": 3534
}

Payment Account Transaction Status

List of the PaymentAccountTransactionStatuses 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "PaymentAccountTransactionStatusID": 3563,
  • "Status": "My Payment Account Transaction Status description"
}

Payment Type

A list of all of the payment types configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My payment type description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "KeyName": "My Key Name",
  • "PaymentTypeID": 346,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

PCI Configuration

A single record containing the PCI settings for 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AllowBatchACHTransactions": true,
  • "ConversionDate": "2017-09-09T17:35:09.156Z",
  • "IsEnhancedPCIMode": false,
  • "OnlineBillPCIVersion": "My Online Bill PCI Version"
}

Per Line Tax Class

A list of all the per-line tax classes 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My per-line tax class description",
  • "IsMultiChannel": false,
  • "PerLineTaxClassID": 13531
}

Point To Point Region

A list of all the point to point regions configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My point to point description",
  • "PointToPointRegionID": 5877
}

Provisioning Company

A list of all the provisioning companies configured in the system. [Rev 1.16]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Company Name",
  • "ProvisioningCompanyID": 367
}

Provisioning Status

A list of all the provisioning statuses 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "BillingStatus": "My Billing Status description",
  • "BillingStatusID": 0,
  • "Description": "My provisioning status description",
  • "KeyName": "My Key Name",
  • "ProvisioningStatusID": 457
}

Rate Center

A list of all the rate centers configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "Abbreviation": "My rate center abbreviation",
  • "Description": "My rate center description",
  • "RateCenterID": 64864,
  • "State": "South Dakota"
}

Rating Method

List of algorithms that can be used by rating plans. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Rating Method Name",
  • "RatingMethodID": 57
}

Region

A list of all regions 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My region description",
  • "RegionID": 574
}

Register Information

A list of all the registers in the system. [Rev 1.02]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My register description",
  • "Location": "My location description",
  • "LocationID": 768,
  • "RegisterID": 5678,
  • "RegisterNumber": 56
}

Register Tender Type Policy Information

A list of all the register tender type policies in the system, along with associated register policy and allowed credit card types. [Rev 1.02]

Note

The unique identifier of a RegisterTenderTypePolicyInformation record is a combination of the CreditCardTypeID, RegisterCreditCardPolicyID, RegisterPolicyID, RegisterTenderTypePolicyID and TenderTypeID. When the tender type is credit card, there will be a separate for record for each accepted credit card type (CreditCardTypeID).

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AllowBillPayment": true,
  • "AllowReturn": false,
  • "AllowSale": false,
  • "BaseTenderType": "My Base Tender Type description",
  • "BaseTenderTypeID": 56854,
  • "CreditAdjustmentType": "My Credit Adjustment Type description",
  • "CreditAdjustmentTypeID": 568,
  • "CreditCardType": "My Credit Card Type description",
  • "CreditCardTypeID": 1,
  • "DebitAdjustmentType": "My Debit Adjustment Type description",
  • "DebitAdjustmentTypeID": 10,
  • "PaymentType": "My Payment Type description",
  • "PaymentTypeID": 3574,
  • "PromptForBTAReferenceNumber": false,
  • "RegisterCreditCardPolicyID": 468,
  • "RegisterPolicyID": 487,
  • "RegisterTenderTypePolicyID": 679,
  • "TenderType": "My Tender Type description",
  • "TenderTypeID": 457,
  • "UniqueKey": "My Unique Key"
}

Report Group

A list of all the Report Groups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My report group description''",
  • "Name": "My Report Group Name",
  • "ReportGroupID": 467
}

Retail Inventory Status

A list of all the inventory statuses configured in the system for retail items. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Retail Inventory Status description",
  • "IsForSale": true,
  • "RetailInventoryStatusID": 364
}

Sales Entity

A list of all the sales entities (organizations, people and channel partners) 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AgentID": "ABC123",
  • "CompanyName": "My Company Name",
  • "ContactID": 568,
  • "FirstName": "William",
  • "LastName": "Riker",
  • "ParentSalesCodeID": 457,
  • "PercentCommission": 0.15,
  • "SalesChannelEndDate": "2021-01-15T17:35:09.156Z",
  • "SalesChannelStartDate": "2021-01-14T17:35:09.156Z",
  • "SalesCode": "NPX",
  • "SalesCodeID": 457,
  • "SalesCodeType": "My Sales Code Type description",
  • "SalesCodeTypeID": 2,
  • "TaxNumber": "My Tax Number",
  • "UserID": "Username"
}

Sales Entity by User Name

A list of all the sales entities (organizations, people and channel partners) associated with users in the system. [Rev 1.25]

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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AgentID": "ABC123",
  • "CompanyName": "My Company Name",
  • "ContactID": 568,
  • "FirstName": "George",
  • "LastName": "Washington",
  • "SalesChannelEndDate": "2021-01-15T17:35:09.156Z",
  • "SalesChannelStartDate": "2021-01-14T17:35:09.156Z",
  • "SalesCode": "NPX",
  • "SalesCodeID": 457,
  • "SalesCodeType": "My Sales Code Type description",
  • "SalesCodeTypeID": 2,
  • "UserID": 777,
  • "UserName": "user_name"
}

Service Address Designator

A list of all configured service address designators. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My long value",
  • "Designator": "My abbreviated value",
  • "DesignatorID": 1356,
  • "DesignatorTypeID": 3
}

Service Address Status

A list of all available service address statuses. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My service address status.",
  • "ServiceAddressStatusID": 2
}

Service Address Thoroughfare

A list of all configured service address thoroughfares. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My long value",
  • "ServiceAddressThoroughfareID": 363,
  • "Thoroughfare": "My abbreviated value"
}

Service Number Owner

A list of all the service number owners configured in the system. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AccessCarrierNameAbbreviation": "CREE",
  • "BlockOwner": true,
  • "Description": "My service number owner/carrier name",
  • "PortedFrom": true,
  • "PortedTo": false,
  • "ServiceNumberOwnerID": 242,
  • "SupportsAutomatedPorts": false
}

Source Code Information

A list of all the Source Codes configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My source code description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "SourceCode": "My Source Code Value",
  • "SourceCodeID": 5685,
  • "StartDate": "2017-09-09T17:35:09.156Z"
}

Street Direction Affix

A list of all configured street direction affixes. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My street direction affix",
  • "StreetDirectionAffixID": 7695
}

Tax Country

List of all the tax countries 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "Germany",
  • "TaxCountryID": 457
}

Tax Jurisdiction

A list of all the Tax Jurisdictions configured in the system. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "Orlando",
  • "County": "Monroe",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "IsAuxiliary": false,
  • "MatchingAuxiliaryJurisdictionCount": 3,
  • "Notes": "My tax jurisdiction notes",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "State": "GA",
  • "TaxJurisdictionID": 547
}

Tax State

List of all the tax states 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "South Carolina",
  • "State": "NC",
  • "TaxCountry": "Italy",
  • "TaxCountryID": 346,
  • "TaxStateID": 356
}

Trouble Ticket

A list of all the trouble tickets in the system. [Rev 1.04]

  • Deprecated: Replaced by TicketJournalItem in the Journal service, CoreDataService. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "My Account Number",
  • "AssignedUser": "Username",
  • "Category": "My Category",
  • "CategoryID": 467,
  • "ChildTroubleTicketCount": 3,
  • "Class": "Customer",
  • "CloseDate": "2017-09-09T17:35:09.156Z",
  • "CloseUser": "Username",
  • "ContactCity": "Buffalo",
  • "ContactEmail1": "auser@mail.com",
  • "ContactEmail1Type": "auser@mail.com",
  • "ContactEmail1TypeID": 2,
  • "ContactFirstName": "Jean-luc",
  • "ContactID": 683,
  • "ContactLastName": "Picard",
  • "ContactPhone1": "123-456-7890",
  • "ContactPhone1Type": "My Contact Phone1 Type Name",
  • "ContactPhone1TypeID": 457,
  • "ContactState": "Maine",
  • "ContactStreet1": "235 whitney road, Syracuse, New York",
  • "ContactStreet2": "445 Mount Eden Road, Mount Eden, Auckland",
  • "ContactStreet3": "3634 Main Street, New York City, NY, 35252",
  • "ContactType": "My Contact Type Name",
  • "ContactTypeID": 246,
  • "ContactZip": 75778,
  • "CreationDate": "2017-09-09T17:35:09.156Z",
  • "CreationUser": "Username",
  • "CustomerID": 468,
  • "CustomerName": "Heather",
  • "Description": "My trouble ticket description",
  • "Internal": true,
  • "JournalStatus": "My trouble ticket state",
  • "JournalStatusID": 2,
  • "JournalType": "My type of trouble ticket name",
  • "JournalTypeID": 57,
  • "ParentTroubleTicketID": 457,
  • "ReferenceNumber": 5434454,
  • "ReferenceToItemID": 673,
  • "ReferenceToItemType": "My Trouble Ticket Item Type",
  • "Resolution": "My resolution type description",
  • "TroubleTicketID": 679,
  • "WebViewable": false
}

Usage Notification Configuration

A list of all of the global Usage Notification Configurations 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "DisableOptOutOption": true,
  • "DisplayUsageNotificationFormInPos": false,
  • "UsageNotificationGlobalConfigID": 36,
  • "UsageNotificationSendToOption": "My default send to option",
  • "UsageNotificationSendToOptionID": 346,
  • "WaitPeriod": 3
}

Usage Notification Send To Option

A list of all the usage notification send to options configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "Send to option description",
  • "UsageNotificationSendToOptionID": 537
}

Usage Type

A list of all Usage Types defined 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "InvoiceCategory": "My Invoice Category Name",
  • "InvoiceCategoryID": 573,
  • "IsInternationalToInternational": false,
  • "IsViewable": true,
  • "Name": "My Usage Type Name",
  • "TaxClass": "My tax class name",
  • "TaxClassID": 36,
  • "UnitSubType": "My Unit Sub Type Name",
  • "UnitSubTypeID": 463,
  • "UnitType": "My Unit Type Name",
  • "UnitTypeID": 5367,
  • "UsageTypeID": 537,
  • "UsageTypeServiceType": "My Usage Type Service Type Name",
  • "UsageTypeServiceTypeID": 537
}

User Data Profile

A list of all of the data profile element values per user 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "Path": "My full path",
  • "UserName": "Username",
  • "Value": "My data profile item value",
  • "ValueType": "My value type description",
  • "ValueTypeID": 2
}

User Group

A list of all the UserGroups configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "EmailAddress": "auser@mail.com",
  • "Name": "My UserGroup Name",
  • "UserGroupID": 4678
}

User Group Member

List of the users that belong to a user group. [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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "UserGroup": "My User Group Name",
  • "UserGroupID": 34634,
  • "UserID": "Username"
}

Wire Center

A list of the wire centers configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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": "Miami",
  • "CLLI": "My CLLI Code",
  • "Country": "New Zealand",
  • "IsEquipmentRelated": false,
  • "KeyName": "My Key Name",
  • "Name": "My Wire Center Name",
  • "State": "Ohio",
  • "Street1": "445 Mount Eden Road, Mount Eden, Auckland",
  • "Street2": "445 Mount Eden Road, Mount Eden, Auckland",
  • "WireCenterID": 357,
  • "WireCenterType": "My wire center type description",
  • "WireCenterTypeID": 457,
  • "ZipCode": 15678
}

Zone

A list of all the zones configured 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
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
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
{
  • "AssignmentTemplateID": 456784,
  • "Description": "My zone description",
  • "StateID": 49,
  • "ZoneID": 457
}

Release Notes

Latest WSDL

Release Notes 2.15

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

Release Notes 2.14

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

Release Notes 2.13

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

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
  • Added AddCashLevel, AutomaticallyCreateFloatWhenNeeded, AutoReconcile, ForceDailyReconciliation, ForceExactReconciliation, InitialFloat, MaxReconcileOverage, MaxReconcileShortage, ShowSystemTotals, SkimCashLevel to LocationRegisterPolicy

Release Notes 2.08

Release Notes 2.07

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

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

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

Release Notes 2.03

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

Release Notes 2.02

Release Notes 2.01

Release Notes 2.00

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

Release Notes 1.28

  • WSDL
  • Added InvoiceFooterSupplementalText, InvoiceRemittanceSupplementalText to Market

Release Notes 1.27

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

Release Notes 1.26

Release Notes 1.25

Release Notes 1.24

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

Release Notes 1.23

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

Release Notes 1.22

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

Release Notes 1.21

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

Release Notes 1.20

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

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 MSAGCounty to Core Data Service

Release Notes 1.17

  • WSDL
  • Added CalledNumberMask Market to Core Data Service

Release Notes 1.16

  • WSDL
  • Added Currency, Language, ProvisioningCompany to Core Data Service

Release Notes 1.15

  • WSDL
  • Added Added RequireZipCode to LocationRegisterPolicy

Release Notes 1.14

  • WSDL
  • Added MailboxConfiguration to Core Data Service

Release Notes 1.14.01

  • WSDL
  • Added AllowAddFeatures to AccountStatus

Release Notes 1.13

  • WSDL
  • Added TaxCountry, TaxState to Core Data Service

Release Notes 1.12

  • WSDL
  • Added Currency, Language, ProvisioningCompany to Core Data Service
  • Added CreditClass, ObjectWorkflowInstanceLink to Core Data Service
  • Added AllowBillPayment, AllowReturn, AllowSale to RegisterTenderTypePolicyInformation
  • Added EmailAddress to UserGroup

Release Notes 1.11

  • WSDL
  • Added LocationSalesRequestInformation, UsageNotificationConfiguration,UsageNotificationSendToOption to Core Data Service

Release Notes 1.11.01

Release Notes 1.11.02

  • WSDL
  • Added NLADServiceType to Core Data Service
  • Added IsFullNameDobTCode, IsFullNameLast4ssnTCode to NLADDisputeResolutionErrorCode
  • Added EndDate to NLADLifelineEligibilityProgramCode

Release Notes 1.10

  • WSDL
  • Added ReferenceMarkedForDelete to AttachedDocument
  • Added MarkedForDeletionCount to AttachedDocumentCategoryOverview
  • Added ReferenceMarkedForDeleteCount, Added Note for CustomerID value of -1, to AttachedDocumentObjectTypeOverview
  • Added MarkedForDeletion to AttachedDocumentReference
  • Added DistanceType, E911ClassOfService, E911TypeOfService, InventoryStatus, PerLineTaxClass, RatingMethod, UsageType to Core Data Service
  • Added ConfirmAccountChangeNotifications to CPNIConfiguration * Added Confidential, Extension, Name, Notes, Size to ModifyAttachedDocumentReq
  • Added City, CLLI, Country, State, Street1, Street2, ZipCode to WireCenter

Release Notes 1.09

  • WSDL
  • Added AdjustmentReason, BackdatingClosedThroughDate, Bank, CommunicationScript, CostGuardServerTimeZone, DepositAllocationType, DepositType, DepositWaiveType, PaymentAccountTransactionDescription, PaymentAccountTransactionStatus, UserDataProfile, AccountsReceivableBatchSummary to Core Data Service
  • Deprecated key for Document Lookup Handler* Added PromptForTaxableAddress to LocationInformation* Added PhoneNumber to Market
  • Added 500259 to PaymentGatewayLookup* Added LookupPaymentAccountInformation to PaymentGatewayLookupReq

Release Notes 1.09.01

  • WSDL
  • Removed permission requirements for users of type 'web service' from SetUserCustomerReq

Release Notes 1.08

  • WSDL
  • Added Carrier, UserGroupMember, Deprecated TroubleTicket for Core Data Service

Release Notes 1.07

  • WSDL
  • Added ObjectDisplayName to Attached Document
  • Added AdjustmentType, AffinityGroup, AttachedDocumentObjectTypeOverview, ExtendedTaxExemption,MSAGCommunity, MSAGProvider, PaymentType, PCIConfiguration, PointToPointRegion, RateCenter, Region, UserGroup, WireCenter to Core Data Service

Release Notes 1.06

  • WSDL
  • Added NLADDeEnrollType, NLADDeEnrollTypeID to ChangeReason
  • Added AttachedDocument, AttachedDocumentObjectType, AttachedDocumentObjectTypeOverview, Market, NLADDisputeResolutionErrorCode, NLADLifelineEligibilityProgramCode, RetailInventoryStatus, Deprecated Journal, to Core Data Service
  • Added USGFile document type to Document Lookup Handler
  • Added AttachedDocument, AttachedDocumentReference to MessageItemType
  • Added AttachedDocument, AttachedDocumentReference, CreateAttachedDocumentReq, CreateAttachedDocumentResult, ModifyAttachedDocumentReq, ModifyAttachedDocumentResult to Object Types
  • Added CreateAttachedDocument, ModifyAttachedDocument to Operations and Setup

Release Notes 1.05

  • WSDL
  • Added CreationUser, JournalClass to Journal
  • Added AssignedUser, ChildTroubleTicketCount, Class, CloseUser, CreationUser, ParentTroubleTicketID, Resolution to TroubleTicket
  • Updated to require Authorization header, allow HTTP GET and HTTP POST requests, removed User and Environment request parameters for Document Lookup Handler

Release Notes 1.04

  • WSDL
  • Added endpoint to Data Service for Backbone Data Service
  • Added Journal, ServiceAddressDesignator, ServiceAddressStatus, ServiceAddressThoroughfare, ServiceNumberOwner, StreetDirectionAffix, TaxJurisdiction, TroubleTicket to Core Data Service

Release Notes 1.03

  • WSDL
  • Note: Updated internally logged information in this release for issues viewing invoice PDF documents.
  • Note: Updated internal logging version compatibility information in this release.
  • Added AccountType, AttributeDefinitionTree, ConfigurationValue, CPNIConfiguration, ProvisioningStatus, ReportGroup, SalesEntity, SourceCodeInformation, Zone to Cored Data Service
  • Added AttributeChoice, AttributeDefinition, AttributeDefinitionLookupReq, AttributeDefinitionLookupResult to Object Types
  • Added AttributeDefinitionLookup to Operations and Setup
  • Added AttributePropertyDisplay, AttributePropertyID to OrderType
  • Added PromptForBTAReferenceNumber to RegisterTenderTypePolicyInformation

Release Notes 1.02

  • WSDL
  • Added ChangeReason, LocationInformation, LocationRegisterPolicy, RegisterInformation, RegisterTenderTypePolicyInformation to Core Data Service
  • Added PaymentGatewayDetail, PaymentGatewayLookupReq, PaymentGatewayLookupResult to Object Types
  • Added PaymentGatewayLookup to Operations and Setup
  • Added Email and UserNotification to SetUserCustomerReq
  • Added Email and UserNotification to SetUserCustomerResult

Release Notes 1.01

  • WSDL
  • Added endpoint to Data Service to Core Data Service and Document Lookup Handler
  • Added SetUserCustomerReq, SetUserCustomerResult to Object Types
  • Added SetUserCustomer to Operations and Setup