opencell API

Resources

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

path methods description
  • /Communication/inbound
  • POST
Receives inbout communication from external source given the rest url above. MEVEO handles it by throwing an inbount communication event with the communicationRequestDto.
  • /Communication/version
  • GET
Get version of application
  • /PdfInvoice
  • GET
  • /PdfInvoice/version
  • GET
Get version of application
  • /account/access
  • GET, POST, PUT
 
  • /account/access/createOrUpdate
  • POST
Create new or update existing access
  • /account/access/list
  • GET
List Access filtered by subscriptionCode.
  • /account/access/version
  • GET
Get version of application
  • /account/access/{accessCode}/{subscriptionCode}
  • DELETE
Remove access with a given access code and subscription code.
  • /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
This service allows to create / update (if exist already) and close / terminate (if termination date is set) a list of customer, customer accounts, billing accounts, user accounts, subscriptions, services, and access in one transaction. It can activate and terminate subscription and service instance. Close customer account. Terminate billing and user account.
  • /account/accountHierarchy/find
  • POST
Search for a list of customer accounts given a set of filter.
  • /account/accountHierarchy/findAccountHierarchy
  • POST
Is an update of findAccountHierarchy wherein the user can search on 1 or multiple levels of the hierarchy in 1 search. These are the modes that can be combined by using bitwise - or |. Example: If we search on level=BA for lastName=legaspi and found a match, the search will return the hierarchy from BA to CUST. If we search on level=UA for address1=my_address and found a match, the search will return the hierarchy from UA to CUST.", notes = "CUST = 1, CA = 2, BA = 4, UA = 8.
  • /account/accountHierarchy/updateCRMAccountHierarchy
  • POST
  • /account/accountHierarchy/version
  • GET
Get version of application
  • /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
Get version of application
  • /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
Filters are: category, seller, brand and provider
  • /account/customer/removeBrand/{brandCode}
  • DELETE
  • /account/customer/removeCategory/{categoryCode}
  • DELETE
  • /account/customer/updateBrand
  • PUT
  • /account/customer/updateCategory
  • PUT
  • /account/customer/version
  • GET
Get version of application
  • /account/customer/{customerCode}
  • DELETE
  • /account/customerAccount
  • GET, POST, PUT
 
  • /account/customerAccount/createOrUpdate
  • POST
  • /account/customerAccount/creditCategory
  • DELETE, POST
  • /account/customerAccount/dunningInclusionExclusion
  • PUT
Performs dunning exclusion to customer account
  • /account/customerAccount/list
  • GET
List CustomerAccount filter by customerCode.
  • /account/customerAccount/version
  • GET
Get version of application
  • /account/customerAccount/{customerAccountCode}
  • DELETE
  • /account/title
  • GET, POST, PUT
  • /account/title/createOrUpdate
  • POST
  • /account/title/list
  • GET
  • /account/title/version
  • GET
Get version of application
  • /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
Get version of application
  • /account/userAccount/{userAccountCode}
  • DELETE
  • /accountOperation
  • POST
  • /accountOperation/addLitigation
  • POST
  • /accountOperation/cancelLitigation
  • POST
  • /accountOperation/list
  • GET
  • /accountOperation/matchOperations
  • POST
  • /accountOperation/unMatchingOperations
  • POST
  • /accountOperation/version
  • GET
Get version of application
  • /billing/invoicing/cancelBillingRun
  • POST
Cancels a billing run. Sets RatedTransaction.status associated to billingRun to OPEN. Remove aggregates and invoice associated to the billingRun. Set billingAccount.billingRun to null.
  • /billing/invoicing/createBillingRun
  • POST
  • /billing/invoicing/getBillingAccountListInRun
  • POST
Returns the list of billable billing accounts of a billing run
  • /billing/invoicing/getBillingRunInfo
  • POST
  • /billing/invoicing/getPostInvoicingReport
  • POST
  • /billing/invoicing/getPreInvoicingReport
  • POST
  • /billing/invoicing/validateBillingRun
  • POST
Depending on the status of the billing run, produce the preinvoicing report, the postInvoicing report or validates a billing run. Sets the next invoice date of a billing account to the next calendar date.
  • /billing/invoicing/version
  • GET
Get version of application
  • /billing/mediation/cancelReservation
  • POST
Cancels the reservation
  • /billing/mediation/chargeCdr
  • POST
Same as registerCDR, but at the same process rate the edr created
  • /billing/mediation/confirmReservation
  • POST
Confirms the reservation
  • /billing/mediation/registerCdrList
  • POST
Accepts a list of CDR line. This CDR is parsed and created as EDR. CDR is same format use in mediation job
  • /billing/mediation/reserveCdr
  • POST
Allows the user to reserve a cdr, this will create a new reservation entity attached to a wallet operation. A reservation has expiration limit save in the provider entity (PREPAID_RESRV_DELAY_MS)
  • /billing/mediation/version
  • GET
Get version of application
  • /billing/subscription
  • GET, POST, PUT
 
  • /billing/subscription/activateServices
  • POST
Activate services. Subscription should not be in status (RESILIATED OR CANCELLED). This service allows to override the charge instance price before activation. This service is actually a 2 step process: service instantiation then activation. If service.subscriptionDate is not set a service is only instantiated else it's instantiated then activated.
  • /billing/subscription/applyOneShotChargeInstance
  • POST
