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/filtering
  • POST
Search for a list of customer accounts given a set of filter.
  • /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/customerAccounts/{customerAccountCode}
  • GET
List BillingAccount filter by customerAccountCode.
  • /account/billingAccount/filterCountersByPeriod
  • GET
filter counters by period date.
  • /account/billingAccount/list
  • GET
List BillingAccount filter by customerAccountCode.
  • /account/billingAccount/listGetAll
  • GET
List BillingAccounts matching a given criteria
  • /account/billingAccount/version
  • GET
Get version of application
  • /account/billingAccount/{billingAccountCode}
  • DELETE GET
 
  • /account/billingAccount/{billingAccountCode}/filterCountersByPeriod
  • GET
filter counters by period date.
  • /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/listGetAll
  • GET
List MeveoModuleDtos matching a given criteria
  • /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/brands
  • POST PUT
 
  • /account/customer/brands/{brandCode}
  • DELETE
Remove existing customer brand with a given brand code
  • /account/customer/categories
  • POST PUT
 
  • /account/customer/categories/{categoryCode}
  • DELETE GET
 
  • /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/filtering
  • POST
List customers matching a given criteria
  • /account/customer/list
  • GET POST
 
  • /account/customer/list47
  • POST
Filters are: category, seller, brand and provider.
  • /account/customer/listGetAll
  • GET
List customers matching a given criteria
  • /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 GET
 
  • /account/customer/{customerCode}/exportation
  • 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/{customerCode}/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /account/customer/{customerCode}/gdprAnonymization
  • 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/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/customers/{customerCode}
  • GET
List CustomerAccount filtered by customerCode.
  • /account/customerAccount/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /account/customerAccount/list
  • GET
List CustomerAccount filtered by customerCode.
  • /account/customerAccount/listGetAll
  • GET
List CustomerAccounts matching a given criteria
  • /account/customerAccount/transferAccount
  • POST
Transfer an amount from one customer to another.
  • /account/customerAccount/version
  • GET
Get version of application
  • /account/customerAccount/{customerAccountCode}
  • DELETE GET
Web service for managing customer account.
  • /account/customerAccount/{customerAccountCode}/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /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/listGetAll
  • GET
List titles matching a given criteria
  • /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/billingAccounts/{billingAccountCode}
  • GET
List user accounts filtered by a billing account's code.
  • /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/listGetAll
  • GET
List user accounts matching a given criteria
  • /account/userAccount/version
  • GET
Get version of application
  • /account/userAccount/{userAccountCode}
  • DELETE GET
 
  • /account/userAccount/{userAccountCode}/filterCountersByPeriod
  • GET
Filter counters by period date.
  • /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
  • /accountOperation/{id}/status/{newStatus}
  • PUT
update account operation's status
  • /accountOperation/{id}/updateAccountingDate/{newAccountingDate}
  • PUT
update account operation's accountingDate
  • /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/listGetAll
  • GET
List fileFormats matching a given criteria
  • /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/executeTransition
  • POST
execute transition
  • /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
  • /attributes
  • POST PUT
 
  • /attributes/cpq/offers/{productCode}/{productVersion}
  • POST
 
  • /attributes/version
  • GET
Get version of application
  • /attributes/{code}
  • DELETE GET
 
  • /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/listGetAll
  • GET
List AccountingCodes matching a given criteria
  • /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/billingRun/{billingRunId}/cancelInvoice
  • PUT
Move invoices to a new Billing Run with the same parameters as the current one, and also in status REJECTED|POSTINVOICED.
  • /billing/invoicing/billingRun/{billingRunId}/canceledInvoices
  • DELETE
Delete canceled invoices for a given billing run.
  • /billing/invoicing/billingRun/{billingRunId}/invalidateInvoiceDocuments
  • PUT
Validate one or several invoices (change status to DRAFT). Body will contain a list of invoice id
  • /billing/invoicing/billingRun/{billingRunId}/moveInvoice
  • PUT
Move invoices to a new Billing Run with the same parameters as the current one, and also in status REJECTED|POSTINVOICED.
  • /billing/invoicing/billingRun/{billingRunId}/rejectInvoice
  • PUT
