logo
API docs by Redocly

Rate Bill Management REST Service (1.26)

Download OpenAPI specification:Download

The Rate Bill Management API provides developers a way to manage their billing request.

System Integrity

Resources related to system integrity.

Health Check

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

Authorizations:
SWT

Responses

Preview

Resources related to the management of Preview Invoices.

Create a Preview Invoice

Creates a Preview Invoice

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

Unique identifier for a billing cycle detail.

customerId
required
integer

Unique identifier for a customer.

skipUsage
boolean

Indicates whether or not to skip billing usage.

Responses

Request samples

Content type
application/json
{
  • "billPeriodId": 1,
  • "customerId": 1,
  • "skipUsage": false
}

Response samples

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

Get Preview Availability

Provides the ability to get information about a customer's preview Availability

Authorizations:
SWT
path Parameters
customerId
required
integer

Unique ID of the customer to retrieve a bill period.

Responses

Response samples

Content type
application/json
Example
{
  • "billPeriodId": 1,
  • "endDate": "2019-08-24T14:15:22Z",
  • "isAvailable": true,
  • "skipUsage": false,
  • "startDate": "2019-08-24T14:15:22Z"
}

Get Preview Request Status by CustomerId

Retrieve the preview request status if pending or running for the customer.

Authorizations:
SWT
path Parameters
customerId
required
integer

Unique ID of the customer to retrieve a bill period.

Responses

Response samples

Content type
application/json
{
  • "requestId": 1,
  • "status": "Pending"
}

Request

Resources related to the management of Requests.

Search Request

Provides the ability to search the ratebill requests in the system.

Available Fields

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

  • Filterable: requestID, requestTypeID, requestStatusID, requestPriorityID, requestJobID, startDate, runDate, endDate
  • Sortable: requestID, requestStatusID, startDate, endDate, runDate
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
required
string
Example: application/json

Responses

Response samples

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

Search Request Details

Provides the ability to search all the request details by requestID.

Available Fields

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

  • Filterable: requestDetailID, requestOperationID, requestStatusID
  • Sortable: requestDetailID, requestStatusID, startDate, endDate, rank
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "billPeriodID": "11090401",
  • "createDate": "2015-05-08T10:09:19.113-04:00",
  • "endDate": "2015-05-08T10:09:19.113-04:00",
  • "lastModified": "2015-05-08T10:09:19.113-04:00",
  • "rank": 1,
  • "requestID": 1,
  • "requestDetailID": 1,
  • "requestOperation": "Rerate",
  • "requestOperationID": 4,
  • "requestStatus": "Pending",
  • "requestStatusID": 1,
  • "startDate": "2015-05-08T10:09:19.113-04:00"
}

Search Request Status

Provides the ability to search the ratebill requests statuses in the system.

Available Fields

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

  • Filterable: requestStatusID, name
  • Sortable: requestStatusID, 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
required
string
Example: application/json

Responses

Response samples

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

Search Request Detail Parameters

Provides the ability to search the ratebill requests detail parameters for a given request and request detail. [Rev 1.26]

Available Fields

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

  • Filterable: requestDetailParamID, requestDetailID, value, lastModifiedDate, name
  • Sortable: requestDetailParamID, requestDetailID, value, lastModifiedDate, name
Authorizations:
SWT
path Parameters
requestID
required
integer
Example: 1

Unique identifier for the Request.

requestDetailID
required
integer
Example: 1

Unique identifier for the Request Detail.

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

Responses

Response samples

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

Search Request Detail Statistics

Provides the ability to search the ratebill requests detail statistics for a given request and request detail. [Rev 1.26]

Available Fields

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

  • Filterable: requestDetailID, statValue, billPeriodID, statName
  • Sortable: requestDetailID, statValue, billPeriodID, statName
Authorizations:
SWT
path Parameters
requestID
required
integer
Example: 1

Unique identifier for the Request.

requestDetailID
required
integer
Example: 1

Unique identifier for the Request Detail.

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

Responses

