logo
API docs by Redocly

Billing Order Management (2.19)

Download OpenAPI specification:Download

This Billing Order Management API provides developers a way to update items within a billing order to correspond with various post order submission activities. For example it maybe required to update billing order item state to some custom value at certain points prior to completion to account for shipping, fulfillment or provisioning.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the BillingOrderManagement service is up and running.

Responses

Auxiliary Carrier

Resources related to getting and searching for auxiliary carrier information.

Search For Auxiliary Carrier

Search for auxiliary carriers

Available Fields

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

  • Filterable : auxiliaryCarrierID
  • Sortable : auxiliaryCarrierID, 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.

$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
integer
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Retreive An Auxiliary Carrier

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Unique identifier of the auxiliary carrier to retrieve.

Responses

Response samples

Content type
application/json
{
  • "auxiliaryCarrierID": 1,
  • "name": "'The Auxiliary Carrier'"
}

Auxiliary Data

Resources related to getting and searching for auxiliary data.

Find Line Item Tenders

For the specified billing order line item IDs, find all tenders associated with their billing orders. [Rev 2.14]

Available Fields

The following is a list of fields from Billing Order line items and how they can be used within the search.

  • Filterable : amount, baseTenderTypeID, token
  • Sortable : amount, createDate, receiptNumber
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
integer
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
required
string
Example: application/json
Request Body schema: application/json
billingOrderLineItemIDs
Array of int

List of unique identifiers for billing order line items.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Billing Order

Resources related to searching and modifying billing order information.

List Billing Order Errors

List errors from a billing order, including errors from billing orders originating from the specified billing order. To return only those errors directly associated with a particular billing order, specify a billingOrderID filter. [Rev 1.12]

Available Fields

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

  • Filterable : billingOrderID, billingOrderLineItemID, errorID, rootBillingOrderLineItemID
  • Sortable : billingOrderID, billingOrderLineItemID, serviceNumber
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Change Overview Rollup

List the change overview rollup information for a billing order. Rollup for a billing order attempts to collapse related order line item information into single summary row so that the overall progress of a billing order line items can be seen in one record. [Rev 1.11]

Available Fields

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

  • Filterable : billingOrderLineItemID, featureCatalogID, featureID, featureSKU, hideOnSalesAndReturns, serviceID
  • Sortable : featureCatalog, featureSKU, featureStartDate, serviceNumber
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Find Line Items that Match Criteria

For the specified billing order, find all line items that are for orderable items that match the criteria provided in the request body. [Rev 2.04]

Available Fields

The following is a list of fields from Billing Order line items and how they can be used within the search.

  • Filterable : None
  • Sortable : None
Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order that the line items are associated with.

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
integer
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
required
string
Example: application/json
Request Body schema: application/json
catalogGroupIDs
Array of int

List of unique identifiers for the catalog groups that the orderable items associated with the line items must be members of.

catalogGroupClassIDs
Array of int

List of unique identifiers for the catalog group classes for the groups that the orderable items associated with the line items must be members of.

Responses

Request samples