Reject one or several invoices (change status to REJECTED). Body will contains a list of invoice ids.
  • /billing/invoicing/billingRun/{billingRunId}/validateInvoice
  • PUT
Validate one or several invoices (change status to DRAFT). Body will contain a list of invoice id
  • /billing/invoicing/cancelBillingRun
  • POST PUT
 
  • /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/rebuildInvoice
  • PUT
Recompute invoices based on RatedTransactions and re-apply invoiceValidationScript
  • /billing/invoicing/validateBillingRun
  • POST PUT
 
  • /billing/invoicing/version
  • GET
Get version of application
  • /billing/invoicingPlanItems
  • GET POST PUT
 
  • /billing/invoicingPlanItems/createOrUpdate
  • POST
Create new or update an existing invoicingPlanItem
  • /billing/invoicingPlanItems/list
  • POST
List invoicingPlanItems matching a given criteria
  • /billing/invoicingPlanItems/version
  • GET
Get version of application
  • /billing/invoicingPlanItems/{invoicingPlanItemCode}
  • DELETE
Remove an existing invoicingPlanItem with a given code
  • /billing/invoicingPlans
  • GET POST PUT
 
  • /billing/invoicingPlans/list
  • POST
List invoicingPlans matching a given criteria
  • /billing/invoicingPlans/version
  • GET
Get version of application
  • /billing/invoicingPlans/{invoicingPlanCode}
  • DELETE
Remove an existing invoicingPlan with a given code
  • /billing/mediation/cancelReservation
  • POST
Cancels the reservation
  • /billing/mediation/chargeCdr
  • POST
Parse CDR, convert to EDR and rate it
  • /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/listGetAll
  • GET
List ratedTransactions matching a given criteria
  • /billing/ratedTransaction/version
  • GET
Get version of application
  • /billing/subscription
  • GET POST PUT
 
  • /billing/subscription/activate
  • POST PUT
 
  • /billing/subscription/activateForCustomer
  • POST
Activate a given Subscription for a customer.
  • /billing/subscription/activatePatchedSubscription
  • POST
Activate the patched version of a given Subscription.
  • /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/cancelSubscriptionTermination/{subscriptionCode}
  • POST
Cancels the programed termination of a 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/listGetAll
  • GET
List subscriptions matching a given criteria
  • /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
For V11 catalog use : subscribeAndInstantiateProducts API, then activateServices API Create a subscription and activate services in a single transaction.
  • /billing/subscription/subscribeAndInstantiateProducts
  • POST
Create a subscription and instanciate product in a single transaction.
  • /billing/subscription/suspend
  • PUT
Suspend an existing subscription
  • /billing/subscription/suspendServices
  • PUT
Suspend an existing services
  • /billing/subscription/terminate
  • POST PUT
 
  • /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
patch subscription
  • /billing/subscription/{code}/offer/rollback
  • PATCH
rollback offer
  • /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/operation/listGetAll
  • GET
List wallet operations matching a given criteria
  • /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/list
  • GET
Search for list of billingCycles.
  • /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/listGetAll
  • GET
List Calendars matching a given criteria
  • /calendar/version
  • GET
Get version of application
  • /calendar/{calendarCode}
  • DELETE
Remove calendar with a given code.
  • /catalog/bundleTemplate
  • POST PUT
 
  • /catalog/bundleTemplate/createOrUpdate
  • POST
Create or update bundleTemplate
  • /catalog/bundleTemplate/version
  • GET
Get version of application
  • /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/listGetAll
  • GET
List Business Product Models matching a given criteria
  • /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/listGetAll
  • GET
List Business Service Models matching a given criteria
  • /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/chargeTemplates/{chargeTemplateCode}
  • GET
Search for a charge template with a given code
  • /catalog/chargeTemplates/{chargeTemplateCode}/duplicate
  • POST
Duplicate charge template
  • /catalog/chargeTemplates/{chargeTemplateCode}/status/{status}
  • PUT
Update charge template status
  • /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/listGetAll
  • GET
List CounterTemplates matching a given criteria
  • /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/listGetAll
  • GET
