Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

path methods description
  • /Communication/inbound
  • POST
Receives inbound 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
Find a PDF invoice with a given invoice number and a customer account code.
  • /PdfInvoice/version
  • GET
Get version of application
  • /account/access
  • GET POST PUT
 
  • /account/access/createOrUpdate
  • POST
Create new or update an existing access
  • /account/access/list
  • GET
List Access filtered by subscriptionCode.
  • /account/access/version
  • GET
Get version of application
  • /account/access/{accessCode}/{subscriptionCode}/{startDate}/{endDate}
  • DELETE
Remove an access with a given access code and subscription code.
  • /account/access/{accessCode}/{subscriptionCode}/{startDate}/{endDate}/disable
  • POST
Disable an Access point with a given access code and subscription code.
  • /account/access/{accessCode}/{subscriptionCode}/{startDate}/{endDate}/enable
  • POST
Enable an Access point with a given access code and subscription code.
  • /account/accountHierarchy
  • POST PUT
Web service for managing account hierarchy. Account hierarchy is org.meveo.model.crm.Customer->{!link org.meveo.model.payments.CustomerAccount}-> org.meveo.model.billing.BillingAccount-> org.meveo.model.billing.UserAccount.
  • /account/accountHierarchy/createCRMAccountHierarchy
  • POST
Create a CRMAccountHerarchy.
  • /account/accountHierarchy/createOrUpdate
  • POST
Create or update Account Hierarchy based on code.
  • /account/accountHierarchy/createOrUpdateCRMAccountHierarchy
  • POST
Create or update a CRM Account Hierarchy.
  • /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
Update a CRM Account HerarHierarchychy.
  • /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/filterCountersByPeriod
  • GET
filter counters by period date.
  • /account/billingAccount/list
  • GET
List BillingAccount filter by customerAccountCode.
  • /account/billingAccount/version
  • GET
Get version of application
  • /account/billingAccount/{billingAccountCode}
  • DELETE
Remove a billing account with a Billing Account Code.
  • /account/businessAccountModel
  • GET POST PUT
 
  • /account/businessAccountModel/findParents
  • POST
Find parent entities based on account hierarchy code.
  • /account/businessAccountModel/install
  • PUT
Install business account module.
  • /account/businessAccountModel/list
  • GET
Return meveo's modules.
  • /account/businessAccountModel/version
  • GET
Get version of application
  • /account/businessAccountModel/{businessAccountModelCode}
  • DELETE
Remove business account model with a given business account model code.
  • /account/customer
  • GET POST PUT
 
  • /account/customer/anonymizeGdpr
  • GET
Right to be forgotten. This concerns listing of risky or grey/black listed customers and their data. Upon request, they can require their data to be erased. In such case, mandatory information (accounting, invoicing, payments) must be preserved but the data tables including the customer's data must be anonymize (firstname/name/emails/phones/addresses/etc) so if this person register back it will be treated as a new customer without history.
  • /account/customer/category/{categoryCode}
  • GET
Search for a customer category with a given code
  • /account/customer/createBrand
  • POST
Create a new customer brand
  • /account/customer/createCategory
  • POST
Create a new customer category
  • /account/customer/createOrUpdate
  • POST
Create new or update existing customer
  • /account/customer/createOrUpdateBrand
  • POST
Create new or update an existing customer brand
  • /account/customer/createOrUpdateCategory
  • POST
Create new or update an existing customer category
  • /account/customer/customerNumberSequence
  • POST PUT
 
  • /account/customer/exportCustomerHierarchy
  • GET
Exports an account hierarchy given a specific customer selected in the GUI. It includes Subscription, AccountOperation and Invoice details. It packaged the json output as a zipped file along with the pdf invoices.
  • /account/customer/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /account/customer/list
  • GET POST
 
  • /account/customer/list47
  • POST
Filters are: category, seller, brand and provider.
  • /account/customer/removeBrand/{brandCode}
  • DELETE
Remove existing customer brand with a given brand code
  • /account/customer/removeCategory/{categoryCode}
  • DELETE
Remove an existing customer category with a given category code
  • /account/customer/sequence
  • POST PUT
 
  • /account/customer/sequence/{code}/next
  • POST
Generates the next customer sequence number.
  • /account/customer/updateBrand
  • PUT
Update an existing customer brand
  • /account/customer/updateCategory
  • PUT
Update an existing customer category
  • /account/customer/version
  • GET
Get version of application
  • /account/customer/{customerCode}
  • DELETE
Remove customer with a given code
  • /account/customerAccount
  • GET POST PUT
Web service for managing customer account.
  • /account/customerAccount/createOrUpdate
  • POST
Create new or update existing customer account
  • /account/customerAccount/creditCategory
  • POST
Create a new credit category.
  • /account/customerAccount/creditCategory/{creditCategoryCode}
  • DELETE
Remove credit category with a given code.
  • /account/customerAccount/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /account/customerAccount/list
  • GET
List CustomerAccount filtered by customerCode.
  • /account/customerAccount/transferAccount
  • POST
Transfer an amount from one customer to another.
  • /account/customerAccount/version
  • GET
Get version of application
  • /account/customerAccount/{customerAccountCode}
  • DELETE
Remove customerAccount with a given code.
  • /account/providerContact
  • GET POST PUT
 
  • /account/providerContact/createOrUpdate
  • POST
Create new or update an existing provider contact
  • /account/providerContact/list
  • GET
List of provider contacts
  • /account/providerContact/version
  • GET
Get version of application
  • /account/providerContact/{code}
  • DELETE
Remove an existing provider contact with a given code
  • /account/title
  • GET POST PUT
 
  • /account/title/createOrUpdate
  • POST
Create new or update an existing title
  • /account/title/list
  • GET
List titles
  • /account/title/version
  • GET
Get version of application
  • /account/title/{titleCode}
  • DELETE
Remove an existing title with a given code
  • /account/userAccount
  • GET POST PUT
 
  • /account/userAccount/applyProduct
  • POST
Apply a product on a user account.
  • /account/userAccount/createOrUpdate
  • POST
Create new or update an existing user account.
  • /account/userAccount/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /account/userAccount/list
  • GET
List user accounts filtered by a billing account's code.
  • /account/userAccount/version
  • GET
Get version of application
  • /account/userAccount/{userAccountCode}
  • DELETE
Remove an existing user account with a given code.
  • /accountOperation
  • GET POST
 
  • /accountOperation/addLitigation
  • POST
Add a new litigation
  • /accountOperation/cancelLitigation
  • POST
Cancel a litigation
  • /accountOperation/findByCustomerAccount
  • GET
List accountOperations matching customer account
  • /accountOperation/list
  • GET POST
 
  • /accountOperation/matchOperations
  • POST
Match operations
  • /accountOperation/transferAccountOperation
  • POST
Transfer an account operation from one customer to another.
  • /accountOperation/unMatchingOperations
  • POST
Unmatching operations
  • /accountOperation/version
  • GET
Get version of application
  • /accountOperation/{accountOperationId}/listMatchedOperations
  • GET
List matched operations for a given account operation
  • /addressbook
  • GET
Find a AddressBook with a given code and from
  • /addressbook/addContact
  • GET
Create a new contact address for a contact code
  • /addressbook/createAll
  • GET
Create All addressbook
  • /addressbook/list
  • GET
List of address
  • /addressbook/version
  • GET
Get version of application
  • /admin/audit/version
  • GET
Get version of application
  • /admin/audit/{enableORdisable}
  • PUT
Update audit logging
  • /admin/fileFormat
  • GET POST PUT
File format resource
  • /admin/fileFormat/createOrUpdate
  • POST
Create new or update an existing File formats
  • /admin/fileFormat/list
  • GET POST
File format resource
  • /admin/fileFormat/version
  • GET
Get version of application
  • /admin/fileFormat/{code}
  • DELETE
Remove an existing File format with a given code
  • /admin/files
  • GET
Get the list of files in a specific directory
  • /admin/files/all
  • GET
Get the list of files
  • /admin/files/createDir
  • POST
Create a directory
  • /admin/files/downloadFile
  • GET
Download file with a given file name.
  • /admin/files/suppressDirectory
  • POST
Suppress the directory
  • /admin/files/suppressFile
  • POST
Suppress the file
  • /admin/files/upload
  • POST
Upload the file form.
  • /admin/files/uploadFileBase64
  • POST
Upload the file with the specific file data in 64 base.
  • /admin/files/uploadZippedFileBase64
  • POST
Upload the zipped file with the file data.
  • /admin/files/version
  • GET
Get version of application
  • /admin/files/zipDirectory
  • POST
Will make a archive of a directory
  • /admin/files/zipFile
  • POST
Will make a archive of a file
  • /admin/genericWorkflow
  • GET POST PUT
 
  • /admin/genericWorkflow/createOrUpdate
  • POST
Create new or update an existing workflow with a given code
  • /admin/genericWorkflow/execute
  • POST
Execute a workflow
  • /admin/genericWorkflow/findByEntity
  • GET
Find a workflow by entity
  • /admin/genericWorkflow/history
  • GET
Find workflow history
  • /admin/genericWorkflow/list
  • GET
List of workflows.
  • /admin/genericWorkflow/version
  • GET
Get version of application
  • /admin/genericWorkflow/{code}
  • DELETE
Remove an existing workflow with a given code
  • /admin/genericWorkflow/{code}/disable
  • POST
Disable a Workflow with a given code
  • /admin/genericWorkflow/{code}/enable
  • POST
Enable a Workflow with a given code
  • /billing/accountingCode
  • GET POST PUT
API for managing AccountingCode entity.
  • /billing/accountingCode/createOrUpdate
  • POST
Create or update an AccountingCode. Checks if the code already exists.
  • /billing/accountingCode/list
  • GET POST
API for managing AccountingCode entity.
  • /billing/accountingCode/version
  • GET
Get version of application
  • /billing/accountingCode/{accountingCode}
  • DELETE
Removes an AccountingCode entity.
  • /billing/accountingCode/{code}/disable
  • POST
Disable a Accounting code with a given code
  • /billing/accountingCode/{code}/enable
  • POST
Enable a Accounting code with a given code
  • /billing/invoicing/cancelBillingRun
  • POST
Cancels a billing run. Sets RatedTransaction.status associated to billing run to OPEN. Remove aggregates and invoice associated to the billing run. Set billingAccount.billingRun to null.
  • /billing/invoicing/createBillingRun
  • POST
Create a new billing run. The id of the created BillingRun is returned on 'message' field of response object.
  • /billing/invoicing/getBillingAccountListInRun
  • POST
Returns the list of billable billing accounts of a billing run
  • /billing/invoicing/getBillingRunInfo
  • POST
Search for a billing run info with a given Id
  • /billing/invoicing/getPostInvoicingReport
  • POST
Returns the post-invoicing report for a given billing run Id
  • /billing/invoicing/getPreInvoicingReport
  • POST
Returns the pre-invoicing report for a given billing run Id
  • /billing/invoicing/validateBillingRun
  • POST
Depending on the status of the billing run, produce the pre-invoicing report, the post-Invoicing 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 registerCdrList, but at the same process rate the EDR created
  • /billing/mediation/confirmReservation
  • POST
Confirms the reservation
  • /billing/mediation/notifyOfRejectedCdrs
  • POST
Notify of rejected CDRs
  • /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/ratedTransaction/cancelRatedTransactions
  • POST
Call service to cancel one or many opened Rated Transactions according to the passed query, cancel an opened Rated Transaction is to set status to CANCELED.
  • /billing/ratedTransaction/list
  • GET POST
Rated transactions related REST API
  • /billing/ratedTransaction/version
  • GET
Get version of application
  • /billing/subscription
  • GET POST PUT
 
  • /billing/subscription/activate
  • POST
Activate a given Subscription.
  • /billing/subscription/activateForCustomer
  • POST
Activate a given Subscription for a customer.
  • /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/applyProduct
  • POST
Apply a product on a subscription.
  • /billing/subscription/cancelSubscriptionRenewal/{subscriptionCode}
  • POST
Cancels the renewal term of an active subscription.
  • /billing/subscription/createOrUpdate
  • POST
Create or update subscription information ONLY. Does not include access, services nor products
  • /billing/subscription/createOrUpdatePartial
  • POST
Create or update subscription information WITH access, services and products. Terminates subscription if termination date is provided on subscription. Terminates service if termination date is provided on service. Activates inactive service if service subscription date is provided. Instantiates service if no matching service found. Updates service if matching service found. Only those services, access and products passed will be afected.
  • /billing/subscription/dueDateDelay
  • GET
Returns the due date delay information.
  • /billing/subscription/findByCustomer
  • GET
List subscriptions matching a given criteria
  • /billing/subscription/instantiateServices
  • POST
Instantiate a Service subscription
  • /billing/subscription/list
  • GET POST
 
  • /billing/subscription/listAll
  • GET
Deprecated in v.4.7.2 Use /list instead.
  • /billing/subscription/listOneshotChargeOthers
  • GET
Search for a subscription with a given code.
  • /billing/subscription/oneShotCharge/{subscriptionCode}/{oneshotChargeCode}
  • DELETE
Search for a subscription with a given code.
  • /billing/subscription/rate
  • POST
Give a rate data for subscription
  • /billing/subscription/resume
  • PUT
Resume an existing subscription
  • /billing/subscription/resumeServices
  • PUT
Resume an existing services
  • /billing/subscription/serviceInstance
  • GET
Find service instance.
  • /billing/subscription/serviceInstances
  • GET
Returns a list of service instances.
  • /billing/subscription/subscribeAndActivateServices
  • POST
Create a subscription and activate services in a single transaction.
  • /billing/subscription/suspend
  • PUT
Suspend an existing subscription
  • /billing/subscription/suspendServices
  • PUT
Suspend an existing services
  • /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/updateServices
  • PUT
Update existing services
  • /billing/subscription/version
  • GET
Get version of application
  • /billing/subscription/{code}/offer
  • PATCH
 
  • /billing/subscription/{code}/offer/rollback
  • PATCH
 
  • /billing/wallet/balance/current
  • POST
Gets the current (open or reserved) wallet balance amount at a given level and date period. In wallet operation, status='OPEN OR RESERVED'.
  • /billing/wallet/balance/open
  • POST
Gets the open wallet balance amount at a given level and date period. In wallet operation, status='OPEN'.
  • /billing/wallet/balance/reserved
  • POST
Gets the reserved wallet balance amount at a given level and date period. In wallet operation, status='RESERVED'.
  • /billing/wallet/operation
  • POST
Create a new operation
  • /billing/wallet/operation/find
  • POST
Search for an operation with a given (example) code. Deprecated in v.4.7.2
  • /billing/wallet/operation/list
  • GET POST
Wallet operation and balance related REST API
  • /billing/wallet/reservation
  • POST PUT
Wallet operation and balance related REST API
  • /billing/wallet/reservation/confirm
  • POST
Confirm a reservation given an id.
  • /billing/wallet/reservation/{reservationId}
  • DELETE
Cancel a reservation given an id.
  • /billing/wallet/template
  • GET POST PUT
Wallet operation and balance related REST API
  • /billing/wallet/template/createOrUpdate
  • POST
Create new or update an existing wallet template
  • /billing/wallet/template/{walletTemplateCode}
  • DELETE
Remove an existing wallet template with a given code
  • /billing/wallet/version
  • GET
Get version of application
  • /billingCycle
  • GET POST PUT
 
  • /billingCycle/createOrUpdate
  • POST
Create new or update an existing billing cycle with a given code
  • /billingCycle/version
  • GET
Get version of application
  • /billingCycle/{billingCycleCode}
  • DELETE
Remove an existing billing cycle with a given code.
  • /calendar
  • GET POST PUT
 
  • /calendar/bankingDateStatus
  • GET
Gets the banking date status.
  • /calendar/createOrUpdate
  • POST
Create new or update an existing calendar with a given code.
  • /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
Create new or update an existing business offer model.
  • /catalog/businessOfferModel/install
  • PUT
Install business offer model module.
  • /catalog/businessOfferModel/list
  • GET POST
 
  • /catalog/businessOfferModel/version
  • GET
Get version of application
  • /catalog/businessOfferModel/{businessOfferModelCode}
  • DELETE
Remove an existing business offer model with a given code.
  • /catalog/businessProductModel
  • GET POST PUT
 
  • /catalog/businessProductModel/createOrUpdate
  • POST
Create new or update an existing business product model
  • /catalog/businessProductModel/install
  • PUT
Install business product model module
  • /catalog/businessProductModel/list
  • GET
List business product models
  • /catalog/businessProductModel/version
  • GET
Get version of application
  • /catalog/businessProductModel/{businessProductModelCode}
  • DELETE
Remove an existing business product model with a given code
  • /catalog/businessServiceModel
  • GET POST PUT
 
  • /catalog/businessServiceModel/createOrUpdate
  • POST
Create new or update an existing business service model
  • /catalog/businessServiceModel/install
  • PUT
Install business offer model module
  • /catalog/businessServiceModel/list
  • GET
List business service model
  • /catalog/businessServiceModel/version
  • GET
Get version of application
  • /catalog/businessServiceModel/{businessServiceModelCode}
  • DELETE
Remove an existing business service model with a given code
  • /catalog/channel
  • DELETE GET POST PUT
 
  • /catalog/channel/createOrUpdate
  • POST
Create new or update an existing channel
  • /catalog/channel/version
  • GET
Get version of application
  • /catalog/channel/{code}/disable
  • POST
Disable a Channel with a given code
  • /catalog/channel/{code}/enable
  • POST
Enable a Channel with a given code
  • /catalog/channelsAndSegments
  • GET
Returns all the active channels list
  • /catalog/channelsAndSegments/version
  • GET
Get version of application
  • /catalog/chargeTemplate
  • GET
Search for a charge template with a given code
  • /catalog/chargeTemplate/version
  • GET
Get version of application
  • /catalog/counterTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.CounterTemplate.
  • /catalog/counterTemplate/createOrUpdate
  • POST
Create or update a counter Template.
  • /catalog/counterTemplate/version
  • GET
Get version of application
  • /catalog/counterTemplate/{code}/disable
  • POST
Disable a Counter template with a given code
  • /catalog/counterTemplate/{code}/enable
  • POST
Enable a Counter template with a given code
  • /catalog/counterTemplate/{counterTemplateCode}
  • DELETE
Remove counter template with a given code.
  • /catalog/discountPlan
  • DELETE GET POST PUT
 
  • /catalog/discountPlan/createOrUpdate
  • POST
Create new or update an existing discount plan
  • /catalog/discountPlan/list
  • GET
List discount plan
  • /catalog/discountPlan/version
  • GET
Get version of application
  • /catalog/discountPlan/{code}/disable
  • POST
Disable a Discount plan with a given code
  • /catalog/discountPlan/{code}/enable
  • POST
Enable a Discount plan with a given code
  • /catalog/discountPlanItem
  • GET POST PUT
CRUD/list discountPlanItem via REST API.
  • /catalog/discountPlanItem/createOrUpdate
  • POST
