API Release Notes

3.28.125 Release (Jan. 9, 2024)

Standard Reseller API Updates

The GET/api/subscriptions/{subscriptionId}/currentInstallmentplan has been implemented in the Standard Resellers API. The call is used to determine whether a subscription has monthly installments.

The IsUsageBased property has been added to the GET api/subscriptions/{subscriptionId} endpoint. The call is used to determine whether a subscription is usage-based.

3.28.116 Release (Nov. 13, 2023)

New API Endpoint Properties Showing Date of Creation/Last Update

API users can now retrieve accounts which have updated their billing address after a specific date. As a result, customers who have integrated the platform with 3rd party CRM software, will see that when a field is updated in the interworks.cloud platform the CRM will be updated accordingly to reflect this.

The CreatedAt and UpdatedAt properties have been added to the billingAddress object for GET /api/accounts, as well as the minBillingAddressUpdatedAt parameter, which can be used combined with the billingAddress object in an Accounts API call to specify a date as the lower limit for the desired result.

Example:

/api/accounts?include=billingaddress&minBillingAddressUpdatedAt=2023-11-03

This example will return all accounts whose billing addresses were last updated on or after Nov. 3rd, 2023.

Please note that the CreatedAt and UpdatedAt properties were created in September 2023. Therefore, all Billing Addresses created before this date will have their CreatedAt date (and UpdatedAt date, if they have not been updated) set to September 2023.
For further assistance concerning this topic, you can contact our support department, even if you haven’t managed to update your infrastructure with this release.

3.28.114 Release (Oct. 27, 2023)

 Subscription API (V.3)Assets API (V.3)
Improvement DescriptionThis endpoint has been added to API V3. The purpose of this endpoint is to update asset custom fields which have been created by a service manager.This endpoint sets IDs for your assets in external systems.
Affected End-Point(s)PUT api/subscriptions/{subscriptionId}/customfieldsPOST api/assets/{assetId}/setexternalId Endpoint

3.28.110 Release (Oct. 02, 2023)

 Order API (V.3)
Improvement DescriptionCreates a change quantity request (decrease/increase) of an existing subscription in order to support asynchronous flow of the change quantity process.Returns the status of a change request for an existing subscription, allowing you to track its progress.
Affected End-PointPOST /api/Subscriptions/{subscriptionId}/quantity
GET /api/subscriptions/{subscriptionId}/quantityrequest/{requestId}

3.28.107 Release (Sep. 11, 2023)

The GET /api/files/folders endpoint has been updated with filter and orderby capabilities. For more info, please see the following links:

Documents ($filter)
Documents ($orderby)

3.28.106 Release (Sep. 04, 2023)

With this release the PUT /api/orders/{orderId}/customfields public API V3 order endpoint has been updated with changes related to order scheduling.

For more information, please visit the Swagger documentation at yourBSS.URL/apidocs and select API Version 3.

3.28.105 Release (Aug. 23, 2023)

Updates to APIv3 Order Endpoints

With this release, the PATCH /api/orders/{orderId} public API V3 order endpoint, has been updated with changes related to order scheduling.

For more information, please visit the Swagger documentation at yourBSS.URL/apidocs and select API Version 3.

3.28.104 Release (Aug 04, 2023)

 Documents API (V.3)
Improvement DescriptionNew API V.3 endpoint that provides the user with the option to update the characteristics of a subscription, based on the given ID, with the new characteristics values and effective date.
Affected End-PointPATCH /api/subscriptions/{subscriptionId}/characteristics

3.28.103 Release (Jul 28, 2023)

Public API – Added “Document Type” to Endpoints

 Documents API (V.3)
Improvement Description The endpoints below have had the Document Type added.
Affected End-PointGET /api/files
PATCH /api/files/{fileId}
GET /api/files/{fileId}
POST /api/files

For more information, please visit the Swagger documentation at yourBSS.URL/apidocs and select ‘API Version 3’.

3.28.100 Release (Jul 07, 2023)

Documents Methods Added to Public API