Response samples

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

Search Request Detail Logs

Provides the ability to search the log entries for a given request detail. [Rev 1.26]

Available Fields

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

  • Filterable: requestDetailLogID, requestDetailID, severity, severityID, messageDate, message, alternativeMessage, workItemID
  • Sortable: requestDetailLogID, requestDetailID, severity, severityID, messageDate, message, alternativeMessage, workItemID
Authorizations:
SWT
path Parameters
requestID
required
integer
Example: 1

Unique identifier for the Request.

requestDetailID
required
integer
Example: 1

Unique identifier for the Request Detail.

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

Responses

Response samples

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

Search Request Types

Provides the ability to search ratebill request types in the system. [Rev 1.23]

Available Fields

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

  • Filterable: name, requestTypeID, isSLAImpacting, isNotifyOnFailure, processAsync
  • Sortable: name, requestTypeID, isSLAImpacting, isNotifyOnFailure, processAsync
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "isNotifyOnFailure": false,
  • "isSLAImpacting": true,
  • "name": "Billing",
  • "processAsync": true,
  • "requestTypeID": 1
}

Request Template

Resources related to the management of Requests Templates.

Search Request Template

Provides the ability to search the ratebill request templates in the system. [Rev 1.23]

Available Fields

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

  • Filterable: requestJobID, description, startDate, enddate, startTimeSeconds, perDayReoccurrenceTypeID, perDayReoccurrence, maxScheduledIterations, maxScheduledDays, requestJobStatusID, requestJobStatus, requestTypeID, requestType, requestPriorityID, requestPriority, userID, lastModified
  • Sortable: requestJobID, description, startDate, enddate, startTimeSeconds, perDayReoccurrenceTypeID, perDayReoccurrence, maxScheduledIterations, maxScheduledDays, requestJobStatusID, requestJobStatus, requestTypeID, requestType, requestPriorityID, requestPriority, userID, lastModified
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
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "description": "This is a request job description.",
  • "endDate": "2024-01-01T12:00:00-04:00",
  • "lastModified": "2024-01-01T09:00:00-04:00",
  • "maxScheduledDays": 30,
  • "maxScheduledIterations": 10,
  • "perDayReoccurrenceTypeID": 1,
  • "perDayReoccurrenceType": "Every N Days",
  • "perDayReoccurrence": 1,
  • "requestJobID": 1,
  • "requestJobStatus": "Active",
  • "requestJobStatusID": 1,
  • "requestPriority": "High",
  • "requestPriorityID": 1,
  • "requestType": "Billing",
  • "requestTypeID": 1,
  • "startDate": "2024-01-01T10:00:00-04:00",
  • "startTimeSeconds": 36000,
  • "userID": "admin_user"
}

Bill Cycle

Resources related to the management of Bill Cycle.

Search Bill Cycles

Provides the ability to search for Bill Cycles in the system.

Available Fields

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

  • Filterable: billCycleID, billCycleTypeID, billCycleType, name, description, dayOfMonth, creationDate, startDate, endDate, billCycleClassID, billCycleClass, approvalRequestTemplateID
  • Sortable: billCycleID, billCycleTypeID, billCycleType, name, description, dayOfMonth, creationDate, startDate, endDate, billCycleClassID, billCycleClass, approvalRequestTemplateID
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
required
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"
}

Search Bill Run Bill Cycle Config

Provides the ability to search for a Bill Cycle's Bill Run Configuration. This includes the configured steps that make up a Bill Run for the given Bill Cycle.

Available Fields

The following is a list of fields from bill run bill cycle configs and how they can be used within the search.

  • Filterable: billRunBillCycleConfigID, billCycleID, rank, name, enabled, locked, requestTemplateID, allowSubmission, allowRequestTemplate, createUser, createDate, lastModifiedUser, lastModifiedDate
  • Sortable: billRunBillCycleConfigID, billCycleID, rank, name, enabled, locked, requestTemplateID, allowSubmission, allowRequestTemplate, createUser, createDate, lastModifiedUser, lastModifiedDate
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
required
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"
}

