API Release Notes

2.8.8.0

Methods

Change

GET api/site/\{id}/servicecharge

GET
api/site/\{id}

 

Requesting a site that
is associated with a company that is not flagged as a ‘customer’ now returns
an appropriate response rather than a permissions error.

2.8.7.4

Methods

Change

GET api/company

 

Not suppling optional parameters returned a response of HTTP status
code 500 rather than returning companies.

 

GET api/company/CompanySearch

GET api/site/sitesearch

GET api/cli

GET api/chargegroup

GET api/servicechargetype/V2/carrierdescription

GET api/servicechargetype

GET api/tariff

GET api/common/BillingPeriodSearch

GET api/invoice/V2/ByPeriod/

GET api/cdr/Summary

GET api/revenueassurance/V2/GetBillingServiceCharges

GET api/servicecharge

 

For methods that can return paged data, the FilteredRecords
property now consistantly returns the count of
records that fall within the specified criteria (outside the values specified
via the paging parameters).

 

2.8.7.2

Methods

Change

GET api/invoice/ByPeriod/

GET api/invoice/V2/ByPeriod/

 

Credit notes no
longer return zero values rather than their (negative) value

 

GET api/invoice/ByPeriod/{id}

 

Method now no
longer failing to return all records

 

GET api/cli/balance/bycli/

 

The API call now
returns a 500 if the call to SBS is not successful.  Furthermore, if the call is successful but
an outstanding balance record is not found for a CLI, then a 500 is returned
as well, but with a specific ‘Outstanding Balance for CLI {x} not found’
message.

 

2.8.6.51

Methods

Change

GET api/site/{siteid}/cli  This method now returns the Presentation
Number field

GET api/CustomProperty/{entityName}/ByEntityId/{entityId}

GET api/CustomProperty/{entityName}/{controlId}?value={value}

 

Custom Properties methods no longer fail to return newer custom
properties.

 

GET api/invoice/ByPeriod/{BillingPeriodId}

GET api/invoice/V2/ByPeriod/{BillingPeriodId}

 

Specifying a column on which to sort no longer returns a HTTP status
code 500

 

2.8.6.47

Methods

Change

GET API/servicecharge/{id}

 

Service Charge method no longer returning erroneous results

 

PATCH api/servicecharge/\{id}

 

Decimal numbers are no longer being rounded to the nearest integer

 

2.8.6.42

Methods

Change

GET api/CustomerCLI

 

Total records and filtered records counts now
included the response.

 

GET api/site/{siteid}/servicecharge/cli/{cli}

 

This method now returns all charges for a specified CLI even if the
end date is in the past.  This method
has also been made much more efficient.

 

2.8.6.37

Methods

Change

PATCH api/servicecharge

 

This method is no
longer returning a spurious CLI when none is specified

 

2.8.6.36

Methods

Change

GET api/company/CompanySearch

 

NEW FIELDS

PrimaryAccMgr

PrimaryAgent

 

NEW FILTER PARAMETERS

updatedafter

 

METHOD IMPROVEMENTS

Return empty response if no data

Add CurrentPageNumber in the response.

Add Page_No parameter

Verify TotalRecords and FilteredRecords
count.

Validate request parameters.

Add fields to the response, DateSigned, DateLive, DateReceived, LastContacted.

 

GET api/site/sitesearch

 

NEW FIELDS

LastUpdated

 

NEW FILTER PARAMETERS

updatedafter

 

RESPONSE IMPROVMENTS

Return empty response if there is no data.

 

GET api/cli

 

NEW FIELDS

CancelDate

ChargesEndDate

 

NEW FILTER PARAMETERS

updatedafter

 

GET api/chargegroup

 

NEW FILTER PARAMETERS

updatedafter

 

RESPONSE IMPROVEMENTS

Verify that the pagesize, page number and
count is working as expected.

Return empty response if there is no data.

 

GET api/servicechargetype/V2/carrierdescription

 

New method

 

INCLUDED FIELDS

LastUpdated

 

INCLUDED PARAMETERS

updatedafter

 

RESPONSE IMPROVEMENTS

Return empty response if there is no data.

Added pagination and count in the response.

 

GET api/tariff

 

NEW FIELDS

LastUpdated

 

NEW FILTER PARAMETERS

LastUpdated

 

GET api/common/BillingPeriodSearch

 

NEW FIELDS

PeriodId

PeriodDate

Monthly

Closed

LastUpdated

 

NEW FILTER PARAMETERS

IsClosed

UpdatedAfter

 

RESPONSE IMPROVEMENTS

Return empty response if there is no data.

Added pagination, totalrecords and filteredrecords in the response.

 

GET api/invoice/V2/ByPeriod/{BillingPeriodID}

New Method

INCLUDED FIELDS

AccountId

AccountRef

PeriodId

SingleText

TmpSiteName

TotalServiceChargesCost (maps to TotRecCost)

ServiceCharges (maps to TotRec)

 

Note: There is no ‘lastupdated’ field on
this method as it would be redundant.

 

INCLUDED PARAMETERS

BillingPeriod

 

RESPONSE

Validate request parameter.

Verify that the pagesize and page number is
working as expected.

Add currentpagenumber, TotalRecords,
FilteredRecords in the response.

 

GET api/cdr/Summary

 

New Method to return CDR Summary details with paging and billing
period parameters

 

FIELDS

BillingAddress

CallType

Carrier

CarrierCost

Chargecode

CLIId

Cost

CustomerTariff

Minutes

Number

BillingPeriodId

SiteId

 

FILTER PARAMETERS

BillingPeriodId

BillingAddress

BillRun

Page_no

Sort_column

Sort_direction

Page_size

search_text

 

RESPONSE IMPROVEMENTS

Return empty response if no data.

Add CurrentPageNumber in the response.

Verify TotalRecords and FilteredRecords
count.

Validate request parameters.

 

GET api/revenueassurance/V2/GetBillingServiceCharges           

 

New method

INCLUDED FIELDS

BillingAddress

BillingId (maps to CLI)

Type (maps to r_ChargeDesc)

PeriodId

Description (maps to r_Desc)

Frequency (maps to r_Frequency_Type)

WriteInChargeId (maps to r_Id)

Rental (maps to r_Rental)

SiteId  (maps to r_siteID)

Quantity (maps to Quantity)

CalculatedBuyPrice (maps to r_RealCost)

SellPrice  (maps to r_default)

 

RESPONSE

CurrentPageNumber, FilteredRecords in the response.

PageNo in
the request.

 

api/servicecharge

NEW FILTER PARAMETERS

updatedafter