logo
API docs by Redocly

Customer Management (2.26)

Download OpenAPI specification:Download

Customer Management Concepts

The Customer Management API is a restful web service that provides end developers a way to integrate with IDI Billing Solutions.

Account Locks

Resources related to account locks.

Get Account Locks

Retrieve account lock information about a customer. [Rev 2.22]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Update Account Locks

Provides the ability to update customer account lock information. [Rev 2.22]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • prohibitPortOuts : replace
  • prohibitSIMChanges : replace
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the customer to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Bill Cycle

Resources related to managing bill cycles.

Calculate Bill Cycle Assignment

Calculates the default bill cycle based on the provided parameters. [Rev 1.08]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
accountTypeID
integer

Account type of the customer

marketID
integer

Market for the customer.

orderDate
string

Date on which the order or customer is created.

Note

  • If this value is not specified. Today at midnight will be used.

Responses

Request samples

Content type
application/json
{
  • "accountTypeID": 2,
  • "marketID": 1,
  • "orderDate": "1996-01-01T14:00:00.156Z"
}

Response samples

Content type
application/json
{
  • "billCycleID": 2
}

Bill Cycle Change

Resources related to managing a customer's bill cycle change.

Create Bill Cycle Change

Create a bill cycle change for a customer. If the customer passed in is the root to a corporate structure, then a bill cycle change will be created for all child accounts.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to create a bill cycle change.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
newBillPeriodID
integer

Bill period the customer is changing to.

Responses

Request samples

Content type
application/json
{
  • "newBillPeriodID": 31170707
}

Response samples

Content type
application/json
{
  • "billCycleChangeID": 777,
  • "customerID": 1,
  • "effectiveDate": "2017-08-07T14:00:00.156Z",
  • "newBillCycleID": 2,
  • "newBillPeriodID": 21170707,
  • "oldBillCycleID": 3,
  • "oldBillPeriodID": 31170303
}

Get Bill Cycle Change

Get a bill cycle change for a customer.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to get a bill cycle change.

billCycleChangeID
required
integer
Example: 777

ID of a bill cycle change to get.

Responses

Response samples

Content type
application/json
{
  • "billCycleChangeID": 777,
  • "customerID": 1,
  • "effectiveDate": "2017-08-07T14:00:00.156Z",
  • "newBillCycleID": 2,
  • "newBillPeriodID": 21170707,
  • "oldBillCycleID": 3,
  • "oldBillPeriodID": 31170303
}

Delete Pending Bill Cycle Change

Delete a pending bill cycle change and revert the customer back to the previous bill cycle.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to delete a pending bill cycle change.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "accountNumber": 12345,
  • "billCycleID": 5,
  • "customerID": 45,
  • "customerName": "John Doe"
}

Get Recommended Bill Periods

Gets the recommended bill period by bill cycle that a customer can be changed to.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to get recommended bill periods.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Collection

Retrieve Collection Information

Provides the ability to retrieve collection information for a customer.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve collection information for.

Responses

Response samples

Content type
application/json
{
  • "assignedUser": "CSR1",
  • "collectionAgency": "'Recovery Systems, Inc.'",
  • "collectionAgencyID": 24,
  • "collectionAgencyStatus": "'Must be sent'",
  • "collectionAgencyStatusID": 1,
  • "collectionStatus": "'Removed from collection'",
  • "collectionStatusID": 1,
  • "note": "First time going into collections.",
  • "statusActionDate": "1996-01-01T14:00:00.156Z"
}

Update Collection Information

Provides the ability to update collection information for a customer.

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Note

The customer must be in collections in order to use this operation.

Patchable Fields

The following is a list of properties that can be patched.

  • assignedUser : add, remove, replace
    • When this field is changed, all open follow-ups associated to open payment plans will be reassigned to the new assignedUser.
  • collectionStatusId : replace
    • collectionStatusId cannot be modified if the customer has a collection agency set.
    • The collection status cannot be set to Out of Collections or Referred to Collection Agency.
  • note : add, remove, replace
  • statusActionDate : remove
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the customer for whom to update collection information.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update Collection Agency Status

Provides the ability to update the customer's collection agency status.