With this release, please note the 8 new methods which have been added to the Public API for the purposes of managing documents in the BSS:

  • Custom Fields
    • GET api/files/{fileId}/customfields – Retrieves the custom fields of a file based on the specified ID.
    • PUT api/files/{fileId}/customfields – Updates the custom fields of an existing file based on the specified ID.
  • Update File
    • PATCH api/files/{fileId} – Partially updates an existing file based on the specified ID.
  • Link/Unlink Document in Account
    • POST api/accounts/{accountId}/files/{fileId} – Link a document to an account.
    • DELETE api/accounts/{accountId}/files/{fileId} – Unlink a document from an account.
  • Retrieve Files
    • GET api/files – Retrieves the files of an organization.
    • GET/api/files/{fileId} – Retrieves a specific file based on the specified ID and on user permissions.
    • GET api/accounts/{accountId}/files – Retrieves all the files for an account.

For more information, please visit the Swagger documentation at yourBSS.URL/apidocs and select API Version 3.

3.28.98 Release (Jun 26, 2023)

Documents Methods Added to Public API

With this release, please note the four new methods which have been added to the Public API for the purposes of creating and managing documents in the BSS:

  • GET/api/files/{fileId} – This API method is used to retrieve a file based on its ID and the permission of the user making the API request.
  • GET/api/files/folders – The Get File Folders method is used to retrieve file folders.
  • POST/api/files – The purpose of this API method is to create a new file in the system.
  • DELETE/api/files/{fileId} – The purpose of this API method is to delete a file from the BSS based on the file ID.

For more information, please visit the Swagger documentation at yourBSS.URL/apidocs and select API Version 3

3.28.84 Release (Mar 1, 2023)

 Synchronization API (V.3)
Improvement DescriptionThe endpoint method can now retrieve the systemic product types as well as the child/custom product types of a service manager’s instance that have as parent the systemic product types.
Affected End-Point(s)GET api/synchronization/{systemID}/productTypesd}

3.28.81 Release (Jan 24, 2023)

Standard Edition for Resellers API: New Subscription Endpoints

The following four subscription-related endpoints have been added to API Version 3 for your Resellers in the Standard Edition:

  • GET api/subscriptions : Retrieves all the subscriptions of the organization.
  • GET api/subscriptions/{subscriptionId} : Retrieves a single subscription based on the given ID.
  • GET api/subscriptions/{subscriptionId}/customfields : Retrieves the custom fields of a subscription based on the given ID.
  • GET /api/subscriptions/{subscriptionId}/characteristics : Retrieves the characteristics of a subscription based on the given ID.

If you have an on-premise installation of our platform, the API documentation is available at the URL:
<BSS URL>/apidocs/?urls.primaryName=API%20Version%203%20for%20Resellers.

3.28.68 Release

Baskets API (V.3)
Improvement DescriptionThe change provides the ability to retrieve a specific basket based on the given ID.
Affected End-Point(s)GET /api/baskets/{basketId}
 
 Baskets API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the items of a specific basket based on the given ID.
Affected End-Point(s)GET /api/baskets/{basketId}/items
  
 Organization API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the information of the current organization as well as the value of the “billingPlansEnabled“ field that an NCE migrator user will require to be able to create NCE subscriptions with installments, since only if all Billing Plans conditions are met the creation can be achieved.
Affected End-Point(s)GET /api/organization/info
  
 Products API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the billing frequency
Affected End-Point(s)GET /api/products/{productId}/billingfrequencyoptions

3.28.67 Release

 Accounts API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the synchronization options of the given account identifier.
Affected End-Point(s)GET api/accounts/{accountId}/syncoptions/{systemId}

3.28.65 Release

 Accounts API (V.3)
Improvement DescriptionThis change concerns the column “IsAffiliatte” inside the endpoint /api/accounts which was previously returning null values but now it returns either the value true or the value false. Existing implementations will receive by default the value false to not affect them. However, the value true will be available when the retrieval of a specific account is requested and that account is an affiliate account.
Affected End-Point(s)GET /api/accounts

3.28.64 Release

 Accounts API (V.3)
Improvement DescriptionThis change provides the ability to retrieve the pricelist that the specified account would buy from the given product/unit combination. If no pricelist is found for the specific combination, it returns null. If the account is billed to a different account, then the “bill to” account is used to filter the pricelists. The account’s currency or the “bill to” account’s currency (in case the given account is billed to a different account) is used to filter the results.
Affected End-Point(s)GET /api/accounts/{accountId}/orderingpricelist
  
 Subscriptions API (V.3)
Improvement DescriptionThe change provides the ability to retrieve a single subscription’s current active installment plan (if exists), else it returns null.
Affected End-Point(s)GET api/subscriptions/{subscriptionId}/currentInstallmentplan
  
 Subscriptions API (V.3)