Content type
application/json
{
  • "catalogGroupIDs": [
    ],
  • "catalogGroupClassIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Retail Rollup

List the retail rollup information for a billing order. Rollup for a billing order attempts to collapse related order line item information into single summary row so that the overall progress of a billing order line items can be seen in one record. [Rev 1.11]

Available Fields

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

  • Filterable : billingOrderLineItemID, hideOnSalesAndReturns, isReturnable, retailProductCatalogID, retailProductCatalogSubtypeID, retailProductCatalogTypeID, retailProductID, retailProductSKU
  • Sortable : createDate, itemNumber, retailProductCatalog, retailProductCatalogSubtype, retailProductCatalogType, retailProductSKU, ServiceNumber
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Service Rollup

List the service rollup information for a billing order. Rollup for a billing order attempts to collapse related order line item information into single summary row so that the overall progress of a billing order line items can be seen in one record. [Rev 1.12]

Available Fields

The following is a list of fields from billing order service rollup and how they can be used within the search.

  • Filterable : billingOrderLineItemID, serviceCatalogID, serviceCatalogSubtypeID, serviceID
  • Sortable : changeDate, serviceCatalogSubtype, serviceNumber
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Starting Code Summary

List the starting codes for a billing order. [Rev 1.24]

Available Fields

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

  • Filterable : accountNumber, billingOrderID, entryDate, receiptNumber, serviceNumber, startingCode, startingCodeID, transactionStatusID
  • Sortable : accountNumber, billingOrderID, duplicateCount, entryDate, serviceNumber, startingCode
Authorizations:
SWT
path Parameters
billingOrderID
required
integer
Example: 1

Unique identifier for the billing order the starting code summary is associated to.

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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Force Complete

Force the order to complete and cancel out all running execution plans. [Rev 1.03]

Note

  • This operation is only available for billing orders with the category of 'Order' or 'POS Order'
  • This operation will unblock any blocked BTA adjustments.
Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

Responses

Response samples

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

Update Line Items

Provides the ability to bulk update properties on billing order line items. [Rev 1.09]

Patchable Fields

The following is a list of properties of a billing order line item that can be patched.

  • stateID : add, remove, replace
Authorizations:
SWT
path Parameters
billingOrderID
required
integer
Example: 1

Unique identifier for the billing order the line items are associated to.

Request Body schema: application/json
billingOrderLineItemIDs
Array of int

Unique identifier for the line items to apply the patch values to.

Array of objects (JSONPatchBillingOrderLineItem)

List of patch operation to apply to the billing order line items indicated in the billingOrderLineItemIDs

fireOnSubmit
boolean

Indicated whether or not to refire the on submit after making the updates to the billing order line items. This useful if processing of the billing order is waiting on state or status transitions to occur.

Responses

Request samples

Content type
application/json
{
  • "billingOrderLineItemIDs": [
    ],
  • "billingOrderLineItemPatch": [
    ],
  • "fireOnSubmit": true
}

Response samples

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

Set Billing Status

Sets the billing status of service and feature billing order line items of type Add Catalog Item or Reconnect Catalog Item to active, and sets the billing status of service and feature billing order line items of type Disconnect Catalog Item to inactive, depending upon options indicated. [Rev 1.03]

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the services and features to update belong to.

Request Body schema: application/json
ignoreActivations
boolean

If true, if a billing order line item is of type Add Catalog Item or Reconnect Catalog Item, it will be ignored.

  • Default Value : false
ignoreDisconnects
boolean

If true, billing order line items of type Disconnect Catalog Item will be ignored.

  • Default Value : false
object (OrderLineItemFilter)

[Rev 1.05]

Responses

Request samples

Content type
application/json
{
  • "ignoreActivations": true,
  • "ignoreDisconnects": true,
  • "orderLineItemFilter": {
    }
}

Response samples

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

Set End Date

Sets the end date of service and feature billing order line items of type Disconnect Catalog Item to the end date specified. If clearEndDate is true, end dates will be cleared regardless of any specified endDate. Otherwise, if no end date is specified, the current date will be used. The new end date must be later than or equal to start dates currently on services and features to be updated. Any services or features with a pre-existing end date earlier than or equal to the new end date will be bypassed. (Note that this check cannot apply if clearing end dates.) [Rev 1.04] [Rev 1.06]

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the services and features to update belong to.

Request Body schema: application/json
clearEndDate
bool

Set this to true to wipe out end dates. Setting clearEndDate to true overrides anything in the endDate field. [Rev 1.06]

  • Default Value : false
endDate
string

Date to set the end date to.

  • Default Value : current date
object (OrderLineItemFilter)

[Rev 1.05]

Responses

Request samples

Content type
application/json
{
  • "clearEndDate": false,
  • "endDate": "2007-09-14",
  • "orderLineItemFilter": {
    }
}

Response samples

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

Set Provisioning Status

Sets the provisioning status of product, package, pricing plan and advance pay product billing order line items to the provisioning status specified, depending upon options indicated. [Rev 1.03]

Note

An unspecified or null provisioning status ID will cause the provisioning status to be cleared. Specifying no options at all will cause the provisioning status to be cleared on the entire billing order.

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the features to update belong to.

Request Body schema: application/json
ignoreAdds
boolean

If true, billing order line items of type Add Catalog Item will be ignored.

  • Default Value : false
ignoreDisconnects
boolean

If true, billing order line items of type Disconnect Catalog Item will be ignored.

  • Default Value : false
ignoreHotlines
boolean

If true, billing order line items of type Hotline Catalog Item will be ignored.

  • Default Value : false
ignoreReconnects
boolean

If true, billing order line items of type Reconnect Catalog Item will be ignored.

  • Default Value : false
ignoreRedirects
boolean

If true, billing order line items of type Redirect Catalog Item will be ignored.

  • Default Value : false
ignoreRestores
boolean

If true, billing order line items of type Restore Catalog Item will be ignored.

  • Default Value : false
ignoreSuspends
boolean

If true, billing order line items of type Suspend Catalog Item will be ignored.

  • Default Value : false
ignoreUpdates
boolean

If true, billing order line items of type Update Catalog Item will be ignored.

  • Default Value : false
provisioningStatusID
number

Unique identifier for a provisioning status to assign.

  • Default Value : null

Responses

Request samples

Content type
application/json
{
  • "ignoreAdds": true,
  • "ignoreDisconnects": true,
  • "ignoreHotlines": true,
  • "ignoreReconnects": true,
  • "ignoreRedirects": true,
  • "ignoreRestores": true,
  • "ignoreSuspends": true,
  • "ignoreUpdates": true,
  • "provisioningStatusID": 3
}

Response samples

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

Set Start Date

Sets the start date of service and feature billing order line items of type Add Catalog Item to the start date specified. If no start date is specified, the current date will be used. The new start date must be earlier or equal to any end dates currently on services and features to be updated, and within the start-end date range of the item's specification in the product catalog. [Rev 1.04]

Note

If the start date of a non-retail installment plan feature is updated, the installment details associated with the installment plan will also updated. The start date of an installment plan feature associated with a retail installment plan can not be updated.

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the services and features to update belong to.

Request Body schema: application/json
startDate
string

Date to set the start date to.

  • Default Value : current date
object (OrderLineItemFilter)

[Rev 1.05]

Responses

Request samples

Content type
application/json
{
  • "startDate": "2007-09-14",
  • "orderLineItemFilter": {
    }
}

Response samples

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

Update Billing Order

Updates a specific Billing Order. [Rev 1.25]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Billing Order, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of a billing order.

  • orderStateID : add, remove, replace [Rev 2.08]
  • sourceCodeID : add, remove, replace
Authorizations:
SWT
path Parameters
billingOrderID
required
integer
Example: 1

Unique identifier for the billing order.

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
required
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": [
    ]
}