create/update a discount plan item.
  • /catalog/discountPlanItem/list
  • GET
List all discount plan items by current user.
  • /catalog/discountPlanItem/version
  • GET
Get version of application
  • /catalog/discountPlanItem/{code}/disable
  • POST
Disable a Discount plan item with a given code
  • /catalog/discountPlanItem/{code}/enable
  • POST
Enable a Discount plan item with a given code
  • /catalog/discountPlanItem/{discountPlanItemCode}
  • DELETE
remove a discount plan item by code.
  • /catalog/offerTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.OfferTemplate.
  • /catalog/offerTemplate/createOrUpdate
  • POST
Create or update offer template based on a given code.
  • /catalog/offerTemplate/list
  • GET POST
Web service for managing org.meveo.model.catalog.OfferTemplate.
  • /catalog/offerTemplate/version
  • GET
Get version of application
  • /catalog/offerTemplate/{code}/disable
  • POST
Disable a Offer template with a given code
  • /catalog/offerTemplate/{code}/enable
  • POST
Enable a Offer template with a given code
  • /catalog/offerTemplate/{offerTemplateCode}
  • DELETE
Remove offer template with a given code and validity dates. If no validity dates are provided, an offer template valid on a current date will be deleted.
  • /catalog/offerTemplateCategory
  • DELETE GET POST PUT
 
  • /catalog/offerTemplateCategory/createOrUpdate
  • POST
Create new or update an existing offer template category
  • /catalog/offerTemplateCategory/version
  • GET
Get version of application
  • /catalog/offerTemplateCategory/{code}/disable
  • POST
Disable a Offer template category with a given code
  • /catalog/offerTemplateCategory/{code}/enable
  • POST
Enable a Offer template category with a given code
  • /catalog/oneShotChargeTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.OneShotChargeTemplate.
  • /catalog/oneShotChargeTemplate/createOrUpdate
  • POST
Create new or update an existing.
  • /catalog/oneShotChargeTemplate/list
  • GET
List one shot charge template with the following filters.
  • /catalog/oneShotChargeTemplate/version
  • GET
Get version of application
  • /catalog/oneShotChargeTemplate/{code}/disable
  • POST
Disable a One shot charge template with a given code
  • /catalog/oneShotChargeTemplate/{code}/enable
  • POST
Enable a One shot charge template with a given code
  • /catalog/oneShotChargeTemplate/{oneShotChargeTemplateCode}
  • DELETE
Remove one shot charge tesmplate with a given code.
  • /catalog/pricePlan
  • GET POST PUT
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/createOrUpdate
  • POST
Create new or update an existing price plan matrix
  • /catalog/pricePlan/list
  • GET
List price plan matrix.
  • /catalog/pricePlan/version
  • GET
Get version of application
  • /catalog/pricePlan/{code}/disable
  • POST
Disable a Price plan with a given code
  • /catalog/pricePlan/{code}/enable
  • POST
Enable a Price plan with a given code
  • /catalog/pricePlan/{pricePlanCode}
  • DELETE
Remove an existing price plan matrix with a given code
  • /catalog/recurringChargeTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.RecurringChargeTemplate.
  • /catalog/recurringChargeTemplate/createOrUpdate
  • POST
Create new or update an existing recurring charge template
  • /catalog/recurringChargeTemplate/version
  • GET
Get version of application
  • /catalog/recurringChargeTemplate/{code}/disable
  • POST
Disable a Recurring charge template with a given code
  • /catalog/recurringChargeTemplate/{code}/enable
  • POST
Enable a Recurring charge template with a given code
  • /catalog/recurringChargeTemplate/{recurringChargeTemplateCode}
  • DELETE
Remove an existing recurring charge template with a given code.
  • /catalog/serviceTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.ServiceTemplate.
  • /catalog/serviceTemplate/createOrUpdate
  • POST
Create new or update an existing service template
  • /catalog/serviceTemplate/list
  • GET
Gets a service template list widh .
  • /catalog/serviceTemplate/version
  • GET
Get version of application
  • /catalog/serviceTemplate/{code}/disable
  • POST
Disable a Service template with a given code
  • /catalog/serviceTemplate/{code}/enable
  • POST
Enable a Service template with a given code
  • /catalog/serviceTemplate/{serviceTemplateCode}
  • DELETE
Remove service template with a given code.
  • /catalog/triggeredEdr
  • GET POST PUT
 
  • /catalog/triggeredEdr/createOrUpdate
  • POST
Create new or update an existing triggered edr template
  • /catalog/triggeredEdr/version
  • GET
Get version of application
  • /catalog/triggeredEdr/{triggeredEdrCode}
  • DELETE
Remove an existing triggered edr template with a given code.
  • /catalog/unitOfMeasure
  • GET POST PUT
 
  • /catalog/unitOfMeasure/createOrUpdate
  • POST
Create new or update an existing unitOfMeasure
  • /catalog/unitOfMeasure/list
  • GET
List all currencies.
  • /catalog/unitOfMeasure/version
  • GET
Get version of application
  • /catalog/unitOfMeasure/{code}
  • DELETE
Remove an existing unitOfMeasure with a given code
  • /catalog/usageChargeTemplate
  • GET POST PUT
Web service for managing org.meveo.model.catalog.UsageChargeTemplate.
  • /catalog/usageChargeTemplate/createOrUpdate
  • POST
Create new or update an existing charge template with a given code.
  • /catalog/usageChargeTemplate/list
  • POST
List UsageChargeTemplate matching a given criteria
  • /catalog/usageChargeTemplate/version
  • GET
Get version of application
  • /catalog/usageChargeTemplate/{code}/disable
  • POST
Disable a Usage charge template with a given code
  • /catalog/usageChargeTemplate/{code}/enable
  • POST
Enable a Usage charge template with a given code
  • /catalog/usageChargeTemplate/{usageChargeTemplateCode}
  • DELETE
Remove usage charge template with a given code.
  • /catalogManagement/category
  • GET
Get a list of categories
  • /catalogManagement/category/{code}
  • GET
Get a single category by its code
  • /catalogManagement/createOfferFromBOM
  • POST
Create offer from BOM definition
  • /catalogManagement/createProductFromBPM
  • POST
Create product from BPM definition
  • /catalogManagement/createServiceFromBSM
  • POST
Create service from BSM definition
  • /catalogManagement/productChargeTemplate
  • POST PUT
TMForum Product catalog API specification implementation. Note: only READ type methods are implemented.
  • /catalogManagement/productChargeTemplate/createOrUpdate
  • POST
Create or update product charge template
  • /catalogManagement/productChargeTemplate/list
  • GET
List all productChargeTemplates
  • /catalogManagement/productChargeTemplate/{code}
  • DELETE GET
TMForum Product catalog API specification implementation. Note: only READ type methods are implemented.
  • /catalogManagement/productChargeTemplate/{code}/disable
  • POST
Disable a Product charge template with a given code
  • /catalogManagement/productChargeTemplate/{code}/enable
  • POST
Enable a Product charge template with a given code
  • /catalogManagement/productOffering
  • GET
Get a list of product offerings optionally filtering by some criteria
  • /catalogManagement/productOffering/{id}
  • GET
Get details of a single Product template and validity dates. If no validity dates are provided, an Product template valid on a current date will be returned.
  • /catalogManagement/productSpecification
  • GET
Get a list of product specifications optionally filtering by some criteria
  • /catalogManagement/productSpecification/{id}
  • GET
Get details of a single product
  • /catalogManagement/productTemplate
  • POST PUT
TMForum Product catalog API specification implementation. Note: only READ type methods are implemented.
  • /catalogManagement/productTemplate/createOrUpdate
  • POST
Create or update product template
  • /catalogManagement/productTemplate/list
  • GET
List all product templates optionally filtering by code and validity dates. If neither date is provided, validity dates will not be considered. If only validFrom is provided, a search will return products valid on a given date. If only validTo date is provided, a search will return products valid from today to a given date.
  • /catalogManagement/productTemplate/{code}
  • DELETE GET
TMForum Product catalog API specification implementation. Note: only READ type methods are implemented.
  • /catalogManagement/productTemplate/{code}/disable
  • POST
Disable a Product template with a given code
  • /catalogManagement/productTemplate/{code}/enable
  • POST
Enable a Product template with a given code
  • /catalogManagement/version
  • GET
Get version of application
  • /chart
  • DELETE GET POST PUT
 
  • /chart/bar
  • POST PUT
 
  • /chart/createOrUpdate
  • POST
Create new or update an existing chart with a given code
  • /chart/line
  • POST PUT
 
  • /chart/pie
  • POST PUT
 
  • /chart/version
  • GET
Get version of application
  • /chart/{code}/disable
  • POST
Disable a Chart with a given code
  • /chart/{code}/enable
  • POST
Enable a Chart with a given code
  • /communication/emailTemplate
  • GET POST PUT
 
  • /communication/emailTemplate/createOrUpdate
  • POST
Create new or update an existing email template by dto
  • /communication/emailTemplate/list
  • GET
List email templates
  • /communication/emailTemplate/version
  • GET
Get version of application
  • /communication/emailTemplate/{code}
  • DELETE
remove an emailTemplate by code
  • /communication/meveoInstance
  • GET POST PUT
 
  • /communication/meveoInstance/createOrUpdate
  • POST
CreateOrUpdate a meveoInstance by dto
  • /communication/meveoInstance/list
  • GET
List meveoInstances
  • /communication/meveoInstance/version
  • GET
Get version of application
  • /communication/meveoInstance/{code}
  • DELETE
Remove a meveoInstance by code
  • /communications/sms/send
  • POST
Send SMS to Customer.
  • /communications/sms/version
  • GET
Get version of application
  • /configurations
  • GET
Converts system properties into json string.
  • /configurations/version
  • GET
Get version of application
  • /contact
  • GET POST PUT
 
  • /contact/createOrUpdate
  • POST
Create or update a CRM contact
  • /contact/importCSVFile
  • POST
Import the contact list from a file
  • /contact/importCSVText
  • POST
Import the contact list to a CSV file text
  • /contact/list
  • GET POST
 
  • /contact/version
  • GET
Get version of application
  • /contact/{code}
  • DELETE
Delete a contact with a given code
  • /contact/{code}/{tag}
  • DELETE PUT
 
  • /country
  • GET POST PUT
Web service for managing org.meveo.model.billing.Country and org.meveo.model.billing.TradingCountry.
  • /country/createOrUpdate
  • POST
Create or update a Trading Country base from the supplied country code. If the country code does not exists, a country and tradingCountry records are created
  • /country/version
  • GET
Get version of application
  • /country/{code}/disable
  • POST
Disable a Trading country with a given country code
  • /country/{code}/enable
  • POST
Enable a Trading country with a given country code
  • /country/{countryCode}/{currencyCode}
  • DELETE
Does not delete a country but the tradingCountry associated to it.
  • /countryIso
  • GET POST PUT
Web service for managing org.meveo.model.billing.Country.
  • /countryIso/createOrUpdate
  • POST
Creates or modify a tradingCountry base from the supplied country code.
  • /countryIso/list
  • GET
List all countries.
  • /countryIso/version
  • GET
Get version of application
  • /countryIso/{countryCode}
  • DELETE
Does not delete a country but the tradingCountry associated to it.
  • /currency
  • GET POST PUT
Web service for managing org.meveo.model.admin.Currency and org.meveo.model.billing.TradingCurrency.
  • /currency/createOrUpdate
  • POST
Create or Update tradingCurrency base on currency code. If the currency code does not exists, a currency record is created
  • /currency/version
  • GET
Get version of application
  • /currency/{code}/disable
  • POST
Disable a Trading currency with a given currency code
  • /currency/{code}/enable
  • POST
Enable a Trading currency with a given currency code
  • /currency/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /currencyIso
  • GET POST PUT
Web service for managing Currency.
  • /currencyIso/createOrUpdate
  • POST
Creates or modify a tradingCurrency base on currency code.
  • /currencyIso/list
  • GET
List all currencies.
  • /currencyIso/version
  • GET
Get version of application
  • /currencyIso/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /customEntityInstance/list/{customEntityTemplateCode}
  • GET
List custom entity instances.
  • /customEntityInstance/version
  • GET
Get version of application
  • /customEntityInstance/{customEntityTemplateCode}
  • POST PUT
Rest API for custom entity instance management
  • /customEntityInstance/{customEntityTemplateCode}/createOrUpdate
  • POST
Create new or update an existing custom entity instance with a given code.
  • /customEntityInstance/{customEntityTemplateCode}/{code}
  • DELETE GET
Rest API for custom entity instance management
  • /customEntityInstance/{customEntityTemplateCode}/{code}/disable
  • POST
Disable a Custom entity instance with a given code
  • /customEntityInstance/{customEntityTemplateCode}/{code}/enable
  • POST
Enable a Custom entity instance with a given code
  • /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
  • /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}/disable
  • POST
Disable a Custom field template with a given code
  • /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}/enable
  • POST
Enable a Custom field template with a given code
  • /customTable
  • DELETE POST PUT
Rest API for custom table data management
  • /customTable/createOrUpdate
  • POST
Append or update data in a custom table
  • /customTable/disable
  • POST
Mark records as disabled in a custom table. Applies only to those custom tables that contain a field 'disabled'
  • /customTable/enable
  • POST
Mark records as enabled in a custom table. Applies only to those custom tables that contain a field 'disabled'
  • /customTable/list/{customTableCode}
  • POST
Search in custom tables
  • /customTable/listFromWrapper
  • POST
Search in custom tables using CustomTableWrapper
  • /customTable/version
  • GET
Get version of application
  • /document/pdf
  • POST
Generate PDF document.
  • /document/pdf/version
  • GET
Get version of application
  • /document/sign/files/{id}/download
  • GET
Download the files with the given id
  • /document/sign/procedures
  • POST
Creates the procedure.
  • /document/sign/procedures/{id}
  • GET
Gets the procedure by id.
  • /document/sign/procedures/{id}/status
  • GET
Gets the procedure status by id.
  • /document/sign/version
  • GET
Get version of application
  • /dunning/dunningDocument
  • GET POST
 
  • /dunning/dunningDocument/addPayments
  • PUT
Add Payments to dunningDocument.
  • /dunning/dunningDocument/list
  • POST
List dunningDocuments matching a given criteria
  • /dunning/dunningDocument/version
  • GET
Get version of application
  • /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
To be sure the compatibility of above method we will create a new one. 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/action/execute/{actionCode}/{appliesTo}/{entityCode}
  • POST
Execute and action of a given entity
  • /entityCustomization/entity/createOrUpdate
  • POST
Define new or update existing custom entity template definition
  • /entityCustomization/entity/list
  • GET
List custom entity templates.
  • /entityCustomization/entity/listELFiltered
  • GET
Returns a list of filtered CustomFieldTemplate of an entity. The list of entity is evaluted againsts the entity with the given code.
  • /entityCustomization/entity/{code}/disable
  • POST
Disable a Custom entity template with a given code
  • /entityCustomization/entity/{code}/enable
  • POST
Enable a Custom entity template with a given code
  • /entityCustomization/entity/{customEntityTemplateCode}
  • DELETE GET
 
  • /entityCustomization/field
  • GET POST PUT
 
  • /entityCustomization/field/createOrUpdate
  • POST
Define new or update existing custom field definition
  • /entityCustomization/field/{actionCode}/{appliesTo}/disable
  • POST
Disable a Entity action with a given code
  • /entityCustomization/field/{actionCode}/{appliesTo}/enable
  • POST
Enable a Entity action with a given code
  • /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}
  • DELETE
Remove custom field definition given its code and entity it applies to
  • /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}/disable
  • POST
Disable a Custom field template with a given code
  • /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}/enable
  • POST
Enable a Custom field template with a given code
  • /entityCustomization/listBusinessEntityForCFVByCode
  • GET
Returns a List of BusinessEntities given a CustomFieldTemplate code. The CustomFieldTemplate is pulled from the database and entityClass is use in query. For example entity class is of type OfferTemplate, then it will return a list of OfferTemplates.
  • /entityCustomization/version
  • GET
Get version of application
  • /filter
  • GET
Find a filter with a given code
  • /filter/createOrUpdate
  • POST
Create new or update an existing filter with a given code
  • /filter/version
  • GET
Get version of application
  • /filter/{code}/disable
  • POST
Disable a Filter with a given code
  • /filter/{code}/enable
  • POST
Enable a Filter with a given code
  • /filteredList/fullSearch
  • GET
Execute a search in Elastic Search on all fields (_all field) and all entity types Deprecated in v. 6.2. Use /search instead
  • /filteredList/listByFilter
  • POST
Execute a filter to retrieve a list of entities
  • /filteredList/reindex
  • GET
Clean and reindex Elastic Search repository
  • /filteredList/search
  • GET
Execute a search in Elastic Search on all fields (_all field)
  • /filteredList/searchByField
  • GET
Execute a search in Elastic Search on given fields for given values. Query values by field are passed in extra query parameters in a form of fieldName=valueToMatch
  • /filteredList/version
  • GET
Get version of application
  • /finance/reportExtracts
  • DELETE GET POST
API for managing ReportExtract.
  • /finance/reportExtracts/createOrUpdate
  • POST
Create / update a report extract with the given data.
  • /finance/reportExtracts/executionHistory
  • GET
API for managing ReportExtract.
  • /finance/reportExtracts/executionHistory/list
  • GET POST
API for managing ReportExtract.
  • /finance/reportExtracts/list
  • GET
Returns a paginated list of ReportExtract.
  • /finance/reportExtracts/run
  • POST
Runs a report extract with the given parameter.
  • /finance/reportExtracts/version
  • GET
Get version of application
  • /finance/reportExtracts/{code}/disable
  • POST
Disable a Report extract with a given code
  • /finance/reportExtracts/{code}/enable
  • POST
Enable a Report extract with a given code
  • /hierarchy/userGroupLevel
  • GET POST PUT
 
  • /hierarchy/userGroupLevel/createOrUpdate
  • POST
Create new or update an existing user hierarchy level with a given code
  • /hierarchy/userGroupLevel/list
  • GET POST
 
  • /hierarchy/userGroupLevel/version
  • GET
Get version of application
  • /hierarchy/userGroupLevel/{hierarchyLevelCode}
  • DELETE
Remove an existing hierarchy level with a given code
  • /iban/validate
  • GET
validate the iban and/or bic
  • /iban/version
  • GET
Get version of application
  • /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
Web service for managing org.meveo.model.billing.Invoice.
  • /invoice/cancel
  • POST
Cancel an invoice based on invoice id.
  • /invoice/fetchPdfInvoice
  • POST
Finds an invoice based on invoice number and optionally an invoice type and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.
  • /invoice/fetchXMLInvoice
  • POST
Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string.
  • /invoice/generateDraftInvoice
  • POST
Generate a Draft invoice
  • /invoice/generateInvoice
  • POST
Launch all the invoicing process for a given billingAccount, that's mean.
  • Create rated transactions
  • Create an exceptional billingRun with given dates
  • Validate the pre-invoicing report
  • Validate the post-invoicing report
  • Validate the BillingRun
  • /invoice/getPdfInvoice
  • GET
