API - Recommended API per version

Action

Method

API

Swagger

Create a customer

POST

/v1/accountManagement/customers

V1

Update a customer

PUT

/v1/accountManagement/customers

V1

Get a customer

GET

/v1/accountManagement/customers

V1

Delete a customer

DEL

/v1/accountManagement/customers

V1

Create a customerAccount 

POST

/v1/accountManagement/customerAccounts

V1

Get a customerAccount

GET

/v1/accountManagement/customerAccounts

V1

Update a customerAccount

PUT

/v1/accountManagement/customerAccounts

V1

Delete a customerAccount 

DEL

/v1/accountManagement/customerAccounts

V1

Create a billingAccount

POST

/v1/accountManagement/billingAccounts

V1

Get a billingAccount

GET

/v1/accountManagement/billingAccounts

V1

Update a billingAccount

PUT

/v1/accountManagement/billingAccounts

V1

Delete a billingAccount

DEL

/v1/accountManagement/billingAccounts

V1

Create a userAccount

POST

/v1/accountManagement/userAccounts

V1

Get a userAccount

GET

/v1/accountManagement/userAccounts

V1

Update a userAccount

PUT

/v1/accountManagement/userAccounts

V1

Delete a userAccount

DEL

/v1/accountManagement/userAccounts

V1

Create a subscription

POST

/v1/accountManagement/subscriptions

V1

Get all subscription

GET

/v1/accountManagement/subscriptions

V1

Get a subscription

GET

/v1/accountManagement/subscriptions/{subscriptionCode}

V1

Activate a subscription

PUT

/v1/accountManagement/subscriptions/{subscriptionCode}/activate

V1

Suspend a subscription

PUT

/v1/accountManagement/subscriptions/{subscriptionCode}/suspend

V1

Update a subscription

PUT

/v1/accountManagement/subscriptions/{subscriptionCode}/updateServices

V1

Terminate a subscription

PUT

/v1/accountManagement/subscriptions/{subscriptionCode}/terminate

V1

Create a new access

POST

/v1/accountManagement/accesses

V1

Create new or update an existing access

POST

/v1/accountManagement/accesses/{accessCode}/creationOrUpdate

V1

Update an existing access

PUT

/v1/accountManagement/accesses/{accessCode}

V1

List Access filtered by subscriptionCode

GET

/v1/accountManagement/subscriptions/{subscriptionCode}/accesses

V1

Search for an access with a given access code and subscription code.

GET

/v1/accountManagement/subscriptions/{subscriptionCode}/accesses/{accessCode}

V1

Action

Method

API

Swagger

Create Product

POST

/catalog/products

V0

Create a Version of Product

POST

/catalog/products/productVersions

V0

Read Product

GET

/catalog/products/{{productCode}}

V0

Read  Product Version

GET

/catalog/products/{{productCode}}/productVersions/{{productVersion}}

V0

Activate Product

PUT

/catalog/products/{{productCode}}/status/{status}

V0

Create Recurring Charge Template

POST

/catalog/recurringChargeTemplate/createOrUpdate

V0

Create Usage Charge Template

POST

/catalog/usageChargeTemplate/createOrUpdate

V0

Create OneShot Charge Template

POST

/catalog/oneShotChargeTemplate/createOrUpdate

V0

Create Attribute

POST

/attributes

V0

Update Attribute

PUT

/attributes

V0

Read Attribute

GET

/attributes/{{code}}

V0

Delete Attribute

DELETE

/attributes/{{code}}

V0

Create Article

POST

/v2/articles

V2

Read Article

GET

/v2/articles

V2

Update Article

PUT

/v2/articles/{{id}}

V2

Create STANDARD Accounting Article

POST

/v2/articles (cet URL est similaire que le premier POST?)

V2

Create Price Plan Matrix 1 w/ Recurring Charge

POST

/catalog/pricePlan

V0

Read Price Plan Matrix with Recurring Charge

GET

/catalog/pricePlan?pricePlanCode={{ppmRcCode}}

V0

Create Price Plan Matrix 2 w/ OneShot Charge

POST

/catalog/pricePlan (cet URL est similaire que le premier POST?)

V0

Read Price Plan Matrix with OneShot Charge

GET

/catalog/pricePlan?pricePlanCode={{ppmRcCode}}

V0

disable Price Plan Matrix

POST

/catalog/pricePlan/{{ppmRcCode}}/disable

V0

enable Price Plan Matrix

POST

/catalog/pricePlan/{{ppmRcCode}}/enable

V0

List Price Plans by Charge Code

GET

/catalog/pricePlan/list?eventCode={{recChargeTemplateCode}}

V0

Publish Price Plan Matrix Version

PUT

/catalog/pricePlan/{{ppmRcCode}}/pricePlanMatrixVersions/{{ppmRcVersion}}/status/{status}

V0

Create new or update an existing business offer model.

POST

/catalog/businessOfferModel/createOrUpdate

V0

Read existing business offer model.

GET

/catalog/businessOfferModel

V0

Action

Method

API

Swagger

reserveCdrList

POST

/v2/mediation/cdrs/reserveCdrList

V2

registerCdrList

POST

/v2/mediation/cdrs/registerCdrList

V2

chargeCDRList 

POST

/v2/mediation/cdrs/chargeCdrList

V2

Action

Method

API

Swagger

Create a Quote

POST

/cpq/quotes

V0

Read The Quote

GET

/cpq/quotes/{{quoteCode}}

V0

Publish The Quote Version

PUT