Customer

Resources related to customer billing orders.

List Billing Order Rollup

List the billing order rollup information for a customer. Rollup for a billing order attempt to collapse related order information into single summary row so that the overall progress of a billing order can be seen in one record. [Rev 1.11]

Available Fields

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

  • Filterable : billingOrderID, isTopLevel, originatingBillingOrderID
  • Sortable : billingOrderID, completeDate, createDate, estimatedCompleteDate, finalizeDate, rollupCompleteDate, rollupFinalizeDate, rollupLastModifiedDate
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Find Billing Orders that Match Criteria

Find billing orders for a customer that match the criteria provided in the request body. [Rev 2.04]

Available Fields

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

  • Filterable : None
  • Sortable : None
Authorizations:
SWT
path Parameters
customerID
required
number
Example: 1

Unique identifier for the customer that the orders are associated to.

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
integer
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
required
string
Example: application/json
Request Body schema: application/json
serialNumber
required
string

A serial number to search for on billing orders for the specified customer.

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "abc_1234567890"
}

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search For Pending Equipment

Search for PON types. [Rev 1.09]

Available Fields

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

  • Filterable : alternateSerialNumber, billingNumber, catalogClassID, catalogID, fulfillmentSaleEquipmentOrderLineItemID, fulfillmentSaleOrderID, fulfillmentSaleServiceOrderLineItemID, fulfillmentSaleServiceOrderLineItemStateID, isPorting, salesRequestOrderID, salesRequestReceiptNumber, serviceID, serviceNumber, serialNumber, shippingProvisioningTypeID, sku
  • Sortable : alias, alternateInvoiceDescription, alternateSerialNumber, billingNumber, catalogClass, catalogClassID, catalogID, description, fulfillmentSaleEquipmentOrderLineItemID, fulfillmentSaleOrderID, fulfillmentSaleServiceOrderLineItemID, fulfillmentSaleServiceOrderLineItemState, fulfillmentSaleServiceOrderLineItemStateID, isPorting, salesRequestOrderID, salesRequestReceiptNumber, serviceID, serviceNumber, serialNumber, shippingProvisioningType, shippingProvisioningTypeID, sku
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
integer
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,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Returnable Line Items