Apply one shot charge. Subscription should not be in status (RESILIATED OR CANCELLED).
  • /billing/subscription/createOrUpdate
  • POST
  • /billing/subscription/instantiateServices
  • POST
  • /billing/subscription/list
  • GET
List Subscription filter by userAccountCode.
  • /billing/subscription/terminate
  • POST
Terminate a subscription. If subscription status is RESILIATED, an error is thrown
  • /billing/subscription/terminateServices
  • POST
Terminate a list of services. If a service is already TERMINATED, an error is thrown.
  • /billing/subscription/version
  • GET
Get version of application
  • /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
Get version of application
  • /billingCycle
  • GET, POST, PUT
 
  • /billingCycle/createOrUpdate
  • POST
  • /billingCycle/version
  • GET
Get version of application
  • /billingCycle/{billingCycleCode}
  • DELETE
Remove billingCycle with a given code.
  • /calendar
  • GET, POST, PUT
 
  • /calendar/createOrUpdate
  • POST
  • /calendar/list
  • GET
Retrieve a list of all calendars.
  • /calendar/version
  • GET
Get version of application
  • /calendar/{calendarCode}
  • DELETE
Remove calendar with a given code.
  • /catalog/businessOfferModel
  • GET, POST, PUT
  • /catalog/businessOfferModel/createOrUpdate
  • POST
  • /catalog/businessOfferModel/version
  • GET
Get version of application
  • /catalog/businessOfferModel/{businessOfferModelCode}
  • DELETE
  • /catalog/businessServiceModel
  • GET, POST, PUT
  • /catalog/businessServiceModel/createOrUpdate
  • POST
  • /catalog/businessServiceModel/version
  • GET
Get version of application
  • /catalog/businessServiceModel/{businessServiceModelCode}
  • DELETE
  • /catalog/chargeTemplate
  • GET
  • /catalog/chargeTemplate/version
  • GET
Get version of application
  • /catalog/counterTemplate
  • GET, POST, PUT
 
  • /catalog/counterTemplate/createOrUpdate
  • POST
  • /catalog/counterTemplate/version
  • GET
Get version of application
  • /catalog/counterTemplate/{counterTemplateCode}
  • DELETE
Remove counter template with a given code.
  • /catalog/discountPlan
  • DELETE, GET, POST, PUT
  • /catalog/discountPlan/createOrUpdate
  • POST
  • /catalog/discountPlan/list
  • GET
  • /catalog/discountPlan/version
  • GET
Get version of application
  • /catalog/offerTemplate
  • GET, POST, PUT
 
  • /catalog/offerTemplate/createOrUpdate
  • POST
Create or update offer template based on a given code.
  • /catalog/offerTemplate/version
  • GET
Get version of application
  • /catalog/offerTemplate/{offerTemplateCode}
  • DELETE
Remove offer template with a given code.
  • /catalog/offerTemplate4_1
  • GET, POST, PUT
 
  • /catalog/offerTemplate4_1/createOrUpdate
  • POST
Create or update offer template based on a given code.
  • /catalog/offerTemplate4_1/version
  • GET
Get version of application
  • /catalog/offerTemplate4_1/{offerTemplateCode}
  • DELETE
Remove offer template with a given code.
  • /catalog/offerTemplateCategory
  • DELETE, GET, POST, PUT
  • /catalog/offerTemplateCategory/createOrUpdate
  • POST
  • /catalog/offerTemplateCategory/version
  • GET
Get version of application
  • /catalog/oneShotChargeTemplate
  • GET, POST, PUT
 
  • /catalog/oneShotChargeTemplate/createOrUpdate
  • POST
  • /catalog/oneShotChargeTemplate/list
  • GET
List one shot charge template with the following filters.
  • /catalog/oneShotChargeTemplate/version
  • GET
Get version of application
  • /catalog/oneShotChargeTemplate/{oneShotChargeTemplateCode}
  • DELETE
Remove one shot charge template with a given code.
  • /catalog/pricePlan
  • GET, POST, PUT
 
  • /catalog/pricePlan/createOrUpdate
  • POST
  • /catalog/pricePlan/list
  • GET
  • /catalog/pricePlan/version
  • GET
Get version of application
  • /catalog/pricePlan/{pricePlanCode}
  • DELETE
Remove price plan with a given id.
  • /catalog/recurringChargeTemplate
  • GET, POST, PUT
 
  • /catalog/recurringChargeTemplate/createOrUpdate
  • POST
  • /catalog/recurringChargeTemplate/version
  • GET
Get version of application
  • /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
Get version of application
  • /catalog/serviceTemplate/{serviceTemplateCode}
  • DELETE
Remove service template with a given code.
  • /catalog/triggeredEdr
  • GET, POST, PUT
 
  • /catalog/triggeredEdr/createOrUpdate
  • POST
  • /catalog/triggeredEdr/version
  • GET
Get version of application
  • /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
Get version of application
  • /catalog/usageChargeTemplate/{usageChargeTemplateCode}
  • DELETE
Remove usage charge template with a given code.
  • /catalogManagement/category
  • GET
Get a list of categories
  • /catalogManagement/category/{id}
  • GET
Get a single category by its code
  • /catalogManagement/createOfferFromBOM
  • POST
Create offer from BOM definition
  • /catalogManagement/productOffering
  • GET
