Resources

You may also enjoy the Swagger UI provided for this API.

path methods description
  • /Communication/inbound
  • POST
  • /Communication/version
  • GET
  • /PdfInvoice
  • GET
  • /PdfInvoice/version
  • GET
  • /account/access
  • GET, POST, PUT
 
  • /account/access/createOrUpdate
  • POST
  • /account/access/list
  • GET
List Access filter by subscriptionCode.
  • /account/access/version
  • GET
  • /account/access/{accessCode}/{subscriptionCode}
  • DELETE
  • /account/accountHierarchy
  • POST, PUT
 
  • /account/accountHierarchy/createCRMAccountHierarchy
  • POST
  • /account/accountHierarchy/createOrUpdate
  • POST
Create or update Account Hierarchy based on code.
  • /account/accountHierarchy/createOrUpdateCRMAccountHierarchy
  • POST
  • /account/accountHierarchy/customerHierarchyUpdate
  • POST
  • /account/accountHierarchy/find
  • POST
Search for a list of customer accounts given a set of filter.
  • /account/accountHierarchy/findAccountHierarchy
  • POST
  • /account/accountHierarchy/updateCRMAccountHierarchy
  • POST
  • /account/accountHierarchy/version
  • GET
  • /account/billingAccount
  • GET, POST, PUT
 
  • /account/billingAccount/createOrUpdate
  • POST
Create or update Billing Account based on code.
  • /account/billingAccount/list
  • GET
List BillingAccount filter by customerAccountCode.
  • /account/billingAccount/version
  • GET
  • /account/billingAccount/{billingAccountCode}
  • DELETE
  • /account/customer
  • GET, POST, PUT
  • /account/customer/createBrand
  • POST
  • /account/customer/createCategory
  • POST
  • /account/customer/createOrUpdate
  • POST
  • /account/customer/createOrUpdateBrand
  • POST
  • /account/customer/createOrUpdateCategory
  • POST
  • /account/customer/list
  • POST
List CustomerAccount filter by customerCode.
  • /account/customer/removeBrand/{brandCode}
  • DELETE
  • /account/customer/removeCategory/{categoryCode}
  • DELETE
  • /account/customer/updateBrand
  • PUT
  • /account/customer/updateCategory
  • PUT
  • /account/customer/version
  • GET
  • /account/customer/{customerCode}
  • DELETE
  • /account/customerAccount
  • GET, POST, PUT
 
  • /account/customerAccount/createOrUpdate
  • POST
  • /account/customerAccount/creditCategory
  • DELETE, POST
  • /account/customerAccount/dunningInclusionExclusion
  • PUT
  • /account/customerAccount/list
  • GET
List CustomerAccount filter by customerCode.
  • /account/customerAccount/version
  • GET
  • /account/customerAccount/{customerAccountCode}
  • DELETE
  • /account/title
  • GET, POST, PUT
  • /account/title/createOrUpdate
  • POST
  • /account/title/version
  • GET
  • /account/title/{titleCode}
  • DELETE
  • /account/userAccount
  • GET, POST, PUT
 
  • /account/userAccount/createOrUpdate
  • POST
  • /account/userAccount/list
  • GET
List UserAccount filter by billingAccountCode.
  • /account/userAccount/version
  • GET
  • /account/userAccount/{userAccountCode}
  • DELETE
  • /accountOperation
  • POST
  • /accountOperation/list
  • GET
  • /accountOperation/version
  • GET
  • /billing/invoicing/cancelBillingRun
  • POST
  • /billing/invoicing/createBillingRun
  • POST
  • /billing/invoicing/getBillingAccountListInRun
  • POST
  • /billing/invoicing/getBillingRunInfo
  • POST
  • /billing/invoicing/getPostInvoicingReport
  • POST
  • /billing/invoicing/getPreInvoicingReport
  • POST
  • /billing/invoicing/validateBillingRun
  • POST
  • /billing/invoicing/version
  • GET
  • /billing/mediation/cancelReservation
  • POST
  • /billing/mediation/chargeCdr
  • POST
  • /billing/mediation/confirmReservation
  • POST
  • /billing/mediation/registerCdrList
  • POST
  • /billing/mediation/reserveCdr
  • POST
  • /billing/mediation/version
  • GET
  • /billing/subscription
  • GET, POST, PUT
  • /billing/subscription/activateServices
  • POST
  • /billing/subscription/applyOneShotChargeInstance
  • POST
  • /billing/subscription/createOrUpdate
  • POST
  • /billing/subscription/instantiateServices
  • POST
  • /billing/subscription/list
  • GET