Create Update Bill Run Bill Cycle Config

Provides the ability to create and update a Bill Run Configs for a Bill Cycle in the system.

Authorizations:
SWT
path Parameters
billCycleID
required
integer
Example: 1

Unique identifier for the Billing Cycle.

Request Body schema: application/json
Array
allowSubmission
boolean

Indicates if submissions are allowed for this config.

billRunConfigID
required
integer

Unique identifier for the Bill Run Config.

enabled
boolean

Indicates if the config is enabled.

requestTemplateID
integer

Unique identifier for the associated request template.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Bypassed Covered Hotlines

Resources related to the management of Bypassed Covered Hotlines.

Search Bypassed Covered Hotlines Summary

Returns a summary of the Bypassed Covered Hotlines.

Available Fields

The following is a list of fields for a Bypassed Covered Hotlines Sumamry and how they can be used within a search.

  • Filterable : eventType, origNumber, termNumber, dateTime, seconds, fileName, recordNumber, processedDate
  • Sortable : eventType, origNumber, termNumber, dateTime, seconds, fileName, recordNumber, processedDate
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
{
  • "eventDate": "2023-10-01T12:00:00.000Z",
  • "eventType": "8xx",
  • "fileName": "file_1234567890.txt",
  • "origNumber": "1234567890",
  • "processedDate": "2023-10-01T12:00:00.000Z",
  • "recordNumber": 1,
  • "seconds": 3600,
  • "termNumber": "1234567890"
}

Bill Period

Resources related to the management of Bill Periods.

Search Bill Periods

Search for Bill Periods in the system. [Rev 1.10]

Available Fields

The following is a list of fields for an E-Rate FRN and how they can be used within a search.

  • Filterable : ApprovalDate, ArchiveDate, BillCycle, BillCycleID, BilledCount, BilledDate, BillPeriodID, BillingStatus, BillingStatusID, ClosedDate, DayOfMonth, EndDate, GLRollupDate, IsLECBilled, LoadCloseDate, LoadGraceEnd, LoadGraceStart, LoadingStatus, LoadingStatusID, OpenDate, Name, NextEndDate, StartDate, UsageName, CampaignID, CampaignCreateDate
  • Sortable : ApprovalDate, ArchiveDate, BillCycle, BillCycleID, BilledCount, BilledDate, BillPeriodID, BillingStatus, BillingStatusID, ClosedDate, DayOfMonth, EndDate, GLRollupDate, IsLECBilled, LoadCloseDate, LoadGraceEnd, LoadGraceStart, LoadingStatus, LoadingStatusID, OpenDate, Name, NextEndDate, StartDate, UsageName, CampaignID, CampaignCreateDate
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"
}

Publish Invoices for Bill Period

Make invoices in the specified bill period customer viewable. [Rev 1.22]

Authorizations:
SWT
path Parameters
billPeriodID
required
integer
Example: 11090401

The unique identifier for the bill period in which invoices will be made customer viewable.

Responses

Associate Campaign to Bill Period

Update Bill Period to Indicate Campaign Invoices Have Been Sent.

Authorizations:
SWT
path Parameters
billPeriodID
required
integer
Example: 11090401

The unique identifier for the bill period in which campaign invoices have been sent.

Request Body schema: application/json
campaignID
required
integer

The unique identifier of the campaign.

Responses

Request samples

Content type
application/json
{
  • "campaignID": 5001
}

Create Bill Run

Create a Bill Run for the specified Bill Period. [Rev 1.25]

Authorizations:
SWT
path Parameters
billPeriodID
required
integer
Example: 11090401

The unique identifier for the bill period in which the Bill Run is associated to.

Responses

Response samples

Content type
application/json
{
  • "billRunID": 3001,
  • "createDate": "2024-01-15T10:20:30Z",
  • "createUser": "adminUser",
  • "lastModifiedUser": "adminUser2",
  • "steps": [
    ]
}

Get Bill Run