Improvement DescriptionThe change provides the ability to retrieve all the subscription’s installment plans that are not draft (if exists), else it returns an empty list.
Affected End-Point(s)GET api/subscriptions/{subscriptionId}/installmentplans
  
 Installment Plans API (V.3)
Improvement DescriptionThe change provides the ability to retrieves all the installment plan’s installments that are not draft (if exists), else it returns an empty list.
Affected End-Point(s)GET api/installmentplans/{installmentPlanId}/installments

3.28.63 Release

 Subscriptions API (V.3)
Improvement DescriptionThe change provides the ability to cancel a subscription immediately.
Affected End-Point(s)POST /api/subscriptions/{subscriptionId}/cancel
  
 Subscriptions API (V.3)
Improvement DescriptionThe change provides the ability to cancel a subscription at the end of its billing period.
Affected End-Point(s)POST /api/subscriptions/{subscriptionId}/cancelendofbillingperiod
  
 Subscriptions API (V.3)
Improvement DescriptionThe change provides the ability to cancel a subscription at a specific date.
Affected End-Point(s)POST /api/subscriptions/{subscriptionId}/cancelspecificdate

3.28.62 Release

 Invoices API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the orders related to an invoice.
Affected End-Point(s)GET /api/invoices/{invoiceId}/orders
  
 Products API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the information of whether a specific product has the “pricing from external systems” option enabled or not. The new field is the “hasexternalpricing“.
Affected End-Point(s)GET /api/products/{productId}/pricing

3.28.60 Release

Synchronization API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the products of a provisioning system. (External System Instance)
Affected End-Point(s)GET api/synchronization/{systemId}/products
  
 Applications API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the available service manager applications per organization.
Affected End-Point(s)GET /api/applications
  
 Applications API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the available instances of a specific service manager application.
Affected End-Point(s)GET /api/applications/{applicationId}/externalSystems
  
 ALL MODULES API (V.3)
Improvement DescriptionThe change provides the ability to use the OData $filter mechanism to filter the request response by the Id field.
Affected End-Point(s)All Endpoints Supporting OData Mechanism
ExampleGet /api/accounts?$filter=Id eq 234

3.28.59 Release

Organization API (V.3)
Improvement DescriptionThe change provides the ability to retrieve all banks of an organization.
Affected End-Point(s)GET /api/organization/banks
  
 Payments API (V.3)
Improvement DescriptionThe change provides the ability to create a new cash payment.
Affected End-Point(s)POST /api/payments/cash
  
 Payments API (V.3)
Improvement DescriptionThe change provides the ability to create a new deposit payment.
Affected End-Point(s)POST /api/payments/deposit
  
 Payments API (V.3)
Improvement DescriptionThe change provides the ability to create a new check payment.
Affected End-Point(s)POST /api/payments/check
  
 Products API (V.3)
Improvement DescriptionThe change provides the ability to retrieve whether a specific product has the external pricing option enabled or disabled.
Affected End-Point(s)GET/api/products/{productId}/pricing

3.28.58 Release

Accounts API (V.3)
Improvement DescriptionCreates a new cash payment for an account. With the following endpoint there is no connection to the invoices.
Affected End-Point(s)POST /api/accounts/{accountId}/payments/cash
 Accounts API (V.3)
Improvement DescriptionCreates a new deposit payment for an account. With the following endpoint there is no connection to the invoices.
Affected End-Point(s)POST /api/accounts/{accountId}/payments/deposit
 Accounts API (V.3)
Improvement DescriptionCreates a new check payment for an account. With the following endpoint there is no connection to the invoices.
Affected End-Point(s)POST /api/accounts/{accountId}/payments/check

3.28.56 Release

Payments API (V.3)
Improvement DescriptionThe change provides the ability to retrieve a specific payment based on the given ID.
Affected End-Point(s)GET /api/payments/{paymentId}
  
 Payments API (V.3)
Improvement DescriptionThe change provides the ability to retrieve all payments of the organization.
Affected End-Point(s)GET /api/payments

3.28.54 Release

 Products API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the storefront settings of a product.
Affected End-Point(s)GET /api/products/{productId}/storefrontsettings
  
 Products API (V.3)
Improvement DescriptionThe change provides the ability to partially update the storefront settings of a product based on the given ID.
Affected End-Point(s)PATCH /api/products/{productId}/storefrontsettings

3.28.53 Release