List Subscription filter by userAccountCode.
  • /billing/subscription/terminate
  • POST
  • /billing/subscription/terminateServices
  • POST
  • /billing/subscription/version
  • GET
  • /billing/wallet/balance/current
  • POST
  • /billing/wallet/balance/open
  • POST
  • /billing/wallet/balance/reserved
  • POST
  • /billing/wallet/operation
  • POST
  • /billing/wallet/operation/find
  • POST
  • /billing/wallet/reservation
  • POST, PUT
  • /billing/wallet/reservation/confirm
  • POST
  • /billing/wallet/reservation/{reservationId}
  • DELETE
  • /billing/wallet/template
  • GET, POST, PUT
  • /billing/wallet/template/createOrUpdate
  • POST
  • /billing/wallet/template/{walletTemplateCode}
  • DELETE
  • /billing/wallet/version
  • GET
  • /billingCycle
  • GET, POST, PUT
 
  • /billingCycle/createOrUpdate
  • POST
  • /billingCycle/version
  • GET
  • /billingCycle/{billingCycleCode}
  • DELETE
Remove billingCycle with a given code.
  • /calendar
  • GET, POST, PUT
 
  • /calendar/createOrUpdate
  • POST
  • /calendar/version
  • GET
  • /calendar/{calendarCode}
  • DELETE
Remove calendar with a given code.
  • /catalog/chargeTemplate
  • GET
  • /catalog/chargeTemplate/version
  • GET
  • /catalog/counterTemplate
  • GET, POST, PUT
 
  • /catalog/counterTemplate/createOrUpdate
  • POST
  • /catalog/counterTemplate/version
  • GET
  • /catalog/counterTemplate/{counterTemplateCode}
  • DELETE
Remove counter template with a given code.
  • /catalog/offerTemplate
  • GET, POST, PUT
 
  • /catalog/offerTemplate/createOrUpdate
  • POST
Create or update offer template based on a given code.
  • /catalog/offerTemplate/version
  • GET
  • /catalog/offerTemplate/{offerTemplateCode}
  • DELETE
Remove offer template with a given code.
  • /catalog/oneShotChargeTemplate
  • GET, POST, PUT
 
  • /catalog/oneShotChargeTemplate/createOrUpdate
  • POST
  • /catalog/oneShotChargeTemplate/version
  • GET
  • /catalog/oneShotChargeTemplate/{oneShotChargeTemplateCode}
  • DELETE
Remove one shot charge template with a given code.
  • /catalog/pricePlan
  • GET, POST, PUT
 
  • /catalog/pricePlan/createOrUpdate
  • POST
  • /catalog/pricePlan/version
  • GET
  • /catalog/pricePlan/{pricePlanCode}
  • DELETE
Remove price plan with a given id.
  • /catalog/recurringChargeTemplate
  • GET, POST, PUT
 
  • /catalog/recurringChargeTemplate/createOrUpdate
  • POST
  • /catalog/recurringChargeTemplate/version
  • GET
  • /catalog/recurringChargeTemplate/{recurringChargeTemplateCode}
  • DELETE
Remove recurring charge template with a given code.
  • /catalog/serviceTemplate
  • GET, POST, PUT
 
  • /catalog/serviceTemplate/createOrUpdate
  • POST
  • /catalog/serviceTemplate/version
  • GET
  • /catalog/serviceTemplate/{serviceTemplateCode}
  • DELETE
Remove service template with a given code.
  • /catalog/triggeredEdr
  • GET, POST, PUT
 
  • /catalog/triggeredEdr/createOrUpdate
  • POST
  • /catalog/triggeredEdr/version
  • GET
  • /catalog/triggeredEdr/{triggeredEdrCode}
  • DELETE
Remove triggered edr with a given code.
  • /catalog/usageChargeTemplate
  • GET, POST, PUT
 
  • /catalog/usageChargeTemplate/createOrUpdate
  • POST
Create or update charge template with a given code.
  • /catalog/usageChargeTemplate/version
  • GET
  • /catalog/usageChargeTemplate/{usageChargeTemplateCode}
  • DELETE
Remove usage charge template with a given code.
  • /country
  • GET, POST, PUT
 
  • /country/createOrUpdate
  • POST
  • /country/version
  • GET
  • /country/{countryCode}/{currencyCode}
  • DELETE
Remove country with a given country and currency code.
  • /currency
  • GET, POST, PUT
 
  • /currency/createOrUpdate
  • POST
  • /currency/version
  • GET
  • /currency/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /customFieldTemplate
  • GET, POST, PUT
  • /customFieldTemplate/createOrUpdate
  • POST
  • /customFieldTemplate/version
  • GET
  • /customFieldTemplate/{customFieldTemplateCode}/{accountLevel}
  • DELETE
  • /filteredList
  • GET
  • /filteredList/version
  • GET
  • /filteredList/xmlInput
  • POST
  • /importExport/checkImportDataResult
  • GET
Check for execution results for a given execution identifier
  • /importExport/importData
  • POST