List DiscountPlans matching a given criteria
  • /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/listGetAll
  • GET
List DiscountPlanItems matching a given criteria
  • /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/cpq/list
  • POST
List offerTemplates matching a given criteria
  • /catalog/offerTemplate/createOrUpdate
  • POST
Create or update offer template based on a given code.
  • /catalog/offerTemplate/duplicate/{offerTemplateCode}
  • POST
duplicate offer
  • /catalog/offerTemplate/list
  • GET POST
Web service for managing org.meveo.model.catalog.OfferTemplate.
  • /catalog/offerTemplate/listGetAll
  • GET
List Offer templates matching a given criteria
  • /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/{offerCode}/addProduct
  • POST
Web service for managing org.meveo.model.catalog.OfferTemplate.
  • /catalog/offerTemplate/{offerCode}/dissociateProducts
  • POST
Web service for managing org.meveo.model.catalog.OfferTemplate.
  • /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/offerTemplate/{offerTemplateCode}/update/status
  • POST
update Status
  • /catalog/offerTemplateCategory
  • DELETE GET POST PUT
 
  • /catalog/offerTemplateCategory/createOrUpdate
  • POST
Create new or update an existing offer template category
  • /catalog/offerTemplateCategory/listGetAll
  • GET
List DiscountPlanItems matching a given criteria
  • /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/listGetAll
  • GET
Return the list of oneShotChargeTemplates.
  • /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/listGetAll
  • GET
List PricePlanMatrixes
  • /catalog/pricePlan/pricePlanMatrixColumns/{pricePlanMatrixColumnCode}
  • GET
Find a price plan matrix column with a given code
  • /catalog/pricePlan/pricePlanMatrixLines/{pricePlanMatrixLineId}
  • DELETE GET
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/pricePlanMatrixVersion
  • POST
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/pricePlanMatrixVersions
  • GET
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /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/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}
  • DELETE
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}/duplication
  • POST
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}/pricePlanMatrixColumns
  • POST PUT
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}/pricePlanMatrixColumns/{pricePlanMatrixColumnCode}
  • DELETE
Remove an existing price plan matrix column with a given code
  • /catalog/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}/pricePlanMatrixLines
  • POST PUT
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/{pricePlanMatrixCode}/pricePlanMatrixVersions/{pricePlanMatrixVersion}/status/{status}
  • PUT
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/pricePlan/{pricePlanMatrixCode}/{pricePlanMatrixVersion}/duplication
  • POST
Web service for managing org.meveo.model.catalog.PricePlanMatrix.
  • /catalog/products
  • GET POST
 
  • /catalog/products/cpq/offers
  • POST
 
  • /catalog/products/productLines
  • POST
 
  • /catalog/products/productLines/{productLineCode}
  • DELETE GET
 
  • /catalog/products/productVersions
  • POST
 
  • /catalog/products/version
  • GET
Get version of application
  • /catalog/products/{productCode}
  • DELETE GET PUT
 
  • /catalog/products/{productCode}/addCharges
  • POST
 
  • /catalog/products/{productCode}/duplication
  • POST
 
  • /catalog/products/{productCode}/productVersions
  • GET
 
  • /catalog/products/{productCode}/productVersions/{productVersion}
  • DELETE GET
 
  • /catalog/products/{productCode}/productVersions/{productVersion}/duplication
  • POST
 
  • /catalog/products/{productCode}/productVersions/{productVersion}/status/{status}
  • PUT
 
  • /catalog/products/{productCode}/removeCharges
  • POST
 
  • /catalog/products/{productCode}/status/{status}
  • PUT
 
  • /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/listGetAll
  • GET
Return the list of recurringChargeTemplates.
  • /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
  • POST
Gets a service template list matching given criteria .
  • /catalog/serviceTemplate/listGetAll
  • GET
Gets a service template list.
  • /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/listGetAll
  • GET
Gets a triggeredEdrs list.
  • /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/listGetAll
  • GET
List UnitOfMeasures matching a given criteria
  • /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/listGetAll
  • GET