Get a list of product offerings optionally filtering by some criteria
  • /catalogManagement/productOffering/{id}
  • GET
Get details of a single product offering
  • /catalogManagement/productSpecification
  • GET
Get a list of product specifications optionally filtering by some criteria
  • /catalogManagement/productSpecification/{id}
  • GET
Get details of a single product
  • /chart
  • DELETE, GET, POST, PUT
  • /chart/bar
  • POST, PUT
  • /chart/createOrUpdate
  • POST
  • /chart/line
  • POST, PUT
  • /chart/pie
  • POST, PUT
  • /chart/version
  • GET
Get version of application
  • /country
  • DELETE, GET, POST, PUT
 
  • /country/createOrUpdate
  • POST
  • /country/version
  • GET
Get version of application
  • /country/{countryCode}/{currencyCode}
  • DELETE
Does not delete a country but the tradingCountry associated to it.
  • /countryIso
  • DELETE, GET, POST, PUT
 
  • /countryIso/createOrUpdate
  • POST
  • /countryIso/version
  • GET
Get version of application
  • /currency
  • GET, POST, PUT
 
  • /currency/createOrUpdate
  • POST
  • /currency/version
  • GET
Get version of application
  • /currency/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /currencyIso
  • GET, POST, PUT
 
  • /currencyIso/createOrUpdate
  • POST
  • /currencyIso/version
  • GET
Get version of application
  • /currencyIso/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /customEntityInstance/version
  • GET
Get version of application
  • /customEntityInstance/{customEntityTemplateCode}
  • POST, PUT
  • /customEntityInstance/{customEntityTemplateCode}/createOrUpdate
  • POST
  • /customEntityInstance/{customEntityTemplateCode}/{code}
  • DELETE, GET
  • /customFieldTemplate
  • GET, POST, PUT
 
  • /customFieldTemplate/createOrUpdate
  • POST
Define new or update existing custom field definition
  • /customFieldTemplate/version
  • GET
Get version of application
  • /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}
  • DELETE
Remove custom field definition given its code and entity it applies to
  • /entityCustomization/action
  • GET, POST, PUT
 
  • /entityCustomization/action/createOrUpdate
  • POST
Define new or update existing entity action definition
  • /entityCustomization/action/{actionCode}/{appliesTo}
  • DELETE
Remove entity action definition given its code and entity it applies to
  • /entityCustomization/cet/createOrUpdate
  • POST
Define new or update existing custom entity template definition
  • /entityCustomization/customize
  • PUT
Customize a standard Meveo entity definition by adding fields and/or custom actions
  • /entityCustomization/customize/{customizedEntityClass}
  • GET
Get customizations made on a standard Meveo entity given its class
  • /entityCustomization/entity
  • POST, PUT
 
  • /entityCustomization/entity/list
  • GET
List custom entity templates.
  • /entityCustomization/entity/{customEntityTemplateCode}
  • DELETE, GET
 
  • /entityCustomization/field
  • GET, POST, PUT
 
  • /entityCustomization/field/createOrUpdate
  • POST
Define new or update existing custom field definition
  • /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}
  • DELETE
Remove custom field definition given its code and entity it applies to
  • /entityCustomization/version
  • GET
Get version of application
  • /filter/createOrUpdate
  • POST
  • /filter/version
  • GET
Get version of application
  • /filteredList
  • GET
  • /filteredList/version
  • GET
Get version of application
  • /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
Get version of application
  • /invoice
  • GET, POST
 
  • /invoice/generateInvoice
  • POST
This operation generates rated transaction given a billing account and invoicing date, updates billing account amounts and generates aggregates and invoice.
  • /invoice/getPdfInvoice
  • POST
Finds an invoice and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.
  • /invoice/getPdfInvoiceWithType
  • POST
Finds an invoice and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.
  • /invoice/getXMLInvoice
  • POST
Finds an invoice and return it as xml string
  • /invoice/getXMLInvoiceWithType
  • POST
Finds an invoice and return it as xml string
  • /invoice/version
  • GET
Get version of application
  • /invoiceCategory
  • GET, POST, PUT
 
  • /invoiceCategory/createOrUpdate
  • POST
Create or update invoice with a given code.
  • /invoiceCategory/version
  • GET
Get version of application
  • /invoiceCategory/{invoiceCategoryCode}
  • DELETE
Remove invoice with a given code.
  • /invoiceSubCategory
  • GET, POST, PUT
 
  • /invoiceSubCategory/version
  • GET
Get version of application
  • /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
Get version of application
  • /invoiceSubCategoryCountry/{invoiceSubCategoryCode}/{country}
  • DELETE
Remove invoice sub category country with a given code and country.
  • /job
  • GET, PUT
  • /job/create
  • POST
  • /job/createOrUpdate
  • POST
  • /job/execute
  • POST
  • /job/timer
  • GET, POST, PUT
  • /job/timer/createOrUpdate
  • POST
  • /job/timer/{timerCode}
  • DELETE
  • /job/version
  • GET
Get version of application
  • /job/{jobInstanceCode}
  • DELETE
  • /jobInstance
  • GET
  • /jobInstance/create
  • POST
  • /jobInstance/createOrUpdate
  • POST
  • /jobInstance/update
  • POST
  • /jobInstance/version
  • GET