Finds an invoice based on invoice number and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.
  • /invoice/getPdfInvoiceWithType
  • GET
Finds an invoice based on invoice number and invoice type and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.
  • /invoice/getXMLInvoice
  • GET
Finds an invoice based on its invoice number and return it as xml string.
  • /invoice/getXMLInvoiceWithType
  • GET
Finds an invoice based on invoice number and invoice type. It returns the result as xml string
  • /invoice/list
  • GET POST
Web service for managing org.meveo.model.billing.Invoice.
  • /invoice/listInvoiceByCustomerAccount
  • GET
Search for a list of invoices given a customer account code. Deprecated in v.4.7.2, use "list()" instead with criteria "billingAccount.customerAccount.code=xxx"
  • /invoice/listPresentInAR
  • GET
List invoices with account operation for a given customer account Deprecated in v.4.8. Use list() instead with criteria "recordedInvoice=IS_NOT_NULL and billingAccount.customerAccount.code=xxx"
  • /invoice/sendByEmail
  • POST
Send invoice by Email.
  • /invoice/validate
  • POST
Validate an invoice based on the invoice id.
  • /invoice/version
  • GET
Get version of application
  • /invoiceCategory
  • GET POST PUT
Web service for managing org.meveo.model.billing.InvoiceCategory.
  • /invoiceCategory/createOrUpdate
  • POST
Create or update invoice with a given code.
  • /invoiceCategory/list
  • POST
List InvoiceCategory matching a given criteria
  • /invoiceCategory/version
  • GET
Get version of application
  • /invoiceCategory/{invoiceCategoryCode}
  • DELETE
Remove invoice with a given code.
  • /invoiceSequence
  • GET POST PUT
Web service for managing org.meveo.model.billing.InvoiceSequence.
  • /invoiceSequence/createOrUpdate
  • POST
Create new or update an existing invoiceSequence with a given code.
  • /invoiceSequence/list
  • GET
List of invoiceSequence.
  • /invoiceSequence/version
  • GET
Get version of application
  • /invoiceSubCategory
  • GET POST PUT
Web service for managing org.meveo.model.billing.InvoiceSubCategory.
  • /invoiceSubCategory/createOrUpdate
  • POST
Create or update invoice sub category.
  • /invoiceSubCategory/list
  • POST
List InvoiceSubCategory matching a given criteria
  • /invoiceSubCategory/version
  • GET
Get version of application
  • /invoiceSubCategory/{invoiceSubCategoryCode}
  • DELETE
Remove invoice sub category with a given code.
  • /invoiceType
  • GET POST PUT
Web service for managing org.meveo.model.billing.InvoiceType.
  • /invoiceType/createOrUpdate
  • POST
Create new or update an existing invoiceType with a given code.
  • /invoiceType/list
  • GET
List of invoiceType.
  • /invoiceType/version
  • GET
Get version of application
  • /invoiceType/{invoiceTypeCode}
  • DELETE
Remove invoiceType with a given code.
  • /job
  • GET PUT
 
  • /job/create
  • POST
Create a new job instance
  • /job/createOrUpdate
  • POST
Create new or update an existing job instance with a given code
  • /job/execute
  • POST
Execute a given job instance info
  • /job/jobReport
  • GET
Find a job execution result with a given id
  • /job/jobReport/list
  • GET POST
 
  • /job/list
  • GET
Deprecated in v.4.7.2 Use /list instead.
  • /job/listCategories
  • GET
List job categories
  • /job/stop/{jobInstanceCode}
  • POST
Stop a given job instance info
  • /job/timer
  • GET POST PUT
 
  • /job/timer/createOrUpdate
  • POST
Create new or update an existing timer entity with a given code
  • /job/timer/{timerCode}
  • DELETE
Remove an existing timer with a given code
  • /job/version
  • GET
Get version of application
  • /job/{jobInstanceCode}
  • DELETE
Remove an existing job instance with a given code
  • /jobInstance
  • GET
Find a job instance with a given code
  • /jobInstance/create
  • POST
Create a new job instance
  • /jobInstance/createOrUpdate
  • POST
Create new or update an existing job instance with a given code
  • /jobInstance/update
  • POST
Update an existing job instance
  • /jobInstance/version
  • GET
Get version of application
  • /jobInstance/{code}/disable
  • POST
Disable a Job instance with a given code
  • /jobInstance/{code}/enable
  • POST
Enable a Job instance with a given code
  • /jobInstance/{jobInstanceCode}
  • DELETE
Remove an existing job instance with a given code
  • /language
  • GET POST PUT
* Web service for managing org.meveo.model.billing.Language and org.meveo.model.billing.TradingLanguage.
  • /language/createOrUpdate
  • POST
Create or update a language if it doesn't exists.
  • /language/version
  • GET
Get version of application
  • /language/{code}/disable
  • POST
Disable a Trading language with a given language code
  • /language/{code}/enable
  • POST
Enable a Trading language with a given language code
  • /language/{languageCode}
  • DELETE
Does not delete a language but the tradingLanguage associated to it.
  • /languageIso
  • GET POST PUT
* Web service for managing org.meveo.model.billing.Language.
  • /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
  • GET POST PUT
 
  • /measurableQuantity/findMVByDateAndPeriod
  • GET
Find a Measurable value during a period of date and period
  • /measurableQuantity/list
  • GET
List Measurable quantity with a given code.
  • /measurableQuantity/version
  • GET
Get version of application
  • /measurableQuantity/{code}
  • DELETE
Remove Measurable quantity with a given code.
  • /measurableQuantity/{code}/disable
  • POST
Disable a Measurable quantity with a given code
  • /measurableQuantity/{code}/enable
  • POST
Enable a Measurable quantity with a given code
  • /metrics/config
  • DELETE GET POST PUT
Web service for managing MetricsConfiguration.
  • /metrics/config/version
  • GET
Get version of application
  • /module
  • GET POST PUT
 
  • /module/createOrUpdate
  • POST
Create new or update an existing Meveo module
  • /module/disable
  • GET
Disable a Meveo's module with a given code
  • /module/enable
  • GET
Enable a Meveo's module with a given code
  • /module/install
  • PUT
Install Meveo module
  • /module/list
  • GET
List all Meveo's modules
  • /module/uninstall
  • GET
uninstall a Meveo's module with a given code
  • /module/version
  • GET
Get version of application
  • /module/{code}
  • DELETE
Remove an existing module with a given code
  • /module/{code}/disable
  • POST
Disable a Opencell module with a given code
  • /module/{code}/enable
  • POST
Enable a Opencell module with a given code
  • /notification
  • GET POST PUT
REST service for managing Notification object.
  • /notification/createOrUpdate
  • POST
Create new or update an existing notification with a given code
  • /notification/email
  • GET POST PUT
 
  • /notification/email/createOrUpdate
  • POST
Create new or update an existing email notification with a given code
  • /notification/email/version
  • GET
Get version of application
  • /notification/email/{code}/disable
  • POST
Disable a Email notification with a given code
  • /notification/email/{code}/enable
  • POST
Enable a Email notification with a given code
  • /notification/email/{notificationCode}
  • DELETE
Remove an existing email notification with a given code
  • /notification/jobTrigger
  • GET POST PUT
 
  • /notification/jobTrigger/createOrUpdate
  • POST
Create new or update an existing job trigger with a given code
  • /notification/jobTrigger/version
  • GET
Get version of application
  • /notification/jobTrigger/{code}/disable
  • POST
Disable a Job execution trigger notification with a given code
  • /notification/jobTrigger/{code}/enable
  • POST
Enable a Job execution trigger notification with a given code
  • /notification/jobTrigger/{notificationCode}
  • DELETE
Remove an existing job trigger with a given code
  • /notification/listInboundRequest
  • GET
List inbound requests
  • /notification/listNotificationHistory
  • GET
List the notification history
  • /notification/version
  • GET
Get version of application
  • /notification/webhook
  • GET POST PUT
 
  • /notification/webhook/createOrUpdate
  • POST
Create new or update an existing web hook notification with a given code
  • /notification/webhook/version
  • GET
Get version of application
  • /notification/webhook/{code}/disable
  • POST
Disable a Webhook notification with a given code
  • /notification/webhook/{code}/enable
  • POST
Enable a Webhook notification with a given code
  • /notification/webhook/{notificationCode}
  • DELETE
Remove an existing web hook notification with a given code
  • /notification/{code}/disable
  • POST
Disable a Script type notification with a given code
  • /notification/{code}/enable
  • POST
Enable a Script type notification with a given code
  • /notification/{notificationCode}
  • DELETE
Remove an existing notification with a given code
  • /occTemplate
  • GET POST PUT
 
  • /occTemplate/createOrUpdate
  • POST
Create or update OccTemplate.
  • /occTemplate/list
  • GET POST
 
  • /occTemplate/version
  • GET
Get version of application
  • /occTemplate/{occTemplateCode}
  • DELETE
Remove OccTemplate with a given code.
  • /orderManagement/productOrder
  • GET POST
TMForum Product ordering API specification implementation
  • /orderManagement/productOrder/validate
  • GET
validate a product order
  • /orderManagement/productOrder/{id}
  • PATCH
Modify partially a product order
  • /orderManagement/productOrder/{orderId}
  • DELETE GET
TMForum Product ordering API specification implementation
  • /orderManagement/productOrder/{orderId}/applicableDueDateDelay
  • GET
Evaluate and return the dueDateDelayEL. It checks the EL in this order: Order, CustomerAccount, BillingCycle.
  • /orderManagement/productOrder/{orderId}/simpleDueDateDelay
  • PUT
Updates the dueDateDelayEL of an Order.
  • /payment
  • POST
Creates automated payment. It also process if a payment is matching or not
  • /payment/cardPaymentMethod
  • DELETE GET POST PUT
The Interface PaymentRs.
  • /payment/cardPaymentMethod/list
  • GET
List available card payment methods for a given customer account identified either by id or by code.
  • /payment/create
  • POST
Creates automated payment. It also process if a payment is matching or not Deprecated and replaced by "reatePayment" using /payment path
  • /payment/creditCategory
  • GET POST PUT
 
  • /payment/creditCategory/createOrUpdate
  • POST
Create or update a credit category payment
  • /payment/creditCategory/list
  • GET
Retrieve the list of credit category paiement
  • /payment/creditCategory/version
  • GET
Get version of application
  • /payment/creditCategory/{creditCategoryCode}
  • DELETE
Delete a credit category with his given code
  • /payment/customerPayment
  • GET
Returns a list of account operations along with the balance of a customer.
  • /payment/ddRequestBuilder
  • DELETE GET POST PUT
The Interface PaymentRs.
  • /payment/ddRequestBuilder/createOrUpdate
  • POST
Create or update ddRequest builder.
  • /payment/ddRequestBuilder/list
  • GET POST
The Interface PaymentRs.
  • /payment/ddRequestBuilder/{code}/disable
  • POST
Disable a ddRequest builder with a given code
  • /payment/ddRequestBuilder/{code}/enable
  • POST
Enable a ddRequest builder with a given code
  • /payment/ddrequestLotOp
  • POST
Create a ddrequestLotOp by dto
  • /payment/ddrequestLotOp/list
  • GET
List ddrequestLotOps by fromDueDate,toDueDate,status
  • /payment/ddrequestLotOp/version
  • GET
Get version of application
  • /payment/history/list
  • GET POST
The Interface PaymentRs.
  • /payment/paymentGateway
  • DELETE GET POST PUT
The Interface PaymentRs.
  • /payment/paymentGateway/createOrUpdate
  • POST
Create or update payment gateway.
  • /payment/paymentGateway/getHostedCheckoutUrl
  • GET
Get the Hosted Checkout URL for payment.
  • /payment/paymentGateway/list
  • GET POST
The Interface PaymentRs.
  • /payment/paymentGateway/rumSequence
  • POST PUT
The Interface PaymentRs.
  • /payment/paymentGateway/rumSequence/{code}
  • DELETE GET
The Interface PaymentRs.
  • /payment/paymentGateway/rumSequence/{code}/next
  • POST
Generates the next RUM sequence number.
  • /payment/paymentGateway/{code}/disable
  • POST
Disable a Payment gateway with a given code
  • /payment/paymentGateway/{code}/enable
  • POST
Enable a Payment gateway with a given code
  • /payment/paymentMethod
  • DELETE GET POST PUT
The Interface PaymentRs.
  • /payment/paymentMethod/findByCustomerAccount
  • GET
List Payment Methods matching a customer account
  • /payment/paymentMethod/list
  • GET POST
The Interface PaymentRs.
  • /payment/paymentMethod/{id}/disable
  • POST
Disable a Payment method with a given id
  • /payment/paymentMethod/{id}/enable
  • POST
Enable a Payment method with a given id
  • /payment/paymentScheduleInstance
  • GET PUT
The Interface PaymentRs.
  • /payment/paymentScheduleInstance/cancel
  • PUT
Cancel payment Schedules instance.
  • /payment/paymentScheduleInstance/list
  • GET POST
The Interface PaymentRs.
  • /payment/paymentScheduleInstance/terminate
  • PUT
Terminate payment Schedules instance.
  • /payment/paymentScheduleTemplate
  • DELETE GET POST PUT
The Interface PaymentRs.
  • /payment/paymentScheduleTemplate/createOrUpdate
  • POST
Create or update payment Schedules template.
  • /payment/paymentScheduleTemplate/list
  • GET POST
The Interface PaymentRs.
  • /payment/rumSequences
  • PUT
Update the Provider's RUM sequence configuration.
  • /payment/rumSequences/nextMandateNumber
  • POST
Calculates and returns the next value of the mandate number.
  • /payment/rumSequences/version
  • GET
Get version of application
  • /payment/version
  • GET
Get version of application
  • /permission/list
  • GET
List of permissions
  • /permission/version
  • GET
Get version of application
  • /provider
  • GET POST PUT
Web service for managing Provider.
  • /provider/createOrUpdate
  • POST
Create or update a provider if it doesn't exists. Deprecated in v. 4.5. Use updateProvider() instead.
  • /provider/createTenant
  • POST
Register a new tenant
  • /provider/findProviderCF
  • GET
Find a provider Cf with a given provider code.
  • /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/listTenants
  • GET
List tenants
  • /provider/updateProviderCF
  • PUT
Update a provider CF.
  • /provider/version
  • GET
Get version of application
  • /provider/{providerCode}
  • DELETE
Remove a tenant
  • /query
  • GET
THIS IS A TEMPORARY API FOR DYNAMIC PORTAL USE ONLY. IT MAY BE REMOVED AT ANY TIME.
  • /quoteManagement/productQuote
  • GET POST
TMForum Product quote API specification implementation
  • /quoteManagement/productQuote/placeOrder/{quoteId}
  • POST
Place an order based on a product quote.
  • /quoteManagement/productQuote/{id}
  • PATCH
Modify partially a product quote
  • /quoteManagement/productQuote/{quoteId}
  • DELETE GET
TMForum Product quote API specification implementation
  • /refund
  • POST
Creates refund.
  • /refund/version
  • GET
Get version of application
  • /revenueRecognitionRule
  • GET POST PUT
 
  • /revenueRecognitionRule/createOrUpdate
  • POST
Create new or update an existing revenue recognition rule with a given code
  • /revenueRecognitionRule/list
  • POST
List of revenue recognition rules.
  • /revenueRecognitionRule/version
  • GET
Get version of application
  • /revenueRecognitionRule/{code}/disable
  • POST
Disable a Revenue recognition rule with a given code
  • /revenueRecognitionRule/{code}/enable
  • POST
Enable a Revenue recognition rule with a given code
  • /revenueRecognitionRule/{revenueRecognitionRuleCode}
  • DELETE
Remove an existing revenue recognition rule with a given code
  • /role
  • GET POST PUT
REST API for managing Role.
  • /role/createOrUpdate
  • POST
Create or update role.
  • /role/external
  • GET
List external roles.
  • /role/list
  • GET POST
REST API for managing Role.
  • /role/version
  • GET
Get version of application
  • /role/{roleName}
  • DELETE
Remove role.
  • /scriptInstance
  • GET POST PUT
 
  • /scriptInstance/createOrUpdate
  • POST
Create new or update an existing script instance with a given code.
  • /scriptInstance/execute
  • GET
Execute a script instance with a given code and list of parameters for the context of the script
  • /scriptInstance/version
  • GET
Get version of application
  • /scriptInstance/{code}/disable
  • POST
Disable a Script instance with a given code
  • /scriptInstance/{code}/enable
  • POST
Enable a Script instance with a given code
  • /scriptInstance/{scriptInstanceCode}
  • DELETE
Remove an existing script instance with a given code .
  • /seller
  • GET POST PUT
Web service for managing org.meveo.model.admin.Seller.
  • /seller/createOrUpdate
  • POST
Create or update a seller.
  • /seller/list
  • GET
Search for seller with a given code.
  • /seller/listSellerCodes
  • GET
Search for all seller's code.
  • /seller/version
  • GET
Get version of application
  • /seller/{sellerCode}
  • DELETE
Remove seller with a given code.
  • /tax
  • GET POST PUT
Web service for managing org.meveo.model.billing.Tax.
  • /tax/createOrUpdate
  • POST
Create or uptadate a tax.
  • /tax/list
  • GET
Search for the list of taxes.
  • /tax/version
  • GET
Get version of application
  • /tax/{taxCode}
  • DELETE
Remove tax with a given code.
  • /taxCategory
  • GET POST PUT
REST interface definition of Tax category API
  • /taxCategory/createOrUpdate
  • POST
Create new or update an existing Tax category
  • /taxCategory/list
  • GET POST
REST interface definition of Tax category API
  • /taxCategory/version
  • GET
Get version of application
  • /taxCategory/{code}
  • DELETE
Remove an existing Tax category with a given code
  • /taxClass
  • GET POST PUT
REST interface definition of Tax class API
  • /taxClass/createOrUpdate
  • POST
Create new or update an existing Tax class
  • /taxClass/list
  • GET POST
REST interface definition of Tax class API
  • /taxClass/version
  • GET
Get version of application
  • /taxClass/{code}
  • DELETE
Remove an existing Tax class with a given code
  • /taxMapping
  • GET POST PUT
REST interface definition of Tax mapping API
  • /taxMapping/createOrUpdate
  • POST
Create new or update an existing Tax mapping
  • /taxMapping/list
  • GET POST
REST interface definition of Tax mapping API
  • /taxMapping/version
  • GET
Get version of application
  • /taxMapping/{id}
  • DELETE
Remove an existing Tax mapping with a given id
  • /terminationReason
  • GET POST PUT
 
  • /terminationReason/createOrUpdate
  • POST
Create new or update an existing termination reason with a given code.
  • /terminationReason/list
  • GET
List of termination reasons.
  • /terminationReason/version
  • GET
Get version of application
  • /terminationReason/{terminationReasonCode}
  • DELETE
Remove an existing termination reason with a given code.
  • /timerEntity
  • GET