List UsageChargeTemplate
  • /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.
  • /catalog/version
  • GET
Get version of application
  • /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/listGetAll
  • GET
Gets a productChargeTemplate list.
  • /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/listGetAll
  • GET
Gets a productTemplates list.
  • /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/listGetAll
  • GET
List Calendars matching a given criteria
  • /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
  • /commercialRules
  • GET POST PUT
 
  • /commercialRules/attributeRules
  • GET
 
  • /commercialRules/groupedAttributeRules
  • GET
 
  • /commercialRules/offerRules/{offerCode}
  • GET
 
  • /commercialRules/productRules
  • GET
 
  • /commercialRules/tagRules/{tagCode}
  • GET
 
  • /commercialRules/version
  • GET
Get version of application
  • /commercialRules/{code}
  • DELETE GET
 
  • /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
  • POST
set configuration property
  • /configurations/properties
  • GET POST
Manages system configuration.
  • /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/listGetAll
  • GET
List Contacts matching a given criteria
  • /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/list
  • GET
Search for list of trading countries.
  • /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}
  • DELETE
Does not delete a country but the tradingCountry associated to it.
  • /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/listGetAll
  • GET
List countries ISO matching a given criteria
  • /countryIso/version
  • GET
Get version of application
  • /countryIso/{countryCode}
  • DELETE
Does not delete a country but the tradingCountry associated to it.
  • /cpq/contracts
  • GET POST PUT
 
  • /cpq/contracts/contractLines
  • POST PUT
 
  • /cpq/contracts/contractLines/{contractCode}
  • DELETE
 
  • /cpq/contracts/contractLines/{contractItemCode}
  • GET
 
  • /cpq/contracts/version
  • GET
Get version of application
  • /cpq/contracts/{contractCode}
  • DELETE GET
 
  • /cpq/contracts/{contractCode}/status/{status}
  • PUT
 
  • /cpq/groupedAttributes
  • GET POST PUT
 
  • /cpq/groupedAttributes/version
  • GET
Get version of application
  • /cpq/groupedAttributes/{groupedAttributeCode}
  • DELETE
Remove an Grouped Attribute with a given code.
  • /cpq/quotes
  • GET POST PUT
quote API specification implementation
  • /cpq/quotes/quoteItems
  • POST PUT
quote API specification implementation
  • /cpq/quotes/quoteItems/{quoteCode}/quoteVersions/{quoteVersion}
  • GET
Get details of a single quote
  • /cpq/quotes/quoteItems/{quoteItemId}
  • DELETE GET
quote API specification implementation
  • /cpq/quotes/quoteVersions
  • POST
quote API specification implementation
  • /cpq/quotes/quoteVersions/{quoteCode}/{currentVersion}/pdfGeneration
  • POST
get the quote PDF file.
  • /cpq/quotes/quoteVersions/{quoteCode}/{currentVersion}/status/{status}
  • PUT
quote API specification implementation
  • /cpq/quotes/quoteVersions/{quoteCode}/{currentVersion}/xmlGeneration
  • POST
quote API specification implementation
  • /cpq/quotes/quoteVersions/{quoteCode}/{quoteVersion}
  • DELETE
quote API specification implementation
  • /cpq/quotes/quoteVersions/{quoteCode}/{quoteVersion}/duplication
  • POST
quote API specification implementation
  • /cpq/quotes/quoteVersions/{quoteCode}/{quoteVersion}/quotation
  • POST
quote API specification implementation
  • /cpq/quotes/{quoteCode}
  • DELETE GET
quote API specification implementation
  • /cpq/quotes/{quoteCode}/quoteVersions/{quoteVersion}/orderPlacement
  • POST
Place an order based on a quote.
  • /cpq/quotes/{quoteCode}/status/{status}
  • PUT
quote API specification implementation
  • /cpq/quotes/{quoteCode}/{quoteVersion}/duplication
  • POST
quote API specification implementation
  • /cpq/tags
  • GET POST PUT
 
  • /cpq/tags/tagTypes
  • POST PUT
 
  • /cpq/tags/tagTypes/{codeTagType}
  • DELETE GET
 
  • /cpq/tags/version
  • GET