Get version of application
  • /jobInstance/{jobInstanceCode}
  • DELETE
  • /language
  • GET, POST, PUT
 
  • /language/createOrUpdate
  • POST
Create or update a language if it doesn't exists
  • /language/version
  • GET
Get version of application
  • /language/{languageCode}
  • DELETE
Does not delete a language but the tradingLanguage associated to it.
  • /languageIso
  • GET, POST, PUT
 
  • /languageIso/createOrUpdate
  • POST
Create or update a language if it doesn't exists
  • /languageIso/version
  • GET
Get version of application
  • /languageIso/{languageCode}
  • DELETE
Does not delete a language but the tradingLanguage associated to it.
  • /measurableQuantity
  • POST, PUT
 
  • /measurableQuantity/version
  • GET
Get version of application
  • /module
  • GET, POST, PUT
  • /module/createOrUpdate
  • POST
  • /module/list
  • GET
  • /module/version
  • GET
Get version of application
  • /module/{code}
  • DELETE
  • /notification
  • GET, POST, PUT
  • /notification/createOrUpdate
  • POST
  • /notification/email
  • GET, POST, PUT
  • /notification/email/createOrUpdate
  • POST
  • /notification/email/version
  • GET
Get version of application
  • /notification/email/{notificationCode}
  • DELETE
  • /notification/jobTrigger
  • GET, POST, PUT
  • /notification/jobTrigger/createOrUpdate
  • POST
  • /notification/jobTrigger/version
  • GET
Get version of application
  • /notification/jobTrigger/{notificationCode}
  • DELETE
  • /notification/listInboundRequest
  • GET
  • /notification/listNotificationHistory
  • GET
  • /notification/version
  • GET
Get version of application
  • /notification/webhook
  • GET, POST, PUT
  • /notification/webhook/createOrUpdate
  • POST
  • /notification/webhook/version
  • GET
Get version of application
  • /notification/webhook/{notificationCode}
  • DELETE
  • /notification/{notificationCode}
  • DELETE
  • /occTemplate
  • GET, POST, PUT
 
  • /occTemplate/createOrUpdate
  • POST
Create or update OccTemplate
  • /occTemplate/version
  • GET
Get version of application
  • /occTemplate/{occTemplateCode}
  • DELETE
Remove OccTemplate with a given code.
  • /orderManagement/productOrder
  • GET, POST
 
  • /orderManagement/productOrder/{id}
  • PATCH
Modify partially a product order
  • /orderManagement/productOrder/{orderId}
  • DELETE, GET
 
  • /payment/create
  • POST
Creates automated payment. It also process if a payment is matching or not
  • /payment/customerPayment
  • GET
Returns a list of account operations along with the balance of a customer
  • /payment/version
  • GET
Get version of application
  • /permission/list
  • GET
  • /permission/version
  • GET
Get version of application
  • /provider
  • GET, POST, PUT
 
  • /provider/createOrUpdate
  • POST
Create or update a provider if it doesn't exists
  • /provider/getCustomerAccountConfiguration
  • GET
Returns list of payment method and credit categories
  • /provider/getCustomerConfiguration
  • GET
Returns list of customer brands, categories and titles
  • /provider/getInvoicingConfiguration
  • GET