Note

  • The customer must not be collection exempt.
  • The customer must have a collection status of Referred to Agency.
  • The customer must already be assigned to a collection agency
  • Setting the collection agency status to Sent to Collection Agency will also set the `statusActionDate' to the current date and time.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer to send to collection.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
collectionAgencyStatusId
required
integer

Unique identifier for the requested collection agency status.

Responses

Request samples

Content type
application/json
{
  • "collectionAgencyStatusId": 1
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Search Collection History

Provides the ability to Search collection history for a customer.

Available Fields

The following is a list of fields from collection history and how they can be used within the search.

  • Filterable : assignedUser, changeDate, collectionAgency, collectionAgencyID, collectionStatus, collectionStatusID, collectionHistoryID, isCollectionExempt, statusActionDate, User
  • Sortable : assignedUser, changeDate, collectionAgency, collectionAgencyID, collectionStatus, collectionStatusID, collectionHistoryID, isCollectionExempt, statusActionDate, User
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve collection history for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Payment Plans

Provides the ability to search payment plans for a customer.

Available Fields

The following is a list of fields from payment plan and how they can be used within the search.

  • Filterable : amount, description, isClosed, followupID, lastModified, paymentIDPlan, promiseToPayDate, user,
  • Sortable : amount, description, isClosed, followupID, lastModified, paymentIDPlan, promiseToPayDate, user
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve payment plans for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

inlinecount
string ($inlinecount)
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. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create Payment Plan

Provides the ability to create a payment plan for a customer. [Rev 1.03]

Note

  • The customer must be in collections.
  • The customer collections information must have an assigned user.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer to send to collection.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
amount
required
number

The amount of the payment plan.

description
string

The description of the payment plan.

followUpDate
required
string

The action date used for the follow-up created for the payment plan.

promiseToPayDate
required
string

The date by which the payment plan amount payment should be made.

Responses

Request samples

Content type
application/json
{
  • "amount": 125,
  • "description": "Customer will pay the full amount.",
  • "followUpDate": "2019-05-02T18:00:00.000Z",
  • "promiseToPayDate": "2019-05-01T18:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update Payment Plan

Provides the ability to update a payment plan.

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Note

The customer must be in collections and the payment plan must not be closed in order to use this operation.

Patchable Fields

The following is a list of properties that can be patched.

  • amount : replace
  • description : add, remove, replace
  • followupDate : replace
  • promiseToPayDate : replace
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the customer.

paymentPlanId
required
integer
Example: 1

Unique Identifier for the payment plan to be modified.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Close Payment Plan

Provides the ability to close a payment plan.

Note

  • The customer must be in collections.
  • The payment plan must not already be closed.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer.

paymentPlanId
required
integer
Example: 1

ID of the payment plan to close.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove From Collection

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer to remove from collection.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Send To Collection

Provides the ability to update customer information to indicate that they have been sent to collection.

Note

  • The customer must be out of collections, and cannot be collections exempt.
  • The requested value for collectionStatusId cannot be 2 (Out of Collections) or 102 (Referred To Collection Agency).
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer to send to collection.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
assignTo
string

The user assigned to manage the customer's collection state.

Note

A null or unspecified value will result in no change to the value of this field.

An empty string ("") will clear the value of this field.

collectionStatusId
integer

Unique identifier for the requested collection status.

  • Default Value : 1
note
string

A note to include in the customer's collection information.

Note

Note: A null or unspecified value will result in no change to the value of this field.

Note: An empty string ("") will clear the value of this field.

Responses

Request samples

Content type
application/json
{
  • "assignTo": "Kesha",
  • "collectionStatusId": 1,
  • "note": "Does not pay bill"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve Spending Limit

Provides the ability to retrieve spending limit information for a customer.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve spending limit information for.

Responses

Response samples

Content type
application/json
{
  • "billedBalance": 100.52,
  • "lastModified": "1996-01-01T14:00:00.156Z",
  • "percentOfLimit": 50.2,
  • "spendingLimit": 100,
  • "spendingLimitStatusID": 5,
  • "totalBalanceWithUnbilledUsage 15.54": 0,
  • "unbilledUsage": 13.13
}

Search Spending Limit History

Provides the ability to search spending limit change history for a customer.

Available Fields

The following is a list of fields from spending limit history and how they can be used within the search.

  • Filterable : changeDate, spendingLimitID, spendingLimitStatus, spendingLimitStatusID
  • Sortable : changeDate, spendingLimitID, spendingLimitStatus, spendingLimitStatusID
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve spending limit change history for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

inlinecount
string ($inlinecount)
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. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Update Collection Agency

Provides the ability to update the collection agency on a customer's collection information.

Note

  • The customer must be in collections.
  • When a collectionAgencyId is specified, the collection status will be set to Referred to Collection Agency and the collection agency status will be set to Must be Sent.
  • If the collection agency is cleared, the collection status will be set to Past Due, and the following properties will be cleared: collection agency status, collection agency, status action date.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the customer to send to collection.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
clearCollectionAgency
boolean

If true then the collection agency will be cleared from the customer's collection information.

Note

Note: This field is ignored if a collectionAgencyId is specified on the request.

collectionAgencyId
integer

Unique identifier for the requested collection agency.

Note

Note: This field is required if you are not clearing the collection agency.

Responses

Request samples

Content type
application/json
{
  • "clearCollectionAgency": false,
  • "collectionAgencyId": 1
}

Common Data

Search Collection Agency

Provides the ability to search all the collection agencies in the system.

Available Fields

The following is a list of fields from collection agency statuses and how they can be used within the search.

  • Filterable: city, collectionAgencyID, companyName, country, county, emailAddress1, emailAddress1TypeID, emailAddress2, emailAddress2TypeID, emailAddress3, emailAddress3TypeID, firstName, fullName, hoursOfAccess, lastName, latitude, locationNumber, longitude, middleInitial, note, phoneNumber1, phoneNumber1TypeID, phoneNumber2, phoneNumber2TypeID, phoneNumber3, phoneNumber3TypeID, phoneNumber4, phoneNumber4TypeID, state, street1, street2, street3, title, zipCode
  • Sortable: city, collectionAgencyID, companyName, country, county, emailAddress1, emailAddress1TypeID, emailAddress2, emailAddress2TypeID, emailAddress3, emailAddress3TypeID, firstName, fullName, hoursOfAccess, lastName, latitude, locationNumber, longitude, middleInitial, note, phoneNumber1, phoneNumber1TypeID, phoneNumber2, phoneNumber2TypeID, phoneNumber3, phoneNumber3TypeID, phoneNumber4, phoneNumber4TypeID, state, street1, street2, street3, title, zipCode
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Collection Agency Status

Provides the ability to search form collection agency statuses in the system.

Available Fields

The following is a list of fields from collection agency statuses and how they can be used within the search.

  • Filterable : collectionAgencyStatusID, name
  • Sortable : collectionAgencyStatusID, name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Collection Status

Provides the ability to search all the collection statuses in the system.

Available Fields

The following is a list of fields from Collection Status and how they can be used within the search.

  • Filterable : collectionStatusID, name
  • Sortable : collectionStatusID, name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Notification Sources

Provides the ability to search all the notification sources in the system. [Rev 1.09]

Available Fields

The following is a list of fields found in notification source and how they can be used within the search.

  • Filterable : name, notificationSourceID, notificationSourceKeyName, objectID, objectType
  • Sortable : name, notificationSourceID, notificationSourceKeyName, objectID, objectType
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

List Protection Plan Activity Types

Provides the ability to list the available protection plan activity types.

Available Fields

The following is a list of fields from protection plan activity types and how they can be used within the search.

  • Filterable : protectionPlanActivityTypeID
  • Sortable : name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

List Protection Plan Statuses

Provides the ability to list the available protection plan statuses. [Rev 2.03]

Available Fields

The following is a list of fields for a protection plan status and how they can be used within a search.

  • Filterable : protectionPlanStatusID
  • Sortable : name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Corporate Accounts

Resources related to managing corporate accounts.

Change Market

Provides the ability to update the market for the corporate account structure [Rev 1.09]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the root of the corporate account structure.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
marketID
required
integer

Unique identifier for the market.

Responses

Request samples

Content type
application/json
{
  • "marketID": 1002
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Contact

Resources related to managing contacts.

Delete Contact

Provides the ability to delete a contact. [Rev 1.19]

Note

  • A primary customer contact, primary billing contact, and contacts associated to objects on the customer cannot be deleted.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve contact for.

contactID
required
integer
Example: 1

Unique identifier for the contact.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Credit Reports

Resources related to managing a customers credit reports.

Search Credit Reports

Provides the ability to search credit reports for a customer. [Rev 1.12]

Available Fields

The following is a list of fields from a credit report and how they can be used within the search.

  • Filterable : creditClassID, creditReportID, creditReportProviderID, creditReportResultID, creditReportStatusID, requestDate, userID
  • Sortable : creditClass, creditClassID, creditReportID, creditReportProvider, creditReportProviderID, creditReportResult, creditReportResultID, creditReportStatus, creditReportStatusID, requestDate, userID
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve credit reports for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Get Credit Report

Provides the ability to get a credit report for a customer. [Rev 1.12]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve credit reports for.

creditReportID
required
integer
Example: 1

Id of credit report to retrieve for the customer.

Responses

Response samples

Content type
application/json
{
  • "creditClass": "A",
  • "creditClassID": 5,
  • "creditReportID": 45,
  • "creditReportInformation": {
    },
  • "creditReportProvider": "Equifax",
  • "creditReportProviderID": 45,
  • "creditReportResult": "Multiple matches were found.",
  • "creditReportResultID": 5,
  • "creditReportStatus": "Submitted",
  • "creditReportStatusID": 25,
  • "message": "Too Many Inquiries Last 12 Months",
  • "requestContact": {
    },
  • "requestContactID": 5,
  • "requestDate": "1996-01-01T19:00:00.000Z",
  • "requestDOB": "1977-01-01T19:00:00.000Z",
  • "requestDriversLicense": 987654321,
  • "requestDriversLicenseState": "NY",
  • "requestSSN": 123456789,
  • "responseContact": {
    },
  • "responseContactID": 5,
  • "responseDOB": "1977-01-01T19:00:00.000Z",
  • "responseDriversLicense": 987654321,
  • "responseDriversLicenseState": "NY",
  • "responseSSN": 123456789,
  • "score": 650,
  • "userID": "idi_system"
}

Get Credit Report Detail

Provides the ability to get detailed information about a credit report for a customer. [Rev 1.12]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of Customer to retrieve credit reports for.

creditReportID
required
integer
Example: 1

Id of credit report to retrieve for the customer.

Responses

Response samples

Content type
application/json
{
  • "creditClass": "A",
  • "creditClassID": 5,
  • "creditReportID": 45,
  • "creditReportInformation": {
    },
  • "creditReportProvider": "Equifax",
  • "creditReportProviderID": 45,
  • "creditReportResult": "Multiple matches were found.",
  • "creditReportResultID": 5,
  • "creditReportStatus": "Submitted",
  • "creditReportStatusID": 25,
  • "requestDate": "1996-01-01T19:00:00.000Z",
  • "userID": "idi_system"
}

Submit Experian Credit Report

Provides the ability to submit a request for a credit report through Experian. [Rev 2.06]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

The customer the credit report is requested for.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
billingOrderTypeID
integer

Unique identifier of the billing order type.

dateOfBirth
string

The customer's date of birth.

driversLicenseID
string

The customer's drivers license ID number.

driversLicenseState
string

The state that issued the drivers license.

required
object (ExperianRequestContact)

The customer's contact information.

socialSecurityNumber
string

The customer's social security number.

Responses

Request samples

Content type
application/json
{
  • "billingOrderTypeID": 5,
  • "dateOfBirth": "1996-01-01",
  • "driversLicenseID": "ABC123",
  • "driversLicenseState": "NY",
  • "requestContact": {
    },
  • "socialSecurityNumber": "123456789"
}

Response samples

Content type
application/json
{
  • "creditReportID": 1,
  • "creditReportProvider": "Experian",
  • "creditReportProviderID": 1,
  • "creditReportResult": "Multiple matches were found.",
  • "creditReportResultID": 5,
  • "creditReportStatus": "Submitted",
  • "creditReportStatusID": 25,
  • "message": "Too Many Inquiries Last 12 Months"
}

Submit TransUnion Credit Report

Provides the ability to submit a request for a credit report through TransUnion. [Rev 2.06]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

The customer the credit report is requested for.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
accessPIN
string

Access Code

billingOrderTypeID
integer

Unique identifier of the billing order type.

dateOfBirth
string

The customer's date of birth.

monthsInResidence
integer

Number of months in residence at current address.

required
object (TransunionRequestContact)

The customer's contact information.

residentialStatus
string (ResidentialStatus)
Enum: "Unknown" "Own" "Rent" "Other"

Identifier for the residential status.

socialSecurityNumber
string

The customer's social security number.

storeLocation
string

Location of the requesting store.

suffix
string

Suffix for the name of the person in the credit report.

title
string

Title for the individual in the credit report.

Responses

Request samples

Content type
application/json
{
  • "accessPIN": 123,
  • "billingOrderTypeID": 5,
  • "dateOfBirth": "1996-01-01",
  • "monthsInResidence": 27,
  • "requestContact": {
    },
  • "residentialStatus": "Own",
  • "socialSecurityNumber": "123456789",
  • "storeLocation": "Pleasantville",
  • "suffix": "III",
  • "title": "Dr"
}

Response samples

Content type
application/json
{
  • "creditReportID": 1,
  • "creditReportProvider": "TransUnion",
  • "creditReportProviderID": 1,
  • "creditReportResult": "Multiple matches were found.",
  • "creditReportResultID": 5,
  • "creditReportStatus": "Submitted",
  • "creditReportStatusID": 25,
  • "message": "Too Many Inquiries Last 12 Months"
}

Customer

Resources related to managing a customer

Account Lookup By SSN

Provides the ability to lookup customer accounts associated by the Social Security Number or the last four digits of the Social Security Number. [Rev 1.21]

Available Fields

The following is a list of fields on a customer account and how they can be used within the search.

  • Filterable : accountNumber, accountStatusID, accountTypeID, billCycleID, billingStatusID, customerID, customerName, customerTypeID, marketID
  • Sortable : accountNumber, accountStatus, accountStatusID, accountType,accountTypeID, billCycle, billCycleID, billingStatus, billingStatusID, customerID, customerName, customerType, customerTypeID, disconnectDate, establishDate,firstName, isCorporateAccount, isInvoiceResponsible, lastName, market, marketID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json
socialSecurityNumber
required
string

Social security number to lookup

Responses

Request samples

Content type
application/json
{
  • "socialSecurityNumber": 123456789
}

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get Customer Credit Information

Provides the ability to retrieve a customers credit information [Rev 1.10]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer.

Responses

Response samples

Content type
application/json
{
  • "creditClass": "A",
  • "creditClassID": 5,
  • "creditLimit": 100
}

Update Credit Information

Provides the ability to update customer credit class information. [Rev 1.10]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • creditClassID : add,replace,remove
  • creditLimit : add,replace,remove
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the customer to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Notification Options

Retrieve notification options about a customer. [Rev 1.08]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer.

Responses

Response samples

Content type
application/json
{
  • "ePayNotificationOptOut": true
}

Update Notification Options

Provides the ability to update customer notification options. [Rev 1.08]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • ePayNotificationOptOut : replace
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the customer to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create CPNI Verification Log

Provides the ability to create a CPNI Verification Log entry for the customer. [Rev 1.08]

This is used, for example, when a customer is accessed and CPNI information is either verified or not verified.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the customer for which to create the log.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
message
required
string

The verification message to log.

user
required
string

The user on behalf of which this log was created.

Responses

Request samples

Content type
application/json
{
  • "message": "Customer was verified using the CPNI PIN",
  • "user": "user123"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

CPNI Verification Log

Retrieves the CPNI verification logs for a customer. [Rev 1.08]

Available Fields

The following is a list of fields found in CPNI Verification Log and how they can be used within the search.

  • Filterable : cpniVerificationLogID, user, verificationDate
  • Sortable : cpniVerificationLogID, user, verificationDate
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to get the CPNI verification logs for.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Usage Balance

Gets the account level usage balance information for a customer in a specific bill period.

Available Fields

The following is a list of fields usage balance and how they can be used within the search.

  • Filterable : discountCategoryID, unitSubTypeID, unitsUsed
  • Sortable : discountCategory, discountCategoryID, unitSubType, unitSubTypeID, unitsUsed
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a customer for whom to get account usage balance information.

billPeriodId
required
integer
Example: 31160915

ID of a bill period.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

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=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Search For Accounts

Provides the ability to Search for customer accounts. [Rev 1.05]

Available Fields

The following is a list of fields on a customer account and how they can be used within the search.

  • Filterable : accountNumber, accountStatusID, accountTypeID, billCycleID, billingStatusID, customerID, customerName, customerTypeID, disconnectDate, marketID
  • Sortable : accountNumber, accountStatus, accountStatusID, accountType,accountTypeID, billCycle, billCycleID, billingStatus, billingStatusID, customerID, customerName, customerType, customerTypeID, disconnectDate, establishDate,firstName, isCorporateAccount, isInvoiceResponsible, lastName, market, marketID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Retail Orders

Search for Retail Orders in the system. [Rev 1.22]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : billingOrderID, createDate, customerID, finalizeDate, locationID, orderID, orderTypeID, receiptNumber, registerID, tenderTypeID, transactionStatusID, transactionTypeID, userID
  • Sortable : createDate, finalizeDate, orderType, orderTypeID, receiptNumber, tenderType, tenderTypeID, totalDeposits, totalDue, totalExtendedPrice, totalInstallments, transactionStatus, transactionStatusID, transactionType, transactionTypeID, userID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "count": 145,
  • "value": [
    ],
  • "nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Sales Entity Account

Provides the ability to Search for customer accounts that have a Sales Entity. [Rev 1.17]

Available Fields

The following is a list of fields on a customer account and how they can be used within the search.

  • Filterable : accountNumber, accountStatusID, accountTypeID, customerName, customerTypeID, isCorporateAccount, salesCodeID
  • Sortable : accountNumber, accountStatus, accountStatusID, accountType, accountTypeID, customerName, customerType, customerTypeID, isCorporateAccount, salesCode, salesCodeCompanyName, salesCodeFirstName, salesCodeID, salesCodeLastName
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

SSN Lookup

Provides the ability to check if there are customer accounts with a given social security number. [Rev 1.13]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
socialSecurityNumber
required
string

Social security number to lookup

Responses

Request samples

Content type
application/json
{
  • "socialSecurityNumber": 123456789
}

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Change Reason History Search

Search Change Reason History for a customer [Rev 1.19]

Available Fields

The following is a list of fields from a Change Reason History entry and how they can be used within the search.

  • Filterable : changeReasonID, changeReason, changeTypeID, changeType, serviceNumber, createDate, userID, serviceID
  • Sortable : changeReasonID, changeReason, changeTypeID, changeType, serviceNumber, createDate, userID, serviceID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Change Type Search

Search Change Types [Rev 1.20]

Available Fields

The following is a list of fields from Change Type and how they can be used within the search.

  • Filterable : changeTypeID, changeType
  • Sortable : changeTypeID, changeType
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get Payment Restrictions

Provides the ability to search for Payment Restrictions for a customer. [Rev 1.21]

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable : baseTenderTypeID, createDate, createUser
  • Sortable : baseTenderTypeID, createDate, createUser
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1234

ID of a customer for whom to get payment restriction information.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Update Payment Restriction

Provides the ability to update a Payment Restriction for a customer. [Rev 1.21]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • baseTenderTypeID : add, remove

Valid baseTenderTypeID values are 4 and 15.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1234

ID of a customer for whom to get payment restriction information.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add and remove.

path
required
string

Path within the JSON document that should be modified.

value
required
integer

Base Tender Type ID to Modify for the Customer. Valid values are 4 and 15.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Customer CPNI Authorized User

Retrieves the customer CPNI authorized users in the system. [Rev 2.09]

Available Fields

The following is a list of fields found in Customer CPNI Authorized Users and how they can be used within the search.

  • Filterable : accountNumber, authorizedUserPhoneNumber, custID
  • Sortable : accountNumber, authorizedUserPhoneNumber, custID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

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=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Customer Notifications

Resources related to customer notifications.

Send Customer Notification

Provides the ability to send a customer notification.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the customer to which a notification will be sent.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
deliveryTypeID
required
integer

Unique identifier for the delivery type to use when sending this notification.

Note

Must be a valid delivery type for the source of the notification template being used.

notificationTemplateID
required
integer

Unique identifier for the template to use when sending this notification.

objectID
required
integer

Unique identifier for the object indicated by this notification.

Responses

Request samples

Content type
application/json
{
  • "deliveryTypeID": 2,
  • "notificationTemplateID": 1,
  • "objectID": 10023
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Resubmit Customer Notification

Provides the ability to resubmit a customer notification.

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the customer to which a notification will be resubmitted.

notificationID
required
integer
Example: 1

ID of the notification to resubmit.

Note

The notification must have been originally sent from a template that is marked as "safe for resubmit".

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Directory Listing

Resources related to managing directory listings.

Create Directory Listing

Create a directory listing. [Rev 2.08]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
accountTypeID
integer

Unique identifier for the account type directory listing

alphaListingIdentifierCode
string

The identifier for the alpha listing

degreeOfIndent
string

The degree of indentation

designation
string

The designation value

designerListingsID
integer

Unique identifier for the designer listings directory listing

directoryName
string

The directory name

directorySubsection
string

The directory subsection

featureID
required
integer

Unique identifier for the NonUsgSvc

Note

  • featureID is required
headerTelephoneNumber
string

Contact telephone number

housePrefix
string

Prefix to the house number

houseNumber
string

The house number

houseSuffix
string

Suffix to the house number

isDualNamesInListing
boolean

Indicates whether there are two names in the listing

isOmitAddressFromDirectMailList
boolean

Indicates whether to omit the address from the direct mailing list

isOmitAddressFromListing
boolean

Indicates whether to omit the address from the listing

levelOfIndent
string

The level of indentation

lineOfText
string

The line of text

lineOfTextReferenceNumber
string

The reference number for the text

listingActivityIndicatorID
integer

Unique identifier for the listing activity indicator directory listing

listingName
string

The listing Name

listingNamePlacementID
integer

Unique identifier for the listing name placement directory listing

listingNumber
string

The listing number

listingTextTypeID
integer

Unique identifier for the listing text type directory listing

listingTypeID
integer

Unique identifier for the listing type directory listing

locality
string

The address city

nonStandardNumber
string

Indicates if the listing uses a non-standard number

placementOverrideID
integer

Unique identifier for the placement override directory listing

positionOfListing
string

Indicates the position of the listing

recordTypeID
integer

Unique identifier for the record type directory listing

standardIndustryClassification
string

The standard industry classification

state
string

The state

streetDirectional
string

The direction of the street ### Note

  • StreetDirectional has a maximum length of 2 characters
streetName
string

The street name

streetSuffix
string

First line of contact address ### Note

  • StreetSuffix has a maximum length of 2 characters
streetThoroughfare
string

The type of street thoroughfare ### Note

  • StreetThoroughfare has a maximum length of 4 characters
styleCodeID
integer

Unique identifier for the style code directory listing

tddIndicatorID
integer

Unique identifier for the TDD indicator directory listing

yellowPageHeadingCode
string

The yellow page heading code

zip
string

The zip code

Responses

Request samples

Content type
application/json
{
  • "accountTypeID": 1,
  • "alphaListingIdentifierCode": "123456",
  • "degreeOfIndent": "",
  • "designation": "value",
  • "designerListingsID": 1,
  • "directoryName": "Emergency",
  • "directorySubsection": "Section1",
  • "featureID": 1,
  • "headerTelephoneNumber": "555-555-5555",
  • "housePrefix": "Suite",
  • "houseNumber": "123",
  • "houseSuffix": "1/3",
  • "isDualNamesInListing": false,
  • "isOmitAddressFromDirectMailList": false,
  • "isOmitAddressFromListing": false,
  • "levelOfIndent": "",
  • "lineOfText": "sample",
  • "lineOfTextReferenceNumber": "1000ABS",
  • "listingActivityIndicatorID": 1,
  • "listingName": "Listing1",
  • "listingNamePlacementID": 1,
  • "listingNumber": "123456",
  • "listingTextTypeID": 1,
  • "listingTypeID": 1,
  • "locality": "Pleasantville",
  • "nonStandardNumber": "123-45:6",
  • "placementOverrideID": 1,
  • "positionOfListing": "top",
  • "recordTypeID": 1,
  • "standardIndustryClassification": "123456",
  • "state": "MA",
  • "streetDirectional": "S",
  • "streetName": "Alana",
  • "streetSuffix": "St",
  • "streetThoroughfare": "Blvd",
  • "styleCodeID": 1,
  • "tddIndicatorID": 1,
  • "yellowPageHeadingCode": "1",
  • "zip": "01234"
}

Response samples

Content type
application/json
{
  • "accountTypeID": 1,
  • "alphaListingIdentifierCode": "123456",
  • "degreeOfIndent": "",
  • "designation": "value",
  • "designerListingsID": 1,
  • "directoryListingID": 1,
  • "directoryName": "Emergency",
  • "directorySubsection": "Section1",
  • "featureID": 1,
  • "headerTelephoneNumber": "555-555-5555",
  • "housePrefix": "Suite",
  • "houseNumber": "123",
  • "houseSuffix": "1/3",
  • "isDualNamesInListing": false,
  • "isOmitAddressFromDirectMailList": false,
  • "isOmitAddressFromListing": false,
  • "levelOfIndent": "",
  • "lineOfText": "sample",
  • "lineOfTextReferenceNumber": "1000ABS",
  • "listingActivityIndicatorID": 1,
  • "listingName": "Listing1",
  • "listingNamePlacementID": 1,
  • "listingNumber": "123456",
  • "listingTextTypeID": 1,
  • "listingTypeID": 1,
  • "locality": "Pleasantville",
  • "nonStandardNumber": "123-45:6",
  • "placementOverrideID": 1,
  • "positionOfListing": "top",
  • "recordTypeID": 1,
  • "standardIndustryClassification": "123456",
  • "state": "MA",
  • "streetDirectional": "South",
  • "streetName": "Alana",
  • "streetSuffix": "Ave",
  • "streetThoroughfare": "City Hall",
  • "styleCodeID": 1,
  • "tddIndicatorID": 1,
  • "yellowPageHeadingCode": "1",
  • "zip": "01234"
}

Get Missing Directory Listings

Search for missing directory listings in the system. [Rev 2.12]

Available Fields

The following is a list of fields for a missing directory listing and how they can be used within a search.

  • Filterable : accountNumber, customerID, featureID, serviceNumber, serviceType, sku
  • Sortable : accountNumber, customerID, customerName, featureID, serviceNumber, serviceType, sku, endDate, startDate

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "Account_Number",
  • "customerID": 125,
  • "customerName": "Customer_Name",
  • "endDate": "2019-08-24T14:15:22Z",
  • "featureID": 1,
  • "serviceDescription": "Service_Description",
  • "serviceNumber": "123456",
  • "serviceType": 1,
  • "sku": "123456",
  • "skuDescription": "SKU_Description",
  • "startDate": "2019-08-24T14:15:22Z"
}

Get Directory Listing

Search for directory listings in the system. [Rev 2.08]

Available Fields

The following is a list of fields for a directory listing and how they can be used within a search.

  • Filterable : accountNumber, customerID, customerName, directoryListingID, endDate, featureID, listingName, listingNumber, listingType, serviceDescription, serviceType, sku, skuDescription, startDate, status
  • Sortable : accountNumber, customerName [Rev 2.19], endDate, listingName, listingNumber, listingType, serviceDescription [Rev 2.19], serviceNumber, serviceType, sku, skuDescription, startDate, status

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "123456",
  • "accountType": "Residential",
  • "accountTypeID": 1,
  • "alphaListingIdentifierCode": "123456",
  • "customerID": 12345,
  • "customerName": "Bobs law Firm",
  • "degreeOfIndent": "",
  • "designation": "value",
  • "designerListings": "",
  • "designerListingsID": 1,
  • "directoryListingID": 1,
  • "directoryName": "Emergency",
  • "directorySubsection": "Section1",
  • "endDate": "2019-08-24T14:15:22Z",
  • "featureID": 1,
  • "headerTelephoneNumber": "555-555-5555",
  • "housePrefix": "Suite",
  • "houseNumber": "123",
  • "houseSuffix": "1/3",
  • "isDualNamesInListing": false,
  • "isOmitAddressFromListing": false,
  • "isOmitFromDirectMailList": false,
  • "levelOfIndent": "",
  • "lineOfText": "sample",
  • "lineOfTextReferenceNumber": "1000ABS",
  • "listingActivityIndicator": "New Listing",
  • "listingActivityIndicatorID": 1,
  • "listingName": "Listing1",
  • "listingNamePlacement": "Yellow Pages",
  • "listingNamePlacementID": 1,
  • "listingNumber": "123456",
  • "listingTextType": "",
  • "listingTextTypeID": 1,
  • "listingType": "Published",
  • "listingTypeID": 1,
  • "locality": "Pleasantville",
  • "nonStandardNumber": "123-45:6",
  • "placementOverride": "",
  • "placementOverrideID": 1,
  • "positionOfListing": "top",
  • "recordType": "",
  • "recordTypeID": 1,
  • "serviceDescription": "Full Data",
  • "serviceID": 1,
  • "serviceNumber": "123456",
  • "serviceType": 46,
  • "sku": "123456",
  • "skuDescription": "Wireless_SkuDescription",
  • "standardIndustryClassification": "123456",
  • "startDate": "2019-08-24T14:15:22Z",
  • "state": "MA",
  • "status": "active",
  • "streetDirectional": "South",
  • "streetName": "Alana",
  • "streetSuffix": "Ave",
  • "streetThoroughfare": "City Hall",
  • "styleCode": "",
  • "styleCodeID": 1,
  • "tddIndicator": "",
  • "tddIndicatorID": 1,
  • "yellowPageHeadingCode": "1",
  • "zip": "01234"
}

Update a Directory Listing

Provides the ability to update directory listings. [Rev 2.10]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • accountTypeID : replace, add, remove
  • alphaListingIdentifierCode : replace, add, remove
  • degreeOfIndent : replace, add, remove
  • designation : replace, add, remove
  • designerListingsID : replace, add, remove
  • directoryName : replace, add, remove
  • directorySubsection : replace, add, remove
  • featureID : replace, add
  • headerTelephoneNumber : replace, add, remove
  • housePrefix : replace, add, remove
  • houseNumber : replace, add, remove
  • houseSuffix : replace, add, remove
  • isDualNamesInListing : replace, add
  • isOmitAddressFromListing : replace, add
  • isOmitFromDirectMailList : replace, add
  • levelOfIndent : replace, add, remove
  • lineOfText : replace, add, remove
  • lineOfTextReferenceNumber : replace, add, remove
  • listingActivityIndicatorID : replace, add, remove
  • listingName : replace, add, remove
  • listingNamePlacementID : replace, add, remove
  • listingNumber : replace, add, remove
  • listingTextTypeID : replace, add, remove
  • listingTypeID : replace, add, remove
  • locality : replace, add, remove
  • nonStandardNumber : replace, add, remove
  • placementOverrideID : replace, add, remove
  • positionOfListing : replace, add, remove
  • recordTypeID : replace, add, remove
  • standardIndustryClassification : replace, add, remove
  • state : replace, add, remove
  • streetDirectional : replace, add, remove
  • streetName : replace, add, remove
  • streetSuffix : replace, add, remove
  • streetThoroughfare : replace, add, remove
  • styleCodeID : replace, add, remove
  • tddIndicatorID : replace, add, remove
  • yellowPageHeadingCode : replace, add, remove
  • zip : replace, add, remove
Authorizations:
SWT
path Parameters
directoryListingID
required
integer
Example: 1

Unique identifier of the directory listing to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete Directory Listing

Provides the ability to delete a directory listing. [Rev 2.13]

Authorizations:
SWT
path Parameters
directoryListingID
required
integer
Example: 1

Unique identifier for the directory listing.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Search Listing Activity Indicator

Get listing activity indicator directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Type Of Account

Get type of account directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Record Type

Get listing record type directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Listing Type

Get listing type directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Listing Name Placement

Get listing name placement directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Style Code

Get style code directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Designer Listings

Get designer listings directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search TDD Indicator

Get TDD Indicator directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Placement Override

Get placement override directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Listing Text Type

Get listing text type directory listings. [Rev 2.08]

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Protection Plan

Resources related to managing protection plans.

Create Protection Plan

Create a protection plan. [Rev 2.01]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
activationDate
string <date-time>

Date and time the protection plan is activated.

Note

  • This field is ignored unless autoActivate is true.
  • If autoActivate is true and no activationDate is specified, the activationDate will be set to the current date and time.
address1
string

First line of contact address

address2
string

Second line of contact address

autoActivate
boolean

Whether or not the protection plan should be set to active upon creation.

city
string

Contact's address city

companyName
string

Contact company name

country
string

The contact's country

county
string

The contact's county

customerID
required
integer

Unique identifier for the customer associated with the protection plan.

email1
string

The contact's email address

extendedInformation
object

An open object to specify additional information. [Rev 2.02]

firstName
string

The contact's first name.

lastName
string

The contact's last name.

protectionPlanProfileID
required
integer

Unique identifier for the protection plan profile.

serialNumber
required
string

Serial number of the item associated with the protection plan.

state
string

The contact's state.

verificationRequestID
integer

Unique identifier for the verification request associated with the protection plan. [Rev 2.03]

Note

  • verificationRequestID is required if autoActivate is true and the protection plan profile is configured to require verification.
zip
string

The contact's zip code.

Responses

Request samples

Content type
application/json
{
  • "activationDate": "2019-08-24T14:15:22Z",
  • "address1": "123 Main Street",
  • "address2": "Unit 234",
  • "autoActivate": false,
  • "city": "Pleasantville",
  • "companyName": "ABC123",
  • "country": "USA",
  • "county": "Westchester",
  • "customerID": 1,
  • "email1": "bob@here.com",
  • "extendedInformation": { },
  • "firstName": "Bob",
  • "lastName": "Smith",
  • "protectionPlanProfileID": 1,
  • "serialNumber": "10001000ABS",
  • "state": "MA",
  • "verificationRequestID": 1,
  • "zip": "01234"
}

Response samples

Content type
application/json
{
  • "accountNumber": "ABC123",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "address1": "123 Main Street",
  • "address2": "Unit 234",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "city": "Pleasantville",
  • "companyName": "ABC123",
  • "contactID": 1,
  • "country": "USA",
  • "county": "Westchester",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "customerID": 1,
  • "customerName": "John Smith",
  • "email1": "bob@here.com",
  • "firstName": "Bob",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "lastName": "Smith",
  • "protectionPlanID": 1,
  • "protectionPlanProfile": "IPhone 11 Pay Up Front",
  • "protectionPlanProfileID": 1,
  • "protectionPlanRequestedStatus": "Cancelled",
  • "protectionPlanRequestedStatusID": 2,
  • "protectionPlanStatus": "Enrolled",
  • "protectionPlanStatusID": 1,
  • "serialNumber": "10001000ABS",
  • "state": "MA",
  • "verificationRequestID": 1,
  • "zip": "01234"
}

Search Protection Plans

Search for protection plans in the system. [Rev 2.01]

Available Fields

The following is a list of fields for a protection plan and how they can be used within a search.

  • Filterable : accountNumber, activationDate, cancellationDate, customerID, firstName, lastName, protectionPlanID, protectionPlanProfileID, protectionPlanRequestedStatusID, protectionPlanStatusID
  • Sortable : accountNumber, activationDate, cancellationDate, createDate, createUser, customerName, lastModifiedDate, lastModifiedUser, protectionPlanID, protectionPlanProfile, protectionPlanRequestedStatus, protectionPlanStatus
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Verify Protection Plan

Verifies a protection plan and creates a provisioning request. [Rev 2.03]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
activationDate
string <date-time>

Date and time the protection plan is activated.

Note

  • This field is ignored unless autoActivate is true.
  • If autoActivate is true and no activationDate is specified, the activationDate will be set to the current date and time.
address1
string

First line of contact address

address2
string

Second line of contact address

autoActivate
boolean

Whether or not the protection plan should be set to active upon creation.

city
string

Contact's address city

companyName
string

Contact company name

country
string

The contact's country

county
string

The contact's county

customerID
required
integer

Unique identifier for the customer associated with the protection plan.

email1
string

The contact's email address

extendedInformation
object

An open object to specify additional information.

firstName
string

The contact's first name.

lastName
string

The contact's last name.

protectionPlanProfileID
required
integer

Unique identifier for the protection plan profile.

serialNumber
required
string

Serial number of the item associated with the protection plan.

state
string

The contact's state.

zip
string

The contact's zip code.

Responses

Request samples

Content type
application/json
{
  • "activationDate": "2019-08-24T14:15:22Z",
  • "address1": "123 Main Street",
  • "address2": "Unit 234",
  • "autoActivate": false,
  • "city": "Pleasantville",
  • "companyName": "ABC123",
  • "country": "USA",
  • "county": "Westchester",
  • "customerID": 1,
  • "email1": "bob@here.com",
  • "extendedInformation": { },
  • "firstName": "Bob",
  • "lastName": "Smith",
  • "protectionPlanProfileID": 1,
  • "serialNumber": "10001000ABS",
  • "state": "MA",
  • "zip": "01234"
}

Response samples

Content type
application/json
{
  • "provisioningRequestID": 123
}

Get a Protection Plan

Retrieve a specific protection plan by ID. [Rev 2.01]

Authorizations:
SWT
path Parameters
protectionPlanID
required
integer

Unique ID of the Protection Plan to retrieve.

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "ABC123",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "address1": "123 Main Street",
  • "address2": "Unit 234",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "city": "Pleasantville",
  • "companyName": "ABC123",
  • "contactID": 1,
  • "country": "USA",
  • "county": "Westchester",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "customerID": 1,
  • "customerName": "John Smith",
  • "email1": "bob@here.com",
  • "firstName": "Bob",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "lastName": "Smith",
  • "protectionPlanID": 1,
  • "protectionPlanProfile": "IPhone 11 Pay Up Front",
  • "protectionPlanProfileID": 1,
  • "protectionPlanRequestedStatus": "Cancelled",
  • "protectionPlanRequestedStatusID": 2,
  • "protectionPlanStatus": "Enrolled",
  • "protectionPlanStatusID": 1,
  • "serialNumber": "10001000ABS",
  • "state": "MA",
  • "verificationRequestID": 1,
  • "zip": "01234"
}

Update a Protection Plan

Provides the ability to update protection plans. [Rev 2.02]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • activationDate : replace, add
  • address1 : replace, add, remove
  • address2 : replace, add, remove
  • cancellationDate : replace, add
  • city : replace, add, remove
  • companyName : replace, add, remove
  • country : replace, add, remove
  • county : replace, add, remove
  • email1 : replace, add, remove
  • firstName : replace, add
  • lastName : replace, add
  • serialNumber : replace, add, remove
  • state : replace, add, remove
  • verificationRequestID : replace, add, remove
  • zip : replace, add, remove
  • extendedInformation : replace, add, remove
Authorizations:
SWT
path Parameters
protectionPlanID
required
integer
Example: 1

Unique identifier of the protection plN to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
activationDate
string <date-time>

Date and time the protection plan is activated.

address1
string

First line of contact address

address2
string

Second line of contact address

cancellationDate
string <date-time>

Date and time the protection plan is CancellationDate.

city
string

Contact's address city

companyName
string

Contact company name

country
string

The contact's country

county
string

The contact's county

email1
string

The contact's email address

extendedInformation
object

An open object to specify additional information. [Rev 2.02]

firstName
string

The contact's first name.

lastName
string

The contact's last name.

serialNumber
string

Serial number of the item associated with the protection plan.

state
string

The contact's state.

verificationRequestID
integer

Unique identifier for the verification request associated with the protection plan. [Rev 2.03]

Note

  • verificationRequestID cannot be cleared once the protection plan has passed the Assembling phase.
zip
string

The contact's zip code.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Cancel Protection Plan

Cancel a protection plan. [Rev 2.01]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
cancellationDate
string <date-time>

Date and time the protection plan is cancelled.

Note

  • If no cancellationDate is specified, the cancellationDate will be set to the current date and time if it is currently empty.
extendedInformation
object

An open object to specify additional information. [Rev 2.02]

Responses

Request samples

Content type
application/json
{
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "extendedInformation": { }
}

Enroll Protection Plan

Enroll a protection plan. [Rev 2.01]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
activationDate
string <date-time>

Date and time the protection plan is activated.

Note

  • If no activationDate is specified, the activationDate will be set to the current date and time if it is currently empty.

Responses

Request samples

Content type
application/json
{
  • "activationDate": "2019-08-24T14:15:22Z"
}

Search Protection Plan Activity for a Protection Plan

get protection plan activities in the system. [Rev 2.01]

Available Fields

The following is a list of fields for a protection plan activity and how they can be used within a search.

  • Filterable : code, protectionPlanActivityTypeID, provisioningRequestStatusID, regenerated, protectionPlanActivityID, lastModifiedDate, lastModifiedUser, createDate, createUser
  • Sortable : code, protectionPlanActivityType, lastModifiedDate, provider, provisioningRequestStatus, lastModifiedDate, lastModifiedUser, createDate, createUser
path Parameters
protectionPlanID
required
integer
Example: 1

Unique identifier of the protection plan to get the activities.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Run Protection Plan Query

Run a custom query for a protection plan. [Rev 2.03]

Authorizations:
SWT
path Parameters
protectionPlanID
required
integer

Unique identifier for the protection plan to run the query for.

queryName
required
string

Name of the query to run on the protection plan.

Responses

Response samples

Content type
application/json
{
  • "provisioningRequestID": 123
}

Search Protection Plan Activity

Search for protection plan activities in the system. [Rev 2.02]

Available Fields

The following is a list of fields for a protection plan and how they can be used within a search.

  • Filterable : accountNumber, code, createDate, createUser, lastModifiedDate, lastModifiedUser, protectionPlanActivityID, protectionPlanActivityTypeID, protectionPlanID, protectionPlanLastModifiedDate, protectionPlanLastModifiedUser, protectionPlanProfileID, protectionPlanProfileTypeID, protectionPlanRequestedStatusID, protectionPlanStatusID, provisioningRequestID, provisioningRequestStatusID, regenerated, serialNumber
  • Sortable : accountNumber, code, createDate, createUser, customerName, lastModifiedDate, lastModifiedUser, protectionPlanActivityType, protectionPlanLastModifiedDate, protectionPlanLastModifiedUser, protectionPlanProfile, protectionPlanProfileType, protectionPlanRequestedStatus, protectionPlanStatus, provider, provisioningRequestStatus, serialNumber
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Regenerate Provisioning Activity

Causes the system to regenerate the provisioning associated with an activity. Is only legitimate for items that are in an error status. [Rev 2.02]

Authorizations:
SWT
path Parameters
protectionPlanActivityID
required
integer

Unique identifier for the protection plan activity to regnerate.

Responses

Provisioning Callback for Protection Plan

Provisioning uses the callback function to update protection plans. [Rev 2.02]

Authorizations:
SWT
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
note
required
string

Note about the provisioning response for this item.

provider
required
string

Name of the provider for the provisioing is processed by for this protection plan activity.

provisioningRequestID
required
integer

Unique identifier for the provisioning request.

provisioningRequestStatusID
required
integer

Unique identifier for the requested status.

Responses

Request samples

Content type
application/json
{
  • "note": "ABC123",
  • "provider": "ABC123",
  • "provisioningRequestID": 2,
  • "provisioningRequestStatusID": 2
}

Sales Entity

Resources related to sales entity.

Descendant

Get a list of child Sales Entities for a specific parent Entity. [Rev 1.18]

Available Fields

The following is a list of fields on a sales entity and how they can be used within the search.

  • Filterable : companyName, firstName, lastName, salesCode, salesCodeID, salesCodeParentID
  • Sortable : companyName, firstName, lastName, salesCode, salesCodeID, salesCodeParentID
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a sales entity for whom to get child sales entities.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Attached Document

Get a list of documents visibile by the Sales Entity. This includes documents associated to this sales entity, parent, or at the global level_[Rev 1.18]_

Available Fields

The following is a list of fields on a sales entity and how they can be used within the search.

  • Filterable : attachedDocumentID, name, salesCode, salesCodeID
  • Sortable : attachedDocumentID, category, confidential, createDate, createUser, documentStorageExternalID, environment, extension, lastModifiedDate, lastModifiedUser, markedForDelete, name, notes, referenceMarkedForDelete, salesCode, salesCodeID, size
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a sales entity for whom to get associated attached documents.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Notice

Get a list of notices visibile by the Sales Entity. This includes notices associated to this sales entity, parent, or at the global level . [Rev 1.18]

Available Fields

The following is a list of fields on a sales entity notice and how they can be used within the search.

  • Filterable : endDate, salesEntityNoticeID, salesCodeID, salesCode, startDate
  • Sortable : endDate, priority, salesEntityNoticeID, salesCodeID, salesCode, startDate, title
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of the sales entity to get notices for.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Search Sales Entity Notices

Provides the ability to search for notices associated with a sales entity notice. [Rev 1.18]

Available Fields

The following is a list of fields on a sales entity and how they can be used within the search.

  • Filterable : endDate, salesEntityNoticeID, salesCodeID, salesCode, startDate
  • Sortable : createDate, endDate, priority, salesEntityNoticeID, salesCodeID, salesCode, startDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
aplication/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Sales Entity Notice

Provides the ability to create a notices that is associated with a sales entity. [Rev 1.18]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
endDate
string <date-time>

End Date of this notice.

priority
required
string (SalesAgentNoticePriority)
Enum: "Low" "Standard" "High"

Priority of the notice.

noticeText
required
string

Text of the notice.

salesCodeID
integer

Unique identifier for the sales entity.

startDate
string <date-time>

Start Date of this notice.

title
string

Title of the notice.

Responses

Request samples

Content type
application/json
{
  • "endDate": "2017-08-07T18:00:00.000Z",
  • "priority": "High",
  • "noticeText": "There is fresh coffee in the break room.",
  • "salesCodeID": 1,
  • "startDate": "2017-08-07T18:00:00.000Z",
  • "title": "Notice title"
}

Response samples

Content type
application/json
{
  • "createDate": "2017-08-07T18:00:00.000Z",
  • "createUser": "admin",
  • "endDate": "2017-08-07T18:00:00.000Z",
  • "lastModifiedDate": "2017-08-07T18:00:00.000Z",
  • "lastModifiedUser": "admin",
  • "priority": "High",
  • "noticeText": "There is fresh coffee in the break room.",
  • "salesCode": "Prospect",
  • "salesCodeID": 1,
  • "salesEntityNoticeID": 1,
  • "startDate": "2017-08-07T18:00:00.000Z",
  • "title": "Notice title"
}

Sales Entity Notice

Get a single sales entity notice [Rev 1.18]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

ID of a sales entity notice.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2017-08-07T18:00:00.000Z",
  • "createUser": "admin",
  • "endDate": "2017-08-07T18:00:00.000Z",
  • "lastModifiedDate": "2017-08-07T18:00:00.000Z",
  • "lastModifiedUser": "admin",
  • "priority": "High",
  • "noticeText": "There is fresh coffee in the break room.",
  • "salesCode": "Prospect",
  • "salesCodeID": 1,
  • "salesEntityNoticeID": 1,
  • "startDate": "2017-08-07T18:00:00.000Z",
  • "title": "Notice title"
}

Delete Sales Entity Notice

Provides the ability to delete a sales entity notice [Rev 1.18]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the sales entity notice to be deleted.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update Sales Entity Notice

Provides the ability to update a sales entity notice. [Rev 1.18]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

  • endDate : add, remove, replace
  • noticeText : replace
  • priority : replace
  • salesCode : add, remove, replace
  • startDate : add, remove, replace
  • title : replace
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier of the sales entity notice.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Service

Resources related to customer services.

System Integrity

Resources related to system integrity.

Health Check

Checks if the Customer Management web service is up and running.

Authorizations:
SWT

Responses

Unit Balance

Resources related to unit Balance.

Unit Balance Categories

Provides the ability to look up the different Unit Balance Categories associated to a Customer's UsgSvc

Available Fields

The following is a list of fields on a unit balance category and how they can be used within the search.

  • Filterable : customerID, discountCategory, discountCategoryID, expirationDate, serviceID, units, unitsTypeID, unitType, unitTypeSubTypeID
  • Sortable : customerID, discountCategory, discountCategoryID, expirationDate, serviceID, units, unitsTypeID, unitType, unitTypeSubTypeID
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json
rootFeatureID
integer

Unique identifier for the root feature ID.

showExpired
boolean

Determines if should display expired unit balance categories or not.

Responses

Request samples

Content type
application/json
{
  • "rootFeatureID": 1,
  • "showExpired": false
}

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Unit Balance Catalog

Provides the ability to look up the different Unit Balance Catalog Items associated to a Customer's UsgSvc

Available Fields

The following is a list of fields on a unit balance catalog item and how they can be used within the search.

  • Filterable : rootFeatureID, serviceDescription, sku
  • Sortable : rootFeatureID, serviceDescription, sku
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Unit Balance Ledger

Provides the ability to look up Unit Balance Ledgers associated to the Customer

path Parameters
customerId
required
integer
Example: 1

Unique identifier of the customer.

Request Body schema: application/json
discountCatalogID
integer

Unique identifier for the discount catalog ID.

discountCategoryID
integer

Unique identifier for the discount category ID.

rootFeatureID
integer

Unique identifier for the root feature ID.

serviceID
required
integer

Unique identifier for the usage service. If this value is not supplied, only account-level results will be returned.

showExpired
boolean

Determines if should display expired unit balance categories or not.

showFuture
boolean

Determines if should display future unit balance categories or not.

Responses

Request samples

Content type
application/json
{
  • "discountCatalogID": 1,
  • "discountCategoryID": 1,
  • "rootFeatureID": 1,
  • "serviceID": 1,
  • "showExpired": false,
  • "showFuture": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Unit Balance Discount Search

Search Unit Balance Discount for a customer

Available Fields

The following is a list of fields from a Unit Balance Discount entry and how they can be used within the search.

  • Filterable : customerID, serviceID, discountCategoryID, rootFeatureID, SKU, description, catalogID
  • Sortable : customerID, serviceID, discountCategoryID, rootFeatureID, SKU, description, catalogID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/customermanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Shared Grant Transaction

Creates a new Shared Grant Transaction

Request Body schema: application/json
featureID
required
integer

Unique identifier for the feature.

units
required
decimal

The portion of the shared grant that is associated with the service, must be non-zero. Negative units indicate a debit adjustment, positive units indicate a credit adjustment.

unitsTypeID
required
integer

Unique identifier for the unit type.

availableDate
required
date

Date the Shared Grant Transaction is available.

postDate
required
date

Date the Shared Grant Transaction was posted.

expirationDate
date

Date the Shared Grant Transaction expires.

description
string

Description of the Shared Grant Transaction.

Responses

Request samples

Content type
application/json
{
  • "featureID": 1,
  • "units": 1,
  • "unitsTypeID": 1,
  • "availableDate": "2020-01-27T16:27:30.41646-05:00",
  • "postDate": "2020-01-27T16:27:30.41646-05:00",
  • "expirationDate": "2020-01-27T16:27:30.41646-05:00",
  • "description": "Description"
}

Response samples

Content type
application/json
{
  • "sharedGrantTransactionID": 1
}

Release Notes

Release Notes 2.27 (Latest)

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

Release Notes 2.26

Release Notes 2.25

Release Notes 2.24

Release Notes 2.23

Release Notes 2.22

Release Notes 2.21

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

Release Notes 2.20

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

Release Notes 2.19

Release Notes 2.18

Release Notes 2.17

  • Updated DirectoryListingFull (#/components/schemas/DirectoryListingFull) object parameter

Release Notes 2.16

  • Updated MissingDirectoryListingResponse parameters

Release Notes 2.15

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

Release Notes 2.14

Release Notes 2.13

Release Notes 2.12

  • Updated MissingDirectoryListingResponse parameter names

Release Notes 2.11

Release Notes 2.10

Release Notes 2.09

Release Notes 2.08

Release Notes 2.07

Release Notes 2.06

Release Notes 2.05

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

Release Notes 2.04

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

Release Notes 2.03

Release Notes 2.02

Release Notes 2.01

Release Notes 2.00

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

Release Notes 1.25

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

Release Notes 1.24

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

Release Notes 1.23

Release Notes 1.22

Release Notes 1.21

Release Notes 1.20

Release Notes 1.19

Release Notes 1.18

Release Notes 1.17

Release Notes 1.16

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

Release Notes 1.15

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

Release Notes 1.14

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

Release Notes 1.13

Release Notes 1.12

Release Notes 1.11

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

Release Notes 1.10

Release Notes 1.09

Release Notes 1.08

Release Notes 1.07

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

Release Notes 1.06

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

Release Notes 1.05

  • Added GET /api/customer/accountSearch operation

Release Notes 1.04

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

Release Notes 1.03

  • Added PATCH api/customer/{id}/collection/paymentPlan/{paymentPlanId} operation
  • Added POST api/customer/{id}/collection/paymentPlan operation
  • Added POST api/customer/{id}/collection/paymentPlan/{paymentPlanId}/close operation

Release Notes 1.02

  • Added PATCH /api/customer/{id}/collection operation
  • Added POST /api/customer/{id}/collection/agencyStatus operation
  • Added POST /api/customer/{id}/collection/remove operation
  • Added POST /api/customer/{id}/collection/send operation
  • Added POST /api/customer/{id}/collection/updateAgency operation

Release Notes 1.01

  • Added GET /api/collectionAgency operation
  • Added GET /api/collectionAgencyStatus operation
  • Added GET /api/collectionStatus operation
  • Added GET /api/customer/{id}/collection operation
  • Added GET /api/customer/{id}/collection/history operation
  • Added GET /api/customer/{id}/collection/paymentPlan operation
  • Added GET /api/customer/{id}/collection/spendingLimitHistory operation
  • Added GET /api/customer/{id}/collection/spendingLimit operation

Release Notes 2.27 (Latest)

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

Release Notes 2.26

Release Notes 2.24

Release Notes 2.22

Release Notes 2.21

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

Release Notes 2.20

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

Release Notes 2.19

Release Notes 2.18

Release Notes 2.17

  • Updated DirectoryListingFull (#/components/schemas/DirectoryListingFull) object parameter

Release Notes 2.16

  • Updated MissingDirectoryListingResponse parameters

Release Notes 2.15

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

Release Notes 2.14

Release Notes 2.13

Release Notes 2.12

  • Updated MissingDirectoryListingResponse parameter names

Release Notes 2.11

Release Notes 2.10

Release Notes 2.09

Release Notes 2.07

Release Notes 2.06

Release Notes 2.05

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

Release Notes 2.04

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

Release Notes 2.02

Release Notes 2.00

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

Release Notes 1.25

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

Release Notes 1.24

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

Release Notes 1.23

Release Notes 1.22

Release Notes 1.20

Release Notes 1.17

Release Notes 1.16

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

Release Notes 1.15

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

Release Notes 1.14

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

Release Notes 1.13

Release Notes 1.12

Release Notes 1.11

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

Release Notes 1.10

Release Notes 1.09

Release Notes 1.08

Release Notes 1.07

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

Release Notes 1.06

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

Release Notes 1.05

  • Added GET /api/customer/accountSearch operation

Release Notes 1.04

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

Release Notes 1.03

  • Added PATCH api/customer/{id}/collection/paymentPlan/{paymentPlanId} operation
  • Added POST api/customer/{id}/collection/paymentPlan operation
  • Added POST api/customer/{id}/collection/paymentPlan/{paymentPlanId}/close operation

Release Notes 1.02

  • Added PATCH /api/customer/{id}/collection operation
  • Added POST /api/customer/{id}/collection/agencyStatus operation
  • Added POST /api/customer/{id}/collection/remove operation
  • Added POST /api/customer/{id}/collection/send operation
  • Added POST /api/customer/{id}/collection/updateAgency operation

Release Notes 1.01

  • Added GET /api/collectionAgency operation
  • Added GET /api/collectionAgencyStatus operation
  • Added GET /api/collectionStatus operation
  • Added GET /api/customer/{id}/collection operation
  • Added GET /api/customer/{id}/collection/history operation
  • Added GET /api/customer/{id}/collection/paymentPlan operation
  • Added GET /api/customer/{id}/collection/spendingLimitHistory operation
  • Added GET /api/customer/{id}/collection/spendingLimit operation