/cpq/quotes/quoteVersions/{{quoteCode}}/{{quoteVersion}}/status/{status}

V0

Quote Quotation

POST

/cpq/quotes/quoteVersions/{{quoteCode}}/{{quoteVersion}}/quotation

V0

Generate Quote XML

POST

/cpq/quotes/quoteVersions/{{quoteCode}}/{{quoteVersion}}/xmlGeneration

V0

Generate Quote PDF

POST

/cpq/quotes/quoteVersions/{{quoteCode}}/{{quoteVersion}}/pdfGeneration?generatePdf=true

V0

Create a quote item

POST

/cpq/quotes/quoteItems

V0

Modify a quote item

PUT

/cpq/quotes/quoteItems

V0

Delete a quote

DEL

/cpq/quotes/{{quoteCode}}

V0

Create a quote version

POST

/cpq/quotes/quoteVersions

V0

update a quote version of status

PUT

/cpq/quotes/quoteVersions/{quoteCode}/{currentVersion}/status/{status}

V0

Get List of quote offer by quote code and quote version number

GET

/cpq/quotes/quoteItems/{quoteCode}/quoteVersions/{quoteVersion}

V0

duplicate a quote version

POST

/cpq/quotes/quoteVersions/{quoteCode}/{quoteVersion}/duplication

V0

Delete a quote version

DEL

/cpq/quotes/quoteVersions/{quoteCode}/{quoteVersion}

V0

Place The Order

POST

/cpq/quotes/{{quoteCode}}/quoteVersions/{{quoteVersion}}/orderPlacement

V0

Return an order

GET

/orderManagement/commercialOrders/{orderId}

V2

Update The Commercial Order for a user account

PUT

/orderManagement/commercialOrders/{{commercialOrderId}}/userAccounts/{{userAccountCode}}

V2

delete an existing order

DEL

/orderManagement/commercialOrders/{orderId}

V2

partially update an existing order

PATCH

/orderManagement/commercialOrders

V2

Return a list of orders

GET

/orderManagement/commercialOrders

V2

Action

Method

API

Swagger

Finds an invoice based on invoice number and invoice type. It returns the result as xml string

GET

/invoice​/getXMLInvoiceWithType

V0

Finds an invoice based on invoice number and invoice type and return it as pdf as byte []

GET

/invoice​/getPdfInvoiceWithType

V0

Search for an invoice given an invoice id or invoice number and invoice type.

GET

/invoice

V0

Create invoice. Invoice number depends on invoice type

POST

/invoice

V0

Generate a Draft invoice

POST

/invoice​/generateDraftInvoice

V0

Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string.

POST

/invoice​/fetchXMLInvoice

V0

Finds an invoice based on its invoice number and return it as xml string.

GET

/invoice​/getXMLInvoice

V0

Finds an invoice based on invoice number and optionally an invoice type and return it as pdf as byte []

POST

/invoice​/fetchPdfInvoice

V0

Finds an invoice based on invoice number and return it as pdf as byte []

GET

/invoice​/getPdfInvoice

V0

List invoices matching a given criteria.

GET

/invoice​/list

V0

Launch all the invoicing process for a given billingAccount, that's mean

POST

/invoice​/generateInvoice

V0

Send invoice by Email.

POST

/invoice​/sendByEmail

V0

Cancel an invoice based on invoice id.

POST

/invoice​/cancel

V0

List invoices matching a given criteria

GET

/invoice​/listGetAll

V0

Validate an invoice based on invoice id.

PUT

/invoice​/validate

V0

Validate an invoice based on the invoice id.

POST

/invoice​/validate

V0

duplicate invoice

POST

/v2​/billing​/invoices​/{invoiceId}​/duplication

V2

Duplicate invoice lines

POST

/v2​/billing​/invoices​/{id}​/invoiceLines​/duplicate

V2

Action

Method

API

Swagger

Creates automated payment. It also process if a payment is matching or not

POST

/payment

V0

Returns a list of account operations along with the balance of a customer.

GET

/payment/customerPayment

V0

List invoices matching a given criteria.

POST

/payment/history/list

V0

Retrieve payment method by its id.

GET

/payment​/paymentMethod

V0

Update existing payment method.

PUT

/payment​/paymentMethod

V0

Add a new payment method. It will be marked as preferred.

POST

/payment​/paymentMethod

V0

Remove payment method.

DEL

/payment​/paymentMethod

V0

Retrieve payment gateway by its code.

GET

/payment​/paymentGateway

V0

Update existing payment gateway.

PUT

/payment​/paymentGateway

V0

Add a new payment gateway.

POST

/payment​/paymentGateway

V0

Remove payment gateway.

DEL

/payment​/paymentGateway

V0

Enable a Payment gateway with a given code

POST

​/api​/rest​/payment​/paymentGateway​/{code}​/enable

V0

Disable a Payment gateway with a given code

POST

​/api​/rest​/payment​/paymentGateway​/{code}​/disable

V0

Action

Method

API

Swagger

Export price plan matrix versions

POST

/api/rest/v2/catalog/priceManagement/pricePlanMatrixVersions/export

V2

Import price plan versions

POST

/api/rest/v2/catalog/priceManagement/pricePlanMatrixVersions/import

V2

Import grid data in price versions

POST

/api/rest/v2/catalog/priceManagement/pricePlanMatrixLines/import

V2

Check if the current price plan version is used

GET

/api/rest/v2/pricePlans/{pricePlanMatrixCode}/pricePlanVersions/{pricePlanMatrixVersion}/checkIfUsed

V2