Get version of application
  • /cpq/tags/{codeTag}
  • DELETE
 
  • /currency
  • GET POST PUT
Web service for managing org.meveo.model.admin.Currency and org.meveo.model.billing.TradingCurrency.
  • /currency/addExchangeRate
  • POST
Add an exchange rate
  • /currency/addFunctionalCurrency
  • POST
add functional currency to the main provider
  • /currency/createOrUpdate
  • POST
Create or Update tradingCurrency base on currency code. If the currency code does not exists, a currency record is created
  • /currency/exchangeRate/{id}
  • DELETE
Web service for managing org.meveo.model.admin.Currency and org.meveo.model.billing.TradingCurrency.
  • /currency/list
  • GET
Search for list of trading currencies.
  • /currency/updateExchangeRate/{id}
  • PUT
Web service for managing org.meveo.model.admin.Currency and org.meveo.model.billing.TradingCurrency.
  • /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/listGetAll
  • GET
List currencies ISO matching a given criteria
  • /currencyIso/version
  • GET
Get version of application
  • /currencyIso/{currencyCode}
  • DELETE
Remove currency with a given currency code.
  • /customEntityInstance/list/{customEntityTemplateCode}
  • GET POST
Rest API for custom entity instance management
  • /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
  • /customTable/{customTableCode}
  • DELETE
Remove existing data from a custom table given search parameters
  • /dataCollector
  • GET POST
 
  • /dataCollector/executeQuery
  • GET
Execute data collector SQL query
  • /dataCollector/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 GET
 
  • /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/entities
  • GET
List custom entity templates.
  • /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 GET
 
  • /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/listBusinessEntityForCFVByCode/{code}/{wildcode}
  • 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 POST PUT
 
  • /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
  • /genericCode
  • GET POST PUT
 
  • /genericCode/generateCode
  • POST
Generate generic code
  • /genericCode/sequence
  • POST
createSequence
  • /genericCode/version
  • GET
Get version of application
  • /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/exportData
  • POST
export data
  • /importExport/exportDataFromEntityList
  • POST
export Data From Entity List
  • /importExport/generateEntityList
  • POST
returns an entity list CSV
  • /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 PUT
Web service for managing org.meveo.model.billing.Invoice.
  • /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/listGetAll
  • GET
List invoices matching a given criteria
  • /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 PUT
Web service for managing org.meveo.model.billing.Invoice.
  • /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
  • GET POST
Web service for managing org.meveo.model.billing.InvoiceCategory.
  • /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
  • GET POST
Web service for managing org.meveo.model.billing.InvoiceSubCategory.
  • /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 POST 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/execution
  • POST
Execute a given job instance info
  • /job/jobReport
  • GET
Find a job execution result.
  • /job/jobReport/list
  • GET POST
 
  • /job/jobReport/listGetAll
  • GET
List jobExecutions matching a given criteria
  • /job/list
  • GET
Deprecated in v.4.7.2 Use /list instead.
  • /job/listCategories
  • GET
List job categories
  • /job/stop/{jobInstanceCode}
  • POST PUT
 
  • /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/timers/{timerCode}
  • GET
Find a timer with a given code
  • /job/version
  • GET
Get version of application
  • /job/{code}/jobExecution/{id}/jobReport
  • GET
Find a job execution result.
  • /job/{jobInstanceCode}
  • DELETE GET
 
  • /jobInstance
  • GET PUT
 
  • /jobInstance/create
  • POST
Create a new job instance
  • /jobInstance/createOrUpdate
  • POST
Create new or update an existing job instance with a given code
  • /jobInstance/list
  • GET
Search for list of jobInstances.
  • /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/list
  • GET
Search for list of trading languages.
  • /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/list
  • GET
List all languages.
  • /languageIso/listGetAll
  • GET