Get Bill Run for the specified Bill Period. [Rev 1.25]

Authorizations:
SWT
path Parameters
billPeriodID
required
integer
Example: 11090401

The unique identifier for the bill period in which the Bill Run is associated to.

Responses

Response samples

Content type
application/json
{
  • "billRunID": 3001,
  • "createDate": "2024-01-15T10:20:30Z",
  • "createUser": "adminUser",
  • "lastModifiedUser": "adminUser2",
  • "steps": [
    ]
}

Get Invoice Generation Statistics

Get Invoice Generation Statistics for the specified Bill Period. [Rev 1.26]

path Parameters
billPeriodID
required
integer
Example: 11090401

The unique identifier for the bill period in which the Bill Run is associated to.

Responses

Response samples

Content type
application/json
{
  • "pdfFileCount": 1000,
  • "pdfMaxFileDate": "2024-01-15T12:45:00Z",
  • "pdfMinFileDate": "2024-01-15T10:20:30Z",
  • "xmlFileCount": 1000,
  • "xmlMaxFileDate": "2024-01-15T12:45:00Z",
  • "xmlMinFileDate": "2024-01-15T10:20:30Z"
}

Search Requests Associated to Bill Run Steps

Returns requests associated to the bill run step for the specified bill period. [Rev 1.25]

  • Filterable: requestID, requestTypeID, requestStatusID, requestPriorityID, requestJobID, startDate, runDate, endDate, billRunStepID
  • Sortable: requestID, requestStatusID, startDate, endDate, runDate, billRunStepID
Authorizations:
SWT
path Parameters
billPeriodID
required
integer

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

$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 Bill Run Step

Runs a BillRunStep. [Rev 1.25]

Authorizations:
SWT
path Parameters
billPeriodID
required
integer

The ID of the Bill Period.

billRunStepID
required
integer

The ID of the Bill Run Step.

Request Body schema: application/json
Array of objects (RunBillRunOverrideParameter)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "billRunStatusID": 1,
  • "requestID": 123
}

General Ledger

Resources related to the management of General Ledger.

Search Output Method

Get the output method for the General Ledger.

Available Fields

The following is a list of fields for a General Ledger Output Method and how they can be used within a search.

  • Filterable : outputMethodID, name, storedProcedureName
  • Sortable : ouutputMethodID, name, storedProcedureName
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"
}

GL Output Method Extract

Executes the specified General Ledger Output Method and returns the results.

Authorizations:
SWT
Request Body schema: application/json
outputMethodID
required
number

Unique identifier of the general ledger output method

runDate
required
date-time

Date that is used to run the General Ledger Output Method

Responses

Request samples

Content type
application/json
{
  • "outputMethodID": 1,
  • "runDate": "2024-12-01T00:00:00.000Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Search General Ledger Action Log

Search for General Ledger Action Log in the system.

Available Fields

The following is a list of fields for an General Ledger Action Log and how they can be used within a search.

  • Filterable : generalLedgerActionLogID, startDate, endDate, transactionDate, transactions, transactionAmount, transactionDeltaAmount, netSuiteJournalEntryID, outputMethodID, repostID, message
  • Sortable : generalLedgerActionLogID, startDate, endDate, transactionDate, transactions, transactionAmount, transactionDeltaAmount, netSuiteJournalEntryID, outputMethodID, repostID, message
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"
}

Create General Ledger Action Log

Creates a General Ledger NetSuite Action Log.

Authorizations:
SWT
Request Body schema: application/json
endDate
date-time

Date and Time the action ended.

outputMethodID
required
number

Unique identifier of the general ledger output method.

message
string

Extra data about each log entry including errors.

netSuiteJournalEntryID
number

Unique Identifier of the Net Suite Journal Entry created.

repostID
number

Unique Identifier of the action log that was redone due to re-posted GL data.

startDate
required
date-time

Date and Time the action started.

transactionAmount
required
decimal

The sum of the amount of the credit/debit values of all the transactions created in the NetSuite Journal Entry.