Find returnable line items for a customer that match the criteria provided in the request body. [Rev 2.11]

Available Fields

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

  • Filterable : description, receiptNumber, sku, transactionDate
  • Sortable : description, receiptNumber, sku, transactionDate
Authorizations:
SWT
path Parameters
customerID
required
number
Example: 1

Unique identifier for the customer that the line items are associated to.

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
integer
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
required
string
Example: application/json
Request Body schema: application/json
objectTypeIDs
Array of integers

If supplied, only returnable line items with an objectTypeID in this list will be returned.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "advancePayFeatureID": 123,
  • "billingOrderID": 1425,
  • "billingOrderLineItemID": 2,
  • "description": "Direct Invoice Retail",
  • "locationID": 3,
  • "objectTypeID": 13,
  • "originalQuantity": 1,
  • "previouslyReturnedQuantity": 0,
  • "receivedQuantity": 0,
  • "receiptNumber": "REG1-00-1000",
  • "registerID": 5,
  • "returnRequestedQuantity": 1,
  • "serviceNumber": "1238675309",
  • "sku": "AH1",
  • "transactionDate": "2017-12-11T00:33:00.11-05:00"
}

PON

Resources related to searching and modifying PON information.

Search For PON

Search for PON.

Available Fields

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

  • Filterable : auxiliaryCarrierID, billingCompletionNotificationDate, firmOrderCompletionDate, ponID, ponTypeID, providerOrderNumber, provisioningCompletionNotificationDate, purchaseOrderNumber
  • Sortable : auxiliaryCarrier, auxiliaryCarrierID, billingCompletionNotificationDate, firmOrderCompletionDate, ponID, ponType, ponTypeID, providerOrderNumber, provisioningCompletionNotificationDate, purchaseOrderNumber
Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

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
integer
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Create A PON

Create a PON.

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

Request Body schema: application/json
ponTypeID
required
number

Unique identifier for the PON Type of the PON.

addBillingOrderLineItemIDs
Array of numbers

Unique identifier for the billing order line items to associate to the PON.

auxiliaryCarrierID
number

Unique identifier for the auxiliary carrier that the PON is for.

billingCompletionNotificationDate
string

Date and time for the billing completion notification.

firmOrderCompletionDate
string

Date and time for the firm order completion.

providerOrderNumber
string

Number associated to the PON in the auxiliary carrier's system.

provisioningCompletionNotificationDate
string

Date and time for the provisioning completion notificate.

purchaseOrderNumber
string

Internal tracking number for the PON.

Responses

Request samples

Content type
application/json
{
  • "ponTypeID": 2,
  • "addBillingOrderLineItemIDs": [
    ],
  • "auxiliaryCarrierID": 1,
  • "billingCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "firmOrderCompletionDate": "2007-09-14T16:31:25.6570000+00:00",
  • "providerOrderNumber": 123456,
  • "provisioningCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "purchaseOrderNumber": 789
}

Response samples

Content type
application/json
{
  • "auxiliaryCarrier": "The Auxiliary Carrier",
  • "auxiliaryCarrierID": 1,
  • "billingCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "firmOrderCompletionDate": "2007-09-14T16:31:25.6570000+00:00",
  • "ponID": 1,
  • "ponType": "Directory",
  • "ponTypeID": 2,
  • "providerOrderNumber": 123456,
  • "provisioningCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "purchaseOrderNumber": 789
}

Retreive A PON

Get a single PON.

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

ponID
required
number
Example: 1

Unique identifier for the PON.

Responses

Response samples

Content type
application/json
{
  • "auxiliaryCarrier": "The Auxiliary Carrier",
  • "auxiliaryCarrierID": 1,
  • "billingCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "firmOrderCompletionDate": "2007-09-14T16:31:25.6570000+00:00",
  • "ponID": 1,
  • "ponType": "Directory",
  • "ponTypeID": 2,
  • "providerOrderNumber": 123456,
  • "provisioningCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "purchaseOrderNumber": 789
}

Delete A PON

Delete a single PON and all associated links.

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

ponID
required
number
Example: 1

Unique identifier for the PON.

Responses

Response samples

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

Update A PON