Send a file to be imported. ImportExportResponseDto.executionId contains
  • /importExport/version
  • GET
  • /invoice
  • GET, POST
 
  • /invoice/generateInvoice
  • POST
  • /invoice/getPdfInvoice
  • POST
  • /invoice/getPdfInvoiceWithType
  • POST
  • /invoice/getXMLInvoice
  • POST
  • /invoice/getXMLInvoiceWithType
  • POST
  • /invoice/version
  • GET
  • /invoiceCategory
  • GET, POST, PUT
 
  • /invoiceCategory/createOrUpdate
  • POST
Create or update invoice with a given code.
  • /invoiceCategory/version
  • GET
  • /invoiceCategory/{invoiceCategoryCode}
  • DELETE
Remove invoice with a given code.
  • /invoiceSubCategory
  • GET, POST, PUT
 
  • /invoiceSubCategory/version
  • GET
  • /invoiceSubCategory/{invoiceSubCategoryCode}
  • DELETE
Remove invoice sub category with a given code.
  • /invoiceSubCategoryCountry
  • GET, POST, PUT
 
  • /invoiceSubCategoryCountry/createOrUpdate
  • POST
Create or update Invoice SubCategory Country based on invoice sub-category and country
  • /invoiceSubCategoryCountry/version
  • GET
  • /invoiceSubCategoryCountry/{invoiceSubCategoryCode}/{country}
  • DELETE
Remove invoice sub category country with a given code and country.
  • /job/create
  • POST
  • /job/createTimer
  • POST
  • /job/execute
  • POST
  • /job/version
  • GET
  • /jobInstance
  • GET
  • /jobInstance/create
  • POST
  • /jobInstance/createOrUpdate
  • POST
  • /jobInstance/update
  • POST
  • /jobInstance/version
  • GET
  • /jobInstance/{jobInstanceCode}
  • DELETE
  • /language
  • GET, POST, PUT
 
  • /language/createOrUpdate
  • POST
  • /language/version
  • GET
  • /language/{languageCode}
  • DELETE
Remove language with a given code.
  • /notification
  • GET, POST, PUT
  • /notification/createOrUpdate
  • POST
  • /notification/email
  • GET, POST, PUT
  • /notification/email/createOrUpdate
  • POST
  • /notification/email/version
  • GET
  • /notification/email/{notificationCode}
  • DELETE
  • /notification/listInboundRequest
  • GET
  • /notification/listNotificationHistory
  • GET
  • /notification/version
  • GET
  • /notification/webhook
  • GET, POST, PUT
  • /notification/webhook/createOrUpdate
  • POST
  • /notification/webhook/version
  • GET
  • /notification/webhook/{notificationCode}
  • DELETE
  • /notification/{notificationCode}
  • DELETE
  • /occTemplate
  • GET, POST, PUT
 
  • /occTemplate/createOrUpdate
  • POST
Create or update OccTemplate
  • /occTemplate/version
  • GET
  • /occTemplate/{occTemplateCode}
  • DELETE
Remove OccTemplate with a given code.
  • /payment/create
  • POST
  • /payment/customerPayment
  • GET
  • /payment/version
  • GET
  • /provider
  • GET, POST, PUT
 
  • /provider/createOrUpdate
  • POST
  • /provider/getCustomerAccountConfiguration
  • GET
  • /provider/getCustomerConfiguration
  • GET
  • /provider/getInvoicingConfiguration
  • GET
  • /provider/getTradingConfiguration
  • GET
  • /provider/version
  • GET
  • /resteasy/registry
  • GET
  • /scriptInstance
  • GET, POST, PUT
  • /scriptInstance/createOrUpdate
  • POST
  • /scriptInstance/version
  • GET
  • /scriptInstance/{scriptInstanceCode}
  • DELETE
  • /seller
  • GET, POST, PUT
 
  • /seller/createOrUpdate
  • POST
  • /seller/list
  • GET
Search for seller with a given code.
  • /seller/listSellerCodes
  • GET
  • /seller/version
  • GET
  • /seller/{sellerCode}
  • DELETE
Remove seller with a given code.
  • /tax
  • GET, POST, PUT
 
  • /tax/createOrUpdate
  • POST
  • /tax/version
  • GET
  • /tax/{taxCode}
  • DELETE
Remove tax with a given code.
  • /timerEntity/create
  • POST
  • /timerEntity/createOrUpdate
  • POST
  • /timerEntity/update
  • POST
  • /timerEntity/version
  • GET
  • /user
  • GET, POST, PUT
 
  • /user/createOrUpdate
  • POST
Create or update user based on the username
  • /user/version
  • GET
  • /user/{username}
  • DELETE
Remove user with a given username.
  • /{job-id}
  • DELETE, GET, POST