Returns list of invoicing configuration (calendars, taxes, invoice categories, invoice sub categories, billing cycles and termination reasons
  • /provider/getTradingConfiguration
  • GET
Returns list of trading countries, currencies and languages
  • /provider/version
  • GET
Get version of application
  • /resteasy/registry
  • GET
  • /role
  • GET, POST, PUT
 
  • /role/createOrUpdate
  • POST
Create or update role
  • /role/version
  • GET
Get version of application
  • /role/{roleName}
  • DELETE
Remove role.
  • /script/offerModelScript
  • GET, POST, PUT
  • /script/offerModelScript/createOrUpdate
  • POST
  • /script/offerModelScript/version
  • GET
Get version of application
  • /script/offerModelScript/{code}
  • DELETE
  • /script/serviceModelScript
  • GET, POST, PUT
  • /script/serviceModelScript/createOrUpdate
  • POST
  • /script/serviceModelScript/version
  • GET
Get version of application
  • /script/serviceModelScript/{code}
  • DELETE
  • /scriptInstance
  • GET, POST, PUT
  • /scriptInstance/createOrUpdate
  • POST
  • /scriptInstance/version
  • GET
Get version of application
  • /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
Get version of application
  • /seller/{sellerCode}
  • DELETE
Remove seller with a given code.
  • /tax
  • GET, POST, PUT
 
  • /tax/createOrUpdate
  • POST
  • /tax/list
  • GET
  • /tax/version
  • GET
Get version of application
  • /tax/{taxCode}
  • DELETE
Remove tax with a given code.
  • /terminationReason
  • DELETE, GET, POST, PUT
  • /terminationReason/createOrUpdate
  • POST
  • /terminationReason/list
  • GET
  • /terminationReason/version
  • GET
Get version of application
  • /timerEntity
  • GET
  • /timerEntity/create
  • POST
  • /timerEntity/createOrUpdate
  • POST
  • /timerEntity/update
  • POST
  • /timerEntity/version
  • GET
Get version of application
  • /user
  • GET, POST, PUT
 
  • /user/createOrUpdate
  • POST
Create or update user based on the username
  • /user/version
  • GET
Get version of application
  • /user/{username}
  • DELETE
Remove user with a given username.
  • /{job-id}
  • DELETE, GET, POST

Services

Namespace http://ws.api.meveo.org/
name description
AccountWs
Catalog4_1Ws
CatalogWs
CommunicationWs
EntityCustomizationWs
FilterWs
FilteredListWs
InvoiceWs
InvoicingWs
JobWs
MediationWs
ModuleWs
NotificationWs
PaymentWs
ReportingWs
ScriptInstanceWs
ScriptWs
SettingsWs
SubscriptionWs
WalletWs
Namespace http://superAdmin.ws.api.meveo.org/
name description
SuperAdminSettingsWs

Data Types

JSON

type description
AbstractCatalogEntity
AbstractEntity
AbstractEntityReference
AccessDto
AccessesDto
AccessesResponseDto
AccessibleObject
AccountDto
AccountHierarchyDto
AccountHierarchyTypeEnum
AccountOperationDto
AccountOperationsDto
AccountOperationsResponseDto
AccountStatusEnum
ActionStatus Determine the status of the MEVEO API web service response.
ActionStatusEnum Tells whether the request is successful or not.
ActivateServicesRequestDto
AddressDto
AlterationPrice
ApplyOneShotChargeInstanceRequestDto
BankCoordinatesDto
BarChartDto
BaseDataModelDto
BaseDto
BaseResponse All the MEVEO API web service response must extend this class.
BaseServiceChargeTemplateDto
BillingAccount
BillingAccountDto
BillingAccountsDto
BillingAccountsResponseDto
BillingCycleDto
BillingCyclesDto
BillingProcessTypesEnum
BillingRunDto
BillingRunStatusEnum
BillingWalletTypeEnum
BomOfferDto
BundledProductReference
BusinessOfferModelDto
BusinessServiceModelDto
CRMAccountHierarchyDto
CalendarDateIntervalDto
CalendarDto
CalendarIntervalTypeEnum
CalendarPeriodUnitEnum
CalendarTypeEnum
CalendarsDto
CatalogReference
CdrListDto
CdrReservationResponseDto
CertPath
Certificate
Channel
ChargeInstanceOverrideDto
ChargeInstanceOverridesDto
ChargeTemplateDto
ChartDto
Class
ClassLoader
CodeSigner
CodeSource
CommunicationRequestDto
Constructor
ContactInformationDto
CounterTemplateDto
CounterTemplateLevel
CounterTypeEnum
CountriesDto
CountryDto
CountryIsoDto
CreateBillingRunDto
CreditCategoriesDto
CreditCategoryDto
CurrenciesDto
CurrencyDto
CurrencyIsoDto
CustomEntityInstanceDto
CustomEntityInstanceResponseDto
CustomEntityTemplateDto
CustomEntityTemplateResponseDto
CustomEntityTemplatesResponseDto
CustomFieldDto
CustomFieldMapKeyEnum
CustomFieldMatrixColumnDto
CustomFieldStorageTypeEnum
CustomFieldTemplateDto
CustomFieldTypeEnum
CustomFieldValueDto Represents a single CF simple value inside a more complex CF value (list, map, matrix)
CustomFieldsDto
CustomScriptDto
CustomerAccountDto
CustomerAccountStatusEnum
CustomerAccountsDto
CustomerAccountsResponseDto
CustomerBrandDto
CustomerBrandsDto
CustomerCategoriesDto
CustomerCategoryDto
CustomerDto
CustomerHierarchyDto
CustomerInvoicesResponse
CustomerListResponse
CustomerPaymentsResponse
CustomersDto
CustomersResponseDto
DayInYearDto
DiscountPlanDto
DiscountPlansDto
DunningInclusionExclusionDto
DunningLevelEnum
EmailNotificationDto
EntityActionScriptDto
EntityActionScriptResponseDto
EntityCustomizationDto
EntityCustomizationResponseDto
EntityReferenceDto Represents a custom field value type - reference to an Meveo entity identified by a classname and code. In case a class is a generic Custom Entity Template a classnameCode is required to identify a concrete custom entity template by its code
ErrorManager
Field
FilterDto
FilteredListDto
FindAccountHierachyRequestDto
FindWalletOperationsDto
FindWalletOperationsResponseDto
Formatter
GenerateInvoiceRequestDto
GenerateInvoiceResponseDto
GenerateInvoiceResultDto
GetAccessResponseDto
GetAccountHierarchyResponseDto
GetBillingAccountListInRunResponseDto
GetBillingAccountResponseDto
GetBillingCycleResponse
GetBillingRunInfoResponseDto
GetBusinessOfferModelResponseDto
GetBusinessServiceModelResponseDto
GetCalendarResponse
GetChargeTemplateResponseDto
GetChartResponse
GetCounterTemplateResponseDto
GetCountryIsoResponse
GetCountryResponse
GetCurrencyIsoResponse
GetCurrencyResponse
GetCustomFieldTemplateReponseDto
GetCustomerAccountConfigurationResponseDto
GetCustomerAccountResponseDto
GetCustomerConfigurationResponseDto
GetCustomerResponseDto
GetDiscountPlanResponseDto
GetDiscountPlansResponseDto
GetEmailNotificationResponseDto
GetInvoiceCategoryResponse
GetInvoiceSubCategoryCountryResponse
GetInvoiceSubCategoryResponse
GetInvoicingConfigurationResponseDto
GetJobTriggerResponseDto
GetLanguageIsoResponse
GetLanguageResponse
GetNotificationResponseDto
GetOccTemplateResponseDto
GetOfferTemplateCategoryResponseDto
GetOfferTemplateResponseDto
GetOneShotChargeTemplateResponseDto
GetPdfInvoiceResponseDto
GetPostInvoicingReportsResponseDto
GetPreInvoicingReportsResponseDto
GetPricePlanResponseDto
GetProviderResponse
GetRecurringChargeTemplateResponseDto
GetRoleResponse
GetScriptInstanceResponseDto
GetSellerResponse
GetServiceTemplateResponseDto
GetSubscriptionResponseDto
GetTaxResponse
GetTaxesResponse
GetTerminationReasonResponse
GetTimerEntityResponseDto
GetTradingConfigurationResponseDto
GetTradingCountryResponse
GetTradingCurrencyResponse
GetTradingLanguageResponse
GetTriggeredEdrResponseDto
GetUsageChargeTemplateResponseDto
GetUserAccountResponseDto
GetUserResponse
GetWalletTemplateResponseDto
GetWebHookNotificationResponseDto
GetXmlInvoiceResponseDto
Handler
HourInDayDto
ImportExportResponseDto
InboundRequestDto
InboundRequestsDto
InboundRequestsResponseDto
InstanceStatusEnum
InstantiateServicesRequestDto
InvoiceCategoriesDto
InvoiceCategoryDto
InvoiceConfigurationDto
InvoiceCreationResponse
InvoiceDto
InvoiceSubCategoriesDto
InvoiceSubCategoryCountryDto
InvoiceSubCategoryDto
InvoiceTypeEnum
JobCategoryEnum
JobInstanceDto
JobInstanceInfoDto
JobInstanceResponseDto
JobTriggerDto
LanguageDescriptionDto
LanguageDto
LanguageIsoDto
LanguagesDto
LegendPositionEnum
Level
LifecycleStatus
LineChartDto
ListCalendarResponse
LitigationRequestDto
Locale
Logger
MatchOperationRequestDto
MatchingAmountDto
MatchingAmountsDto
MatchingCodeDto
MatchingCodesDto
MatchingStatusEnum
MatchingTypeEnum
MeasurableQuantityDto
MeasurementPeriodEnum
Method
MeveoApiErrorCodeEnum Action status error codes. See ActionStatus.message for a detailed error message
MeveoModuleDtoResponse
MeveoModuleDtosResponse
ModuleDto
ModuleLicenseEnum
MonthEnum
NameDto
Note
NotificationDto
NotificationEventTypeEnum
NotificationHistoriesDto
NotificationHistoriesResponseDto
NotificationHistoryDto
NotificationHistoryStatusEnum
OccTemplateDto
OfferModelScriptDto
OfferModelScriptResponseDto
OfferServiceTemplateDto
OfferTemplate4_1Dto
OfferTemplateCategoryDto
OfferTemplateDto
OneShotChargeTemplateDto
OneShotChargeTemplateTypeEnum
OneShotChargeTemplateWithPriceDto
OneShotChargeTemplateWithPriceListDto
OperationCategoryEnum
OperationTypeEnum
OrderItem
OrientationEnum
OtherCreditAndChargeDto
Package
ParsedVersion
PaymentDto
PaymentMethodEnum
PaymentTermEnum
PdfInvoiceResponse
PermissionCollection
PermissionDto
PermissionResponseDto
PermissionsDto
PieChartDto
Place
PostInvoicingReportsDTO
PreInvoicingReportsDTO
PrepaidReservationDto
Price
PricePlanDto
PricePlanMatrixesResponseDto
PricePlansDto
Product
ProductCharacteristic
ProductOfferPriceAlteration
ProductOfferPriceAlterationType
ProductOffering
ProductOfferingPrice
ProductOfferingPriceType
ProductOfferingTerm
ProductOrder
ProductRelationship
ProtectionDomain
ProviderDto
RatedTransactionDto
RecordedInvoiceDto
RecurringChargeTemplateDto
RegistryData
RegistryEntry
RejectedPaymentDto
RejectedType
RelatedParty
ResourceBundle
ResourceMethodEntry
RoleDto
RoundingModeEnum
ScriptInstanceDto
ScriptInstanceErrorDto
ScriptInstanceReponseDto
ScriptSourceTypeEnum
SellerCodesResponseDto
SellerDto
SellerResponseDto
SellersDto
ServiceChargeTemplateRecurringDto
ServiceChargeTemplateRecurringsDto
ServiceChargeTemplateSubscriptionDto
ServiceChargeTemplateSubscriptionsDto
ServiceChargeTemplateTerminationDto
ServiceChargeTemplateTerminationsDto
ServiceChargeTemplateUsagesDto
ServiceCodeDto
ServiceInstanceDto
ServiceInstancesDto
ServiceLevelAgreement
ServiceModelScriptDto
ServiceModelScriptResponseDto
ServiceTemplateDto
ServiceTemplatesDto
ServiceToActivateDto
ServiceToInstantiateDto
ServiceUsageChargeTemplateDto
ServicesToActivateDto
ServicesToInstantiateDto
SubCategoryInvoiceAgregateDto
SubresourceLocator
SubscriptionDto
SubscriptionsDto
SubscriptionsResponseDto
TaxDto
TaxesDto
TerminateSubscriptionRequestDto
TerminateSubscriptionServicesRequestDto
TerminationReasonDto
TerminationReasonsDto
TimeRange
TimerEntityDto
TimerEntityResponseDto
Timestamp
TitleDto
TitleResponseDto
TitlesDto
TitlesResponseDto
TriggeredEdrTemplateDto
TriggeredEdrTemplatesDto
URL
UnMatchingOperationRequestDto
UsageChargeTemplateDto
UserAccountDto
UserAccountsDto
UserAccountsResponseDto
UserDto
WalletBalanceDto
WalletOperationDto
WalletOperationStatusEnum
WalletReservationDto
WalletTemplateDto
WalletsDto
WebHookMethodEnum
WebhookNotificationDto

XML

Default Namespace
type description
deleteResourceMethod
getResourceMethod
headResourceMethod
optionsResourceMethod
postResourceMethod
putResourceMethod
registryData
registryEntry
resourceMethodEntry
subresourceLocator
traceResourceMethod
meveoApiErrorCodeEnum Action status error codes. See ActionStatus.message for a detailed error message
ActionStatus Determine the status of the MEVEO API web service response.
actionStatusEnum Tells whether the request is successful or not.
baseDto
billingCycleDto
billingCyclesDto
calendarDateIntervalDto
Calendar
calendarTypeEnum
calendarsDto
catMessagesDto
countriesDto
countryDto
countryIsoDto
currenciesDto
currencyDto
currencyIsoDto
customEntityInstanceDto
customEntityTemplateDto
customFieldDto
customFieldMatrixColumnDto
customFieldTemplateDto
customFieldValueDto Represents a single CF simple value inside a more complex CF value (list, map, matrix)
customFieldsDto
dayInYearDto
entityActionScriptDto
entityCustomizationDto
entityReferenceDto Represents a custom field value type - reference to an Meveo entity identified by a classname and code. In case a class is a generic Custom Entity Template a classnameCode is required to identify a concrete custom entity template by its code
filterDto
hourInDayDto
invoiceCategoriesDto
invoiceCategoryDto
invoiceSubCategoriesDto
invoiceSubCategoryCountryDto
invoiceSubCategoryDto
languageDescriptionDto
languageDto
languageIsoDto
languagesDto
occTemplateDto
permissionDto
Permissions
providerDto
ratedTransactionDto
roleDto
scriptInstanceDto
scriptInstanceErrorDto
Seller
Sellers
subCategoryInvoiceAgregateDto
taxDto
taxesDto
terminationReasonDto
terminationReasonsDto
userDto
Access
Accesses
accountDto
accountHierarchyDto
accountHierarchyTypeEnum
addressDto
applyOneShotChargeInstanceRequestDto
bankCoordinatesDto
BillingAccount
BillingAccounts
CRMAccountHierarchyDto
ContactInformation
creditCategoriesDto
creditCategoryDto
CustomerAccount
CustomerAccounts
customerBrandDto
customerCategoryDto
Customer
customerHierarchyDto
Customers
FindAccountHierachyRequest
nameDto
UserAccount
UserAccounts
activateServicesRequestDto
billingRunDto
cdrListDto
ChargeInstanceOverride
ChargeInstanceOverrides
createBillingRunDto
FindWalletOperations
generateInvoiceResultDto
instantiateServicesRequestDto
PrepaidReservation
ServiceInstance
ServiceInstances
serviceToActivateDto
serviceToInstantiateDto
servicesToActivateDto
servicesToInstantiateDto
Subscription
Subscriptions
terminateSubscriptionRequestDto
terminateSubscriptionServicesRequestDto
walletBalanceDto
walletOperationDto
walletReservationDto
WalletTemplate
baseServiceChargeTemplateDto
bomOfferDto
businessOfferModelDto
businessServiceModelDto
chargeTemplateDto
counterTemplateDto
discountPlanDto
DiscountPlans
offerServiceTemplateDto
offerTemplate4_1Dto
offerTemplateCategoryDto
offerTemplateDto
oneShotChargeTemplateDto
oneShotChargeTemplateWithPriceDto
oneShotChargeTemplateWithPriceListDto
pricePlanDto
PricePlans
recurringChargeTemplateDto
ServiceChargeTemplateRecurring
ServiceChargeTemplateRecurrings
ServiceChargeTemplateSubscription
ServiceChargeTemplateSubscriptions
ServiceChargeTemplateTermination
ServiceChargeTemplateTerminations
ServiceChargeTemplateUsages
serviceCodeDto
serviceTemplateDto
serviceTemplatesDto
serviceUsageChargeTemplateDto
triggeredEdrTemplateDto
triggeredEdrTemplatesDto
usageChargeTemplateDto
Wallets
communicationRequestDto
barChartDto
chartDto
lineChartDto
measurableQuantityDto
pieChartDto
filteredListDto
generateInvoiceRequestDto
generateInvoiceResponseDto
getPdfInvoiceResponseDto
getXmlInvoiceResponseDto
invoiceConfigurationDto
invoiceDto
jobInstanceDto
jobInstanceInfoDto
timerEntityDto
baseDataModelDto
moduleDto
emailNotificationDto
inboundRequestDto
inboundRequestsDto
jobTriggerDto
notificationDto
notificationHistoriesDto
notificationHistoryDto
webhookNotificationDto
accountOperationDto
accountOperationsDto
dunningInclusionExclusionDto
litigationRequestDto
matchOperationRequestDto
matchingAmountDto
matchingAmountsDto
matchingCodeDto
matchingCodesDto
OtherCreditAndCharge
paymentDto
RecordedInvoice
RejectedPayment
unMatchingOperationRequestDto
baseResponse All the MEVEO API web service response must extend this class.
catMessagesListDto
customEntityInstanceResponseDto
customEntityTemplateResponseDto
customEntityTemplatesResponseDto
customerBrandsDto
customerCategoriesDto
customerInvoicesResponse
customerListResponse
customerPaymentsResponse
descriptionsResponseDto
entityActionScriptResponseDto
entityCustomizationResponseDto
getBillingCycleResponse
getCalendarResponse
getCountryIsoResponse
getCountryResponse
getCurrencyIsoResponse
getCurrencyResponse
getCustomFieldTemplateReponseDto
getCustomerAccountConfigurationResponseDto
getCustomerConfigurationResponseDto
getDescriptionsResponse
getInvoiceCategoryResponse
getInvoiceSubCategoryCountryResponse
getInvoiceSubCategoryResponse
getInvoicingConfigurationResponseDto
getLanguageIsoResponse
getLanguageResponse
getOccTemplateResponseDto
getProviderResponse
getRoleResponse
getScriptInstanceResponseDto
getSellerResponse
getTaxResponse
getTaxesResponse
getTerminationReasonResponse
getTimerEntityResponseDto
getTradingConfigurationResponseDto
getTradingCountryResponse
getTradingCurrencyResponse
getTradingLanguageResponse
getUserResponse
invoiceCreationResponse
listCalendarResponse
pdfInvoiceResponse
permissionResponseDto
scriptInstanceReponseDto
sellerCodesResponseDto
sellerResponseDto
titleDto
titlesDto
accessesResponseDto
billingAccountsResponseDto
customerAccountsResponseDto
customersResponseDto
getAccessResponseDto
getAccountHierarchyResponseDto
getBillingAccountResponseDto
getCustomerAccountResponseDto
getCustomerResponseDto
getUserAccountResponseDto
titleResponseDto
titlesResponseDto
userAccountsResponseDto
cdrReservationResponseDto
filteredListResponseDto
findWalletOperationsResponseDto
getBillingAccountListInRunResponseDto
getBillingRunInfoResponseDto
getPostInvoicingReportsResponseDto
getPreInvoicingReportsResponseDto
getSubscriptionResponseDto
getWalletTemplateResponseDto
subscriptionsResponseDto
getBusinessOfferModelResponseDto
getBusinessServiceModelResponseDto
getChargeTemplateResponseDto
getCounterTemplateResponseDto
getDiscountPlanResponseDto
getDiscountPlansResponseDto
getOfferTemplateCategoryResponseDto
getOfferTemplateResponseDto
getOneShotChargeTemplateResponseDto
getPricePlanResponseDto
getRecurringChargeTemplateResponseDto
getServiceTemplateResponseDto
getTriggeredEdrResponseDto
getUsageChargeTemplateResponseDto
pricePlanMatrixesResponseDto
getChartResponse
jobInstanceResponseDto
timerEntityResponseDto
meveoModuleDtoResponse
meveoModuleDtosResponse
getEmailNotificationResponseDto
getJobTriggerResponseDto
getNotificationResponseDto
getWebHookNotificationResponseDto
inboundRequestsResponseDto
notificationHistoriesResponseDto
accountOperationsResponseDto
offerModelScriptResponseDto
serviceModelScriptResponseDto
importExportResponseDto
customScriptDto
offerModelScriptDto
serviceModelScriptDto
accountStatusEnum
billingProcessTypesEnum
billingRunStatusEnum
billingWalletTypeEnum
instanceStatusEnum
invoiceTypeEnum
operationTypeEnum
postInvoicingReportsDTO
preInvoicingReportsDTO
walletOperationStatusEnum
calendarIntervalTypeEnum
calendarPeriodUnitEnum
counterTemplateLevel
counterTypeEnum
monthEnum
oneShotChargeTemplateTypeEnum
roundingModeEnum
customFieldMapKeyEnum
customFieldStorageTypeEnum
customFieldTypeEnum
jobCategoryEnum
moduleLicenseEnum
notificationEventTypeEnum
notificationHistoryStatusEnum
webHookMethodEnum
customerAccountStatusEnum
dunningLevelEnum
matchingStatusEnum
matchingTypeEnum
operationCategoryEnum
paymentMethodEnum
paymentTermEnum
rejectedType
scriptSourceTypeEnum
legendPositionEnum
measurementPeriodEnum
orientationEnum
abstractCatalogEntity
abstractEntity
catalogReference
lifecycleStatus
serviceLevelAgreement
timeRange
billingAccount
note
orderItem
product
productCharacteristic
productOrder
productRelationship
RelatedPartyOrder
alterationPrice
bundledProductReference
channel
place
price
productOfferPriceAlteration
productOfferPriceAlterationType
productOffering
productOfferingPrice
productOfferingPriceType
productOfferingTerm
abstractEntityReference
parsedVersion