For integrating with third-party systems like SAP or Siebel we offer the following alternatives:

• Use of our interworks.cloud API
• Use of our Integration Framework
• Use of out of the box connectors
• Data Exchange through CDR files

interworks.cloud Platform API

interworks.cloud platform API is a REST API designed for retrieving customer charges, adding payments and getting customer financial details. 

REST is a web-service protocol that helps rapid development by using everyday HTTP and JSON technology. REST benefits are the following:

• Easy to use and learn for developers
• Works with virtually any language and platform
• Well-suited for solutions that fall outside the traditional desktop application model

For the methods our API supports, check interworks.cloud Platform API

interworks.cloud Integration Framework

The interworks.cloud integration framework is designed to enable data synchronization (accounts, products, invoices etc.) with third party systems. It can be used for integrating with any ERP, Finance, CRM or ticketing system that supports RESTful API. It requires no development effort since all data synchronization scenarios are defined with a use of a JSON document that follows the OpenAPI-Specification (v3) Standard. This JSON document will be used to describe the third system RESTful API (authentication, API paths and objects) and the transformation schemas between interworks.cloud and third party system data objects. 

For more details, check please Integrate to interworks.cloud

Out of box Connectors

We offer out-of-the box connectors with /wiki/spaces/ICPD/pages/4662491, /wiki/spaces/ICPD/pages/4663045, /wiki/spaces/ICPD/pages/4662953, /wiki/spaces/ICPD/pages/4664301and ConnectWise.

For more details, check please Connectors with Third Party Systems

Data Exchange through CDR Files

This is a ‘zero-touch’ integration where IwCP generates a CDR file with customers charges for the third party system to consume them. The CDR file includes the charges for the current billing cycle and is generated automatically at the end of each billing cycle. This approach can be used when you don’t want to create an intermediate layer for dynamic exchange of billing information.

The generation of the CDR file is part of our billing service. This service runs once per day and it's responsible for subscriptions renewals, trials expirations and invoices generations. If the integration via a CDR file has been enabled, our service gathers the generated invoices and creates the CDR file. Depending of the system configuration, a CDR file can be generated only once per month (if for example all customers are billed on the 1st of each month) or more than once if there are more that one billing days (e.g. there are customers that are billed on the 1st of each month and customers that are billed on 20th of each month). Our system creates one CDR file that includes one line for each invoice item IwCP has generated.

• CDR file format. The generated file can be an excel or a csv file.
  
  
• CDR file upload location. The generated file can be stored in a designated folder or it can be uploaded in an SFTP location.
   
• CDR file columns. What information the CDR file includes, it will be finalized in coordination with the service provider. A typical CDR file includes the following information:
  • Subscription_ID. The identifier of customer subscription in IwCP

  • Interwoks_CustomerID. the customer identifier in IwCP

  • ServiceProvider_CustomerID. The identifier of the customer in service provider's billing system

  • Customer_Name. The customer name

  • Service_Code. The code of the service or the add-on that is charged. Typically, we use in Cloud BSS the service codes the service provider is using already in his billing system.

  • Service_Description. The service or add-on description

  • BillingPeriod_StartDate. The start date of the chargable period. For one-off services (e.g. support services) this field has no value
  • BillingPeriod_EndDate. The end date of the chargable period. For one-off services (e.g. support services) this field has no value 

  • Quantity. the quantity that is charged

  • Unit_Price. The price per unit.

  • Discount. The applied discount for this invoice item. It can be a percentage or an amount, depending on the discount model you have defined for the specific service or customer.
  • Total. The invoice item  total 

What type of charges the CDR file will include, it depends on the charge type and models the service provider has setup in Cloud BSS. The CDR may include prorated charges, charges for services renewals, charges for one-off services etc.

CDR Sample Files

• CSV file. interworks.cloud20110910.00001.BCOCC.csv. 
• Excel file. CDR_IwCP_20121103.xls