Find a timer schedule with a given code
  • /timerEntity/create
  • POST
Create a new timer schedule
  • /timerEntity/createOrUpdate
  • POST
Create new or update an existing timer schedule with a given code
  • /timerEntity/update
  • POST
Update an existing timer schedule
  • /timerEntity/version
  • GET
Get version of application
  • /timerEntity/{code}/disable
  • POST
Disable a Timer schedule with a given code
  • /timerEntity/{code}/enable
  • POST
Enable a Timer schedule with a given code
  • /unitaryCustomTable
  • POST PUT
 
  • /unitaryCustomTable/version
  • GET
Get version of application
  • /unitaryCustomTable/{tableName}/{id}
  • DELETE
Remove an existing data from a custom table.
  • /unitaryCustomTable/{tableName}/{id}/disable
  • POST
Mark a record as disabled in a custom table. Applies only to those custom tables that contain a field 'disabled'
  • /unitaryCustomTable/{tableName}/{id}/enable
  • POST
Mark a record as enabled in a custom table. Applies only to those custom tables that contain a field 'disabled'
  • /usage
  • GET
Search for all opened ratedTransactions with a given userAccountCode,fromDate and toDate .
  • /usage/chargeAggregate
  • GET
Search for charge aggregate isage from a user account code during a period of time.
  • /usage/version
  • GET
Get version of application
  • /user
  • GET POST PUT
Web service for managing org.meveo.model.admin.User. User has a unique username that is use for update, search and remove operation.
  • /user/createOrUpdate
  • POST
Create or update user based on the username.
  • /user/external
  • POST PUT
Web service for managing org.meveo.model.admin.User. User has a unique username that is use for update, search and remove operation.
  • /user/external/{username}
  • DELETE
Deletes a user in keycloak and core given a username.
  • /user/list
  • GET POST
Web service for managing org.meveo.model.admin.User. User has a unique username that is use for update, search and remove operation.
  • /user/version
  • GET
Get version of application
  • /user/{username}
  • DELETE
Remove user with a given username.

Services

Namespace http://superAdmin.ws.api.meveo.org/
name description
SuperAdminSettingsWs
Namespace http://ws.api.meveo.org/
name description
AccountWs
AccountingWs REST API to manage AccountingCode or Chart of accounts.
CatalogWs
CommunicationWs
EntityCustomizationWs
FilterWs
FilteredListWs
FinanceWs
InvoiceWs
InvoicingWs
JobWs
MediationWs Mediation related API WS interface
ModuleWs
NotificationWs
PaymentWs The Interface PaymentWs.
ReportingWs
ScriptInstanceWs
SettingsWs SOAP endpoints for settings.
SubscriptionWs
UsageWs
WalletWs Wallet operation and balance related Webservices API
Namespace http://wf.ws.api.meveo.org/
name description
WorkflowWs
Namespace http://wf.generic.ws.api.meveo.org/
name description
GenericWorkflowWs

The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.

Data Types

JSON

type description
Access
AccessDto The Class AccessDto.
AccessesDto The Class AccessesDto.
AccessesResponseDto The Class AccessesResponseDto.
AccountDto The Class AccountDto.
AccountHierarchyDto The Class AccountHierarchyDto.
AccountHierarchyTypeEnum
AccountOperation
AccountOperationDto The Class AccountOperationDto.
AccountOperationResponseDto The Class AccountOperationResponseDto.
AccountOperationsDto The Class AccountOperationsDto.
AccountOperationsResponseDto The Class AccountOperationsResponseDto.
AccountStatusEnum
AccountingCode
AccountingCodeDto The Class AccountingCodeDto.
AccountingCodeGetResponseDto The Class AccountingCodeGetResponseDto.
AccountingCodeListResponseDto The Class AccountingCodeListResponse.
AccountingWriting
AccumulatorCounterTypeEnum
ActionDunning
ActionPlanItemResponseDto The Class ActionPlanItemResponseDto.
ActionStatus Determine the status of the MEVEO API web service response.
ActionStatusEnum Tells whether the request is successful or not.
ActivateServicesRequestDto The Class ActivateServicesRequestDto.
AdditionalDetails
AdditionalDetailsDto A base class for all API DTO classes
Address
AddressBook
AddressBookDto Equivalent of BusinessEntity in DTO
AddressDto The Class AddressDto.
AlterationPrice
AmountsDto Contains amounts with and without tax.
ApplicableDueDateDelayDto The Class ApplicableDueDateDelayDto.
ApplyOneShotChargeInstanceRequestDto The Class ApplyOneShotChargeInstanceRequestDto.
ApplyProductRequestDto The Class ApplyProductRequestDto.
Attachment
AuditChangeTypeEnum
Auditable
AuditableDto Equivalent of AuditableEntity in DTO Contain the entity creation and modification dates.
AuditableEntityDto Equivalent of AuditableEntity in DTO
AuditableFieldDto The Class AuditableFieldDto.
AuditableFieldHistory
AutomatedPayment
AutomatedRefund
BSMConfigurationDto The Class BSMConfigurationDto.
BadRequestException
BankCoordinates
BankCoordinatesDto The Class BankCoordinatesDto.
BankingDateStatusDto The Class BankingDateStatusDto.
BankingDateStatusResponse The Class BankingDateStatusResponse.
BarChartDto The Class BarChartDto.
BaseEntityDto A base class for all API DTO classes
BaseResponse All the Opencell API web service response must extend this class.
BaseServiceChargeTemplateDto
BillingAccount
BillingAccount
BillingAccountDto The Class BillingAccountDto.
BillingAccountsDto The Class BillingAccountsDto.
BillingAccountsResponseDto The Class BillingAccountsResponseDto.
BillingCycle
BillingCycleDto The Class BillingCycleDto.
BillingCyclesDto The Class BillingCyclesDto.
BillingEntityTypeEnum
BillingProcessTypesEnum
BillingRun
BillingRunDto The Class BillingRunDto.
BillingRunList
BillingRunStatusEnum
BillingWalletTypeEnum
BomOfferDto The Class BomOfferDto.
BpmProductDto The Class BpmProductDto.
BsmServiceDto The Class BsmServiceDto.
BundleProductTemplateDto The Class BundleProductTemplateDto.
BundleTemplateDto The Class BundleTemplateDto.
BundledProductReference
BusinessAccountModel
BusinessAccountModelDto The Class BusinessAccountModelDto.
BusinessAccountModelResponseDto The Class BusinessAccountModelResponseDto.
BusinessEntity
BusinessEntityDto Equivalent of BusinessEntity in DTO
BusinessEntityResponseDto The Class BusinessEntityResponseDto.
BusinessOfferModel
BusinessOfferModelDto The Class BusinessOfferModelDto.
BusinessProductModel
BusinessProductModelDto The Class BusinessProductModelDto.
BusinessServiceModel
BusinessServiceModelDto The Class BusinessServiceModelDto.
CRMAccountHierarchyDto The Class CRMAccountHierarchyDto.
CRMAccountTypeSearchDto The Class CRMAccountTypeSearchDto.
Calendar
CalendarDateIntervalDto The Class CalendarDateIntervalDto.
CalendarDto The Class CalendarDto.
CalendarHolidayDto The Class CalendarHolidayDto.
CalendarIntervalTypeEnum
CalendarPeriodUnitEnum
CalendarTypeEnum The Enum CalendarTypeEnum.
CalendarsDto The Class CalendarsDto.
Campaign
CampaignDto Equivalent of BusinessEntity in DTO
CampaignStatusEnum
CardPaymentMethodDto Card payment method. Deprecated in v.4.8. Use PaymentMethodDto instead
CardPaymentMethodTokenDto The Class CardPaymentMethodTokenDto.
CardPaymentMethodTokensDto The Class CardPaymentMethodTokensDto.
CatMessagesDto The Class CatMessagesDto.
CatMessagesListDto The Class CatMessagesListDto.
CatUsageDto The Class CatUsageDto.
CatalogReference
CategoryInvoiceAgregate
CategoryInvoiceAgregateDto Invoice category invoice aggregate DTO
CdrListDto The Class CdrListDto.
CdrReservationResponse The Class CdrReservationResponse.
CdrReservationResponseDto The Class CdrReservationResponseDto.
Channel
Channel
ChannelDto The Class ChannelDto.
Characteristic
ChargeAggregateDto The Class ChargeAggregateDto.
ChargeCDRDto The Class ChargeCDRDto.
ChargeCDRResponseDto The Class ChargeCDRResponseDto.
ChargeInstance
ChargeInstanceDto The Class ChargeInstanceDto.
ChargeInstanceOverrideDto The Class ChargeInstanceOverrideDto.
ChargeInstanceOverridesDto The Class ChargeInstanceOverridesDto.
ChargeTemplate
ChargeTemplateDto The Class ChargeTemplateDto.
ChargeTypeEnum
ChartDto The Class ChartDto.
ChartOfAccountTypeEnum
ChartOfAccountViewTypeEnum
CheckPaymentMethod
CommunicationPolicy
CommunicationRequestDto The Class CommunicationRequestDto.
Contact
ContactDto The Class AccountDto.
ContactInformation
ContactInformationDto The Class ContactInformationDto.
ContactsDto
ContactsResponseDto Pagination and sorting criteria plus total record count.
CounterInstance
CounterInstanceDto The Class CounterInstanceDto.
CounterPeriod
CounterPeriodDto
CounterTemplate
CounterTemplateDto The Class CounterTemplateDto.
CounterTemplateLevel
CounterTemplatesDto The Class CounterTemplatesDto.
CounterTypeEnum
CountersInstancesDto The Class CountersInstancesDto.
CountersPeriodsDto
CountriesDto The Class CountriesDto.
Country
CountryDto The Class CountryDto.
CountryIsoDto The Class CountryIsoDto.
CreateBillingRunDto The Class CreateBillingRunDto.
CreateInvoiceResponseDto The Class CreateInvoiceResponseDto.
CreateProcedureRequestDto A Dto holding inputs to create a document signature procedure from OC side.
CreditCardTypeEnum
CreditCategoriesDto The Class CreditCategoriesDto.
CreditCategoriesResponseDto The Class CreditCategoriesResponseDto.
CreditCategory
CreditCategoryDto The Class CreditCategoryDto.
CreditCategoryResponseDto The Class CreditCategoryResponseDto.
CreditLimitDto The Class CreditLimitDto.
CurrenciesDto The Class CurrenciesDto.
Currency
CurrencyDto The Class CurrencyDto.
CurrencyIsoDto The Class CurrencyIsoDto.
CustomEntityInstanceDto The Class CustomEntityInstanceDto.
CustomEntityInstanceResponseDto The Class CustomEntityInstanceResponseDto.
CustomEntityInstancesResponseDto The Class CustomEntityInstancesResponseDto.
CustomEntityTemplateDto The Class CustomEntityTemplateDto.
CustomEntityTemplateResponseDto The Class CustomEntityTemplateResponseDto.
CustomEntityTemplatesResponseDto The Class CustomEntityTemplatesResponseDto.
CustomFieldColumnUseEnum
CustomFieldDto The Class CustomFieldDto.
CustomFieldFormattedValueDto The Class CustomFieldFormattedValueDto.
CustomFieldIndexTypeEnum
CustomFieldMapKeyEnum
CustomFieldMatrixColumn
CustomFieldMatrixColumnDto The Class CustomFieldMatrixColumnDto.
CustomFieldStorageTypeEnum
CustomFieldTemplate
CustomFieldTemplateDto The Class CustomFieldTemplateDto.
CustomFieldTypeEnum
CustomFieldValue Encapsulates a custom field value. Supports the following data types:
  • string, date, double and long that are stored as separate fields
  • reference to an entity, that is serialized as Json to serializedValue field
  • a child entity containing the actual data, that is serialized as Json to serializedValue field
  • a list or a map of above mentioned data types, serialized as Json to to serializedValue field

A reference to an entity, child entity, list and map values should not be modified behind the scenes - an appropriate SET method has to be called to serialize the value. - This limitations comes from MERGE loosing transient values and thus JPA callback @postUpdate can not be used (see CustomFieldInstance class).

Serialized value format is described in serializeValue() method for each data type.

entityReferenceValueForGUI, mapValuesForGUI, matrixValuesForGUI fields are used in data entry from GUI ONLY.