Orders API (V.3)
Improvement DescriptionThe change aligns the functionality of the API to that of the BSS. It concerns the related subscriptions as well as the related items for add-ons.
Affected End-Point(s)POST /api/orders/{orderId}/items
  
 Invoices API (V.3)
Improvement DescriptionThe change provides the ability to get the order item id together with all the other fields of an invoice item.
Affected End-Point(s)GET /api/invoices/{invoiceId}/items

3.28.51 Release

 OrderItems API (V.3)
Improvement DescriptionThe change provides the ability to retrieve the characteristics of a sub-item of a bundle order item based on the given IDs.
Affected End-Point(s)GET /api/orderItems/{itemId}/bundleProducts/{productId}/characteristics
 
 Products API (V.3)
Improvement DescriptionThe new endpoint provides the ability to retrieve the category path of a product.
Affected End-Point(s)GET /api/products/{productId}/categorypath
 
 Products API (V.3)
Improvement DescriptionThe new endpoint provides the ability to retrieve all product categories of the organization. (Pagination is supported)
Affected End-Point(s)GET /api/products/categories

3.28.50 Release

 OrderItems API (V.3)
Improvement DescriptionThe change provides the ability to update the characteristics of a sub-item of a bundle order item based on the given IDs.
Affected End-Point(s)PUT /api/orderItems/{itemId}/bundleProducts/{productId}/characteristics
  
 Orders API (V.3)
Improvement DescriptionThe change provides the ability to create a new order item of a bundle product and add it to an order based on the given ID.
Affected End-Point(s)POST /api/orders/{orderId}/items/bundle
  
 Invoices API (V.3)
Improvement DescriptionThis change provides the ability to update the “billing toaccount of an invoice.
Affected End-Point(s)PATCH /api/invoices/{invoiceId}/billingto

3.28.47 Release

 Products API (V.3)
Improvement DescriptionA performance improvement was made to the Products API (V.3). The change concerns the response of the following four end-points where the add-ons schema does not contain the full information of the add-on anymore but rather only the necessary information.
Affected End-Point(s)GET /api/products : Retrieves the products of the current organization.POST /api/products : Creates a new product for the current organization.GET /api/products/{productId} : Retrieves a specific product of the current organization based on the given ID.PATCH /api/products/{productId} : Partially updated an existing product of the organization based on the given ID.

3.28.45 Release

 Orders API
Improvement DescriptionInside the Orders API V3 the isBundle boolean flag is added to check whether an order item is a bundle or not.
Affected End-Point(s)GET api/orders/{orderId}/itemsGET api/orders/{orderId}/items/{itemId}

3.28.43 Release

 Organization API
Improvement DescriptionOrganization API V3 can now precisely return the billing cycle of a unit, since two new property fields, named billingCycleDuration and billingCycleUnitType, have been added inside the end-point mentioned below.
Affected End-Point(s)GET /api/organization/unitGroups/{unitGroupId}/units

For information regarding the Unit Groups $filter, please check the Platform JSON Objects page.

3.28.42 Release

 Products APIAccounts API
Improvement DescriptionProducts API V3 can now precisely screen the price lists that are returned for specific products depending on whether their active units are aligned or not. Consequently, the price list of a product (or product group) will not be returned if that product does not have active units that correspond to the active units of the price list.Accounts API V3 can now automatically assign notification plans during an account’s creation.
Affected End-Point(s)GET /api/products/{productId}/pricelistsPOST /api/accounts

Bundle Child Subscriptions API

In API v3, we introduced new methods for managing the bundle child subscriptions. More methods will be published in the following releases.

MethodDescription
GET /api/bundleChildSubscriptions/Retrieves all the bundle child subscriptions of the organization.
GET /api/bundleChildSubscriptions/{bundleChildSubscriptionId}Retrieves a bundle child subscription based on a given ID.
GET /api/bundleChildSubscriptions/{bundleChildSubscriptionId}/characteristicsRetrieves the characteristics of a bundle child subscription based on a given ID.
GET /api/bundleChildSubscriptions/{bundleChildSubscriptionId}/addonsRetrieves the add-ons of a bundle child subscription based on a given ID.
GET /api/bundleChildSubscriptions/{bundleChildSubscriptionId}/synchronizationRetrieves the synchronization info of a bundle child subscription based on a given ID.
GET /api/bundleChildSubscriptions/{bundleChildSubscriptionId}/addons/{addonId}/synchronizationRetrieves the synchronization info of a bundle child subscription add-on based on a given ID.

Please refer to the Bundle Child Subscription $filters page.