List languages ISO matching a given criteria
  • /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
  • /media
  • POST PUT
 
  • /media/{code}
  • DELETE GET
 
  • /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/commercialOrders
  • GET POST PUT
 
  • /orderManagement/commercialOrders/orderOffers
  • POST PUT
 
  • /orderManagement/commercialOrders/orderOffers/{id}
  • DELETE GET
 
  • /orderManagement/commercialOrders/{commercialOrderId}/invoicingPlans/{invoicingPlanCode}
  • PUT
 
  • /orderManagement/commercialOrders/{commercialOrderId}/orderProgress/{progressValue}
  • PUT
 
  • /orderManagement/commercialOrders/{commercialOrderId}/userAccounts/{userAccountCode}
  • PUT
 
  • /orderManagement/commercialOrders/{orderId}
  • DELETE
 
  • /orderManagement/commercialOrders/{orderId}/duplication
  • POST
 
  • /orderManagement/commercialOrders/{orderId}/orderValidation
  • POST
 
  • /orderManagement/commercialOrders/{orderId}/status/{statusTarget}
  • PUT
 
  • /orderManagement/commercialOrders/{orderNumber}
  • GET
 
  • /orderManagement/orderTypes
  • POST PUT
 
  • /orderManagement/orderTypes/list
  • POST
 
  • /orderManagement/orderTypes/{orderTypeCode}
  • DELETE GET
 
  • /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/listGetAll
  • GET
List creditCategories matching a given criteria
  • /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/approveSepaDDMandate
  • GET
approve SepaDDMandate
  • /payment/paymentGateway/checkMandate
  • GET
Gets a created mandate.
  • /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/listGetAll
  • GET
List paymentMethods matching a given criteria
  • /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/paymentScheduleInstance/{id}/items
  • PUT
Update Payment schedule instance item, the update is only about amount and requestPaymentDate.
  • /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/{quoteCode}
  • POST
Place an order based on a product quote.
  • /quoteManagement/productQuote/quoteItem
  • POST
Create a new product quote item
  • /quoteManagement/productQuote/quoteItem/{quoteItemCode}
  • DELETE PUT
TMForum Product quote API specification implementation
  • /quoteManagement/productQuote/quoteVersion
  • POST PUT
TMForum Product quote API specification implementation
  • /quoteManagement/productQuote/quoteVersion/{quoteCode}/{quoteVersion}
  • DELETE
delete quote version
  • /quoteManagement/productQuote/{quoteCode}
  • DELETE GET PUT
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/externals
  • GET
List external roles.
  • /role/filtering
  • GET POST
REST API for managing Role.
  • /role/list
  • GET POST
REST API for managing Role.
  • /role/version
  • GET
Get version of application
  • /role/{roleName}
  • DELETE GET
REST API for managing 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/listGetAll
  • GET
List taxes matching a given criteria
  • /tax/version
  • GET
Get version of application
  • /tax/{taxCode}
  • DELETE
Remove tax with a given code.
  • /taxCategory
  • GET POST PUT
 
  • /taxCategory/createOrUpdate
  • POST
Create new or update an existing Tax category
  • /taxCategory/list
  • GET POST
 
  • /taxCategory/listGetAll
  • GET
List taxCategories matching a given criteria
  • /taxCategory/version
  • GET
Get version of application
  • /taxCategory/{code}
  • DELETE
Remove an existing Tax category with a given code
  • /taxClass
  • GET POST PUT
 
  • /taxClass/createOrUpdate
  • POST
Create new or update an existing Tax class
  • /taxClass/list
  • GET POST
 
  • /taxClass/listGetAll
  • GET
List taxClasses matching a given criteria
  • /taxClass/version
  • GET
Get version of application
  • /taxClass/{code}
  • DELETE
Remove an existing Tax class with a given code
  • /taxMapping
  • GET POST PUT
 
  • /taxMapping/createOrUpdate
  • POST
Create new or update an existing Tax mapping
  • /taxMapping/list
  • GET POST
 
  • /taxMapping/listGetAll
  • GET
List taxMappings matching a given criteria
  • /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/current
  • GET
Get info of currently logged in user
  • /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/filtering
  • 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/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/listGetAll
  • GET
List users matching a given criteria
  • /user/name/{username}
  • GET
Search user with a given username.
  • /user/version
  • GET
Get version of application
  • /user/{username}
  • DELETE
Remove user with a given username.