Modify a single PON and associated links. This operation uses the JSON Patch document structure for defining updates to the company objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

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

  • auxiliaryCarrierID : add, remove, replace
  • billingCompletionNotificationDate : add, remove, replace
  • addBillingOrderLineItemIDs : replace (adding ids to this field will cause additional billing line items to be associated to the PON)
  • firmOrderCompletionDate : add, remove, replace
  • ponTypeID : add, replace
  • providerOrderNumber : add, remove, replace
  • provisioningCompletionNotificationDate : add, remove, replace
  • purchaseOrderNumber : add, remove, replace
  • removeBillingOrderLineItemIDs : replace (adding ids to this field will cause the billing line items to be deassociated from the PON)
Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

ponID
required
number
Example: 1

Unique identifier for the PON.

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
required
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
{
  • "auxiliaryCarrier": "The Auxiliary Carrier",
  • "auxiliaryCarrierID": 1,
  • "billingCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "firmOrderCompletionDate": "2007-09-14T16:31:25.6570000+00:00",
  • "ponID": 1,
  • "ponType": "Directory",
  • "ponTypeID": 2,
  • "providerOrderNumber": 123456,
  • "provisioningCompletionNotificationDate": "2007-09-14T16:31:25.6570000+00:00",
  • "purchaseOrderNumber": 789
}

Search For PON Line Items

Search for billing line items associated to a PON.

Available Fields

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

  • Filterable : billingOrderLineItemID, stateID [Rev 1.09], statusID [Rev 1.09]
  • Sortable : billingOrderLineItemID, description, state [Rev 1.09], stateID [Rev 1.09], status [Rev 1.09], statusID [Rev 1.09]
Authorizations:
SWT
path Parameters
billingOrderID
required
string
ponID
required
string
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
integer
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Set Date

Provides the ability to set the dates on a pon and update aspects of the corresponding billing order. [Rev 1.03]

Authorizations:
SWT
path Parameters
billingOrderID
required
number
Example: 1

Unique identifier for the billing order the PON is associated to.

ponID
required
number
Example: 1

Unique identifier for the PON.

Request Body schema: application/json
billingOrderStateID
number

The new billing order state for the related billing order.

Array of objects (PONDateDetail)

List of dates to update as part of this request.

Responses

Request samples

Content type
application/json
{
  • "billingOrderStateID": 12,
  • "ponDateDetails": [
    ]
}

Response samples

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

PON Type

Resources related to getting and searching for PON type information.

Search For PON Type

Search for PON types. [Rev 1.09]

Available Fields

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

  • Filterable : ponTypeID
  • Sortable : ponTypeID, 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.

$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
integer
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "name": "'Facility'",
  • "ponTypeID": 1
}

Release Notes

Release Notes 2.19

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

Release Notes 2.18

Release Notes 2.17

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

Release Notes 2.16

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

Release Notes 2.15

  • Added accountHolderName, bankAccountNumber, cardNumber, expirationDate, tenderNumber to operation Find Line Item Tenders.

Release Notes 2.14

Release Notes 2.13

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

Release Notes 2.12

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

Release Notes 2.11

Release Notes 2.10

Release Notes 2.09

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

Release Notes 2.08

Release Notes 2.07

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

Release Notes 2.06

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

Release Notes 2.05

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

Release Notes 2.04

Release Notes 2.03

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

Release Notes 2.02

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

Release Notes 2.01

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

Release Notes 2.00

  • Note: Major version change was for internal changes only and not a breaking change.

Release Notes 1.25

Release Notes 1.24

Release Notes 1.23

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

Release Notes 1.22

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

Release Notes 1.21

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

Release Notes 1.20

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

Release Notes 1.19

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

Release Notes 1.18

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

Release Notes 1.17

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

Release Notes 1.16

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

Release Notes 1.15

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

Release Notes 1.14

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

Release Notes 1.13

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

Release Notes 1.12

Release Notes 1.11

Release Notes 1.10

Release Notes 1.09

Release Notes 1.08

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

Release Notes 1.07

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

Release Notes 1.06

  • Updated SetEndDate operation to take in an optional clearEndDate parameter

Release Notes 1.05

  • Updated SetBillingStatus operation to take in an optional orderLineItemFilter parameter

  • Updated SetStartDate operation to take in an optional orderLineItemFilter parameter

  • Updated SetEndDate operation to take in an optional orderLineItemFilter parameter

Release Notes 1.04

Release Notes 1.03

Release Notes 1.02

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

Release Notes 1.01

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

Release Notes 1.00

  • Billing Order Management API Added new endpoint