transactionDate
required
date-time

Year and Month of the GL data.

transactionDeltaAmount
required
decimal

The sum of the amount of the credit - debit values of all the transactions created in the NetSuite Journal Entry.

transactions
required
number

Number of transactions created in the NetSuite Journal Entry.

Responses

Request samples

Content type
application/json
{
  • "endDate": "2025-02-12 13:40:55.7587047 -05:00",
  • "outputMethodID": 1,
  • "message": "Message",
  • "netSuiteJournalEntryID": 1,
  • "repostID": 1,
  • "startDate": "2025-02-12 11:40:55.7587047 -05:00",
  • "transactionAmount": 10,
  • "transactionDate": "2025-02-12 13:40:55.7587047 -05:00",
  • "transactionDeltaAmount": 5.5,
  • "transactions": 5
}

Response samples

Content type
application/json
[
  • {
    }
]

Update General Ledger Action Log

Updates an existing General Ledger NetSuite Action Log.

Authorizations:
SWT
path Parameters
generalLedgerActionLogID
required
number
Example: 1

Unique identifier of the IDI NetSuite General Action Log.

Request Body schema: application/json
endDate
date-time

Date and Time the action ended.

outputMethodID
required
number

Unique identifier of the general ledger output method.

message
string

Extra data about each log entry including errors.

netSuiteJournalEntryID
number

Unique Identifier of the Net Suite Journal Entry created.

repostID
number

Unique Identifier of the action log that was redone due to re-posted GL data.

startDate
required
date-time

Date and Time the action started.

transactionAmount
required
decimal

The sum of the amount of the credit/debit values of all the transactions created in the NetSuite Journal Entry.

transactionDate
required
date-time

Year and Month of the GL data.

transactionDeltaAmount
required
decimal

The sum of the amount of the credit - debit values of all the transactions created in the NetSuite Journal Entry.

transactions
required
number

Number of transactions created in the NetSuite Journal Entry.

Responses

Request samples

Content type
application/json
{
  • "endDate": "2025-02-12 13:40:55.7587047 -05:00",
  • "outputMethodID": 1,
  • "message": "Message",
  • "netSuiteJournalEntryID": 1,
  • "repostID": 1,
  • "startDate": "2025-02-12 11:40:55.7587047 -05:00",
  • "transactionAmount": 10,
  • "transactionDate": "2025-02-12 13:40:55.7587047 -05:00",
  • "transactionDeltaAmount": 5.5,
  • "transactions": 5
}

Response samples

Content type
application/json
[
  • {
    }
]

Bill Run Config

Resources related to the management of Bill Run Config.

Search Bill Run Config

Provides the ability to search the for Bill Run Configs in the system.

Available Fields

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

  • Filterable: billRunConfigID, name, description, locked, allowSubmission, allowRequestTemplate
  • Sortable: billRunConfigID, name, description, locked, allowSubmission, allowRequestTemplate
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
required
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"
}

Bill Run Status

Resources related to the management of Bill Run Status.

Search Bill Run Status

Provides the ability to search for Bill Run Statuses in the system. [Rev 1.25]

Available Fields

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

  • Filterable: billRunStatusID, name
  • Sortable: billRunStatusID, 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
required
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"
}

NetSuite

Resources related to the management of Net Suite.

Create Journal Entry in NetSuite

Create a journal entry in NetSuite.

Authorizations:
SWT
Request Body schema: application/json
externalId
required
string

Unique ID of the IDI NetSuite GL Action Log.

transactionDate
required
date-time

Year and Month will be used for the transaction data.

subsidiary
required
string

Unique ID of the Subsidiary in NetSuite. NetSuite Configuration Data Subsidiary

required
Array of objects (JournalEntryLineItem)

Responses

Request samples

Content type
application/json
{
  • "externalId": "1234",
  • "transactionDate": "2016-09-09",
  • "subsidiary": "1",
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "netSuiteJournalEntryID": "1234"
}

Update Journal Entry in NetSuite