CustomFieldValueDto Represents a single CF simple value inside a more complex CF value (list, map, matrix).
CustomFieldValueHolder
CustomFieldValues Represents custom field values held by an ICustomFieldEntity entity
CustomFieldsDto The Class CustomFieldsDto.
CustomScriptDto The Class CustomScriptDto.
CustomTableDataDto Represents data in custom table - custom entity data stored in a separate table
CustomTableDataResponseDto Represents search within custom table results
CustomTableRecordDto Represents data in custom table - custom entity data stored in a separate table
CustomTableWrapperDto
Customer
Customer
CustomerAccount
CustomerAccountDto Customer Account DTO.
CustomerAccountStatusEnum
CustomerAccountsDto The Class CustomerAccountsDto.
CustomerAccountsResponseDto The Class CustomerAccountsResponseDto.
CustomerBrand
CustomerBrandDto The Class CustomerBrandDto.
CustomerBrandsDto The Class CustomerBrandsDto.
CustomerCategoriesDto The Class CustomerCategoriesDto.
CustomerCategory
CustomerCategoryDto The Class CustomerCategoryDto.
CustomerDto The Class CustomerDto.
CustomerHierarchyDto The Class CustomerHierarchyDto.
CustomerInvoicesResponse The Class CustomerInvoicesResponse.
CustomerListResponse The Class CustomerListResponse.
CustomerPaymentsResponse The Class CustomerPaymentsResponse.
CustomerSequence
CustomerSequenceDto Customer Sequence value DTO representation.
CustomersDto The Class CustomersDto.
CustomersResponseDto The Class CustomersResponseDto.
DDPaymentMethod
DDRequestBuilder
DDRequestBuilderDto The DDRequestBuilderDto Dto.
DDRequestBuilderResponseDto The Class DDRequestBuilderResponseDto.
DDRequestBuilderTypeEnum
DDRequestItem
DDRequestLOT
DDRequestLotOpDto The Class DDRequestLotOpDto.
DDRequestLotOpResponseDto The Class DDRequestLotOpResponseDto.
DDRequestLotOpsResponseDto The Class DDRequestLotOpsResponseDto.
DDRequestOpEnum
DDRequestOpStatusEnum
DateFormat
DatePeriod A period of dates
DayInYearDto The Class DayInYearDto.
DecisionRuleTypeEnum
DescriptionDto The Class DescriptionDto.
DescriptionsResponseDto The Class DescriptionsResponseDto.
DigitalResource
DigitalResourceDto Equivalent of EnableBusinessEntity in DTO
DiscountInvoiceAggregateDto Discount invoice aggregate DTO
DiscountPlan
DiscountPlanDto The Class DiscountPlanDto.
DiscountPlanInstance
DiscountPlanInstanceDto A base class for all API DTO classes
DiscountPlanItem
DiscountPlanItemDto Discount plan item
DiscountPlanItemResponseDto The Class DiscountPlanItemResponseDto.
DiscountPlanItemTypeEnum
DiscountPlanItemsResponseDto The Class DiscountPlanItemsResponseDto.
DiscountPlansDto The Class DiscountPlansDto.
DueDateDelayDto The Class DueDateDelayDto.
DueDateDelayEnum
DueDateDelayLevelEnum The Enum DueDateDelayLevelEnum.
DueDateDelayReferenceDateEnum The Enum DueDateDelayReferenceDateEnum.
DunningActionStatusEnum
DunningActionTypeEnum
DunningDocument
DunningDocumentDto DTO equivalent of DunningDocument entity.
DunningDocumentListDto The Class DunningDocumentListDto.
DunningDocumentResponseDto The Class DunningDocumentsResponseDto.
DunningDocumentsDto The Class DunningDocumentsDto.
DunningDocumentsListResponseDto The Class DunningDocumentsListResponseDto.
DunningHistory
DunningInclusionExclusionDto The Class DunningInclusionExclusionDto.
DunningLOT
DunningLevelEnum
DurationPeriodUnitEnum
EDR
EDRDto The Class WalletOperationDto.
EDRStatusEnum
EmailNotificationDto The Class EmailNotificationDto.
EmailTemplate
EmailTemplateDto The Class EmailTemplateDto.
EmailTemplateResponseDto The Class EmailTemplateResponseDto.
EmailTemplatesResponseDto The Class EmailTemplatesResponseDto.
EnableBusinessDto Equivalent of EnableBusinessEntity in DTO
EndOfTermActionEnum End of subscription term action to be taken
EntityCustomActionDto Custom action.
EntityCustomActionResponseDto The Class EntityCustomActionResponseDto.
EntityCustomizationDto The Class EntityCustomizationDto.
EntityCustomizationResponseDto The Class 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
EntityReferenceWrapper 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
EntityTag
Family
FieldsNotImportedStringCollectionDto The Class FieldsNotImportedStringCollectionDto.
FileDto The Class FileDto.
FileFormatDto The Class FileFormatDto.
FileFormatListResponseDto API response containing a list of File format Dto
FileFormatResponseDto API response containing the File format Dto
FileRequestDto The Class FileRequestDto.
FilterDto DTO class for Filter entity
FilteredListDto The Class FilteredListDto.
FilteredListResponseDto Filtering or search response.
FindAccountHierachyRequestDto The Class FindAccountHierachyRequestDto.
FindWalletOperationsDto The Class FindWalletOperationsDto.
FindWalletOperationsResponseDto The Class FindWalletOperationsResponseDto.
ForbiddenException
GDPRInfoDto
GWFTransitionDto The Class GWFTransitionDto
GWFTransitionResponseDto The Class GWFTransitionResponseDto.
GatewayPaymentNamesEnum
GeneralLedger
GenerateInvoiceRequestDto The Class GenerateInvoiceRequestDto.
GenerateInvoiceResponseDto The Class GenerateInvoiceResponseDto.
GenerateInvoiceResultDto Invoice generate request DTO
GenericSearchResponse Search results - Actual search results plus Pagination and sorting criteria plus total record count
GenericSequence
GenericSequenceDto Sequence value DTO representation.
GenericSequenceValueResponseDto Sequence value response DTO representation.
GenericWorkflowDto The Class GenericWorkflowDto
GenericWorkflowResponseDto The Class GenericWorkflowResponseDto.
GenericWorkflowsResponseDto The Class GenericWorkflowsResponseDto.
GetAccessResponseDto The Class GetAccessResponseDto.
GetAccountHierarchyResponseDto The Class GetAccountHierarchyResponseDto.
GetAddressBookResponseDto All the Opencell API web service response must extend this class.
GetBillingAccountListInRunResponseDto The Class GetBillingAccountListInRunResponseDto.
GetBillingAccountResponseDto The Class GetBillingAccountResponseDto.
GetBillingCycleResponse The Class GetBillingCycleResponse.
GetBillingRunInfoResponseDto The Class GetBillingRunInfoResponseDto.
GetBundleTemplateResponseDto The Class GetBundleTemplateResponseDto.
GetBusinessOfferModelResponseDto The Class GetBusinessOfferModelResponseDto.
GetBusinessProductModelResponseDto The Class GetBusinessProductModelResponseDto.
GetBusinessServiceModelResponseDto The Class GetBusinessServiceModelResponseDto.
GetCalendarResponse The Class GetCalendarResponse.
GetChannelResponseDto The Class GetChannelResponseDto.
GetChargeTemplateResponseDto The Class GetChargeTemplateResponseDto.
GetChartResponse The Class GetChartResponse.
GetConfigurationResponse The Class GetConfigurationResponse.
GetContactResponseDto All the Opencell API web service response must extend this class.
GetCounterTemplateResponseDto The Class GetCounterTemplateResponseDto.
GetCountersInstancesResponseDto The Class GetCountersInstancesResponseDto.
GetCountriesIsoResponse The Class GetCountriesIsoResponse.
GetCountryIsoResponse The Class GetCountryIsoResponse.
GetCountryResponse The Class GetCountryResponse.
GetCurrenciesIsoResponse The Class GetCurrenciesIsoResponse.
GetCurrencyIsoResponse The Class GetCurrencyIsoResponse.
GetCurrencyResponse The Class GetCurrencyResponse.
GetCustomFieldTemplateReponseDto The Class GetCustomFieldTemplateReponseDto.
GetCustomerAccountConfigurationResponseDto The Class GetCustomerAccountConfigurationResponseDto.
GetCustomerAccountResponseDto The Class GetCustomerAccountResponseDto.
GetCustomerCategoryResponseDto GetCustomerCategoryResponse Dto.
GetCustomerConfigurationResponseDto The Class GetCustomerConfigurationResponseDto.
GetCustomerResponseDto The Class GetCustomerResponseDto.
GetDescriptionsResponse The Class GetDescriptionsResponse.
GetDigitalResourceResponseDto The Class GetDigitalResourceResponseDto.
GetDiscountPlanResponseDto The Class GetDiscountPlanResponseDto.
GetDiscountPlansResponseDto The Class GetDiscountPlansResponseDto.
GetDueDateDelayResponseDto The Class GetDueDateDelayResponseDto.
GetEmailNotificationResponseDto The Class GetEmailNotificationResponseDto.
GetFilesResponseDto The Class GetFilesResponseDto.
GetFilterResponseDto Return DTO for FilteredList API that includes the FilterDto in the response.
GetInvoiceCategoryResponse The Class GetInvoiceCategoryResponse.
GetInvoiceResponseDto The Class GetInvoiceResponseDto.
GetInvoiceSequenceResponse The Class GetInvoiceSequenceResponse.
GetInvoiceSequencesResponse The Class GetInvoiceSequencesResponse.
GetInvoiceSubCategoryResponse The Class GetInvoiceSubCategoryResponse.
GetInvoiceTypeResponse The Class GetInvoiceTypeResponse.
GetInvoiceTypesResponse The Class GetInvoiceTypesResponse.
GetInvoicingConfigurationResponseDto The Class GetInvoicingConfigurationResponseDto.
GetJobTriggerResponseDto The Class GetJobTriggerResponseDto.
GetLanguageIsoResponse The Class GetLanguageIsoResponse.
GetLanguageResponse The Class GetLanguageResponse.
GetLanguagesIsoResponse The Class GetLanguagesIsoResponse.
GetListBundleTemplateResponseDto The Class GetListBundleTemplateResponseDto.
GetListChannelsAndSegmentsResponseDto All the Opencell API web service response must extend this class.
GetListMeasurableQuantityResponse The Class GetListMeasurableQuantityResponse.
GetListOfferTemplateResponseDto The Class GetListOfferTemplateResponseDto.
GetListProductTemplateResponseDto The Class GetListProductTemplateResponseDto.
GetListServiceInstanceResponseDto The Class GetListServiceInstanceResponseDto.
GetListServiceTemplateResponseDto The Class GetListServiceTemplateResponseDto.
GetListUnitOfMeasureResponseDto The Class GetListUnitOfMeasureResponseDto.
GetMeasurableQuantityResponse The Class GetMeasurableQuantityResponse.
GetMeasuredValueResponse The Class GetMeasuredValueResponse.
GetMetricsConfigurationResponse The Class GetMetricConfigurationResponse.
GetOccTemplateResponseDto The Class GetOccTemplateResponseDto.
GetOccTemplatesResponseDto The Class GetOccTemplatesResponseDto.
GetOfferTemplateCategoryResponseDto The Class GetOfferTemplateCategoryResponseDto.
GetOfferTemplateResponseDto The Class GetOfferTemplateResponseDto.
GetOneShotChargeTemplateResponseDto The Class GetOneShotChargeTemplateResponseDto.
GetOneShotChargesResponseDto The Class GetOneShotChargesResponseDto.
GetPdfInvoiceRequestDto The Class GetPdfInvoiceRequestDto.
GetPdfInvoiceResponseDto The Class GetPdfInvoiceResponseDto.
GetPostInvoicingReportsResponseDto The Class GetPostInvoicingReportsResponseDto.
GetPreInvoicingReportsResponseDto The Class GetPreInvoicingReportsResponseDto.
GetPricePlanResponseDto The Class GetPricePlanResponseDto.
GetProductChargeTemplateResponseDto The Class GetProductChargeTemplateResponseDto.
GetProductTemplateResponseDto The Class GetProductTemplateResponseDto.
GetProviderResponse The Class GetProviderResponse.
GetRecurringChargeTemplateResponseDto The Class GetRecurringChargeTemplateResponseDto.
GetRoleResponse The Class GetRoleResponse.
GetScriptInstanceResponseDto The Class GetScriptInstanceResponseDto.
GetScriptNotificationResponseDto The Class GetNotificationResponseDto.
GetSellerResponse The Class GetSellerResponse.
GetServiceInstanceResponseDto The Class GetServiceInstanceResponseDto.
GetServiceTemplateResponseDto The Class GetServiceTemplateResponseDto.
GetSubscriptionResponseDto The Class GetSubscriptionResponseDto.
GetTaxResponse The Class GetTaxResponse.
GetTaxesResponse The Class GetTaxesResponse.
GetTerminationReasonResponse The Class GetTerminationReasonResponse.
GetTimerEntityResponseDto The Class GetTimerEntityResponseDto.
GetTradingConfigurationResponseDto The Class GetTradingConfigurationResponseDto.
GetTradingCountryResponse The Class GetTradingCountryResponse.
GetTradingCurrencyResponse The Class GetTradingCurrencyResponse.
GetTradingLanguageResponse The Class GetTradingLanguageResponse.
GetTriggeredEdrResponseDto The Class GetTriggeredEdrResponseDto.
GetUnitOfMeasureResponseDto The Class GetUnitOfMeasureResponseDto.
GetUsageChargeTemplateResponseDto The Class GetUsageChargeTemplateResponseDto.
GetUserAccountResponseDto The Class GetUserAccountResponseDto.
GetUserResponse The Class GetUserResponse.
GetWalletTemplateResponseDto The Class GetWalletTemplateResponseDto.
GetWebHookNotificationResponseDto The Class GetWebHookNotificationResponseDto.
GetXmlInvoiceRequestDto The Class GetXmlInvoiceRequestDto.
GetXmlInvoiceResponseDto The Class GetXmlInvoiceResponseDto.
HierarchyLevel
HourInDayDto The Class HourInDayDto.
HttpProtocol
ICustomFieldEntity
IReferenceEntity
IdentityResponseDTO All the Opencell API web service response must extend this class.
ImportExportResponseDto The Class ImportExportResponseDto.
InboundRequestDto The Class InboundRequestDto.
InboundRequestsDto The Class InboundRequestsDto.
InboundRequestsResponseDto The Class InboundRequestsResponseDto.
InitialTermTypeEnum The default subscription renewal term type. A subscription can be automatically renewed on a period basis or on a fixed date.
InstanceStatusEnum
InstantiateServicesRequestDto The Class InstantiateServicesRequestDto.
InternalServerErrorException
Invoice
InvoiceAgregate
InvoiceCategoriesDto The Class InvoiceCategoriesDto.
InvoiceCategory
InvoiceCategoryDto The Class InvoiceCategoryDto.
InvoiceCategoryResponseDto The Class InvoiceCategoryResponseDto.
InvoiceConfigurationDto The Class InvoiceConfigurationDto.
InvoiceCreationResponse The Class InvoiceCreationResponse.
InvoiceDto DTO equivalent of Invoice entity.
InvoiceModeEnum
InvoiceSequence
InvoiceSequenceDto The Class InvoiceSequenceDto.
InvoiceSequencesDto The Class InvoiceSequencesDto.
InvoiceStatusEnum
InvoiceSubCategoriesDto The Class InvoiceSubCategoriesDto.
InvoiceSubCategory
InvoiceSubCategoryDto The Class InvoiceSubCategoryDto.
InvoiceSubCategoryResponseDto The Class InvoiceSubCategoryResponseDto.
InvoiceType
InvoiceTypeDto The Class InvoiceTypeDto.
InvoiceTypeSellerSequence
InvoiceTypesDto The Class InvoiceTypesDto.
InvoicesDto The Class InvoicesDto.
JobCategoriesResponseDto The Class JobCategoriesResponseDto.
JobExecutionResultDto Contains information about job execution status and history once job is completed.
JobExecutionResultResponseDto The Class JobExecutionResultResponseDto.
JobExecutionResultsDto
JobExecutionResultsResponseDto Pagination and sorting criteria plus total record count.
JobInstanceDto The Class JobInstanceDto.
JobInstanceInfoDto The Class JobInstanceInfoDto.
JobInstanceListDto The Class JobInstanceListDto.
JobInstanceListResponseDto The Class JobInstanceListResponseDto.
JobInstanceResponseDto The Class JobInstanceResponseDto.
JobTriggerDto The Class JobTriggerDto.
Language
LanguageDescriptionDto The Class LanguageDescriptionDto.
LanguageDto The Class LanguageDto.
LanguageIsoDto The Class LanguageIsoDto.
LanguagesDto The Class LanguagesDto.
LegendPositionEnum
LevelEnum
LifeCycleStatusEnum
LifecycleStatus
LineChartDto The Class LineChartDto.
Link
ListCalendarResponse The Class ListCalendarResponse.
LitigationRequestDto The Class LitigationRequestDto.
MailingTypeEnum
MandatInfoDto The Class MandatInfoDto.
MandatStateEnum
MatchOperationRequestDto The Class MatchOperationRequestDto.
MatchedOperationDto Represents matched account operations.
MatchedOperationsResponseDto The Class MatchedOperationsResponseDto.
MatchingAmount
MatchingAmountDto The Class MatchingAmountDto.
MatchingAmountsDto The Class MatchingAmountsDto.
MatchingCode
MatchingCodeDto The Class MatchingCodeDto.
MatchingCodesDto The Class MatchingCodesDto.
MatchingStatusEnum
MatchingTypeEnum
MeasurableQuantityDto The Class MeasurableQuantityDto.
MeasuredValueDto The Class MeasuredValueDto.
MeasurementPeriodEnum
MediaEnum
MediaType
Message
MessageDto A base class for all API DTO classes
MessageStatusEnum
MessageTemplateDto The Class MessageTemplateDto.
MessageTemplateTypeEnum
MessageVariableValue
MetricsConfigurationDto Equivalent of BusinessEntity in DTO
MeveoInstance
MeveoInstanceDto The Class MeveoInstanceDto.
MeveoInstanceResponseDto The Class MeveoInstanceResponseDto.
MeveoInstanceStatusEnum
MeveoInstancesResponseDto The Class MeveoInstancesResponseDto.
MeveoModule
MeveoModuleDto The Class MeveoModuleDto.
MeveoModuleDtoResponse The Class MeveoModuleDtoResponse.
MeveoModuleDtosResponse The Class MeveoModuleDtosResponse.
MeveoModuleItem
MinimumAmountElDto Store all minimum amount information for a CRM account hierarchy.
ModuleLicenseEnum
MonthEnum
Name
NameDto The Class NameDto.
NewCookie
NotAcceptableException
NotAllowedException
NotAuthorizedException
NotFoundException
Note
NotificationDto The Class NotificationDto.
NotificationEventTypeEnum
NotificationHistoriesDto The Class NotificationHistoriesDto.
NotificationHistoriesResponseDto The Class NotificationHistoriesResponseDto.
NotificationHistoryDto The Class NotificationHistoryDto.
NotificationHistoryStatusEnum
NumberFormat
OCCTemplate
OccTemplateDto The Class OccTemplateDto.
OccTemplatesDto The Class OccTemplatesDto.
OfferPricePlanDto The Class OfferPricePlanDto.
OfferProductTemplate
OfferProductTemplateDto The Class OfferProductTemplateDto.
OfferRollbackDto
OfferServiceTemplate
OfferServiceTemplateDto The Class OfferServiceTemplateDto.
OfferTemplate
OfferTemplateCategory
OfferTemplateCategoryDto The Class OfferTemplateCategoryDto.
OfferTemplateDto The Class OfferTemplateDto.
OneShotChargeInstanceDto Equivalent of BusinessEntity in DTO
OneShotChargeTemplate
OneShotChargeTemplateDto The Class OneShotChargeTemplateDto.
OneShotChargeTemplateTypeEnum
OneShotChargeTemplateWithPriceDto The Class OneShotChargeTemplateWithPriceDto.
OneShotChargeTemplateWithPriceListDto The Class OneShotChargeTemplateWithPriceListDto.
OperationCategoryEnum
OperationServicesRequestDto The Class OperationServicesRequestDto.
OperationSubscriptionRequestDto The Class OperationSubscriptionRequestDto.
OperationTypeEnum
Order
OrderHistory
OrderItem
OrderItemActionEnum
OrderItemProductOffering
OrderStatusEnum
OrganizationDto The Class OrganizationDto.
OrientationEnum
OtherCreditAndChargeDto The Class OtherCreditAndChargeDto.
OtherTransaction
OverrideProrataEnum
PDFDocumentRequestDto A Dto holding information required to generate the document pdf file.
PDFDocumentResponseDto A DTO Class holding the response of Generating a document PDF file.
PDFTemplateDto A Dto class to encapsulate the PDFTemplate request params.
PagingAndFiltering The Class PagingAndFiltering.
ParentEntitiesDto The Class ParentEntitiesDto.
ParentEntitiesResponseDto The Class ParentEntitiesResponseDto.
ParentEntityDto The Class ParentEntityDto.
ParentListResponse The Class ParentListResponse.
ParsedVersion
PayByCardDto The Class PayByCardDto.
Payment
PaymentActionStatus The Class PaymentActionStatus.
PaymentDto The Class PaymentDto.
PaymentErrorTypeEnum
PaymentGateway
PaymentGatewayDto The PaymentGateway Dto.
PaymentGatewayResponseDto The Class PaymentGatewayResponseDto.
PaymentGatewayRumSequence
PaymentGatewayRumSequenceDto Equivalent of BusinessEntity in DTO
PaymentGatewayRumSequenceResponseDto All the Opencell API web service response must extend this class.
PaymentGatewayTypeEnum
PaymentHistoriesDto The Class PaymentHistoriesDto.
PaymentHistoryDto Class to represent payments that was initiated from OC, we find payment done, ,pending,rejected and error.
PaymentHostedCheckoutResponseDto The Class PaymentGatewayResponseDto.
PaymentLevelEnum
PaymentMethod
PaymentMethodDto The PaymentMethod Dto.
PaymentMethodEnum
PaymentMethodTokenDto The Class PaymentMethodTokenDto.
PaymentMethodTokensDto The Class PaymentMethodTokensDto.
PaymentOrRefundEnum
PaymentReplayCauseEnum
PaymentResponseDto The Class PaymentResponseDto.
PaymentScheduleInstance
PaymentScheduleInstanceBalanceDto The Class PaymentScheduleInstanceDto.
PaymentScheduleInstanceDto The Class PaymentScheduleInstanceDto.
PaymentScheduleInstanceItem
PaymentScheduleInstanceItemDto The Class PaymentScheduleInstanceItemDto.
PaymentScheduleInstanceResponseDto The Class PaymentScheduleInstanceResponseDto.
PaymentScheduleInstancesDto The Class PaymentScheduleInstancesDto.
PaymentScheduleStatusEnum
PaymentScheduleTemplate
PaymentScheduleTemplateDto The Class PaymentScheduleTemplateDto.
PaymentScheduleTemplateResponseDto The Class PaymentScheduleTemplateResponseDto.
PaymentScheduleTemplatesDto The Class PaymentScheduleTemplatesDto.
PaymentStatusEnum
PaymentVentilation
PaypalPaymentMethod
PdfInvoiceResponse The Class PdfInvoiceResponse.
Permission
PermissionDto The Class PermissionDto.
PermissionResponseDto The Class PermissionResponseDto.
PermissionsDto The Class PermissionsDto.
PieChartDto The Class PieChartDto.
Place
PostInvoicingReportsDTO
PreInvoicingReportsDTO
PrepaidReservationDto The Class PrepaidReservationDto.
Price
PricePlanMatrix
PricePlanMatrixDto DTO for PricePlanMatrix.
PricePlanMatrixesResponseDto The Class PricePlanMatrixesResponseDto.
PricePlansDto The Class PricePlansDto.
PriorityEnum
Product
ProductCharacteristic
ProductChargeInstance
ProductChargeInstanceDto The Class ProductChargeInstanceDto.
ProductChargeTemplate
ProductChargeTemplateDto The Class ProductChargeTemplateDto.
ProductDto The Class ProductDto.
ProductInstance
ProductInstanceDto The Class ProductInstanceDto.
ProductInstancesDto The Class ProductInstancesDto.
ProductOfferPriceAlteration
ProductOfferPriceAlterationType
ProductOffering
ProductOffering
ProductOfferingDto The Class ProductOfferingDto.
ProductOfferingPrice
ProductOfferingPriceType
ProductOfferingTerm
ProductOrder Equivalent of AuditableEntity in DTO
ProductOrderItem
ProductQuote
ProductQuoteItem
ProductRelationship
ProductTemplate
ProductTemplateDto The Class ProductTemplateDto.
ProductToApplyDto The Class ProductToApplyDto.
ProductsDto The Class ProductsDto.
ProductsToApplyDto The Class ProductsToApplyDto.
ProviderContact
ProviderContactDto The Class ProviderContactDto.
ProviderContactResponseDto The Class ProviderContactResponseDto.
ProviderContactsResponseDto The Class ProviderContactsResponseDto.
ProviderDto The Class ProviderDto.
ProvidersDto The Class ProvidersDto.
QueryResponse Pagination and sorting criteria plus total record count.
Quote
QuoteItem
QuoteItemProductOffering
QuotePriceAlteration
QuoteProductOfferingPrice
QuoteStatusEnum Quote status lifecycle
RateSubscriptionRequestDto A Dto class holding the request criterion for the Rate Subscription.
RateSubscriptionResponseDto A Dto class holding the Rate subscription response.
RatedTransaction
RatedTransactionDto A Dto class for Rated Transaction informations
RatedTransactionListResponseDto RatedTransactionListResponseDto : A class containing the response of searching a list of Rated transactions
RatedTransactionStatusEnum
RatedTransactionTypeEnum
RawResponseDto A Dto class to wrap a raw API response.
RawResponseDtoOfString A Dto class to wrap a raw API response.
RecordedInvoice
RecordedInvoiceCatAgregate
RecordedInvoiceDto The Class RecordedInvoiceDto.
RecurrenceTypeEnum
RecurringChargeDto The Class RecurringChargeDto.
RecurringChargeInstance
RecurringChargeTemplate
RecurringChargeTemplateDto The Class RecurringChargeTemplateDto.
ReferenceDateEnum
RefundActionStatus The Class RefundActionStatus.
RefundDto The Class RefundDto.
RejectedBillingAccount
RejectedPayment
RejectedPaymentDto The Class RejectedPaymentDto.
RejectedType
RelatedParty
RenewalPeriodUnitEnum Subscription renewal period unit
RenewalTermTypeEnum
ReportExtractDto DTO class for ReportExtract entity
ReportExtractExecutionOrigin
ReportExtractExecutionResultDto A base class for all API DTO classes
ReportExtractExecutionResultResponseDto All the Opencell API web service response must extend this class.
ReportExtractExecutionResultsResponseDto Pagination and sorting criteria plus total record count.
ReportExtractResponseDto The Class ReportExtractResponseDto.
ReportExtractResultTypeEnum
ReportExtractScriptTypeEnum
ReportExtractsResponseDto The Class ReportExtractsResponseDto.
Response
Result
RevenueRecognitionDelayUnitEnum
RevenueRecognitionEventEnum
RevenueRecognitionRule
RevenueRecognitionRuleDto The Class RevenueRecognitionRuleDto.
RevenueRecognitionRuleDtoResponse The Class RevenueRecognitionRuleDtoResponse.
RevenueRecognitionRuleDtosResponse The Class RevenueRecognitionRuleDtosResponse.
RevenueScheduleDto The Class RevenueScheduleDto.
Role
RoleDto The Class RoleDto.
RolesDto The Class RolesDto.
RoundingMode
RoundingModeEnum
RunReportExtractDto The Class RunReportExtractDto.
SMSInfoDto
SMSInfoResponseDTO
ScriptInstance
ScriptInstanceCategory
ScriptInstanceDto The Class ScriptInstanceDto.
ScriptInstanceError
ScriptInstanceErrorDto The Class ScriptInstanceErrorDto.
ScriptInstanceReponseDto The Class ScriptInstanceReponseDto.
ScriptNotificationDto The Class ScriptNotificationDto.
ScriptSourceTypeEnum
SearchResponse Pagination and sorting criteria plus total record count.
SecuredEntity
SecuredEntityDto The Class SecuredEntityDto.
Seller
SellerCodesResponseDto The Class SellerCodesResponseDto.
SellerDto The Class SellerDto.
SellerResponseDto The Class SellerResponseDto.
SellersDto The Class SellersDto.
SequenceDto The Class SequenceDto.
Serializable
ServiceChargeTemplateRecurring
ServiceChargeTemplateRecurringDto The Class ServiceChargeTemplateRecurringDto.
ServiceChargeTemplateRecurringsDto The Class ServiceChargeTemplateRecurringsDto.
ServiceChargeTemplateSubscription
ServiceChargeTemplateSubscriptionDto The Class ServiceChargeTemplateSubscriptionDto.
ServiceChargeTemplateSubscriptionsDto The Class ServiceChargeTemplateSubscriptionsDto.
ServiceChargeTemplateTermination
ServiceChargeTemplateTerminationDto The Class ServiceChargeTemplateTerminationDto.
ServiceChargeTemplateTerminationsDto The Class ServiceChargeTemplateTerminationsDto.
ServiceChargeTemplateUsage
ServiceChargeTemplateUsagesDto The Class ServiceChargeTemplateUsagesDto.
ServiceConfigurationDto The Class ServiceConfigurationDto.
ServiceInstance
ServiceInstanceDto The Class ServiceInstanceDto.
ServiceInstancesDto The Class ServiceInstancesDto.
ServiceLevelAgreement
ServiceTemplate
ServiceTemplateDto The Class ServiceTemplateDto.
ServiceTemplatesDto The Class ServiceTemplatesDto.
ServiceToActivateDto The Class ServiceToActivateDto.
ServiceToAddDto The Class ServiceToAddDto.
ServiceToInstantiateDto The Class ServiceToInstantiateDto.
ServiceToTerminateDto The Class ServiceToTerminateDto.
ServiceToUpdateDto The Class ServiceToUpdateDto.
ServiceUsageChargeTemplateDto The Class ServiceUsageChargeTemplateDto.
ServicesToActivateDto The Class ServicesToActivateDto.
ServicesToInstantiateDto The Class ServicesToInstantiateDto.
SignCallbackDto The Class SignCallbackDto holding request payload of yousign webhook callback
SignEventEmailDto DTO encapsulating an email template inputs for a signature procedure event.
SignEventWebhookDto DTO encapsulating a webhook (for server-server notification) inputs for a signature procedure event.
SignFileObjectRequestDto DTO Class for a File Object for a Yousign object document.
SignFileRequestDto DTO class for a document request informations.
SignFileResponseDto DTO Class for a File informations : response from Yousign document.
SignMemberDto A DTO class for a Signature procedure member
SignMemberRequestDto A DTO class for a Request of a Signature procedure Member.
SignProcedureConfigDto DTO used basically to configure email notification, based on some events , kind of procedure.started ...
SignProcedureDto A Dto holding inputs required to create a document signature procedure on Yousign platform side
SignProcedureResponseDto A DTO Class holding the response of Creating a document signature procedure.
SortOrder The Enum SortOrder.
StackTraceElement
StatusType
StdDefaultDateFormat
StripePaymentMethod
SubCatUsageDto The Class SubCatUsageDto.
SubCategoryInvoiceAgregate
SubCategoryInvoiceAgregateDto The Class SubCategoryInvoiceAgregateDto.
Subscription
SubscriptionAndServicesToActivateRequestDto The Class SubscriptionAndServicesToActivateRequestDto.
SubscriptionChargeInstance
SubscriptionDto The Class SubscriptionDto.
SubscriptionFeeDto The Class SubscriptionFeeDto.
SubscriptionForCustomerRequestDto Equivalent of BusinessEntity in DTO
SubscriptionForCustomerResponseDto All the Opencell API web service response must extend this class.
SubscriptionPatchDto
SubscriptionRenewal Embeddable set of renewal fields. Use in ServiceTemplate and Subscription.
SubscriptionRenewalDto The Class SubscriptionRenewalDto.
SubscriptionStatusEnum
SubscriptionTerminationReason Subscription termination rule
SubscriptionWithCreditLimitDto The Class SubscriptionWithCreditLimitDto.
SubscriptionWithCreditLimitResponse The Class SubscriptionWithCreditLimitResponse.
SubscriptionWithCreditLimitUpdateDto The Class SubscriptionWithCreditLimitUpdateDto.
SubscriptionsDto The Class SubscriptionsDto.
SubscriptionsListDto The Class SubscriptionsListDto.
SubscriptionsListResponseDto The Class SubscriptionsListResponseDto.
SubscriptionsResponseDto The Class SubscriptionsResponseDto.
Tax
TaxCategory
TaxCategoryDto DTO implementation of Tax category. Tax category
TaxCategoryListResponseDto API response containing a list of Tax category Dto
TaxCategoryResponseDto API response containing the Tax category Dto
TaxClass
TaxClassDto DTO implementation of Tax class. Tax class
TaxClassListResponseDto API response containing a list of Tax class Dto
TaxClassResponseDto API response containing the Tax class Dto
TaxDto DTO for Tax.
TaxInvoiceAggregateDto Invoice category invoice aggregate DTO
TaxMappingDto DTO implementation of Tax mapping. Tax mapping
TaxMappingListResponseDto API response containing a list of Tax mapping Dto
TaxMappingResponseDto API response containing the Tax mapping Dto
TaxesDto The Class TaxesDto.
TerminateCustomerSubscriptionDto The Class TerminateCustomerSubscriptionDto.
TerminateCustomerSubscriptionResponse The Class TerminateCustomerSubscriptionResponse.
TerminateSubscriptionRequestDto The Class TerminateSubscriptionRequestDto.
TerminateSubscriptionServicesRequestDto The Class TerminateSubscriptionServicesRequestDto.
TerminationChargeInstance
TerminationFeeDto The Class TerminationFeeDto.
TerminationReasonDto The Class TerminationReasonDto.
TerminationReasonsDto The Class TerminationReasonsDto.
ThresholdOptionsEnum
Throwable
TimeRange
TimeZone
TimerEntityDto The Class TimerEntityDto.
TimerEntityResponseDto The Class TimerEntityResponseDto.
Title
TitleDto The Class TitleDto.
TitleResponseDto The Class TitleResponseDto.
TitlesDto The Class TitlesDto.
TitlesResponseDto The Class TitlesResponseDto.
TradingCountry
TradingCurrency
TradingLanguage
TransferAccountOperationDto Represents the data necessary to establish an account operation transfer from one customer to another .
TransferCustomerAccountDto Represents the data necessary to establish an amount transfer from one customer to another .
TriggeredEDRTemplate
TriggeredEdrTemplateDto The Class TriggeredEdrTemplateDto.
TriggeredEdrTemplatesDto The Class TriggeredEdrTemplatesDto.
UnMatchingOperationRequestDto The Class UnMatchingOperationRequestDto.
UnitOfMeasure
UnitOfMeasureDto The Class UnitOfMeasureDto.
UnitaryCustomTableDataDto Represents data in custom table - custom entity data stored in a separate table This DTO is used for unitary table updates
UpdateServicesRequestDto The Class UpdateServicesRequestDto.
UriBuilder
UsageChargeAggregateResponseDto The Class UsageChargeAggregateResponseDto.
UsageChargeDto The Class UsageChargeDto.
UsageChargeInstance
UsageChargeTemplateDto The Class UsageChargeTemplateDto.
UsageChargeTemplateResponseDto The Class UsageChargeTemplateResponseDto.
UsageChargeTemplatesDto The Class UsageChargeTemplatesDto.
UsageDto The Class UsageDto.
UsageRequestDto The Class UsageRequestDto.
UsageResponseDto The Class UsageResponseDto.
User
UserAccount
UserAccountDto The Class UserAccountDto.
UserAccountsDto The Class UserAccountsDto.
UserAccountsResponseDto The Class UserAccountsResponseDto.
UserDto The Class UserDto.
UserHierarchyLevel
UserHierarchyLevelDto The Class UserHierarchyLevelDto.
UserHierarchyLevelResponseDto The Class UserHierarchyLevelResponseDto.
UserHierarchyLevelsDto The Class UserHierarchyLevelsDto.
UsersDto The Class UsersDto.
VentilationActionStatusEnum
WFAction
WFActionDto The Class WFActionDto.
WFDecisionRule
WFDecisionRuleDto The Class WFDecisionRuleDto.
WFStatusDto The Class WFStatusDto
WFTransition
WFTransitionDto The Class WFTransitionDto.
WFTransitionResponseDto The Class WFTransitionResponseDto.
WalletBalanceDto Parameters to calculate wallet balance. Seller, customer, customer account, billing account and user account code parameters are mutually exclusive and only one of them should be provided.
WalletBalanceResponseDto Wallet balance.
WalletInstance
WalletOperation
WalletOperationDto The Class WalletOperationDto.
WalletOperationStatusEnum
WalletReservationDto The Class WalletReservationDto.
WalletTemplate
WalletTemplateDto The Class WalletTemplateDto.
WalletsDto The Class WalletsDto.
WebHookDto The Class WebHookDto.
WebHookMethodEnum
WirePaymentMethod
WoRatedTransactionDto WoRatedTransactionDto : A dto class containing a minimum of Rated Transaction informations like "id" and "status" ...
Workflow
WorkflowDto The Class WorkflowDto.
WorkflowHistoryActionDto The Class WorkflowHistoryActionDto.
WorkflowHistoryDto The Class WorkflowHistoryDto.
WorkflowHistoryResponseDto The Class WorkflowHistoryResponseDto.
WorkflowInsHistoryResponseDto The Class WorkflowInsHistoryResponseDto.
WorkflowInstanceHistoryDto The Class WorkflowHistoryDto.
WorkflowResponseDto The Class WorkflowResponseDto.
WorkflowsResponseDto The Class WorkflowsResponseDto.
YousignEventEnum The Enum WebhookEventEnum for Yousign webhook events : https://dev.yousign.com/#/apiDoc

XML

Default Namespace
type description
actionStatus Determine the status of the MEVEO API web service response.
actionStatusEnum Tells whether the request is successful or not.
auditableDto Equivalent of AuditableEntity in DTO Contain the entity creation and modification dates.
auditableEntityDto Equivalent of AuditableEntity in DTO
bankingDateStatusDto The Class BankingDateStatusDto.
baseEntityDto A base class for all API DTO classes
billingCycleDto The Class BillingCycleDto.
billingCyclesDto The Class BillingCyclesDto.
businessEntityDto Equivalent of BusinessEntity in DTO
CRMAccountTypeSearchDto The Class CRMAccountTypeSearchDto.
calendarDateIntervalDto The Class CalendarDateIntervalDto.
calendarDto The Class CalendarDto.
calendarHolidayDto The Class CalendarHolidayDto.
calendarTypeEnum The Enum CalendarTypeEnum.
calendarsDto The Class CalendarsDto.
catMessagesDto The Class CatMessagesDto.
categoryInvoiceAgregateDto Invoice category invoice aggregate DTO
countriesDto The Class CountriesDto.
countryDto The Class CountryDto.
countryIsoDto The Class CountryIsoDto.
creditLimitDto The Class CreditLimitDto.
currenciesDto The Class CurrenciesDto.
currencyDto The Class CurrencyDto.
currencyIsoDto The Class CurrencyIsoDto.
customEntityInstanceDto The Class CustomEntityInstanceDto.
customEntityTemplateDto The Class CustomEntityTemplateDto.
customFieldDto The Class CustomFieldDto.
customFieldFormattedValueDto The Class CustomFieldFormattedValueDto.
customFieldMatrixColumnDto The Class CustomFieldMatrixColumnDto.
customFieldTemplateDto The Class CustomFieldTemplateDto.
customFieldValueDto Represents a single CF simple value inside a more complex CF value (list, map, matrix).
customFieldsDto The Class CustomFieldsDto.
dayInYearDto The Class DayInYearDto.
descriptionDto The Class DescriptionDto.
discountInvoiceAggregateDto Discount invoice aggregate DTO
enableBusinessDto Equivalent of EnableBusinessEntity in DTO
entityCustomActionDto Custom action.
entityCustomizationDto The Class 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 DTO class for Filter entity
GDPRInfoDto
hourInDayDto The Class HourInDayDto.
invoiceCategoriesDto The Class InvoiceCategoriesDto.
invoiceCategoryDto The Class InvoiceCategoryDto.
invoiceSubCategoriesDto The Class InvoiceSubCategoriesDto.
invoiceSubCategoryDto The Class InvoiceSubCategoryDto.
languageDescriptionDto The Class LanguageDescriptionDto.
languageDto The Class LanguageDto.
languageIsoDto The Class LanguageIsoDto.
languagesDto The Class LanguagesDto.
occTemplateDto The Class OccTemplateDto.
occTemplatesDto The Class OccTemplatesDto.
offerPricePlanDto The Class OfferPricePlanDto.
organizationDto The Class OrganizationDto.
paymentActionStatus The Class PaymentActionStatus.
permissionDto The Class PermissionDto.
permissionsDto The Class PermissionsDto.
providerDto The Class ProviderDto.
providersDto The Class ProvidersDto.
ratedTransactionDto A Dto class for Rated Transaction informations
recurringChargeDto The Class RecurringChargeDto.
refundActionStatus The Class RefundActionStatus.
roleDto The Class RoleDto.
rolesDto The Class RolesDto.
scriptInstanceDto The Class ScriptInstanceDto.
scriptInstanceErrorDto The Class ScriptInstanceErrorDto.
securedEntityDto The Class SecuredEntityDto.
sellerDto The Class SellerDto.
sellersDto The Class SellersDto.
sequenceDto The Class SequenceDto.
serviceToAddDto The Class ServiceToAddDto.
serviceToTerminateDto The Class ServiceToTerminateDto.
subCategoryInvoiceAgregateDto The Class SubCategoryInvoiceAgregateDto.
subscriptionFeeDto The Class SubscriptionFeeDto.
subscriptionWithCreditLimitDto The Class SubscriptionWithCreditLimitDto.
subscriptionWithCreditLimitUpdateDto The Class SubscriptionWithCreditLimitUpdateDto.
taxDto DTO for Tax.
taxInvoiceAggregateDto Invoice category invoice aggregate DTO
taxesDto The Class TaxesDto.
terminateCustomerSubscriptionDto The Class TerminateCustomerSubscriptionDto.
terminationFeeDto The Class TerminationFeeDto.
terminationReasonDto The Class TerminationReasonDto.
terminationReasonsDto The Class TerminationReasonsDto.
usageChargeDto The Class UsageChargeDto.
usageChargeTemplatesDto The Class UsageChargeTemplatesDto.
userDto The Class UserDto.
usersDto The Class UsersDto.
accessDto The Class AccessDto.
accessesDto The Class AccessesDto.
accountDto The Class AccountDto.
accountHierarchyDto The Class AccountHierarchyDto.
addressDto The Class AddressDto.
applyOneShotChargeInstanceRequestDto The Class ApplyOneShotChargeInstanceRequestDto.
applyProductRequestDto The Class ApplyProductRequestDto.
bankCoordinatesDto The Class BankCoordinatesDto.
billingAccountDto The Class BillingAccountDto.
billingAccountsDto The Class BillingAccountsDto.
businessAccountModelDto The Class BusinessAccountModelDto.
CRMAccountHierarchyDto The Class CRMAccountHierarchyDto.
contactInformationDto The Class ContactInformationDto.
creditCategoriesDto The Class CreditCategoriesDto.
creditCategoryDto The Class CreditCategoryDto.
customerAccountDto Customer Account DTO.
customerAccountsDto The Class CustomerAccountsDto.
customerBrandDto The Class CustomerBrandDto.
customerCategoryDto The Class CustomerCategoryDto.
customerDto The Class CustomerDto.
customerHierarchyDto The Class CustomerHierarchyDto.
customersDto The Class CustomersDto.
findAccountHierachyRequestDto The Class FindAccountHierachyRequestDto.
minimumAmountElDto Store all minimum amount information for a CRM account hierarchy.
nameDto The Class NameDto.
parentEntitiesDto The Class ParentEntitiesDto.
parentEntityDto The Class ParentEntityDto.
providerContactDto The Class ProviderContactDto.
transferAccountOperationDto Represents the data necessary to establish an account operation transfer from one customer to another .
transferCustomerAccountDto Represents the data necessary to establish an amount transfer from one customer to another .
userAccountDto The Class UserAccountDto.
userAccountsDto The Class UserAccountsDto.
fileDto The Class FileDto.
fileFormatDto The Class FileFormatDto.
fileFormatListResponseDto API response containing a list of File format Dto
fileFormatResponseDto API response containing the File format Dto
fileRequestDto The Class FileRequestDto.
auditableFieldDto The Class AuditableFieldDto.
accountingCodeDto The Class AccountingCodeDto.
activateServicesRequestDto The Class ActivateServicesRequestDto.
amountsDto Contains amounts with and without tax.
applicableDueDateDelayDto The Class ApplicableDueDateDelayDto.
billingRunDto The Class BillingRunDto.
cdrListDto The Class CdrListDto.
chargeCDRDto The Class ChargeCDRDto.
chargeCDRResponseDto The Class ChargeCDRResponseDto.
chargeInstanceDto The Class ChargeInstanceDto.
chargeInstanceOverrideDto The Class ChargeInstanceOverrideDto.
chargeInstanceOverridesDto The Class ChargeInstanceOverridesDto.
counterInstanceDto The Class CounterInstanceDto.
counterPeriodDto
countersInstancesDto The Class CountersInstancesDto.
countersPeriodsDto
createBillingRunDto The Class CreateBillingRunDto.
discountPlanInstanceDto A base class for all API DTO classes
dueDateDelayDto The Class DueDateDelayDto.
dueDateDelayLevelEnum The Enum DueDateDelayLevelEnum.
dueDateDelayReferenceDateEnum The Enum DueDateDelayReferenceDateEnum.
EDRDto The Class WalletOperationDto.
findWalletOperationsDto The Class FindWalletOperationsDto.
generateInvoiceResultDto Invoice generate request DTO
instantiateServicesRequestDto The Class InstantiateServicesRequestDto.
invoiceSequenceDto The Class InvoiceSequenceDto.
invoiceSequencesDto The Class InvoiceSequencesDto.
invoiceTypeDto The Class InvoiceTypeDto.
invoiceTypesDto The Class InvoiceTypesDto.
offerRollbackDto
oneShotChargeInstanceDto Equivalent of BusinessEntity in DTO
operationServicesRequestDto The Class OperationServicesRequestDto.
operationSubscriptionRequestDto The Class OperationSubscriptionRequestDto.
prepaidReservationDto The Class PrepaidReservationDto.
productChargeInstanceDto The Class ProductChargeInstanceDto.
productDto The Class ProductDto.
productInstanceDto The Class ProductInstanceDto.
productToApplyDto The Class ProductToApplyDto.
productsDto The Class ProductsDto.
productsToApplyDto The Class ProductsToApplyDto.
rateSubscriptionRequestDto A Dto class holding the request criterion for the Rate Subscription.
serviceInstanceDto The Class ServiceInstanceDto.
serviceInstancesDto The Class ServiceInstancesDto.
serviceToActivateDto The Class ServiceToActivateDto.
serviceToInstantiateDto The Class ServiceToInstantiateDto.
serviceToUpdateDto The Class ServiceToUpdateDto.
servicesToActivateDto The Class ServicesToActivateDto.
servicesToInstantiateDto The Class ServicesToInstantiateDto.
subscriptionAndServicesToActivateRequestDto The Class SubscriptionAndServicesToActivateRequestDto.
subscriptionDto The Class SubscriptionDto.
subscriptionForCustomerRequestDto Equivalent of BusinessEntity in DTO
subscriptionForCustomerResponseDto All the Opencell API web service response must extend this class.
subscriptionPatchDto
subscriptionRenewalDto The Class SubscriptionRenewalDto.
subscriptionsDto The Class SubscriptionsDto.
subscriptionsListDto The Class SubscriptionsListDto.
terminateSubscriptionRequestDto The Class TerminateSubscriptionRequestDto.
terminateSubscriptionServicesRequestDto The Class TerminateSubscriptionServicesRequestDto.
updateServicesRequestDto The Class UpdateServicesRequestDto.
walletBalanceDto Parameters to calculate wallet balance. Seller, customer, customer account, billing account and user account code parameters are mutually exclusive and only one of them should be provided.
walletOperationDto The Class WalletOperationDto.
walletReservationDto The Class WalletReservationDto.
walletTemplateDto The Class WalletTemplateDto.
woRatedTransactionDto WoRatedTransactionDto : A dto class containing a minimum of Rated Transaction informations like "id" and "status" ...
BSMConfigurationDto The Class BSMConfigurationDto.
baseServiceChargeTemplateDto
bomOfferDto The Class BomOfferDto.
bpmProductDto The Class BpmProductDto.
bsmServiceDto The Class BsmServiceDto.
bundleProductTemplateDto The Class BundleProductTemplateDto.
bundleTemplateDto The Class BundleTemplateDto.
businessOfferModelDto The Class BusinessOfferModelDto.
businessProductModelDto The Class BusinessProductModelDto.
businessServiceModelDto The Class BusinessServiceModelDto.
channelDto The Class ChannelDto.
chargeTemplateDto The Class ChargeTemplateDto.
counterTemplateDto The Class CounterTemplateDto.
counterTemplatesDto The Class CounterTemplatesDto.
digitalResourceDto Equivalent of EnableBusinessEntity in DTO
discountPlanDto The Class DiscountPlanDto.
discountPlanItemDto Discount plan item
discountPlansDto The Class DiscountPlansDto.
offerProductTemplateDto The Class OfferProductTemplateDto.
offerServiceTemplateDto The Class OfferServiceTemplateDto.
offerTemplateCategoryDto The Class OfferTemplateCategoryDto.
offerTemplateDto The Class OfferTemplateDto.
oneShotChargeTemplateDto The Class OneShotChargeTemplateDto.
oneShotChargeTemplateWithPriceDto The Class OneShotChargeTemplateWithPriceDto.
oneShotChargeTemplateWithPriceListDto The Class OneShotChargeTemplateWithPriceListDto.
pricePlanMatrixDto DTO for PricePlanMatrix.
pricePlansDto The Class PricePlansDto.
productChargeTemplateDto The Class ProductChargeTemplateDto.
productOfferingDto The Class ProductOfferingDto.
productTemplateDto The Class ProductTemplateDto.
recurringChargeTemplateDto The Class RecurringChargeTemplateDto.
serviceChargeTemplateRecurringDto The Class ServiceChargeTemplateRecurringDto.
serviceChargeTemplateRecurringsDto The Class ServiceChargeTemplateRecurringsDto.
serviceChargeTemplateSubscriptionDto The Class ServiceChargeTemplateSubscriptionDto.
serviceChargeTemplateSubscriptionsDto The Class ServiceChargeTemplateSubscriptionsDto.
serviceChargeTemplateTerminationDto The Class ServiceChargeTemplateTerminationDto.
serviceChargeTemplateTerminationsDto The Class ServiceChargeTemplateTerminationsDto.
serviceChargeTemplateUsagesDto The Class ServiceChargeTemplateUsagesDto.
serviceConfigurationDto The Class ServiceConfigurationDto.
serviceTemplateDto The Class ServiceTemplateDto.
serviceTemplatesDto The Class ServiceTemplatesDto.
serviceUsageChargeTemplateDto The Class ServiceUsageChargeTemplateDto.
triggeredEdrTemplateDto The Class TriggeredEdrTemplateDto.
triggeredEdrTemplatesDto The Class TriggeredEdrTemplatesDto.
unitOfMeasureDto The Class UnitOfMeasureDto.
usageChargeTemplateDto The Class UsageChargeTemplateDto.
walletsDto The Class WalletsDto.
communicationRequestDto The Class CommunicationRequestDto.
emailTemplateDto The Class EmailTemplateDto.
messageDto A base class for all API DTO classes
messageTemplateDto The Class MessageTemplateDto.
meveoInstanceDto The Class MeveoInstanceDto.
additionalDetailsDto A base class for all API DTO classes
addressBookDto Equivalent of BusinessEntity in DTO
campaignDto Equivalent of BusinessEntity in DTO
contactDto The Class AccountDto.
contactsDto
customTableDataDto Represents data in custom table - custom entity data stored in a separate table
customTableDataResponseDto Represents search within custom table results
customTableRecordDto Represents data in custom table - custom entity data stored in a separate table
customTableWrapperDto
identityResponseDTO All the Opencell API web service response must extend this class.
unitaryCustomTableDataDto Represents data in custom table - custom entity data stored in a separate table This DTO is used for unitary table updates
PDFDocumentRequestDto A Dto holding information required to generate the document pdf file.
PDFTemplateDto A Dto class to encapsulate the PDFTemplate request params.
createProcedureRequestDto A Dto holding inputs to create a document signature procedure from OC side.
signEventEmailDto DTO encapsulating an email template inputs for a signature procedure event.
signEventWebhookDto DTO encapsulating a webhook (for server-server notification) inputs for a signature procedure event.
signFileObjectRequestDto DTO Class for a File Object for a Yousign object document.
signFileRequestDto DTO class for a document request informations.
signFileResponseDto DTO Class for a File informations : response from Yousign document.
signMemberDto A DTO class for a Signature procedure member
signMemberRequestDto A DTO class for a Request of a Signature procedure Member.
signProcedureConfigDto DTO used basically to configure email notification, based on some events , kind of procedure.started ...
signProcedureDto A Dto holding inputs required to create a document signature procedure on Yousign platform side
signProcedureResponseDto A DTO Class holding the response of Creating a document signature procedure.
yousignEventEnum The Enum WebhookEventEnum for Yousign webhook events : https://dev.yousign.com/#/apiDoc
dunningDocumentDto DTO equivalent of DunningDocument entity.
dunningDocumentListDto The Class DunningDocumentListDto.
dunningDocumentResponseDto The Class DunningDocumentsResponseDto.
dunningDocumentsListResponseDto The Class DunningDocumentsListResponseDto.
barChartDto The Class BarChartDto.
chartDto The Class ChartDto.
getListMeasurableQuantityResponse The Class GetListMeasurableQuantityResponse.
getMeasurableQuantityResponse The Class GetMeasurableQuantityResponse.
lineChartDto The Class LineChartDto.
measurableQuantityDto The Class MeasurableQuantityDto.
measuredValueDto The Class MeasuredValueDto.
pieChartDto The Class PieChartDto.
filteredListDto The Class FilteredListDto.
reportExtractDto DTO class for ReportExtract entity
reportExtractExecutionResultDto A base class for all API DTO classes
revenueRecognitionRuleDto The Class RevenueRecognitionRuleDto.
revenueScheduleDto The Class RevenueScheduleDto.
GWFTransitionDto The Class GWFTransitionDto
genericWorkflowDto The Class GenericWorkflowDto
WFStatusDto The Class WFStatusDto
workflowInstanceHistoryDto The Class WorkflowHistoryDto.
userHierarchyLevelDto The Class UserHierarchyLevelDto.
userHierarchyLevelsDto The Class UserHierarchyLevelsDto.
createInvoiceResponseDto The Class CreateInvoiceResponseDto.
generateInvoiceRequestDto The Class GenerateInvoiceRequestDto.
generateInvoiceResponseDto The Class GenerateInvoiceResponseDto.
getInvoiceResponseDto The Class GetInvoiceResponseDto.
getPdfInvoiceRequestDto The Class GetPdfInvoiceRequestDto.
getPdfInvoiceResponseDto The Class GetPdfInvoiceResponseDto.
getXmlInvoiceRequestDto The Class GetXmlInvoiceRequestDto.
getXmlInvoiceResponseDto The Class GetXmlInvoiceResponseDto.
invoiceConfigurationDto The Class InvoiceConfigurationDto.
invoiceDto DTO equivalent of Invoice entity.
jobExecutionResultDto Contains information about job execution status and history once job is completed.
jobExecutionResultsDto
jobInstanceDto The Class JobInstanceDto.
jobInstanceInfoDto The Class JobInstanceInfoDto.
jobInstanceListDto The Class JobInstanceListDto.
timerEntityDto The Class TimerEntityDto.
metricsConfigurationDto Equivalent of BusinessEntity in DTO
meveoModuleDto The Class MeveoModuleDto.
emailNotificationDto The Class EmailNotificationDto.
inboundRequestDto The Class InboundRequestDto.
inboundRequestsDto The Class InboundRequestsDto.
jobTriggerDto The Class JobTriggerDto.
notificationDto The Class NotificationDto.
notificationHistoriesDto The Class NotificationHistoriesDto.
notificationHistoryDto The Class NotificationHistoryDto.
SMSInfoDto
scriptNotificationDto The Class ScriptNotificationDto.
webHookDto The Class WebHookDto.
accountOperationDto The Class AccountOperationDto.
accountOperationsDto The Class AccountOperationsDto.
cardPaymentMethodDto Card payment method. Deprecated in v.4.8. Use PaymentMethodDto instead
cardPaymentMethodTokenDto The Class CardPaymentMethodTokenDto.
cardPaymentMethodTokensDto The Class CardPaymentMethodTokensDto.
DDRequestBuilderDto The DDRequestBuilderDto Dto.
DDRequestBuilderResponseDto The Class DDRequestBuilderResponseDto.
DDRequestLotOpDto The Class DDRequestLotOpDto.
dunningInclusionExclusionDto The Class DunningInclusionExclusionDto.
litigationRequestDto The Class LitigationRequestDto.
mandatInfoDto The Class MandatInfoDto.
matchOperationRequestDto The Class MatchOperationRequestDto.
matchingAmountDto The Class MatchingAmountDto.
matchingAmountsDto The Class MatchingAmountsDto.
matchingCodeDto The Class MatchingCodeDto.
matchingCodesDto The Class MatchingCodesDto.
otherCreditAndChargeDto The Class OtherCreditAndChargeDto.
payByCardDto The Class PayByCardDto.
paymentDto The Class PaymentDto.
paymentGatewayDto The PaymentGateway Dto.
paymentGatewayResponseDto The Class PaymentGatewayResponseDto.
paymentGatewayRumSequenceDto Equivalent of BusinessEntity in DTO
paymentHistoriesDto The Class PaymentHistoriesDto.
paymentHistoryDto Class to represent payments that was initiated from OC, we find payment done, ,pending,rejected and error.
paymentHostedCheckoutResponseDto The Class PaymentGatewayResponseDto.
paymentMethodDto The PaymentMethod Dto.
paymentMethodTokenDto The Class PaymentMethodTokenDto.
paymentMethodTokensDto The Class PaymentMethodTokensDto.
paymentResponseDto The Class PaymentResponseDto.
paymentScheduleInstanceBalanceDto The Class PaymentScheduleInstanceDto.
paymentScheduleInstanceDto The Class PaymentScheduleInstanceDto.
paymentScheduleInstanceItemDto The Class PaymentScheduleInstanceItemDto.
paymentScheduleInstanceResponseDto The Class PaymentScheduleInstanceResponseDto.
paymentScheduleInstancesDto The Class PaymentScheduleInstancesDto.
paymentScheduleTemplateDto The Class PaymentScheduleTemplateDto.
paymentScheduleTemplateResponseDto The Class PaymentScheduleTemplateResponseDto.
paymentScheduleTemplatesDto The Class PaymentScheduleTemplatesDto.
recordedInvoiceDto The Class RecordedInvoiceDto.
refundDto The Class RefundDto.
rejectedPaymentDto The Class RejectedPaymentDto.
result
unMatchingOperationRequestDto The Class UnMatchingOperationRequestDto.
WFActionDto The Class WFActionDto.
WFDecisionRuleDto The Class WFDecisionRuleDto.
WFTransitionDto The Class WFTransitionDto.
workflowDto The Class WorkflowDto.
workflowHistoryActionDto The Class WorkflowHistoryActionDto.
workflowHistoryDto The Class WorkflowHistoryDto.
bankingDateStatusResponse The Class BankingDateStatusResponse.
baseResponse All the Opencell API web service response must extend this class.
businessEntityResponseDto The Class BusinessEntityResponseDto.
catMessagesListDto The Class CatMessagesListDto.
cdrReservationResponse The Class CdrReservationResponse.
customEntityInstanceResponseDto The Class CustomEntityInstanceResponseDto.
customEntityInstancesResponseDto The Class CustomEntityInstancesResponseDto.
customEntityTemplateResponseDto The Class CustomEntityTemplateResponseDto.
customEntityTemplatesResponseDto The Class CustomEntityTemplatesResponseDto.
customerBrandsDto The Class CustomerBrandsDto.
customerCategoriesDto The Class CustomerCategoriesDto.
customerInvoicesResponse The Class CustomerInvoicesResponse.
customerListResponse The Class CustomerListResponse.
customerPaymentsResponse The Class CustomerPaymentsResponse.
descriptionsResponseDto The Class DescriptionsResponseDto.
entityCustomActionResponseDto The Class EntityCustomActionResponseDto.
entityCustomizationResponseDto The Class EntityCustomizationResponseDto.
genericSearchResponse Search results - Actual search results plus Pagination and sorting criteria plus total record count
getBillingCycleResponse The Class GetBillingCycleResponse.
getCalendarResponse The Class GetCalendarResponse.
getConfigurationResponse The Class GetConfigurationResponse.
getCountriesIsoResponse The Class GetCountriesIsoResponse.
getCountryIsoResponse The Class GetCountryIsoResponse.
getCountryResponse The Class GetCountryResponse.
getCurrenciesIsoResponse The Class GetCurrenciesIsoResponse.
getCurrencyIsoResponse The Class GetCurrencyIsoResponse.
getCurrencyResponse The Class GetCurrencyResponse.
getCustomFieldTemplateReponseDto The Class GetCustomFieldTemplateReponseDto.
getCustomerAccountConfigurationResponseDto The Class GetCustomerAccountConfigurationResponseDto.
getCustomerConfigurationResponseDto The Class GetCustomerConfigurationResponseDto.
getDescriptionsResponse The Class GetDescriptionsResponse.
getFilterResponseDto Return DTO for FilteredList API that includes the FilterDto in the response.
getInvoiceCategoryResponse The Class GetInvoiceCategoryResponse.
getInvoiceSequenceResponse The Class GetInvoiceSequenceResponse.
getInvoiceSequencesResponse The Class GetInvoiceSequencesResponse.
getInvoiceSubCategoryResponse The Class GetInvoiceSubCategoryResponse.
getInvoiceTypeResponse The Class GetInvoiceTypeResponse.
getInvoiceTypesResponse The Class GetInvoiceTypesResponse.
getInvoicingConfigurationResponseDto The Class GetInvoicingConfigurationResponseDto.
getLanguageIsoResponse The Class GetLanguageIsoResponse.
getLanguageResponse The Class GetLanguageResponse.
getLanguagesIsoResponse The Class GetLanguagesIsoResponse.
getMetricsConfigurationResponse The Class GetMetricConfigurationResponse.
getOccTemplateResponseDto The Class GetOccTemplateResponseDto.
getOccTemplatesResponseDto The Class GetOccTemplatesResponseDto.
getProviderResponse The Class GetProviderResponse.
getRoleResponse The Class GetRoleResponse.
getScriptInstanceResponseDto The Class GetScriptInstanceResponseDto.
getSellerResponse The Class GetSellerResponse.
getTaxResponse The Class GetTaxResponse.
getTaxesResponse The Class GetTaxesResponse.
getTerminationReasonResponse The Class GetTerminationReasonResponse.
getTimerEntityResponseDto The Class GetTimerEntityResponseDto.
getTradingConfigurationResponseDto The Class GetTradingConfigurationResponseDto.
getTradingCountryResponse The Class GetTradingCountryResponse.
getTradingCurrencyResponse The Class GetTradingCurrencyResponse.
getTradingLanguageResponse The Class GetTradingLanguageResponse.
getUserResponse The Class GetUserResponse.
invoiceCategoryResponseDto The Class InvoiceCategoryResponseDto.
invoiceCreationResponse The Class InvoiceCreationResponse.
invoiceSubCategoryResponseDto The Class InvoiceSubCategoryResponseDto.
invoicesDto The Class InvoicesDto.
listCalendarResponse The Class ListCalendarResponse.
pagingAndFiltering The Class PagingAndFiltering.
sortOrder The Enum SortOrder.
parentListResponse The Class ParentListResponse.
pdfInvoiceResponse The Class PdfInvoiceResponse.
permissionResponseDto The Class PermissionResponseDto.
queryResponse Pagination and sorting criteria plus total record count.
rawResponseDto A Dto class to wrap a raw API response.
scriptInstanceReponseDto The Class ScriptInstanceReponseDto.
searchResponse Pagination and sorting criteria plus total record count.
sellerCodesResponseDto The Class SellerCodesResponseDto.
sellerResponseDto The Class SellerResponseDto.
subscriptionWithCreditLimitResponse The Class SubscriptionWithCreditLimitResponse.
terminateCustomerSubscriptionResponse The Class TerminateCustomerSubscriptionResponse.
titleDto The Class TitleDto.
titlesDto The Class TitlesDto.
usageChargeTemplateResponseDto The Class UsageChargeTemplateResponseDto.
userHierarchyLevelResponseDto The Class UserHierarchyLevelResponseDto.
accessesResponseDto The Class AccessesResponseDto.
billingAccountsResponseDto The Class BillingAccountsResponseDto.
businessAccountModelResponseDto The Class BusinessAccountModelResponseDto.
customerAccountsResponseDto The Class CustomerAccountsResponseDto.
customersResponseDto The Class CustomersResponseDto.
getAccessResponseDto The Class GetAccessResponseDto.
getAccountHierarchyResponseDto The Class GetAccountHierarchyResponseDto.
getBillingAccountResponseDto The Class GetBillingAccountResponseDto.
getCustomerAccountResponseDto The Class GetCustomerAccountResponseDto.
getCustomerCategoryResponseDto GetCustomerCategoryResponse Dto.
getCustomerResponseDto The Class GetCustomerResponseDto.
getUserAccountResponseDto The Class GetUserAccountResponseDto.
parentEntitiesResponseDto The Class ParentEntitiesResponseDto.
providerContactResponseDto The Class ProviderContactResponseDto.
providerContactsResponseDto The Class ProviderContactsResponseDto.
titleResponseDto The Class TitleResponseDto.
titlesResponseDto The Class TitlesResponseDto.
userAccountsResponseDto The Class UserAccountsResponseDto.
getFilesResponseDto The Class GetFilesResponseDto.
accountingCodeGetResponseDto The Class AccountingCodeGetResponseDto.
accountingCodeListResponseDto The Class AccountingCodeListResponse.
cdrReservationResponseDto The Class CdrReservationResponseDto.
filteredListResponseDto Filtering or search response.
findWalletOperationsResponseDto The Class FindWalletOperationsResponseDto.
getBillingAccountListInRunResponseDto The Class GetBillingAccountListInRunResponseDto.
getBillingRunInfoResponseDto The Class GetBillingRunInfoResponseDto.
getCountersInstancesResponseDto The Class GetCountersInstancesResponseDto.
getDueDateDelayResponseDto The Class GetDueDateDelayResponseDto.
getPostInvoicingReportsResponseDto The Class GetPostInvoicingReportsResponseDto.
getPreInvoicingReportsResponseDto The Class GetPreInvoicingReportsResponseDto.
getSubscriptionResponseDto The Class GetSubscriptionResponseDto.
getWalletTemplateResponseDto The Class GetWalletTemplateResponseDto.
rateSubscriptionResponseDto A Dto class holding the Rate subscription response.
ratedTransactionListResponseDto RatedTransactionListResponseDto : A class containing the response of searching a list of Rated transactions
subscriptionsListResponseDto The Class SubscriptionsListResponseDto.
subscriptionsResponseDto The Class SubscriptionsResponseDto.
walletBalanceResponseDto Wallet balance.
discountPlanItemResponseDto The Class DiscountPlanItemResponseDto.
discountPlanItemsResponseDto The Class DiscountPlanItemsResponseDto.
getBundleTemplateResponseDto The Class GetBundleTemplateResponseDto.
getBusinessOfferModelResponseDto The Class GetBusinessOfferModelResponseDto.
getBusinessProductModelResponseDto The Class GetBusinessProductModelResponseDto.
getBusinessServiceModelResponseDto The Class GetBusinessServiceModelResponseDto.
getChannelResponseDto The Class GetChannelResponseDto.
getChargeTemplateResponseDto The Class GetChargeTemplateResponseDto.
getCounterTemplateResponseDto The Class GetCounterTemplateResponseDto.
getDigitalResourceResponseDto The Class GetDigitalResourceResponseDto.
getDiscountPlanResponseDto The Class GetDiscountPlanResponseDto.
getDiscountPlansResponseDto The Class GetDiscountPlansResponseDto.
getListBundleTemplateResponseDto The Class GetListBundleTemplateResponseDto.
getListChannelsAndSegmentsResponseDto All the Opencell API web service response must extend this class.
getListOfferTemplateResponseDto The Class GetListOfferTemplateResponseDto.
getListProductTemplateResponseDto The Class GetListProductTemplateResponseDto.
getListServiceInstanceResponseDto The Class GetListServiceInstanceResponseDto.
getListServiceTemplateResponseDto The Class GetListServiceTemplateResponseDto.
getListUnitOfMeasureResponseDto The Class GetListUnitOfMeasureResponseDto.
getOfferTemplateCategoryResponseDto The Class GetOfferTemplateCategoryResponseDto.
getOfferTemplateResponseDto The Class GetOfferTemplateResponseDto.
getOneShotChargeTemplateResponseDto The Class GetOneShotChargeTemplateResponseDto.
getOneShotChargesResponseDto The Class GetOneShotChargesResponseDto.
getPricePlanResponseDto The Class GetPricePlanResponseDto.
getProductChargeTemplateResponseDto The Class GetProductChargeTemplateResponseDto.
getProductTemplateResponseDto The Class GetProductTemplateResponseDto.
getRecurringChargeTemplateResponseDto The Class GetRecurringChargeTemplateResponseDto.
getServiceInstanceResponseDto The Class GetServiceInstanceResponseDto.
getServiceTemplateResponseDto The Class GetServiceTemplateResponseDto.
getTriggeredEdrResponseDto The Class GetTriggeredEdrResponseDto.
getUnitOfMeasureResponseDto The Class GetUnitOfMeasureResponseDto.
getUsageChargeTemplateResponseDto The Class GetUsageChargeTemplateResponseDto.
pricePlanMatrixesResponseDto The Class PricePlanMatrixesResponseDto.
emailTemplateResponseDto The Class EmailTemplateResponseDto.
emailTemplatesResponseDto The Class EmailTemplatesResponseDto.
meveoInstanceResponseDto The Class MeveoInstanceResponseDto.
meveoInstancesResponseDto The Class MeveoInstancesResponseDto.
contactsResponseDto Pagination and sorting criteria plus total record count.
getAddressBookResponseDto All the Opencell API web service response must extend this class.
getContactResponseDto All the Opencell API web service response must extend this class.
PDFDocumentResponseDto A DTO Class holding the response of Generating a document PDF file.
getChartResponse The Class GetChartResponse.
getMeasuredValueResponse The Class GetMeasuredValueResponse.
reportExtractExecutionResultResponseDto All the Opencell API web service response must extend this class.
reportExtractExecutionResultsResponseDto Pagination and sorting criteria plus total record count.
reportExtractResponseDto The Class ReportExtractResponseDto.
reportExtractsResponseDto The Class ReportExtractsResponseDto.
runReportExtractDto The Class RunReportExtractDto.
GWFTransitionResponseDto The Class GWFTransitionResponseDto.
genericWorkflowResponseDto The Class GenericWorkflowResponseDto.
genericWorkflowsResponseDto The Class GenericWorkflowsResponseDto.
workflowInsHistoryResponseDto The Class WorkflowInsHistoryResponseDto.
jobCategoriesResponseDto The Class JobCategoriesResponseDto.
jobExecutionResultResponseDto The Class JobExecutionResultResponseDto.
jobExecutionResultsResponseDto Pagination and sorting criteria plus total record count.
jobInstanceListResponseDto The Class JobInstanceListResponseDto.
jobInstanceResponseDto The Class JobInstanceResponseDto.
timerEntityResponseDto The Class TimerEntityResponseDto.
meveoModuleDtoResponse The Class MeveoModuleDtoResponse.
meveoModuleDtosResponse The Class MeveoModuleDtosResponse.
getEmailNotificationResponseDto The Class GetEmailNotificationResponseDto.
getJobTriggerResponseDto The Class GetJobTriggerResponseDto.
getScriptNotificationResponseDto The Class GetNotificationResponseDto.
getWebHookNotificationResponseDto The Class GetWebHookNotificationResponseDto.
inboundRequestsResponseDto The Class InboundRequestsResponseDto.
notificationHistoriesResponseDto The Class NotificationHistoriesResponseDto.
SMSInfoResponseDTO
accountOperationResponseDto The Class AccountOperationResponseDto.
accountOperationsResponseDto The Class AccountOperationsResponseDto.
actionPlanItemResponseDto The Class ActionPlanItemResponseDto.
creditCategoriesResponseDto The Class CreditCategoriesResponseDto.
creditCategoryResponseDto The Class CreditCategoryResponseDto.
DDRequestLotOpResponseDto The Class DDRequestLotOpResponseDto.
DDRequestLotOpsResponseDto The Class DDRequestLotOpsResponseDto.
matchedOperationDto Represents matched account operations.
matchedOperationsResponseDto The Class MatchedOperationsResponseDto.
paymentGatewayRumSequenceResponseDto All the Opencell API web service response must extend this class.
revenueRecognitionRuleDtoResponse The Class RevenueRecognitionRuleDtoResponse.
revenueRecognitionRuleDtosResponse The Class RevenueRecognitionRuleDtosResponse.
taxCategoryListResponseDto API response containing a list of Tax category Dto
taxCategoryResponseDto API response containing the Tax category Dto
taxClassListResponseDto API response containing a list of Tax class Dto
taxClassResponseDto API response containing the Tax class Dto
taxMappingListResponseDto API response containing a list of Tax mapping Dto
taxMappingResponseDto API response containing the Tax mapping Dto
fieldsNotImportedStringCollectionDto The Class FieldsNotImportedStringCollectionDto.
importExportResponseDto The Class ImportExportResponseDto.
customScriptDto The Class CustomScriptDto.
customerSequenceDto Customer Sequence value DTO representation.
genericSequenceDto Sequence value DTO representation.
genericSequenceValueResponseDto Sequence value response DTO representation.
taxCategoryDto DTO implementation of Tax category. Tax category
taxClassDto DTO implementation of Tax class. Tax class
taxMappingDto DTO implementation of Tax mapping. Tax mapping
catUsageDto The Class CatUsageDto.
chargeAggregateDto The Class ChargeAggregateDto.
subCatUsageDto The Class SubCatUsageDto.
usageChargeAggregateResponseDto The Class UsageChargeAggregateResponseDto.
usageDto The Class UsageDto.
usageRequestDto The Class UsageRequestDto.
usageResponseDto The Class UsageResponseDto.
WFTransitionResponseDto The Class WFTransitionResponseDto.
workflowHistoryResponseDto The Class WorkflowHistoryResponseDto.
workflowResponseDto The Class WorkflowResponseDto.
workflowsResponseDto The Class WorkflowsResponseDto.
accountEntity
auditable
auditableEntity
baseEntity
businessCFEntity
businessEntity
datePeriod A period of dates
enableBusinessCFEntity
enableBusinessEntity
enableEntity
currency
dunningHistory
securedEntity
seller
user
auditChangeTypeEnum
auditableFieldHistory
jobHistory
accountStatusEnum
accountingCode
bankCoordinates
billingAccount
billingCycle
billingEntityTypeEnum
billingProcessTypesEnum
billingRun
billingRunList
billingRunStatusEnum
billingWalletTypeEnum
categoryInvoiceAgregate
chargeInstance
chartOfAccountTypeEnum
chartOfAccountViewTypeEnum
counterInstance
counterPeriod
country
discountPlanInstance
dueDateDelayEnum
generalLedger
instanceStatusEnum
invoice
invoiceAgregate
invoiceCategory
invoiceModeEnum
invoiceSequence
invoiceStatusEnum
invoiceSubCategory
invoiceType
invoiceTypeSellerSequence
language
operationTypeEnum
overrideProrataEnum
postInvoicingReportsDTO
preInvoicingReportsDTO
productChargeInstance
productInstance
ratedTransaction
ratedTransactionStatusEnum
ratedTransactionTypeEnum
referenceDateEnum
rejectedBillingAccount
serviceInstance
subCategoryInvoiceAgregate
subscription
subscriptionRenewal Embeddable set of renewal fields. Use in ServiceTemplate and Subscription.
endOfTermActionEnum End of subscription term action to be taken
initialTermTypeEnum The default subscription renewal term type. A subscription can be automatically renewed on a period basis or on a fixed date.
renewalPeriodUnitEnum Subscription renewal period unit
renewalTermTypeEnum
subscriptionStatusEnum
subscriptionTerminationReason Subscription termination rule
tax
thresholdOptionsEnum
tradingCountry
tradingCurrency
tradingLanguage
userAccount
walletInstance
walletOperation
walletOperationStatusEnum
accumulatorCounterTypeEnum
businessOfferModel
businessProductModel
businessServiceModel
calendar
calendarIntervalTypeEnum
calendarPeriodUnitEnum
channel
chargeTemplate
counterTemplate
counterTemplateLevel
counterTypeEnum
digitalResource
discountPlan
durationPeriodUnitEnum
discountPlanItem
discountPlanItemTypeEnum
levelEnum
lifeCycleStatusEnum
monthEnum
offerProductTemplate
offerServiceTemplate
offerTemplate
offerTemplateCategory
oneShotChargeTemplate
oneShotChargeTemplateTypeEnum
pricePlanMatrix
productChargeTemplate
productOffering
productTemplate
recurrenceTypeEnum
recurringChargeTemplate
roundingModeEnum
serviceChargeTemplate
serviceChargeTemplateRecurring
serviceChargeTemplateSubscription
serviceChargeTemplateTermination
serviceChargeTemplateUsage
serviceTemplate
triggeredEDRTemplate
unitOfMeasure
usageChargeTemplate
walletTemplate
campaign
campaignStatusEnum
communicationPolicy
mediaEnum
message
messageStatusEnum
messageTemplate
messageTemplateTypeEnum
messageVariableValue
meveoInstance
meveoInstanceStatusEnum
priorityEnum
contact
emailTemplate
mailingTypeEnum
accountHierarchyTypeEnum
businessAccountModel
customer
customerBrand
customerCategory
customerSequence
providerContact
customFieldIndexTypeEnum
customFieldInheritanceEnum
customFieldMapKeyEnum
customFieldColumnUseEnum
customFieldStorageTypeEnum
customFieldTypeEnum
customFieldValues Represents custom field values held by an ICustomFieldEntity entity
dunningDocument
legendPositionEnum
measurementPeriodEnum
orientationEnum
accountingWriting
reportExtractExecutionOrigin
reportExtractResultTypeEnum
reportExtractScriptTypeEnum
revenueRecognitionRule
hierarchyLevel
userHierarchyLevel
additionalDetails
addressBook
access
meveoModule
meveoModuleItem
moduleLicenseEnum
httpProtocol
notificationEventTypeEnum
notificationHistoryStatusEnum
webHookMethodEnum
order
orderHistory
orderItem
orderItemActionEnum
orderItemProductOffering
orderStatusEnum
accountOperation
actionDunning
automatedPayment
automatedRefund
creditCardTypeEnum
creditCategory
customerAccount
customerAccountStatusEnum
DDRequestBuilder
DDRequestBuilderTypeEnum
DDRequestItem
DDRequestLOT
DDRequestOpEnum
DDRequestOpStatusEnum
dunningActionStatusEnum
dunningActionTypeEnum
dunningLOT
dunningLevelEnum
mandatStateEnum
matchingAmount
matchingCode
matchingStatusEnum
matchingTypeEnum
OCCTemplate
operationCategoryEnum
otherTransaction
payment
paymentErrorTypeEnum
paymentGateway
paymentGatewayRumSequence
paymentGatewayTypeEnum
paymentLevelEnum
paymentMethod
paymentMethodEnum
paymentOrRefundEnum
paymentReplayCauseEnum
paymentScheduleInstance
paymentScheduleInstanceItem
paymentScheduleStatusEnum
paymentScheduleTemplate
paymentStatusEnum
paymentVentilation
recordedInvoice
recordedInvoiceCatAgregate
refund
rejectedPayment
rejectedType
ventilationActionStatusEnum
quote
quoteItem
quoteItemProductOffering
QuoteStatus Quote status lifecycle
EDR
EDRStatusEnum
revenueRecognitionDelayUnitEnum
revenueRecognitionEventEnum
scriptInstance
scriptInstanceCategory
scriptInstanceError
scriptSourceTypeEnum
permission
role
genericSequence
address
contactInformation
name
title
taxCategory
taxClass
decisionRuleTypeEnum
WFAction
WFDecisionRule
WFTransition
workflow
abstractCatalogEntity
abstractEntity
catalogReference
lifecycleStatus
serviceLevelAgreement
timeRange
alterationPrice
place
productOfferPriceAlterationType
productOfferingPrice
productOfferingPriceType
abstractEntityReference
parsedVersion
Namespace http://www.tmforum.org
type description
Attachment
RelatedParty
BillingAccount
Note
Product
ProductCharacteristic
ProductOrder Equivalent of AuditableEntity in DTO
OrderItem
ProductRelationship
BundledProductReference
channel
Price
ProductOfferPriceAlteration
ProductOffering
ProductOfferingTerm
Characteristic
Customer
Quote
QuoteItem
QuotePriceAlteration
QuoteProductOfferingPrice