Update a journal entry in NetSuite.

Authorizations:
SWT
path Parameters
netSuiteJournalEntryID
required
number
Example: 1

ID of the NetSuite Journal Entr to update.

Request Body schema: application/json
externalId
required
string

Unique ID of the IDI NetSuite GL Action Log.

transactionDate
required
date-time

Year and Month will be used for the transaction data.

subsidiary
required
string

Unique ID of the Subsidiary in NetSuite. NetSuite Configuration Data Subsidiary

required
Array of objects (JournalEntryLineItem)

Responses

Request samples

Content type
application/json
{
  • "externalId": "1234",
  • "transactionDate": "2016-09-09",
  • "subsidiary": "1",
  • "transactions": [
    ]
}

Search NetSuite Accounts

Get the Accounts From NetSuite

Authorizations:
SWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Derive Search String

Resources related to the management of Derive Search Strings.

Create or Update Derive Search String

Updates or creates a new Derive Search String based on the supplied 'code' and 'number' [Rev 1.19]

The 'code' and 'number' are used to identify the Derive Search String, both must match an existing one in the system to update it, otherwise a new Derive Search String will be created.

Authorizations:
SWT
path Parameters
number
required
string
Example: 1234

The length of the number value must be less than or equal to 255

code
required
string
Example: _CH

The length of the code value must be less than or equal to 3

Request Body schema: application/json
comparisonType
required
integer
Enum: 1 2 3

The ID which corresponds to the type of comparison used for the Derive Search String: 1 = Equals, 2 = Starts With, 3 = Ends With

description
string

The description of the Derive Search String. The max length is 80 characters.

serviceTypeID
required
integer

The ID of the service type associated to the Derive Search String

systemIdentifier
integer

The ID of the system identifier associated to the Derive Search String

Responses

Request samples

Content type
application/json
{
  • "comparisonType": 1,
  • "description": "Description",
  • "serviceTypeID": 105,
  • "systemIdentifier": 15
}

Response samples

Content type
application/json
{
  • "comparisonType": 1,
  • "description": "This is the description",
  • "frontEndID": "SMS",
  • "serviceTypeID": 105,
  • "systemIdentifier": 15,
  • "termNumberID": 10,
  • "termNumberString": "5555"
}

Cleanup Covered Hotlines

Removes all Derive Search Strings for covered hotlines where the SystemIdentifier is populated and does not match the requested SystemIdentifier. A covered hotline is a derive search string that has a code of "_CH". [Rev 1.19]

Authorizations:
SWT
Request Body schema: application/json
systemIdentifier
required
integer

The ID of the system identifier associated to the Derive Search String

Responses

Request samples

Content type
application/json
{
  • "systemIdentifier": 15
}

ID Lookup

Resources related to the ID Lookup.

Search ID Records

Provides the ability to search for ID records in the system.

Available Fields

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

  • Filterable: Id, ObjectType, AccountNumber, DisplayName
  • Sortable: Id, ObjectType, AccountNumber, DisplayName

The following is a list of object types that are included in search.

  • ObjectType: customer, product, service, feature
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
required
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"
}

Release Notes

Release Notes 1.26

Release Notes 1.25

Release Notes 1.24

Release Notes 1.23

Release Notes 1.22

  • Added the following to the response of Search Bill Periods GET api/BillPeriod:
    • approvedByUserID
    • billingCycleClassID
    • billingCycleClass
    • billCycleEndDate
    • billCycleStartDate
    • billRunStats
    • customerViewable
    • invoiceUploadDate
  • Added Publish Invoices for Bill Period POST api/BillPeriod/{billPeriodID}/PublishInvoices

Release Notes 1.21

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

Release Notes 1.20

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

Release Notes 1.18

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

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

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

Release Notes 1.12

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

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

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

Release Notes 1.08

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

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

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

Release Notes 1.04

Release Notes 1.03

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

Release Notes 1.02

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

Release Notes 1.01

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

Release Notes 1.00

  • Initial Release