openapi: 3.0.1 info: title: Swagger of Opencellsoft Api description: '@#Introduction' contact: name: OpenCellSoft url: https://opencellsoft.com/contact_us/ email: contact@opencellsoft.fr license: name: Opencellsoft url: https://opencellsoft.com/ version: 8.0.0-SNAPSHOT servers: - url: http://localhost:8080/opencell/api/rest description: Local Host testing security: - auth: [] tags: - name: BillingCycle description: '@%BillingCycle' - name: Calendar description: '@%Calendar' - name: Configuration description: '@%Configuration' - name: CountryIso description: '@%CountryIso' - name: Country description: '@%Country' - name: CurrencyIso description: '@%CurrencyIso' - name: Currency description: '@%Currency' - name: Filter description: '@%Filter' - name: InvoiceCategory description: '@%InvoiceCategory' - name: InvoiceSequence description: '@%InvoiceSequence' - name: InvoiceSubCategoryCountry description: '@%InvoiceSubCategoryCountry' - name: InvoiceSubCategory description: '@%InvoiceSubCategory' - name: InvoiceType description: '@%InvoiceType' - name: LanguageIso description: '@%LanguageIso' - name: Language description: '@%Language' - name: OccTemplate description: '@%OccTemplate' - name: PdfInvoice description: '@%PdfInvoice' - name: Permission description: '@%Permission' - name: Provider description: '@%Provider' - name: Query description: '@%Query' - name: Role description: '@%Role' - name: ScriptInstance description: '@%ScriptInstance' - name: Seller description: '@%Seller' - name: Tax description: '@%Tax' - name: TerminationReason description: '@%TerminationReason' - name: Usage description: '@%Usage' - name: User description: '@%User' - name: Access description: '@%Access' - name: AccountHierarchy description: '@%AccountHierarchy' - name: BillingAccount description: '@%BillingAccount' - name: BusinessAccountModel description: '@%BusinessAccountModel' - name: CustomerAccount description: '@%CustomerAccount' - name: Customer description: '@%Customer' - name: ProviderContact description: '@%ProviderContact' - name: Title description: '@%Title' - name: UserAccount description: '@%UserAccount' - name: RatedTransaction description: '@%RatedTransaction' - name: Audit description: '@%Audit' - name: Files description: '@%Files' - name: AccountingCode description: '@%AccountingCode' - name: Invoicing description: '@%Invoicing' - name: Mediation description: '@%Mediation' - name: Subscription description: '@%Subscription' - name: Wallet description: '@%Wallet' - name: BusinessOfferModel description: '@%BusinessOfferModel' - name: BusinessProductModel description: '@%BusinessProductModel' - name: BusinessServiceModel description: '@%BusinessServiceModel' - name: Channel description: '@%Channel' - name: ChannelsAndSegments description: '@%ChannelsAndSegments' - name: ChargeTemplate description: '@%ChargeTemplate' - name: CounterTemplate description: '@%CounterTemplate' - name: DiscountPlanItem description: '@%DiscountPlanItem' - name: DiscountPlan description: '@%DiscountPlan' - name: OfferTemplateCategory description: '@%OfferTemplateCategory' - name: OfferTemplate description: '@%OfferTemplate' - name: OneShotChargeTemplate description: '@%OneShotChargeTemplate' - name: PricePlan description: '@%PricePlan' - name: RecurringChargeTemplate description: '@%RecurringChargeTemplate' - name: ServiceTemplate description: '@%ServiceTemplate' - name: TriggeredEdr description: '@%TriggeredEdr' - name: UsageChargeTemplate description: '@%UsageChargeTemplate' - name: Communication description: '@%Communication' - name: EmailTemplate description: '@%EmailTemplate' - name: MeveoInstance description: '@%MeveoInstance' - name: AddressBook description: '@%AddressBook' - name: Contact description: '@%Contact' - name: CustomEntityInstance description: '@%CustomEntityInstance' - name: CustomFieldTemplate description: '@%CustomFieldTemplate' - name: CustomTable description: '@%CustomTable' - name: EntityCustomization description: '@%EntityCustomization' - name: DocumentSign description: '@%DocumentSign' - name: PDFDocument description: '@%PDFDocument' - name: Chart description: '@%Chart' - name: MeasurableQuantity description: '@%MeasurableQuantity' - name: FilteredList description: '@%FilteredList' - name: ReportExtract description: '@%ReportExtract' - name: GenericWorkflow description: '@%GenericWorkflow' - name: UserHierarchyLevel description: '@%UserHierarchyLevel' - name: ImportExport description: '@%ImportExport' - name: Invoice description: '@%Invoice' - name: JobInstance description: '@%JobInstance' - name: Job description: '@%Job' - name: TimerEntity description: '@%TimerEntity' - name: Module description: '@%Module' - name: EmailNotification description: '@%EmailNotification' - name: JobTrigger description: '@%JobTrigger' - name: Notification description: '@%Notification' - name: WebHookNotification description: '@%WebHookNotification' - name: AccountOperation description: '@%AccountOperation' - name: CreditCategory description: '@%CreditCategory' - name: DDRequestLotOp description: '@%DDRequestLotOp' - name: IBan description: '@%IBan' - name: Payment description: '@%Payment' - name: RevenueRecognitionRules description: '@%RevenueRecognitionRules' - name: RumSequence description: '@%RumSequence' - name: Catalog description: '@%Catalog' - name: Order description: '@%Order' - name: Quote description: '@%Quote' paths: /billingCycle/createOrUpdate: post: tags: - BillingCycle summary: ' Create new or update an existing billing cycle with a given code ' description: ' Create new or update an existing billing cycle with a given code ' operationId: createOrUpdate_52 requestBody: description: ' postData The billing cycle''s data ' content: application/json: schema: $ref: '#/components/schemas/BillingCycleDto' application/xml: schema: $ref: '#/components/schemas/BillingCycleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billingCycle/{billingCycleCode}: delete: tags: - BillingCycle summary: ' Remove an existing billing cycle with a given code. ' description: ' Remove an existing billing cycle with a given code. ' operationId: remove_49 parameters: - name: billingCycleCode in: path description: ' billingCycleCode The billing cycle''s code ' required: true schema: type: string responses: default: description: ' action result ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billingCycle: get: tags: - BillingCycle summary: ' Search for billing cycle with a given code. ' description: ' Search for billing cycle with a given code. ' operationId: find_54 parameters: - name: billingCycleCode in: query description: ' billingCycleCode The billing cycle''s code ' schema: type: string responses: default: description: ' billing cycle if exists ' content: application/json: schema: $ref: '#/components/schemas/GetBillingCycleResponse' application/xml: schema: $ref: '#/components/schemas/GetBillingCycleResponse' put: tags: - BillingCycle summary: ' Update an existing billing cycle. ' description: ' Update an existing billing cycle. ' operationId: update_54 requestBody: description: ' postData billing cycle ' content: application/json: schema: $ref: '#/components/schemas/BillingCycleDto' application/xml: schema: $ref: '#/components/schemas/BillingCycleDto' responses: default: description: ' actioon result ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BillingCycle summary: ' Create a new billing cycle. ' description: ' Create a new billing cycle. ' operationId: create_55 requestBody: description: ' postData billing cycle dto ' content: application/json: schema: $ref: '#/components/schemas/BillingCycleDto' application/xml: schema: $ref: '#/components/schemas/BillingCycleDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billingCycle/version: get: tags: - BillingCycle summary: ' Get version of application ' description: ' Get version of application ' operationId: index_72 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /calendar/createOrUpdate: post: tags: - Calendar summary: ' Create new or update an existing calendar with a given code. ' description: ' Create new or update an existing calendar with a given code. ' operationId: createOrUpdate requestBody: content: application/json: schema: $ref: '#/components/schemas/CalendarDto' application/xml: schema: $ref: '#/components/schemas/CalendarDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /calendar/bankingDateStatus: get: tags: - Calendar summary: ' Gets the banking date status. ' description: ' Gets the banking date status. ' operationId: getBankingDateStatus_1 parameters: - name: date in: query description: ' date the date to check if is a working date or not ' schema: type: string format: date-time responses: default: description: ' the banking date status ' content: application/json: schema: $ref: '#/components/schemas/BankingDateStatusResponse' application/xml: schema: $ref: '#/components/schemas/BankingDateStatusResponse' /calendar/{calendarCode}: delete: tags: - Calendar summary: ' Remove calendar with a given code. ' description: ' Remove calendar with a given code. ' operationId: remove parameters: - name: calendarCode in: path required: true schema: type: string responses: default: description: ' action result ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /calendar: get: tags: - Calendar summary: ' Search for calendar with a given code. ' description: ' Search for calendar with a given code. ' operationId: find parameters: - name: calendarCode in: query description: ' calendarCode The calendar''s code ' schema: type: string responses: default: description: ' calendar if exists ' content: application/json: schema: $ref: '#/components/schemas/GetCalendarResponse' application/xml: schema: $ref: '#/components/schemas/GetCalendarResponse' put: tags: - Calendar summary: ' Update calendar. ' description: ' Update calendar. ' operationId: update requestBody: description: ' postData calendar infos ' content: application/json: schema: $ref: '#/components/schemas/CalendarDto' application/xml: schema: $ref: '#/components/schemas/CalendarDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Calendar summary: ' Create a new calendar. ' description: ' Create a new calendar. ' operationId: create requestBody: description: ' postData The calendar''s data ' content: application/json: schema: $ref: '#/components/schemas/CalendarDto' application/xml: schema: $ref: '#/components/schemas/CalendarDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /calendar/list: get: tags: - Calendar summary: ' Retrieve a list of all calendars. ' description: ' Retrieve a list of all calendars. ' operationId: list_24 responses: default: description: ' list of all calendars ' content: application/json: schema: $ref: '#/components/schemas/ListCalendarResponse' application/xml: schema: $ref: '#/components/schemas/ListCalendarResponse' /calendar/version: get: tags: - Calendar summary: ' Get version of application ' description: ' Get version of application ' operationId: index responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /configurations: get: tags: - Configuration operationId: systemProperties_1 responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /configurations/version: get: tags: - Configuration summary: ' Get version of application ' description: ' Get version of application ' operationId: index_1 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /countryIso/createOrUpdate: post: tags: - CountryIso summary: ' Creates or modofy a tradingCountry base from the supplied country code. ' description: ' Creates or modofy a tradingCountry base from the supplied country code. ' operationId: createOrUpdate_1 requestBody: description: ' countryIsoDto country iso ' content: application/json: schema: $ref: '#/components/schemas/CountryIsoDto' application/xml: schema: $ref: '#/components/schemas/CountryIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /countryIso: get: tags: - CountryIso summary: ' Search country with a given country code. ' description: ' Search country with a given country code. ' operationId: find_1 parameters: - name: countryCode in: query description: ' countryCode country code ' schema: type: string responses: default: description: 'link org.meveo.api.dto.response.GetCountryIsoResponse}. ' content: application/json: schema: $ref: '#/components/schemas/GetCountryIsoResponse' application/xml: schema: $ref: '#/components/schemas/GetCountryIsoResponse' put: tags: - CountryIso summary: ' Modify a country' description: ' Modify a country. Same input parameter as create. The country and tradingCountry are created if they don''t exists. The operation fails if the tradingCountry is null. ' operationId: update_1 requestBody: description: ' Modify a country. Same input eter as create. The country and tradingCountry are created if they don''t exists. The operation fails if the tradingCountry is null. ' content: application/json: schema: $ref: '#/components/schemas/CountryIsoDto' application/xml: schema: $ref: '#/components/schemas/CountryIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CountryIso summary: ' Creates a tradingCountry base from the supplied country code' description: ' Creates a tradingCountry base from the supplied country code. If the country code does not exists, a country and tradingCountry records are created ' operationId: create_1 requestBody: description: ' countryIsoDto country iso. ' content: application/json: schema: $ref: '#/components/schemas/CountryIsoDto' application/xml: schema: $ref: '#/components/schemas/CountryIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - CountryIso summary: ' Does not delete a country but the tradingCountry associated to it. ' description: ' Does not delete a country but the tradingCountry associated to it. ' operationId: remove_1 parameters: - name: countryCode in: path description: ' countryCode country code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /countryIso/list: get: tags: - CountryIso summary: ' List all countries. ' description: ' List all countries. ' operationId: list responses: default: description: ' list of countries ' content: application/json: schema: $ref: '#/components/schemas/GetCountriesIsoResponse' application/xml: schema: $ref: '#/components/schemas/GetCountriesIsoResponse' /countryIso/version: get: tags: - CountryIso summary: ' Get version of application ' description: ' Get version of application ' operationId: index_2 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country/createOrUpdate: post: tags: - Country summary: ' Create or update a Trading Country base from the supplied country code' description: ' 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 ' operationId: createOrUpdate_2 requestBody: description: ' countryDto country ' content: application/json: schema: $ref: '#/components/schemas/CountryDto' application/xml: schema: $ref: '#/components/schemas/CountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country/{countryCode}/{currencyCode}: delete: tags: - Country summary: ' Does not delete a country but the tradingCountry associated to it. ' description: ' Does not delete a country but the tradingCountry associated to it. ' operationId: remove_2 parameters: - name: countryCode in: path description: ' countryCode country code ' required: true schema: type: string - name: currencyCode in: path description: ' currencyCode currency code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country: get: tags: - Country summary: ' Search Trading country with a given country code. ' description: ' Search Trading country with a given country code. ' operationId: find_2 parameters: - name: countryCode in: query description: ' countryCode country code ' schema: type: string responses: default: description: 'link org.meveo.api.dto.response.GetCountryResponse}. ' content: application/json: schema: $ref: '#/components/schemas/GetTradingCountryResponse' application/xml: schema: $ref: '#/components/schemas/GetTradingCountryResponse' put: tags: - Country summary: ' Modify a country' description: ' Modify a country. Same input parameter as create. The country and tradingCountry are created if they don''t exists. The operation fails if the tradingCountry is null. ' operationId: update_2 requestBody: description: ' Modify a country. Same input eter as create. The country and tradingCountry are created if they don''t exists. The operation fails if the tradingCountry is null. ' content: application/json: schema: $ref: '#/components/schemas/CountryDto' application/xml: schema: $ref: '#/components/schemas/CountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Country summary: ' Creates a Trading Country base from the supplied country code' description: ' Creates a Trading Country base from the supplied country code. If the country code does not exists, a country and tradingCountry records are created ' operationId: create_2 requestBody: description: ' countryDto country ' content: application/json: schema: $ref: '#/components/schemas/CountryDto' application/xml: schema: $ref: '#/components/schemas/CountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country/{code}/enable: post: tags: - Country summary: ' Enable a Trading country with a given country code ' description: ' Enable a Trading country with a given country code ' operationId: enable_21 parameters: - name: code in: path description: ' code Country code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country/{code}/disable: post: tags: - Country summary: ' Disable a Trading country with a given country code ' description: ' Disable a Trading country with a given country code ' operationId: disable_22 parameters: - name: code in: path description: ' code Country code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /country/version: get: tags: - Country summary: ' Get version of application ' description: ' Get version of application ' operationId: index_3 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currencyIso/createOrUpdate: post: tags: - CurrencyIso summary: ' Creates or modify a tradingCurrency base on currency code. ' description: ' Creates or modify a tradingCurrency base on currency code. ' operationId: createOrUpdate_3 requestBody: description: ' currencyIsoDto currency iso to create or update ' content: application/json: schema: $ref: '#/components/schemas/CurrencyIsoDto' application/xml: schema: $ref: '#/components/schemas/CurrencyIsoDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currencyIso/{currencyCode}: delete: tags: - CurrencyIso summary: ' Remove currency with a given currency code. ' description: ' Remove currency with a given currency code. ' operationId: remove_3 parameters: - name: currencyCode in: path description: ' currencyCode currency code ' required: true schema: type: string responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currencyIso: get: tags: - CurrencyIso summary: ' List all currencies. ' description: ' List all currencies. ' operationId: list_1 responses: default: description: ' list of all currency iso/ ' content: application/json: schema: $ref: '#/components/schemas/GetCurrenciesIsoResponse' application/xml: schema: $ref: '#/components/schemas/GetCurrenciesIsoResponse' put: tags: - CurrencyIso summary: ' Modify a tradingCurrency' description: ' Modify a tradingCurrency. Same input parameter as create. The currency and tradingCurrency are created if they don''t exists. The operation fails if the tradingCurrency is null ' operationId: update_3 requestBody: description: ' Modify a tradingCurrency. Same input eter as create. The currency and tradingCurrency are created if they don''t exists. The operation fails if the tradingCurrency is null ' content: application/json: schema: $ref: '#/components/schemas/CurrencyIsoDto' application/xml: schema: $ref: '#/components/schemas/CurrencyIsoDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CurrencyIso summary: ' Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' description: ' Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' operationId: create_3 requestBody: description: ' currencyIsoDto currency iso ' content: application/json: schema: $ref: '#/components/schemas/CurrencyIsoDto' application/xml: schema: $ref: '#/components/schemas/CurrencyIsoDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currencyIso/version: get: tags: - CurrencyIso summary: ' Get version of application ' description: ' Get version of application ' operationId: index_4 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency/createOrUpdate: post: tags: - Currency summary: ' Create or Update tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' description: ' Create or Update tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' operationId: createOrUpdate_4 requestBody: description: ' postData currency to be created or updated ' content: application/json: schema: $ref: '#/components/schemas/CurrencyDto' application/xml: schema: $ref: '#/components/schemas/CurrencyDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency/{currencyCode}: delete: tags: - Currency summary: ' Remove currency with a given currency code. ' description: ' Remove currency with a given currency code. ' operationId: remove_4 parameters: - name: currencyCode in: path description: ' currencyCode currency code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency: get: tags: - Currency summary: ' Search currency with a given currency code. ' description: ' Search currency with a given currency code. ' operationId: find_3 parameters: - name: currencyCode in: query description: ' currencyCode currency code ' schema: type: string responses: default: description: ' currency if exists ' content: application/json: schema: $ref: '#/components/schemas/GetTradingCurrencyResponse' application/xml: schema: $ref: '#/components/schemas/GetTradingCurrencyResponse' put: tags: - Currency summary: ' Modify a tradingCurrency' description: ' Modify a tradingCurrency. Same input parameter as create. The currency and tradingCurrency are created if they don''t exists. The operation fails if the tradingCurrency is null ' operationId: update_4 requestBody: description: ' Modify a tradingCurrency. Same input eter as create. The currency and tradingCurrency are created if they don''t exists. The operation fails if the tradingCurrency is null ' content: application/json: schema: $ref: '#/components/schemas/CurrencyDto' application/xml: schema: $ref: '#/components/schemas/CurrencyDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Currency summary: ' Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' description: ' Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created ' operationId: create_4 requestBody: description: ' postData currency to be created ' content: application/json: schema: $ref: '#/components/schemas/CurrencyDto' application/xml: schema: $ref: '#/components/schemas/CurrencyDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency/{code}/enable: post: tags: - Currency summary: ' Enable a Trading currency with a given currency code ' description: ' Enable a Trading currency with a given currency code ' operationId: enable parameters: - name: code in: path description: ' code Currency code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency/{code}/disable: post: tags: - Currency summary: ' Disable a Trading currency with a given currency code ' description: ' Disable a Trading currency with a given currency code ' operationId: disable parameters: - name: code in: path description: ' code Currency code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /currency/version: get: tags: - Currency summary: ' Get version of application ' description: ' Get version of application ' operationId: index_5 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /filter/createOrUpdate: post: tags: - Filter summary: ' Create new or update an existing filter with a given code ' description: ' Create new or update an existing filter with a given code ' operationId: createOrUpdate_5 requestBody: content: application/json: schema: $ref: '#/components/schemas/FilterDto' application/xml: schema: $ref: '#/components/schemas/FilterDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /filter: get: tags: - Filter summary: ' Find a filter with a given code ' description: ' Find a filter with a given code ' operationId: find_4 parameters: - name: filterCode in: query schema: type: string responses: default: description: ' Dto for FilteredList API ' content: application/json: schema: $ref: '#/components/schemas/GetFilterResponseDto' application/xml: schema: $ref: '#/components/schemas/GetFilterResponseDto' /filter/{code}/enable: post: tags: - Filter summary: ' Enable a Filter with a given code ' description: ' Enable a Filter with a given code ' operationId: enable_1 parameters: - name: code in: path description: ' code Filter code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /filter/{code}/disable: post: tags: - Filter summary: ' Disable a Filter with a given code ' description: ' Disable a Filter with a given code ' operationId: disable_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /filter/version: get: tags: - Filter summary: ' Get version of application ' description: ' Get version of application ' operationId: index_6 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceCategory/createOrUpdate: post: tags: - InvoiceCategory summary: ' Create or update invoice with a given code. ' description: ' Create or update invoice with a given code. ' operationId: createOrUpdate_6 requestBody: description: ' postData invoice category ' content: application/json: schema: $ref: '#/components/schemas/InvoiceCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceCategoryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceCategory/{invoiceCategoryCode}: delete: tags: - InvoiceCategory summary: ' Remove invoice with a given code. ' description: ' Remove invoice with a given code. ' operationId: remove_5 parameters: - name: invoiceCategoryCode in: path description: ' invoiceCategoryCode invoice category code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceCategory: get: tags: - InvoiceCategory summary: ' Search invoice with a given code. ' description: ' Search invoice with a given code. ' operationId: find_5 parameters: - name: invoiceCategoryCode in: query description: ' invoiceCategoryCode invoice category code ' schema: type: string responses: default: description: ' invoice category ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceCategoryResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceCategoryResponse' put: tags: - InvoiceCategory summary: ' Update invoice category. ' description: ' Update invoice category. ' operationId: update_5 requestBody: description: ' postData invoice category to be updated ' content: application/json: schema: $ref: '#/components/schemas/InvoiceCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceCategoryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - InvoiceCategory summary: ' Create invoice category. Description per language can be defined ' description: ' Create invoice category. Description per language can be defined ' operationId: create_5 requestBody: description: ' postData invoice category to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceCategoryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceCategory/version: get: tags: - InvoiceCategory summary: ' Get version of application ' description: ' Get version of application ' operationId: index_7 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSequence/createOrUpdate: post: tags: - InvoiceSequence summary: ' Create new or update an existing invoiceSequence with a given code. ' description: ' Create new or update an existing invoiceSequence with a given code. ' operationId: createOrUpdate_7 requestBody: description: ' invoiceSequenceDto The invoiceSequence''s data ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSequenceDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSequenceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSequence: get: tags: - InvoiceSequence summary: ' Search invoiceSequence with a given code. ' description: ' Search invoiceSequence with a given code. ' operationId: find_6 parameters: - name: invoiceSequenceCode in: query description: ' invoiceSequenceCode invoice type''s code ' schema: type: string responses: default: description: ' invoice sequence ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceSequenceResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceSequenceResponse' put: tags: - InvoiceSequence summary: ' Update invoiceSequence. ' description: ' Update invoiceSequence. ' operationId: update_6 requestBody: description: ' invoiceSequenceDto invoice Sequence to be updated ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSequenceDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSequenceDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - InvoiceSequence summary: ' Create invoiceSequence. ' description: ' Create invoiceSequence. ' operationId: create_6 requestBody: description: ' invoiceSequenceDto invoice Sequence to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSequenceDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSequenceDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSequence/list: get: tags: - InvoiceSequence summary: ' List of invoiceSequence. ' description: ' List of invoiceSequence. ' operationId: list_2 responses: default: description: ' A list of invoiceSequence ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceSequencesResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceSequencesResponse' /invoiceSequence/version: get: tags: - InvoiceSequence summary: ' Get version of application ' description: ' Get version of application ' operationId: index_8 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategoryCountry/createOrUpdate: post: tags: - InvoiceSubCategoryCountry summary: ' Create or update Invoice SubCategory Country based on invoice sub-category and country. ' description: ' Create or update Invoice SubCategory Country based on invoice sub-category and country. ' operationId: createOrUpdate_8 requestBody: description: ' postData invoice sub category to be created or updated ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategoryCountry/{invoiceSubCategoryCode}/{country}: delete: tags: - InvoiceSubCategoryCountry summary: ' Remove all the InvoiceSubCategoryCountries with a given code and country and the sellerCountry is null. ' description: ' Remove all the InvoiceSubCategoryCountries with a given code and country and the sellerCountry is null. ' operationId: remove_8 parameters: - name: invoiceSubCategoryCode in: path description: ' invoiceSubCategoryCode invoice sub category code ' required: true schema: type: string - name: country in: path description: ' buyerCountryCode Buyer''s country ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategoryCountry/{invoiceSubCategoryCode}/{sellersCountry}/{country}: delete: tags: - InvoiceSubCategoryCountry summary: ' Remove all the InvoiceSubCategoryCountries with a given code and country. ' description: ' Remove all the InvoiceSubCategoryCountries with a given code and country. ' operationId: remove_6 parameters: - name: invoiceSubCategoryCode in: path description: ' invoiceSubCategoryCode invoice sub category code ' required: true schema: type: string - name: sellersCountry in: path description: ' sellersCountry Seller''s country ' required: true schema: type: string - name: country in: path description: ' country Buyer''s country ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategoryCountry: get: tags: - InvoiceSubCategoryCountry summary: ' Search invoice sub category country with a given code and country with the highest priority (1-lowest). ' description: ' Search invoice sub category country with a given code and country with the highest priority (1-lowest). ' operationId: find_7 parameters: - name: invoiceSubCategoryCode in: query description: ' invoiceSubCategoryCode invoice sub category code ' schema: type: string - name: sellersCountry in: query description: ' sellersCountry Seller''s country ' schema: type: string - name: country in: query description: ' country Buyer''s country ' schema: type: string responses: default: description: ' invoice sub category if exists for given codes. ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceSubCategoryCountryResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceSubCategoryCountryResponse' put: tags: - InvoiceSubCategoryCountry summary: ' Update invoice sub category country. ' description: ' Update invoice sub category country. ' operationId: update_7 requestBody: description: ' postData invoice sub category to be updated ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - InvoiceSubCategoryCountry summary: ' Create invoice sub category country. ' description: ' Create invoice sub category country. ' operationId: create_7 requestBody: description: ' postData invoice sub category to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategoryCountry/version: get: tags: - InvoiceSubCategoryCountry summary: ' Get version of application ' description: ' Get version of application ' operationId: index_9 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategory/createOrUpdate: post: tags: - InvoiceSubCategory summary: ' Create or update invoice sub category. ' description: ' Create or update invoice sub category. ' operationId: createOrUpdate_9 requestBody: description: ' postData invoice sub category ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategory/{invoiceSubCategoryCode}: delete: tags: - InvoiceSubCategory summary: ' Remove invoice sub category with a given code. ' description: ' Remove invoice sub category with a given code. ' operationId: remove_7 parameters: - name: invoiceSubCategoryCode in: path description: ' invoiceSubCategoryCode invoice sub category ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategory: get: tags: - InvoiceSubCategory summary: ' Search for invoice sub category with a given code. ' description: ' Search for invoice sub category with a given code. ' operationId: find_8 parameters: - name: invoiceSubCategoryCode in: query description: ' invoiceSubCategoryCode invoice sub category code ' schema: type: string responses: default: description: ' invoice sub category ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceSubCategoryResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceSubCategoryResponse' put: tags: - InvoiceSubCategory summary: ' Update invoice sub category. ' description: ' Update invoice sub category. ' operationId: update_8 requestBody: description: ' postData invoice sub category to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - InvoiceSubCategory summary: ' Create invoice sub category. ' description: ' Create invoice sub category. ' operationId: create_8 requestBody: description: ' postData invoice sub category to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' application/xml: schema: $ref: '#/components/schemas/InvoiceSubCategoryDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceSubCategory/version: get: tags: - InvoiceSubCategory summary: ' Get version of application ' description: ' Get version of application ' operationId: index_10 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceType/createOrUpdate: post: tags: - InvoiceType summary: ' Create new or update an existing invoiceType with a given code. ' description: ' Create new or update an existing invoiceType with a given code. ' operationId: createOrUpdate_10 requestBody: description: ' invoiceTypeDto The invoiceType''s data ' content: application/json: schema: $ref: '#/components/schemas/InvoiceTypeDto' application/xml: schema: $ref: '#/components/schemas/InvoiceTypeDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceType/{invoiceTypeCode}: delete: tags: - InvoiceType summary: ' Remove invoiceType with a given code. ' description: ' Remove invoiceType with a given code. ' operationId: remove_9 parameters: - name: invoiceTypeCode in: path description: ' invoiceTypeCode invoice type''s code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceType: get: tags: - InvoiceType summary: ' Search invoiceType with a given code. ' description: ' Search invoiceType with a given code. ' operationId: find_9 parameters: - name: invoiceTypeCode in: query description: ' invoiceTypeCode invoice type''s code ' schema: type: string responses: default: description: ' invoice type ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceTypeResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceTypeResponse' put: tags: - InvoiceType summary: ' Update invoiceType. Description per language can be defined ' description: ' Update invoiceType. Description per language can be defined ' operationId: update_9 requestBody: description: ' invoiceTypeDto invoice type to be updated ' content: application/json: schema: $ref: '#/components/schemas/InvoiceTypeDto' application/xml: schema: $ref: '#/components/schemas/InvoiceTypeDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - InvoiceType summary: ' Create invoiceType. Description per language can be defined ' description: ' Create invoiceType. Description per language can be defined ' operationId: create_9 requestBody: description: ' invoiceTypeDto invoice type to be created ' content: application/json: schema: $ref: '#/components/schemas/InvoiceTypeDto' application/xml: schema: $ref: '#/components/schemas/InvoiceTypeDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoiceType/list: get: tags: - InvoiceType summary: ' List of invoiceType. ' description: ' List of invoiceType. ' operationId: list_3 responses: default: description: ' A list of invoiceType ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceTypesResponse' application/xml: schema: $ref: '#/components/schemas/GetInvoiceTypesResponse' /invoiceType/version: get: tags: - InvoiceType summary: ' Get version of application ' description: ' Get version of application ' operationId: index_11 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /languageIso/createOrUpdate: post: tags: - LanguageIso summary: ' Create or update a language if it doesn''t exists. ' description: ' Create or update a language if it doesn''t exists. ' operationId: createOrUpdate_11 requestBody: description: ' languageIsoDto langauge iso ' content: application/json: schema: $ref: '#/components/schemas/LanguageIsoDto' application/xml: schema: $ref: '#/components/schemas/LanguageIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /languageIso/{languageCode}: delete: tags: - LanguageIso summary: ' Does not delete a language but the tradingLanguage associated to it. ' description: ' Does not delete a language but the tradingLanguage associated to it. ' operationId: remove_10 parameters: - name: languageCode in: path description: ' languageCode code of language. ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /languageIso: get: tags: - LanguageIso summary: ' List all languages. ' description: ' List all languages. ' operationId: list_4 responses: default: description: ' all languages ' content: application/json: schema: $ref: '#/components/schemas/GetLanguagesIsoResponse' application/xml: schema: $ref: '#/components/schemas/GetLanguagesIsoResponse' put: tags: - LanguageIso summary: ' modify a language' description: ' modify a language. Same input parameter as create. The language and trading Language are created if they don''t exists. The operation fails if the tradingLanguage is null. ' operationId: update_10 requestBody: description: ' modify a language. Same input eter as create. The language and trading Language are created if they don''t exists. The operation fails if the tradingLanguage is null. ' content: application/json: schema: $ref: '#/components/schemas/LanguageIsoDto' application/xml: schema: $ref: '#/components/schemas/LanguageIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - LanguageIso summary: ' Creates tradingLanguage base on language code. If the language code does not exists, a language record is created. ' description: ' Creates tradingLanguage base on language code. If the language code does not exists, a language record is created. ' operationId: create_10 requestBody: description: ' languageIsoDto language iso. ' content: application/json: schema: $ref: '#/components/schemas/LanguageIsoDto' application/xml: schema: $ref: '#/components/schemas/LanguageIsoDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /languageIso/version: get: tags: - LanguageIso summary: ' Get version of application ' description: ' Get version of application ' operationId: index_12 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language/createOrUpdate: post: tags: - Language summary: ' Create or update a language if it doesn''t exists. ' description: ' Create or update a language if it doesn''t exists. ' operationId: createOrUpdate_12 requestBody: description: ' postData language to be created or updated ' content: application/json: schema: $ref: '#/components/schemas/LanguageDto' application/xml: schema: $ref: '#/components/schemas/LanguageDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language/{languageCode}: delete: tags: - Language summary: ' Does not delete a language but the tradingLanguage associated to it. ' description: ' Does not delete a language but the tradingLanguage associated to it. ' operationId: remove_11 parameters: - name: languageCode in: path description: ' languageCode language''s code ' required: true schema: type: string responses: default: description: ' action satus ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language: get: tags: - Language summary: ' Search language given a code. ' description: ' Search language given a code. ' operationId: find_10 parameters: - name: languageCode in: query description: ' languageCode language''s code ' schema: type: string responses: default: description: ' language ' content: application/json: schema: $ref: '#/components/schemas/GetTradingLanguageResponse' application/xml: schema: $ref: '#/components/schemas/GetTradingLanguageResponse' put: tags: - Language summary: ' modify a language' description: ' modify a language. Same input parameter as create. The language and trading Language are created if they don''t exists. The operation fails if the tradingLanguage is null. ' operationId: update_11 requestBody: description: ' modify a language. Same input eter as create. The language and trading Language are created if they don''t exists. The operation fails if the tradingLanguage is null. ' content: application/json: schema: $ref: '#/components/schemas/LanguageDto' application/xml: schema: $ref: '#/components/schemas/LanguageDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Language summary: ' Creates tradingLanguage base on language code. If the language code does not exists, a language record is created. ' description: ' Creates tradingLanguage base on language code. If the language code does not exists, a language record is created. ' operationId: create_11 requestBody: description: ' postData language to be created ' content: application/json: schema: $ref: '#/components/schemas/LanguageDto' application/xml: schema: $ref: '#/components/schemas/LanguageDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language/{code}/enable: post: tags: - Language summary: ' Enable a Trading language with a given language code ' description: ' Enable a Trading language with a given language code ' operationId: enable_2 parameters: - name: code in: path description: ' code Language code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language/{code}/disable: post: tags: - Language summary: ' Disable a Trading language with a given language code ' description: ' Disable a Trading language with a given language code ' operationId: disable_2 parameters: - name: code in: path description: ' code Language code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /language/version: get: tags: - Language summary: ' Get version of application ' description: ' Get version of application ' operationId: index_13 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /occTemplate/createOrUpdate: post: tags: - OccTemplate summary: ' Create or update OccTemplate. ' description: ' Create or update OccTemplate. ' operationId: createOrUpdate_13 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/OccTemplateDto' application/xml: schema: $ref: '#/components/schemas/OccTemplateDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /occTemplate/list: get: tags: - OccTemplate summary: ' Get List of OccTemplates matching a given criteria ' description: ' Get List of OccTemplates matching a given criteria ' operationId: listGet_8 parameters: - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: accountCode - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' A list of account operations ' content: application/json: schema: $ref: '#/components/schemas/GetOccTemplatesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOccTemplatesResponseDto' post: tags: - OccTemplate summary: ' Get List of OccTemplates matching a given criteria ' description: ' Get List of OccTemplates matching a given criteria ' operationId: listPost_11 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of account operations ' content: application/json: schema: $ref: '#/components/schemas/GetOccTemplatesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOccTemplatesResponseDto' /occTemplate/{occTemplateCode}: delete: tags: - OccTemplate summary: ' Remove OccTemplate with a given code. ' description: ' Remove OccTemplate with a given code. ' operationId: remove_12 parameters: - name: occTemplateCode in: path description: ' occTemplateCode code of account operation template ' required: true schema: type: string responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /occTemplate: get: tags: - OccTemplate summary: ' Search OccTemplate with a given code. ' description: ' Search OccTemplate with a given code. ' operationId: find_11 parameters: - name: occTemplateCode in: query description: ' occtemplateCode code of account operation template ' schema: type: string responses: default: description: ' account operation template ' content: application/json: schema: $ref: '#/components/schemas/GetOccTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOccTemplateResponseDto' put: tags: - OccTemplate summary: ' Update OccTemplate. ' description: ' Update OccTemplate. ' operationId: update_12 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/OccTemplateDto' application/xml: schema: $ref: '#/components/schemas/OccTemplateDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - OccTemplate summary: ' Create OccTemplate. ' description: ' Create OccTemplate. ' operationId: create_12 requestBody: description: ' postData posted data to API (account operation template) ' content: application/json: schema: $ref: '#/components/schemas/OccTemplateDto' application/xml: schema: $ref: '#/components/schemas/OccTemplateDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /occTemplate/version: get: tags: - OccTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_14 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /PdfInvoice: get: tags: - PdfInvoice summary: ' Find a PDF invoice with a given invoice number and a customer account code. ' description: ' Find a PDF invoice with a given invoice number and a customer account code. ' operationId: getPDFInvoice_1 parameters: - name: invoiceNumber in: query description: ' invoiceNumber The invoice number ' schema: type: string - name: customerAccountCode in: query description: ' customerAccountCode The customer account''s number ' schema: type: string responses: default: description: ' invoice''s pdf ' content: application/json: schema: $ref: '#/components/schemas/PdfInvoiceResponse' application/xml: schema: $ref: '#/components/schemas/PdfInvoiceResponse' /PdfInvoice/version: get: tags: - PdfInvoice summary: ' Get version of application ' description: ' Get version of application ' operationId: index_15 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /permission/list: get: tags: - Permission summary: ' List of permissions ' description: ' List of permissions ' operationId: list_5 responses: default: description: ' A list of permissions ' content: application/json: schema: $ref: '#/components/schemas/PermissionResponseDto' application/xml: schema: $ref: '#/components/schemas/PermissionResponseDto' /permission/version: get: tags: - Permission summary: ' Get version of application ' description: ' Get version of application ' operationId: index_16 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /provider/createOrUpdate: post: tags: - Provider summary: ' Create or update a provider if it doesn''t exists. Deprecated in v. 4.5. Use updateProvider() instead. ' description: ' Create or update a provider if it doesn''t exists. Deprecated in v. 4.5. Use updateProvider() instead. ' operationId: createOrUpdate_14 requestBody: description: ' postData Provider data ' content: application/json: schema: $ref: '#/components/schemas/ProviderDto' application/xml: schema: $ref: '#/components/schemas/ProviderDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' deprecated: true /provider/getTradingConfiguration: get: tags: - Provider summary: ' Returns list of trading countries, currencies and languages. ' description: ' Returns list of trading countries, currencies and languages. ' operationId: findTradingConfiguration_1 parameters: - name: providerCode in: query description: ' providerCode An optional Provider code. If not passed a current user''s provider will be retrieved ' schema: type: string responses: default: description: ' trading configuration. ' content: application/json: schema: $ref: '#/components/schemas/GetTradingConfigurationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetTradingConfigurationResponseDto' /provider/getInvoicingConfiguration: get: tags: - Provider summary: ' Returns list of invoicing configuration (calendars, taxes, invoice categories, invoice sub categories, billing cycles and termination reasons' description: ' Returns list of invoicing configuration (calendars, taxes, invoice categories, invoice sub categories, billing cycles and termination reasons. ' operationId: findInvoicingConfiguration_1 parameters: - name: providerCode in: query description: ' providerCode An optional Provider code. If not passed a current user''s provider will be retrieved ' schema: type: string responses: default: description: ' invoicing configuration ' content: application/json: schema: $ref: '#/components/schemas/GetInvoicingConfigurationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetInvoicingConfigurationResponseDto' /provider/getCustomerConfiguration: get: tags: - Provider summary: ' Returns list of customer brands, categories and titles. ' description: ' Returns list of customer brands, categories and titles. ' operationId: findCustomerConfiguration_1 parameters: - name: providerCode in: query description: ' providerCode An optional Provider code. If not passed a current user''s provider will be retrieved ' schema: type: string responses: default: description: ' customer configuration ' content: application/json: schema: $ref: '#/components/schemas/GetCustomerConfigurationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomerConfigurationResponseDto' /provider/getCustomerAccountConfiguration: get: tags: - Provider summary: ' Returns list of payment method and credit categories. ' description: ' Returns list of payment method and credit categories. ' operationId: findCustomerAccountConfiguration_1 parameters: - name: providerCode in: query description: ' providerCode An optional Provider code. If not passed a current user''s provider will be retrieved ' schema: type: string responses: default: description: ' customer account configuration ' content: application/json: schema: $ref: '#/components/schemas/GetCustomerAccountConfigurationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomerAccountConfigurationResponseDto' /provider/updateProviderCF: put: tags: - Provider summary: ' Update a provider CF. ' description: ' Update a provider CF. ' operationId: updateProviderCF_1 requestBody: description: ' postData provider to be updated ' content: application/json: schema: $ref: '#/components/schemas/ProviderDto' application/xml: schema: $ref: '#/components/schemas/ProviderDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /provider/findProviderCF: get: tags: - Provider summary: ' Find a provider Cf with a given provider code. ' description: ' Find a provider Cf with a given provider code. ' operationId: findProviderCF_1 parameters: - name: providerCode in: query description: ' providerCode provider''s code ' schema: type: string responses: default: description: ' provider if exists ' content: application/json: schema: $ref: '#/components/schemas/GetProviderResponse' application/xml: schema: $ref: '#/components/schemas/GetProviderResponse' /provider/createTenant: post: tags: - Provider summary: ' Register a new tenant ' description: ' Register a new tenant ' operationId: createTenant_1 requestBody: description: ' postData Tenant/Provider data ' content: application/json: schema: $ref: '#/components/schemas/ProviderDto' application/xml: schema: $ref: '#/components/schemas/ProviderDto' responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /provider/listTenants: get: tags: - Provider summary: ' List tenants ' description: ' List tenants ' operationId: listTenants_1 responses: default: description: ' A list of Tenant/provider data ' content: application/json: schema: $ref: '#/components/schemas/ProvidersDto' application/xml: schema: $ref: '#/components/schemas/ProvidersDto' /provider/{providerCode}: delete: tags: - Provider summary: ' Remove a tenant ' description: ' Remove a tenant ' operationId: removeTenant_1 parameters: - name: providerCode in: path description: ' providerCode Tenant/provider code ' required: true schema: type: string responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /provider: get: tags: - Provider summary: ' Retrieve provider information. ' description: ' Retrieve provider information. ' operationId: find_12 responses: default: description: ' Provider information ' content: application/json: schema: $ref: '#/components/schemas/GetProviderResponse' application/xml: schema: $ref: '#/components/schemas/GetProviderResponse' put: tags: - Provider summary: ' Update provider. ' description: ' Update provider. ' operationId: update_13 requestBody: description: ' postData Provider data ' content: application/json: schema: $ref: '#/components/schemas/ProviderDto' application/xml: schema: $ref: '#/components/schemas/ProviderDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Provider summary: ' Create provider. Deprecated in v. 4.5. Use updateProvider() instead. ' description: ' Create provider. Deprecated in v. 4.5. Use updateProvider() instead. ' operationId: create_13 requestBody: description: ' postData Provider data to be created ' content: application/json: schema: $ref: '#/components/schemas/ProviderDto' application/xml: schema: $ref: '#/components/schemas/ProviderDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' deprecated: true /provider/version: get: tags: - Provider summary: ' Get version of application ' description: ' Get version of application ' operationId: index_17 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /query: get: tags: - Query summary: ' THIS IS A TEMPORARY API FOR DYNAMIC PORTAL USE ONLY. IT MAY BE REMOVED AT ANY TIME. ' description: ' THIS IS A TEMPORARY API FOR DYNAMIC PORTAL USE ONLY. IT MAY BE REMOVED AT ANY TIME. ' operationId: list_7 responses: default: description: ' QueryResponse object that contains the status, pagination, and the result in json string form. ' content: application/json: schema: $ref: '#/components/schemas/QueryResponse' /role/createOrUpdate: post: tags: - Role summary: ' Create or update role. ' description: ' Create or update role. ' operationId: createOrUpdate_15 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/RoleDto' application/xml: schema: $ref: '#/components/schemas/RoleDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /role/list: get: tags: - Role summary: ' List roles matching a given criteria. ' description: ' List roles matching a given criteria. ' operationId: listGet parameters: - name: query in: query description: ' query Search criteria. Query is composed of the following: filterKey1:filterValue1|filterKey2:filterValue2 ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma. Specify permissions in fields to include the permissions. Specify roles to include child roles. ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: name - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' A list of roles ' content: application/json: schema: $ref: '#/components/schemas/RolesDto' application/xml: schema: $ref: '#/components/schemas/RolesDto' post: tags: - Role summary: ' List roles matching a given criteria. ' description: ' List roles matching a given criteria. ' operationId: listPost requestBody: description: ' pagingAndFiltering Pagination and filtering criteria. Specify permissions in fields to include the permissions. Specify roles to include child roles. ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' A list of roles ' content: application/json: schema: $ref: '#/components/schemas/RolesDto' application/xml: schema: $ref: '#/components/schemas/RolesDto' /role/external: get: tags: - Role summary: ' List external roles. ' description: ' List external roles. ' operationId: listExternalRoles_1 responses: default: description: ' list of external roles ' content: application/json: schema: $ref: '#/components/schemas/RolesDto' application/xml: schema: $ref: '#/components/schemas/RolesDto' /role/{roleName}/{provider}: delete: tags: - Role summary: ' Remove role. ' description: ' Remove role. ' operationId: remove_13 parameters: - name: roleName in: path description: ' roleName Role name ' required: true schema: type: string responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /role: get: tags: - Role summary: ' Search role. ' description: ' Search role. ' operationId: find_13 parameters: - name: roleName in: query description: ' roleName Role name ' schema: type: string - name: includeSecuredEntities in: query description: ' includeSecuredEntities if true returns the secured entities ' schema: type: boolean responses: default: description: ' found role ' content: application/json: schema: $ref: '#/components/schemas/GetRoleResponse' application/xml: schema: $ref: '#/components/schemas/GetRoleResponse' put: tags: - Role summary: ' Update role. ' description: ' Update role. ' operationId: update_14 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/RoleDto' application/xml: schema: $ref: '#/components/schemas/RoleDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Role summary: ' Create role. ' description: ' Create role. ' operationId: create_14 requestBody: description: ' postData posted data containing role dto. ' content: application/json: schema: $ref: '#/components/schemas/RoleDto' application/xml: schema: $ref: '#/components/schemas/RoleDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /role/version: get: tags: - Role summary: ' Get version of application ' description: ' Get version of application ' operationId: index_18 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /scriptInstance/createOrUpdate: post: tags: - ScriptInstance summary: ' Create new or update an existing script instance with a given code. ' description: ' Create new or update an existing script instance with a given code. ' operationId: createOrUpdate_16 requestBody: description: ' postData The script instance''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' /scriptInstance/{scriptInstanceCode}: delete: tags: - ScriptInstance summary: ' Remove an existing script instance with a given code . ' description: ' Remove an existing script instance with a given code . ' operationId: remove_14 parameters: - name: scriptInstanceCode in: path description: ' scriptInstanceCode The script instance''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /scriptInstance: get: tags: - ScriptInstance summary: ' Find a script instance with a given code. ' description: ' Find a script instance with a given code. ' operationId: find_14 parameters: - name: scriptInstanceCode in: query description: ' scriptInstanceCode The script instance''s code ' schema: type: string responses: default: description: ' script instance ' content: application/json: schema: $ref: '#/components/schemas/GetScriptInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetScriptInstanceResponseDto' put: tags: - ScriptInstance summary: ' Update an existing script instance. ' description: ' Update an existing script instance. ' operationId: update_15 requestBody: description: ' postData The script instance''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' post: tags: - ScriptInstance summary: ' Create a new script instance. ' description: ' Create a new script instance. ' operationId: create_15 requestBody: description: ' postData The script instance''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' application/xml: schema: $ref: '#/components/schemas/ScriptInstanceReponseDto' /scriptInstance/execute: get: tags: - ScriptInstance summary: ' Execute a script instance with a given code and list of parameters for the context of the script ' description: ' Execute a script instance with a given code and list of parameters for the context of the script ' operationId: execute_1 parameters: - name: scriptInstanceCode in: query description: ' Execute a script instance with a given code and list of eters for the context of the script ' schema: type: string responses: default: description: ' response of the script ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /scriptInstance/{code}/enable: post: tags: - ScriptInstance summary: ' Enable a Script instance with a given code ' description: ' Enable a Script instance with a given code ' operationId: enable_3 parameters: - name: code in: path description: ' code Script instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /scriptInstance/{code}/disable: post: tags: - ScriptInstance summary: ' Disable a Script instance with a given code ' description: ' Disable a Script instance with a given code ' operationId: disable_3 parameters: - name: code in: path description: ' code Script instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /scriptInstance/version: get: tags: - ScriptInstance summary: ' Get version of application ' description: ' Get version of application ' operationId: index_19 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /seller/createOrUpdate: post: tags: - Seller summary: ' Create or update a seller. ' description: ' Create or update a seller. ' operationId: createOrUpdate_17 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/SellerDto' application/xml: schema: $ref: '#/components/schemas/SellerDto' responses: default: description: ' created or updated seller. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /seller/listSellerCodes: get: tags: - Seller summary: ' Search for all seller''s code. ' description: ' Search for all seller''s code. ' operationId: listSellerCodes_1 responses: default: description: ' list of seller''s code. ' content: application/json: schema: $ref: '#/components/schemas/SellerCodesResponseDto' application/xml: schema: $ref: '#/components/schemas/SellerCodesResponseDto' /seller/{sellerCode}: delete: tags: - Seller summary: ' Remove seller with a given code. ' description: ' Remove seller with a given code. ' operationId: remove_15 parameters: - name: sellerCode in: path description: ' sellerCode code of seller ' required: true schema: type: string responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /seller: get: tags: - Seller summary: ' Search for seller with a given code. ' description: ' Search for seller with a given code. ' operationId: find_15 parameters: - name: sellerCode in: query description: ' sellerCode seller code ' schema: type: string - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' found seller. ' content: application/json: schema: $ref: '#/components/schemas/GetSellerResponse' application/xml: schema: $ref: '#/components/schemas/GetSellerResponse' put: tags: - Seller summary: ' Update seller. ' description: ' Update seller. ' operationId: update_16 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/SellerDto' application/xml: schema: $ref: '#/components/schemas/SellerDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Seller summary: ' Create seller. ' description: ' Create seller. ' operationId: create_16 requestBody: description: ' postData posted data to API containing information of seller ' content: application/json: schema: $ref: '#/components/schemas/SellerDto' application/xml: schema: $ref: '#/components/schemas/SellerDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /seller/list: get: tags: - Seller summary: ' Search for seller with a given code. ' description: ' Search for seller with a given code. ' operationId: list_6 responses: default: description: ' list of seller ' content: application/json: schema: $ref: '#/components/schemas/SellerResponseDto' application/xml: schema: $ref: '#/components/schemas/SellerResponseDto' /seller/version: get: tags: - Seller summary: ' Get version of application ' description: ' Get version of application ' operationId: index_20 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /tax/createOrUpdate: post: tags: - Tax summary: ' Create or uptadate a tax. ' description: ' Create or uptadate a tax. ' operationId: createOrUpdate_18 requestBody: description: ' postData tax to be created or updated ' content: application/json: schema: $ref: '#/components/schemas/TaxDto' application/xml: schema: $ref: '#/components/schemas/TaxDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /tax/{taxCode}: delete: tags: - Tax summary: ' Remove tax with a given code. ' description: ' Remove tax with a given code. ' operationId: remove_16 parameters: - name: taxCode in: path description: ' taxCode tax''s code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /tax: get: tags: - Tax summary: ' Search tax with a given code. ' description: ' Search tax with a given code. ' operationId: find_16 parameters: - name: taxCode in: query description: ' taxCode tax''s ' schema: type: string responses: default: description: ' tax if exists ' content: application/json: schema: $ref: '#/components/schemas/GetTaxResponse' application/xml: schema: $ref: '#/components/schemas/GetTaxResponse' put: tags: - Tax summary: ' Update tax. Description per language can be defined ' description: ' Update tax. Description per language can be defined ' operationId: update_17 requestBody: description: ' postData tax to be updated ' content: application/json: schema: $ref: '#/components/schemas/TaxDto' application/xml: schema: $ref: '#/components/schemas/TaxDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Tax summary: ' Create tax. Description per language can be defined ' description: ' Create tax. Description per language can be defined ' operationId: create_17 requestBody: description: ' postData tax to be created ' content: application/json: schema: $ref: '#/components/schemas/TaxDto' application/xml: schema: $ref: '#/components/schemas/TaxDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /tax/list: get: tags: - Tax summary: ' Search for the list of taxes. ' description: ' Search for the list of taxes. ' operationId: list_8 responses: default: description: ' list of all taxes. ' content: application/json: schema: $ref: '#/components/schemas/GetTaxesResponse' application/xml: schema: $ref: '#/components/schemas/GetTaxesResponse' /tax/version: get: tags: - Tax summary: ' Get version of application ' description: ' Get version of application ' operationId: index_21 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /terminationReason/createOrUpdate: post: tags: - TerminationReason summary: ' Create new or update an existing termination reason with a given code. ' description: ' Create new or update an existing termination reason with a given code. ' operationId: createOrUpdate_19 requestBody: description: ' postData The termination reason''s data ' content: application/json: schema: $ref: '#/components/schemas/TerminationReasonDto' application/xml: schema: $ref: '#/components/schemas/TerminationReasonDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /terminationReason/{terminationReasonCode}: delete: tags: - TerminationReason summary: ' Remove an existing termination reason with a given code. ' description: ' Remove an existing termination reason with a given code. ' operationId: remove_17 parameters: - name: terminationReasonCode in: path description: ' terminationReasonCode The termination reason''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /terminationReason: get: tags: - TerminationReason summary: ' Find a termination reason with a given code. ' description: ' Find a termination reason with a given code. ' operationId: find_17 parameters: - name: terminationReasonCode in: query description: ' code The termination reason''s code ' schema: type: string responses: default: description: ' found termination reason ' content: application/json: schema: $ref: '#/components/schemas/GetTerminationReasonResponse' application/xml: schema: $ref: '#/components/schemas/GetTerminationReasonResponse' put: tags: - TerminationReason summary: ' Update an existing termination reason. ' description: ' Update an existing termination reason. ' operationId: update_18 requestBody: description: ' postData The termination reason''s data ' content: application/json: schema: $ref: '#/components/schemas/TerminationReasonDto' application/xml: schema: $ref: '#/components/schemas/TerminationReasonDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - TerminationReason summary: ' Create a new termination reason. ' description: ' Create a new termination reason. ' operationId: create_18 requestBody: description: ' postData The termination reason''s data ' content: application/json: schema: $ref: '#/components/schemas/TerminationReasonDto' application/xml: schema: $ref: '#/components/schemas/TerminationReasonDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /terminationReason/list: get: tags: - TerminationReason summary: ' List of termination reasons. ' description: ' List of termination reasons. ' operationId: list_9 responses: default: description: ' A list of termination reasons ' content: application/json: schema: $ref: '#/components/schemas/GetTerminationReasonResponse' application/xml: schema: $ref: '#/components/schemas/GetTerminationReasonResponse' /terminationReason/version: get: tags: - TerminationReason summary: ' Get version of application ' description: ' Get version of application ' operationId: index_22 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /usage/chargeAggregate: get: tags: - Usage summary: ' Search for charge aggregate isage from a user account code during a period of time. ' description: ' Search for charge aggregate isage from a user account code during a period of time. ' operationId: chargeAggregate_1 parameters: - name: userAccountCode in: query description: ' userAccountCode user account''s code ' schema: type: string - name: fromDate in: query description: ' fromDate from date ' schema: type: string format: date-time - name: toDate in: query description: ' toDate to date ' schema: type: string format: date-time responses: default: description: ' usage charge aggregate ' content: application/json: schema: $ref: '#/components/schemas/UsageChargeAggregateResponseDto' application/xml: schema: $ref: '#/components/schemas/UsageChargeAggregateResponseDto' /usage: get: tags: - Usage summary: ' Search for all opened ratedTransactions with a given userAccountCode,fromDate and toDate . ' description: ' Search for all opened ratedTransactions with a given userAccountCode,fromDate and toDate . ' operationId: find_18 parameters: - name: userAccountCode in: query description: ' userAccountCode user account''s code ' schema: type: string - name: fromDate in: query description: ' fromDate from date ' schema: type: string format: date-time - name: toDate in: query description: ' toDate to date ' schema: type: string format: date-time responses: default: description: ' usage ' content: application/json: schema: $ref: '#/components/schemas/UsageResponseDto' application/xml: schema: $ref: '#/components/schemas/UsageResponseDto' /usage/version: get: tags: - Usage summary: ' Get version of application ' description: ' Get version of application ' operationId: index_23 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user/createOrUpdate: post: tags: - User summary: ' Create or update user based on the username. ' description: ' Create or update user based on the username. ' operationId: createOrUpdate_20 requestBody: description: ' postData user to be created or updated ' content: application/json: schema: $ref: '#/components/schemas/UserDto' application/xml: schema: $ref: '#/components/schemas/UserDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user/list: get: tags: - User summary: ' List users matching a given criteria. ' description: ' List users matching a given criteria. ' operationId: listGet_1 parameters: - name: query in: query description: ' query Search criteria. Query is composed of the following: filterKey1:filterValue1|filterKey2:filterValue2 ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma. Specify securedEntities in fields to include the secured entities. ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: userName - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' A list of users ' content: application/json: schema: $ref: '#/components/schemas/UsersDto' application/xml: schema: $ref: '#/components/schemas/UsersDto' post: tags: - User summary: ' List users matching a given criteria. ' description: ' List users matching a given criteria. ' operationId: listPost_1 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria. Specify securedEntities in fields to include the secured entities. ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' A list of users ' content: application/json: schema: $ref: '#/components/schemas/UsersDto' application/xml: schema: $ref: '#/components/schemas/UsersDto' /user/external: put: tags: - User summary: ' Updates a user in keycloak and core given a username. ' description: ' Updates a user in keycloak and core given a username. ' operationId: updateExternalUser_1 requestBody: description: ' postData user to be updated ' content: application/json: schema: $ref: '#/components/schemas/UserDto' application/xml: schema: $ref: '#/components/schemas/UserDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - User summary: ' Creates a user in keycloak and core. ' description: ' Creates a user in keycloak and core. ' operationId: createExternalUser_1 requestBody: description: ' postData user to be created externally ' content: application/json: schema: $ref: '#/components/schemas/UserDto' application/xml: schema: $ref: '#/components/schemas/UserDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user/external/{username}: delete: tags: - User summary: ' Deletes a user in keycloak and core given a username. ' description: ' Deletes a user in keycloak and core given a username. ' operationId: deleteExternalUser_1 parameters: - name: username in: path description: ' username the username of the user to be deleted. ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user/{username}: delete: tags: - User summary: ' Remove user with a given username. ' description: ' Remove user with a given username. ' operationId: remove_18 parameters: - name: username in: path description: ' username user name ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user: get: tags: - User summary: ' Search user with a given username. ' description: ' Search user with a given username. ' operationId: find_19 parameters: - name: username in: query description: ' username user name ' schema: type: string responses: default: description: ' user ' content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' application/xml: schema: $ref: '#/components/schemas/GetUserResponse' put: tags: - User summary: ' Update user. ' description: ' Update user. ' operationId: update_19 requestBody: description: ' postData user to be updated ' content: application/json: schema: $ref: '#/components/schemas/UserDto' application/xml: schema: $ref: '#/components/schemas/UserDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - User summary: ' Create user. ' description: ' Create user. ' operationId: create_19 requestBody: description: ' postData user to be created ' content: application/json: schema: $ref: '#/components/schemas/UserDto' application/xml: schema: $ref: '#/components/schemas/UserDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /user/version: get: tags: - User summary: ' Get version of application ' description: ' Get version of application ' operationId: index_24 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access/createOrUpdate: post: tags: - Access summary: ' Create new or update an existing access ' description: ' Create new or update an existing access ' operationId: createOrUpdate_30 requestBody: description: ' postData data ' content: application/json: schema: $ref: '#/components/schemas/AccessDto' application/xml: schema: $ref: '#/components/schemas/AccessDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access/list: get: tags: - Access summary: ' List Access filtered by subscriptionCode. ' description: ' List Access filtered by subscriptionCode. ' operationId: listBySubscription_1 parameters: - name: subscriptionCode in: query description: ' subscriptionCode Subscription code ' schema: type: string responses: default: description: ' A list of accesses ' content: application/json: schema: $ref: '#/components/schemas/AccessesResponseDto' application/xml: schema: $ref: '#/components/schemas/AccessesResponseDto' /account/access/{accessCode}/{subscriptionCode}: delete: tags: - Access summary: ' Remove an access with a given access code and subscription code. ' description: ' Remove an access with a given access code and subscription code. ' operationId: remove_28 parameters: - name: accessCode in: path description: ' accessCode Access code ' required: true schema: type: string - name: subscriptionCode in: path description: ' subscriptionCode Subscription code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access: get: tags: - Access summary: ' Search for an access with a given access code and subscription code. ' description: ' Search for an access with a given access code and subscription code. ' operationId: find_30 parameters: - name: accessCode in: query description: ' accessCode Access code ' schema: type: string - name: subscriptionCode in: query description: ' subscriptionCode Subscription code ' schema: type: string responses: default: description: ' Access ' content: application/json: schema: $ref: '#/components/schemas/GetAccessResponseDto' application/xml: schema: $ref: '#/components/schemas/GetAccessResponseDto' put: tags: - Access summary: ' Update an existing access ' description: ' Update an existing access ' operationId: update_30 requestBody: description: ' postData Access data ' content: application/json: schema: $ref: '#/components/schemas/AccessDto' application/xml: schema: $ref: '#/components/schemas/AccessDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Access summary: ' Create a new access ' description: ' Create a new access ' operationId: create_30 requestBody: description: ' postData Access data ' content: application/json: schema: $ref: '#/components/schemas/AccessDto' application/xml: schema: $ref: '#/components/schemas/AccessDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access/{accessCode}/{subscriptionCode}/enable: post: tags: - Access summary: ' Enable an Access point with a given access code and subscription code. ' description: ' Enable an Access point with a given access code and subscription code. ' operationId: enable_6 parameters: - name: accessCode in: path description: ' accessCode Access code ' required: true schema: type: string - name: subscriptionCode in: path description: ' subscriptionCode Subscription code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access/{accessCode}/{subscriptionCode}/disable: post: tags: - Access summary: ' Disable an Access point with a given access code and subscription code. ' description: ' Disable an Access point with a given access code and subscription code. ' operationId: disable_6 parameters: - name: accessCode in: path description: ' accessCode Access code ' required: true schema: type: string - name: subscriptionCode in: path description: ' subscriptionCode Subscription code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/access/version: get: tags: - Access summary: ' Get version of application ' description: ' Get version of application ' operationId: index_35 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/createOrUpdate: post: tags: - AccountHierarchy summary: ' Create or update Account Hierarchy based on code. ' description: ' Create or update Account Hierarchy based on code. ' operationId: createOrUpdate_22 requestBody: description: ' accountHierarchyDto account hierarchy dto. ' content: application/json: schema: $ref: '#/components/schemas/AccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/AccountHierarchyDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/customerHierarchyUpdate: post: tags: - AccountHierarchy summary: ' 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' description: ' 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. ' operationId: customerHierarchyUpdate_1 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/CustomerHierarchyDto' application/xml: schema: $ref: '#/components/schemas/CustomerHierarchyDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/findAccountHierarchy: post: tags: - AccountHierarchy summary: ' Is an update of findAccountHierarchy wherein the user can search on 1 or multiple levels of the hierarchy in 1 search' description: ' 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. ' operationId: findAccountHierarchy2_1 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/FindAccountHierachyRequestDto' application/xml: schema: $ref: '#/components/schemas/FindAccountHierachyRequestDto' responses: default: description: ' account hieracy response. ' content: application/json: schema: $ref: '#/components/schemas/GetAccountHierarchyResponseDto' application/xml: schema: $ref: '#/components/schemas/GetAccountHierarchyResponseDto' /account/accountHierarchy/createCRMAccountHierarchy: post: tags: - AccountHierarchy summary: ' Create a CRMAccountHerarchy. ' description: ' Create a CRMAccountHerarchy. ' operationId: createCRMAccountHierarchy_1 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' responses: default: description: ' acion status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/updateCRMAccountHierarchy: post: tags: - AccountHierarchy summary: ' Update a CRM Account HerarHierarchychy. ' description: ' Update a CRM Account HerarHierarchychy. ' operationId: updateCRMAccountHierarchy_1 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' responses: default: description: ' acion status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/createOrUpdateCRMAccountHierarchy: post: tags: - AccountHierarchy summary: ' Create or update a CRM Account Hierarchy. ' description: ' Create or update a CRM Account Hierarchy. ' operationId: createOrUpdateCRMAccountHierarchy_1 requestBody: description: ' postData posted data ' content: application/json: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/CRMAccountHierarchyDto' responses: default: description: ' acion status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy: put: tags: - AccountHierarchy summary: ' Update account hierarchy. ' description: ' Update account hierarchy. ' operationId: update_21 requestBody: description: ' accountHierarchyDto account hierachy dto ' content: application/json: schema: $ref: '#/components/schemas/AccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/AccountHierarchyDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - AccountHierarchy summary: ' Create account hierarchy. ' description: ' Create account hierarchy. ' operationId: create_21 requestBody: description: ' accountHierarchyDto account hierarchy dto ' content: application/json: schema: $ref: '#/components/schemas/AccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/AccountHierarchyDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/accountHierarchy/find: post: tags: - AccountHierarchy summary: ' Search for a list of customer accounts given a set of filter. ' description: ' Search for a list of customer accounts given a set of filter. ' operationId: find_21 parameters: - name: calculateBalances in: query description: ' calculateBalances true if needs to calculate balances ' schema: type: boolean requestBody: description: ' customerDto customer dto ' content: application/json: schema: $ref: '#/components/schemas/AccountHierarchyDto' application/xml: schema: $ref: '#/components/schemas/AccountHierarchyDto' responses: default: description: ' customer list. ' content: application/json: schema: $ref: '#/components/schemas/CustomerListResponse' application/xml: schema: $ref: '#/components/schemas/CustomerListResponse' /account/accountHierarchy/version: get: tags: - AccountHierarchy summary: ' Get version of application ' description: ' Get version of application ' operationId: index_26 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/billingAccount/createOrUpdate: post: tags: - BillingAccount summary: ' Create or update Billing Account based on code. ' description: ' Create or update Billing Account based on code. ' operationId: createOrUpdate_23 requestBody: description: ' postData Billing account data ' content: application/json: schema: $ref: '#/components/schemas/BillingAccountDto' application/xml: schema: $ref: '#/components/schemas/BillingAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/billingAccount/list: get: tags: - BillingAccount summary: ' List BillingAccount filter by customerAccountCode. ' description: ' List BillingAccount filter by customerAccountCode. ' operationId: listByCustomerAccount_1 parameters: - name: customerAccountCode in: query description: ' customerAccountCode Customer account code ' schema: type: string responses: default: description: ' list of billing account ' content: application/json: schema: $ref: '#/components/schemas/BillingAccountsResponseDto' application/xml: schema: $ref: '#/components/schemas/BillingAccountsResponseDto' /account/billingAccount/filterCountersByPeriod: get: tags: - BillingAccount summary: ' filter counters by period date. ' description: ' filter counters by period date. ' operationId: filterBillingAccountCountersByPeriod_1 parameters: - name: billingAccountCode in: query description: ' billingAccountCode Billing account code ' schema: type: string - name: date in: query description: ' date Date ' schema: type: string format: date-time responses: default: description: ' list of counter instances. ' content: application/json: schema: $ref: '#/components/schemas/GetCountersInstancesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCountersInstancesResponseDto' /account/billingAccount/{billingAccountCode}: delete: tags: - BillingAccount summary: ' Remove a billing account with a Billing Account Code. ' description: ' Remove a billing account with a Billing Account Code. ' operationId: remove_20 parameters: - name: billingAccountCode in: path description: ' billingAccountCode Billing account code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/billingAccount: get: tags: - BillingAccount summary: ' Search for a billing account with a given code. ' description: ' Search for a billing account with a given code. ' operationId: find_22 parameters: - name: billingAccountCode in: query description: ' billingAccountCode Billing account code ' schema: type: string - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' Billing account ' content: application/json: schema: $ref: '#/components/schemas/GetBillingAccountResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBillingAccountResponseDto' put: tags: - BillingAccount summary: ' Update existing billing account. ' description: ' Update existing billing account. ' operationId: update_22 requestBody: description: ' postData Billing account data ' content: application/json: schema: $ref: '#/components/schemas/BillingAccountDto' application/xml: schema: $ref: '#/components/schemas/BillingAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BillingAccount summary: ' Create a new billing account. ' description: ' Create a new billing account. ' operationId: create_22 requestBody: description: ' postData Billing account data ' content: application/json: schema: $ref: '#/components/schemas/BillingAccountDto' application/xml: schema: $ref: '#/components/schemas/BillingAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/billingAccount/version: get: tags: - BillingAccount summary: ' Get version of application ' description: ' Get version of application ' operationId: index_27 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/businessAccountModel/install: put: tags: - BusinessAccountModel summary: ' Install business account module. ' description: ' Install business account module. ' operationId: install_1 requestBody: description: ' moduleDto The module ' content: application/json: schema: $ref: '#/components/schemas/BusinessAccountModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessAccountModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/businessAccountModel/findParents: post: tags: - BusinessAccountModel summary: ' Find parent entities based on account hierarchy code. ' description: ' Find parent entities based on account hierarchy code. ' operationId: findParents_1 requestBody: description: ' searchDto CRM type search dto/ ' content: application/json: schema: $ref: '#/components/schemas/CRMAccountTypeSearchDto' application/xml: schema: $ref: '#/components/schemas/CRMAccountTypeSearchDto' responses: default: description: ' parent list reponse ' content: application/json: schema: $ref: '#/components/schemas/ParentListResponse' application/xml: schema: $ref: '#/components/schemas/ParentListResponse' /account/businessAccountModel/{businessAccountModelCode}: delete: tags: - BusinessAccountModel summary: ' Remove business account model with a given business account model code. ' description: ' Remove business account model with a given business account model code. ' operationId: remove_21 parameters: - name: businessAccountModelCode in: path description: ' bamCode Business account model code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/businessAccountModel: get: tags: - BusinessAccountModel summary: ' Search for a business account model. ' description: ' Search for a business account model. ' operationId: find_23 parameters: - name: businessAccountModelCode in: query description: ' bamCode Business account model code ' schema: type: string responses: default: description: ' business account model response. ' content: application/json: schema: $ref: '#/components/schemas/BusinessAccountModelResponseDto' application/xml: schema: $ref: '#/components/schemas/BusinessAccountModelResponseDto' put: tags: - BusinessAccountModel summary: ' Update an existing business account model. ' description: ' Update an existing business account model. ' operationId: update_23 requestBody: description: ' postData Business account model data ' content: application/json: schema: $ref: '#/components/schemas/BusinessAccountModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessAccountModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BusinessAccountModel summary: ' Create a new business account model. ' description: ' Create a new business account model. ' operationId: create_23 requestBody: description: ' postData Business account model data ' content: application/json: schema: $ref: '#/components/schemas/BusinessAccountModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessAccountModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/businessAccountModel/list: get: tags: - BusinessAccountModel summary: ' Return meveo''s modules. ' description: ' Return meveo''s modules. ' operationId: list_14 responses: default: description: ' meveo module response ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' /account/businessAccountModel/version: get: tags: - BusinessAccountModel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_28 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount/createOrUpdate: post: tags: - CustomerAccount summary: ' Create new or update existing customer account ' description: ' Create new or update existing customer account ' operationId: createOrUpdate_24 requestBody: description: ' postData The customer account''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerAccountDto' application/xml: schema: $ref: '#/components/schemas/CustomerAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount/list: get: tags: - CustomerAccount summary: ' List CustomerAccount filtered by customerCode. ' description: ' List CustomerAccount filtered by customerCode. ' operationId: listByCustomer_1 parameters: - name: customerCode in: query description: ' customerCode The customer account''s code ' schema: type: string responses: default: description: ' list of customer account by customer. ' content: application/json: schema: $ref: '#/components/schemas/CustomerAccountsResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomerAccountsResponseDto' /account/customerAccount/creditCategory: post: tags: - CustomerAccount summary: ' Create a new credit category. ' description: ' Create a new credit category. ' operationId: createCreditCategory_1 requestBody: description: ' postData The credit category''s data ' content: application/json: schema: $ref: '#/components/schemas/CreditCategoryDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount/creditCategory/{creditCategoryCode}: delete: tags: - CustomerAccount summary: ' Remove credit category with a given code. ' description: ' Remove credit category with a given code. ' operationId: removeCreditCategory_1 parameters: - name: creditCategoryCode in: path description: ' creditCategoryCode The credit category''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount/{customerAccountCode}: delete: tags: - CustomerAccount summary: ' Remove customerAccount with a given code. ' description: ' Remove customerAccount with a given code. ' operationId: remove_22 parameters: - name: customerAccountCode in: path description: ' customerAccountCode The customer account''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount: get: tags: - CustomerAccount summary: ' Search for a customer account with a given code. ' description: ' Search for a customer account with a given code. ' operationId: find_24 parameters: - name: customerAccountCode in: query description: ' customerAccountCode The customer account''s code ' schema: type: string - name: calculateBalances in: query description: ' calculateBalances true if needs to calculate balances ' schema: type: boolean - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' customer account ' content: application/json: schema: $ref: '#/components/schemas/GetCustomerAccountResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomerAccountResponseDto' put: tags: - CustomerAccount summary: ' Update an existing customer account ' description: ' Update an existing customer account ' operationId: update_24 requestBody: description: ' postData The customer account''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerAccountDto' application/xml: schema: $ref: '#/components/schemas/CustomerAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CustomerAccount summary: ' Create a new customer account ' description: ' Create a new customer account ' operationId: create_24 requestBody: description: ' postData The customer account''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerAccountDto' application/xml: schema: $ref: '#/components/schemas/CustomerAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customerAccount/version: get: tags: - CustomerAccount summary: ' Get version of application ' description: ' Get version of application ' operationId: index_29 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/createOrUpdate: post: tags: - Customer summary: ' Create new or update existing customer ' description: ' Create new or update existing customer ' operationId: createOrUpdate_25 requestBody: description: ' postData The customer''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerDto' application/xml: schema: $ref: '#/components/schemas/CustomerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/list47: post: tags: - Customer summary: ' Filters are: category, seller, brand and provider. ' description: ' Filters are: category, seller, brand and provider. ' operationId: list47_1 parameters: - name: firstRow in: query description: ' firstRow Pagination - from record number. Deprecated in v.4.7 use from instead ' schema: type: integer format: int32 - name: numberOfRows in: query description: ' numberOfRows Pagination - number of records to retrieve. Deprecated in v.4.7 use limit instead ' schema: type: integer format: int32 - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy sortBy field ' schema: type: string default: c.code - name: sortOrder in: query description: ' sortOrder ASC/DESC ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING requestBody: description: ' postData The customer''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerDto' application/xml: schema: $ref: '#/components/schemas/CustomerDto' responses: default: description: ' list of customers ' content: application/json: schema: $ref: '#/components/schemas/CustomersResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomersResponseDto' /account/customer/list: get: tags: - Customer summary: ' List customers matching a given criteria ' description: ' List customers matching a given criteria ' operationId: listGet_4 parameters: - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE.. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' List of customers ' content: application/json: schema: $ref: '#/components/schemas/CustomersResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomersResponseDto' post: tags: - Customer summary: ' List customers matching a given criteria ' description: ' List customers matching a given criteria ' operationId: listPost_4 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of customers ' content: application/json: schema: $ref: '#/components/schemas/CustomersResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomersResponseDto' /account/customer/createBrand: post: tags: - Customer summary: ' Create a new customer brand ' description: ' Create a new customer brand ' operationId: createBrand_1 requestBody: description: ' postData The customer brand''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerBrandDto' application/xml: schema: $ref: '#/components/schemas/CustomerBrandDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/updateBrand: put: tags: - Customer summary: ' Update an existing customer brand ' description: ' Update an existing customer brand ' operationId: updateBrand_1 requestBody: description: ' postData The customer brand''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerBrandDto' application/xml: schema: $ref: '#/components/schemas/CustomerBrandDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/createOrUpdateBrand: post: tags: - Customer summary: ' Create new or update an existing customer brand ' description: ' Create new or update an existing customer brand ' operationId: createOrUpdateBrand_1 requestBody: description: ' postData The customer brand''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerBrandDto' application/xml: schema: $ref: '#/components/schemas/CustomerBrandDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/createCategory: post: tags: - Customer summary: ' Create a new customer category ' description: ' Create a new customer category ' operationId: createCategory_1 requestBody: description: ' postData The customer category''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerCategoryDto' application/xml: schema: $ref: '#/components/schemas/CustomerCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/updateCategory: put: tags: - Customer summary: ' Update an existing customer category ' description: ' Update an existing customer category ' operationId: updateCategory_1 requestBody: description: ' postData The customer category''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerCategoryDto' application/xml: schema: $ref: '#/components/schemas/CustomerCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/category/{categoryCode}: get: tags: - Customer summary: ' Search for a customer category with a given code ' description: ' Search for a customer category with a given code ' operationId: findCategory_1 parameters: - name: categoryCode in: path description: ' categoryCode The customer category''s code ' required: true schema: type: string responses: default: description: ' The customer category''s data ' content: application/json: schema: $ref: '#/components/schemas/GetCustomerCategoryResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomerCategoryResponseDto' /account/customer/createOrUpdateCategory: post: tags: - Customer summary: ' Create new or update an existing customer category ' description: ' Create new or update an existing customer category ' operationId: createOrUpdateCategory_1 requestBody: description: ' postData The customer category''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerCategoryDto' application/xml: schema: $ref: '#/components/schemas/CustomerCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/removeBrand/{brandCode}: delete: tags: - Customer summary: ' Remove existing customer brand with a given brand code ' description: ' Remove existing customer brand with a given brand code ' operationId: removeBrand_1 parameters: - name: brandCode in: path description: ' brandCode The brand''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/removeCategory/{categoryCode}: delete: tags: - Customer summary: ' Remove an existing customer category with a given category code ' description: ' Remove an existing customer category with a given category code ' operationId: removeCategory_1 parameters: - name: categoryCode in: path description: ' categoryCode The category''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/exportCustomerHierarchy: get: tags: - Customer summary: "\t Exports an account hierarchy given a specific customer selected\ \ in the GUI" description: "\t Exports an account hierarchy given a specific customer selected\ \ in the GUI.\t It includes Subscription, AccountOperation and Invoice details.\ \ It packaged the json output\t as a zipped file along with the pdf invoices.\t\ \ \t " operationId: exportCustomerHierarchy_1 parameters: - name: customerCode in: query description: ' customerCode The customer''s code ' schema: type: string responses: default: description: " Request processing status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/anonymizeGpdr: get: tags: - Customer summary: ' Right to be forgotten' description: " Right to be forgotten. This concerns listing of risky or grey/black\ \ listed customers and their data.\t Upon request, they can require their\ \ data to be erased.\t 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. " operationId: anonymizeGpdr_1 parameters: - name: customerCode in: query description: ' customerCode The code of the customer ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/customerNumberSequence: put: tags: - Customer summary: "\t Update the Provider's customer number sequence configuration.\t\ \ \t " description: "\t Update the Provider's customer number sequence configuration.\t\ \ \t " operationId: updateCustomerNumberSequence_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/GenericSequenceDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceDto' responses: default: description: " status of the operation\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Customer summary: "\t Calculates and returns the next value of the mandate number.\t\ \ \t " description: "\t Calculates and returns the next value of the mandate number.\t\ \ \t " operationId: getNextCustomerNumber_1 responses: default: description: " next customer no value\t " content: application/json: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' /account/customer/sequence: put: tags: - Customer summary: "\t Updates a new customer sequence with a given code.\t " description: "\t Updates a new customer sequence with a given code.\t " operationId: updateCustomerSequence_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerSequenceDto' application/xml: schema: $ref: '#/components/schemas/CustomerSequenceDto' responses: default: description: " request status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Customer summary: "\t Creates a new customer sequence.\t " description: "\t Creates a new customer sequence.\t " operationId: createCustomerSequence_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerSequenceDto' application/xml: schema: $ref: '#/components/schemas/CustomerSequenceDto' responses: default: description: " request status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/sequence/{code}/next: post: tags: - Customer summary: "\t Generates the next customer sequence number.\t " description: "\t Generates the next customer sequence number.\t " operationId: getNextCustomerSequenceNumber_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: " sequence value dto\t " content: application/json: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' /account/customer/{customerCode}: delete: tags: - Customer summary: ' Remove customer with a given code ' description: ' Remove customer with a given code ' operationId: remove_23 parameters: - name: customerCode in: path description: ' customerCode The customer''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer: get: tags: - Customer summary: ' Search for a customer with a given code ' description: ' Search for a customer with a given code ' operationId: find_25 parameters: - name: customerCode in: query description: ' customerCode The customer''s code ' schema: type: string - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' The customer''s data ' content: application/json: schema: $ref: '#/components/schemas/GetCustomerResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomerResponseDto' put: tags: - Customer summary: ' Update an existing customer ' description: ' Update an existing customer ' operationId: update_25 requestBody: description: ' postData The customer''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerDto' application/xml: schema: $ref: '#/components/schemas/CustomerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Customer summary: ' Create a new customer ' description: ' Create a new customer ' operationId: create_25 requestBody: description: ' postData The customer''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomerDto' application/xml: schema: $ref: '#/components/schemas/CustomerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/customer/version: get: tags: - Customer summary: ' Get version of application ' description: ' Get version of application ' operationId: index_30 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/providerContact/createOrUpdate: post: tags: - ProviderContact summary: ' Create new or update an existing provider contact ' description: ' Create new or update an existing provider contact ' operationId: createOrUpdate_26 requestBody: description: ' providerContactDto The provider contact''s data ' content: application/json: schema: $ref: '#/components/schemas/ProviderContactDto' application/xml: schema: $ref: '#/components/schemas/ProviderContactDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/providerContact/{code}: delete: tags: - ProviderContact summary: ' Remove an existing provider contact with a given code ' description: ' Remove an existing provider contact with a given code ' operationId: remove_24 parameters: - name: providerContactCode in: path description: ' providerContactCode The provider contact''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/providerContact: get: tags: - ProviderContact summary: ' Search for a provider contact with a given code ' description: ' Search for a provider contact with a given code ' operationId: find_26 parameters: - name: providerContactCode in: query description: ' providerContactCode The provider contact''s code ' schema: type: string responses: default: description: ' A provider contact ' content: application/json: schema: $ref: '#/components/schemas/ProviderContactResponseDto' application/xml: schema: $ref: '#/components/schemas/ProviderContactResponseDto' put: tags: - ProviderContact summary: ' Update an existing provider contact ' description: ' Update an existing provider contact ' operationId: update_26 requestBody: description: ' providerContactDto The provider contact''s data ' content: application/json: schema: $ref: '#/components/schemas/ProviderContactDto' application/xml: schema: $ref: '#/components/schemas/ProviderContactDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - ProviderContact summary: "\t Create a provider contact\t " description: "\t Create a provider contact\t " operationId: create_26 requestBody: description: " providerContactDto The provider contact's data\t " content: application/json: schema: $ref: '#/components/schemas/ProviderContactDto' application/xml: schema: $ref: '#/components/schemas/ProviderContactDto' responses: default: description: " Request processing status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/providerContact/list: get: tags: - ProviderContact summary: ' List of provider contacts ' description: ' List of provider contacts ' operationId: list_11 responses: default: description: ' A list of provider contacts ' content: application/json: schema: $ref: '#/components/schemas/ProviderContactsResponseDto' application/xml: schema: $ref: '#/components/schemas/ProviderContactsResponseDto' /account/providerContact/version: get: tags: - ProviderContact summary: ' Get version of application ' description: ' Get version of application ' operationId: index_31 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/title/createOrUpdate: post: tags: - Title summary: ' Create new or update an existing title ' description: ' Create new or update an existing title ' operationId: createOrUpdate_27 requestBody: description: ' postData The title''s data ' content: application/json: schema: $ref: '#/components/schemas/TitleDto' application/xml: schema: $ref: '#/components/schemas/TitleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/title/{titleCode}: delete: tags: - Title summary: ' Remove an existing title with a given code ' description: ' Remove an existing title with a given code ' operationId: remove_25 parameters: - name: titleCode in: path description: ' titleCode The title''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/title: get: tags: - Title summary: ' Search for a title with a given code ' description: ' Search for a title with a given code ' operationId: find_27 parameters: - name: titleCode in: query description: ' titleCode The title''s code ' schema: type: string responses: default: description: ' A title''s data ' content: application/json: schema: $ref: '#/components/schemas/TitleResponseDto' application/xml: schema: $ref: '#/components/schemas/TitleResponseDto' put: tags: - Title summary: ' Update an existing title ' description: ' Update an existing title ' operationId: update_27 requestBody: description: ' postData The title''s data ' content: application/json: schema: $ref: '#/components/schemas/TitleDto' application/xml: schema: $ref: '#/components/schemas/TitleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Title summary: ' Create a new title ' description: ' Create a new title ' operationId: create_27 requestBody: description: ' postData The title''s data ' content: application/json: schema: $ref: '#/components/schemas/TitleDto' application/xml: schema: $ref: '#/components/schemas/TitleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/title/list: get: tags: - Title summary: ' List titles ' description: ' List titles ' operationId: list_12 responses: default: description: ' A list of titles ' content: application/json: schema: $ref: '#/components/schemas/TitlesResponseDto' application/xml: schema: $ref: '#/components/schemas/TitlesResponseDto' /account/title/version: get: tags: - Title summary: ' Get version of application ' description: ' Get version of application ' operationId: index_36 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/userAccount/createOrUpdate: post: tags: - UserAccount summary: ' Create new or update an existing user account. ' description: ' Create new or update an existing user account. ' operationId: createOrUpdate_28 requestBody: description: ' postData The user account''s data ' content: application/json: schema: $ref: '#/components/schemas/UserAccountDto' application/xml: schema: $ref: '#/components/schemas/UserAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/userAccount/list: get: tags: - UserAccount summary: ' List user accounts filtered by a billing account''s code. ' description: ' List user accounts filtered by a billing account''s code. ' operationId: listByBillingAccount_1 parameters: - name: billingAccountCode in: query description: ' billingAccountCode The user billing account''s code ' schema: type: string responses: default: description: ' list of user accounts. ' content: application/json: schema: $ref: '#/components/schemas/UserAccountsResponseDto' application/xml: schema: $ref: '#/components/schemas/UserAccountsResponseDto' /account/userAccount/filterCountersByPeriod: get: tags: - UserAccount summary: ' Filter counters by period date. ' description: ' Filter counters by period date. ' operationId: filterUserAccountCountersByPeriod_1 parameters: - name: userAccountCode in: query description: ' userAccountCode The user account''s code ' schema: type: string - name: date in: query description: ' date The date corresponding to the period ' schema: type: string format: date-time responses: default: description: ' counter instances. ' content: application/json: schema: $ref: '#/components/schemas/GetCountersInstancesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCountersInstancesResponseDto' /account/userAccount/applyProduct: post: tags: - UserAccount summary: ' Apply a product on a user account. ' description: ' Apply a product on a user account. ' operationId: applyProduct_1 requestBody: description: ' postData ApplyProductRequestDto userAccount field must be set ' content: application/json: schema: $ref: '#/components/schemas/ApplyProductRequestDto' application/xml: schema: $ref: '#/components/schemas/ApplyProductRequestDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/userAccount/{userAccountCode}: delete: tags: - UserAccount summary: ' Remove an existing user account with a given code. ' description: ' Remove an existing user account with a given code. ' operationId: remove_26 parameters: - name: userAccountCode in: path description: ' userAccountCode The user account''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/userAccount: get: tags: - UserAccount summary: ' Search for a user account with a given code. ' description: ' Search for a user account with a given code. ' operationId: find_28 parameters: - name: userAccountCode in: query description: ' userAccountCode user account code ' schema: type: string - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' found user account if exist ' content: application/json: schema: $ref: '#/components/schemas/GetUserAccountResponseDto' application/xml: schema: $ref: '#/components/schemas/GetUserAccountResponseDto' put: tags: - UserAccount summary: ' Update an existing user account ' description: ' Update an existing user account ' operationId: update_28 requestBody: description: ' postData The user account''s data ' content: application/json: schema: $ref: '#/components/schemas/UserAccountDto' application/xml: schema: $ref: '#/components/schemas/UserAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - UserAccount summary: ' Create a new user account. ' description: ' Create a new user account. ' operationId: create_28 requestBody: description: ' postData The user account''s data ' content: application/json: schema: $ref: '#/components/schemas/UserAccountDto' application/xml: schema: $ref: '#/components/schemas/UserAccountDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /account/userAccount/version: get: tags: - UserAccount summary: ' Get version of application ' description: ' Get version of application ' operationId: index_33 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/ratedTransaction/list: get: tags: - RatedTransaction summary: ' Get a list of rated transactions ' description: ' Get a list of rated transactions ' operationId: listGet_6 parameters: - name: query in: query description: ' query Search criteria. Example : query=fromRange end_Date:2017-05-01|toRange end_date:2019-01-01 or query=code:abcd ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: returnUserAccountCode in: query description: ' returnUserAccountCode the return user account code ' schema: type: boolean default: false responses: default: description: ' A list of Rated transactions ' content: application/json: schema: $ref: '#/components/schemas/RatedTransactionListResponseDto' application/xml: schema: $ref: '#/components/schemas/RatedTransactionListResponseDto' post: tags: - RatedTransaction summary: ' Get a list of rated transactions ' description: ' Get a list of rated transactions ' operationId: listPost_6 requestBody: description: ' pagingAndFiltering Search and paging criteria. Pass userAccountCode as field option to retrieve associated User account''s code. ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' A list of Rated transactions ' content: application/json: schema: $ref: '#/components/schemas/RatedTransactionListResponseDto' application/xml: schema: $ref: '#/components/schemas/RatedTransactionListResponseDto' /billing/ratedTransaction/cancelRatedTransactions: post: tags: - RatedTransaction summary: ' 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' description: ' 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. ' operationId: cancelRatedTransactions_1 requestBody: description: ' pagingAndFiltering Search criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' ActionStatus with SUCESS or FAIL status inside ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/ratedTransaction/version: get: tags: - RatedTransaction summary: ' Get version of application ' description: ' Get version of application ' operationId: index_41 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/audit/{enableORdisable}: put: tags: - Audit summary: ' Update audit logging ' description: ' Update audit logging ' operationId: enableORdisableAudit_1 parameters: - name: enableORdisable in: path description: ' enableORdisable ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/audit/version: get: tags: - Audit summary: ' Get version of application ' description: ' Get version of application ' operationId: index_38 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/zipFile: post: tags: - Files summary: ' Will make a archive of a file ' description: ' Will make a archive of a file ' operationId: zipFile_1 requestBody: description: ' file The name of the file ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/zipDirectory: post: tags: - Files summary: ' Will make a archive of a directory ' description: ' Will make a archive of a directory ' operationId: zipDir_1 requestBody: description: ' dir The name of the directory ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/createDir: post: tags: - Files summary: ' Create a directory ' description: ' Create a directory ' operationId: createDir_1 requestBody: description: ' dir The directory name ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/suppressFile: post: tags: - Files summary: ' Suppress the file ' description: ' Suppress the file ' operationId: suppressFile_1 requestBody: description: ' file The file name ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/suppressDirectory: post: tags: - Files summary: ' Suppress the directory ' description: ' Suppress the directory ' operationId: suppressDir_1 requestBody: description: ' dir the directory name ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/upload: post: tags: - Files summary: ' Upload the file form. ' description: ' Upload the file form. ' operationId: uploadFile_1 requestBody: description: ' form The data to process ' content: multipart/form-data: schema: $ref: '#/components/schemas/FileUploadForm' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/uploadFileBase64: post: tags: - Files summary: ' Upload the file with the specific file data in 64 base. ' description: ' Upload the file with the specific file data in 64 base. ' operationId: uploadFileBase64_1 requestBody: description: ' postData The data to process ' content: application/json: schema: $ref: '#/components/schemas/FileRequestDto' application/xml: schema: $ref: '#/components/schemas/FileRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/uploadZippedFileBase64: post: tags: - Files summary: ' Upload the zipped file with the file data. ' description: ' Upload the zipped file with the file data. ' operationId: uploadZippedFileBase64_1 requestBody: description: ' postData The data to process ' content: application/json: schema: $ref: '#/components/schemas/FileRequestDto' application/xml: schema: $ref: '#/components/schemas/FileRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files/downloadFile: get: tags: - Files summary: ' Download file with a given file name. ' description: ' Download file with a given file name. ' operationId: downloadFile_1 parameters: - name: file in: query description: ' file file name ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/files: get: tags: - Files summary: ' Get the list of files in a specific directory ' description: ' Get the list of files in a specific directory ' operationId: listFiles_2 parameters: - name: dir in: query description: ' dir The directory name ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/GetFilesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetFilesResponseDto' /admin/files/all: get: tags: - Files summary: ' Get the list of files ' description: ' Get the list of files ' operationId: listFiles responses: default: description: ' List of all files ' content: application/json: schema: $ref: '#/components/schemas/GetFilesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetFilesResponseDto' /admin/files/version: get: tags: - Files summary: ' Get version of application ' description: ' Get version of application ' operationId: index_34 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode/createOrUpdate: post: tags: - AccountingCode summary: ' Create or update an AccountingCode. Checks if the code already exists. ' description: ' Create or update an AccountingCode. Checks if the code already exists. ' operationId: createOrUpdate_32 requestBody: description: ' postData object representation of AccountingCode ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode/list: get: tags: - AccountingCode summary: ' List AccountingCode matching the given criteria. ' description: ' List AccountingCode matching the given criteria. ' operationId: listGet_7 parameters: - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' list of AccountingCode ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeListResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeListResponseDto' post: tags: - AccountingCode summary: ' List AccountingCode matching the given criteria. ' description: ' List AccountingCode matching the given criteria. ' operationId: listPost_7 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' list of AccountingCode ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeListResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeListResponseDto' /billing/accountingCode/{accountingCode}: delete: tags: - AccountingCode summary: ' Removes an AccountingCode entity. ' description: ' Removes an AccountingCode entity. ' operationId: remove_29 parameters: - name: accountingCode in: path description: ' accountingCode the string to search ' required: true schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode: get: tags: - AccountingCode summary: ' Finds an AccountingCode. ' description: ' Finds an AccountingCode. ' operationId: find_31 parameters: - name: accountingCode in: query description: ' accountingCode the string to search ' schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeGetResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeGetResponseDto' put: tags: - AccountingCode summary: ' Updates AccountingCode. An existing AccountingCode is search using the code field. ' description: ' Updates AccountingCode. An existing AccountingCode is search using the code field. ' operationId: update_32 requestBody: description: ' postData object representation of AccountingCode ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - AccountingCode summary: ' Creates a new AccountingCode. ' description: ' Creates a new AccountingCode. ' operationId: create_32 requestBody: description: ' postData object representation of AccountingCode ' content: application/json: schema: $ref: '#/components/schemas/AccountingCodeDto' application/xml: schema: $ref: '#/components/schemas/AccountingCodeDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode/{code}/enable: post: tags: - AccountingCode summary: ' Enable a Accounting code with a given code ' description: ' Enable a Accounting code with a given code ' operationId: enable_7 parameters: - name: code in: path description: ' code Accounting code code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode/{code}/disable: post: tags: - AccountingCode summary: ' Disable a Accounting code with a given code ' description: ' Disable a Accounting code with a given code ' operationId: disable_7 parameters: - name: code in: path description: ' code Accounting code code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/accountingCode/version: get: tags: - AccountingCode summary: ' Get version of application ' description: ' Get version of application ' operationId: index_43 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/invoicing/createBillingRun: post: tags: - Invoicing summary: ' Create a new billing run ' description: ' Create a new billing run ' operationId: createBillingRun_1 requestBody: description: ' createBillingRunDto The billing run''s data ' content: application/json: schema: $ref: '#/components/schemas/CreateBillingRunDto' application/xml: schema: $ref: '#/components/schemas/CreateBillingRunDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/invoicing/getBillingRunInfo: post: tags: - Invoicing summary: ' Search for a billing run info with a given Id ' description: ' Search for a billing run info with a given Id ' operationId: getBillingRunInfo_1 requestBody: description: ' billingRunId The billing run''s Id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' The billing run info ' content: application/json: schema: $ref: '#/components/schemas/GetBillingRunInfoResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBillingRunInfoResponseDto' /billing/invoicing/cancelBillingRun: post: tags: - Invoicing summary: ' Cancels a billing run' description: ' 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. ' operationId: cancelBillingRun_1 requestBody: description: ' billingRunId Billing run id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/invoicing/getBillingAccountListInRun: post: tags: - Invoicing summary: ' Returns the list of billable billing accounts of a billing run ' description: ' Returns the list of billable billing accounts of a billing run ' operationId: getBillingAccountListInRun_1 requestBody: description: ' billingRunId The billing run id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' A list of billing accounts ' content: application/json: schema: $ref: '#/components/schemas/GetBillingAccountListInRunResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBillingAccountListInRunResponseDto' /billing/invoicing/getPreInvoicingReport: post: tags: - Invoicing summary: ' Returns the pre-invoicing report for a given billing run Id ' description: ' Returns the pre-invoicing report for a given billing run Id ' operationId: getPreInvoicingReport_1 requestBody: description: ' billingRunId The billing run id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' A pre-invoicing reports ' content: application/json: schema: $ref: '#/components/schemas/GetPreInvoicingReportsResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPreInvoicingReportsResponseDto' /billing/invoicing/getPostInvoicingReport: post: tags: - Invoicing summary: ' Returns the post-invoicing report for a given billing run Id ' description: ' Returns the post-invoicing report for a given billing run Id ' operationId: getPostInvoicingReport_1 requestBody: description: ' billingRunId The billing run id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' A post-invoicing reports ' content: application/json: schema: $ref: '#/components/schemas/GetPostInvoicingReportsResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPostInvoicingReportsResponseDto' /billing/invoicing/validateBillingRun: post: tags: - Invoicing summary: ' Depending on the status of the billing run, produce the pre-invoicing report, the post-Invoicing report or validates a billing run' description: ' 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. ' operationId: validateBillingRun_1 requestBody: description: ' billingRunId The billing run id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/invoicing/version: get: tags: - Invoicing summary: ' Get version of application ' description: ' Get version of application ' operationId: index_37 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/cancelReservation: post: tags: - Mediation summary: ' Cancels the reservation ' description: ' Cancels the reservation ' operationId: cancelReservation_2 requestBody: description: ' reservation Prepaid reservation''s data ' content: application/json: schema: $ref: '#/components/schemas/PrepaidReservationDto' application/xml: schema: $ref: '#/components/schemas/PrepaidReservationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/confirmReservation: post: tags: - Mediation summary: ' Confirms the reservation ' description: ' Confirms the reservation ' operationId: confirmReservation_2 requestBody: description: ' reservation Prepaid reservation''s data ' content: application/json: schema: $ref: '#/components/schemas/PrepaidReservationDto' application/xml: schema: $ref: '#/components/schemas/PrepaidReservationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/registerCdrList: post: tags: - Mediation summary: ' Accepts a list of CDR line. This CDR is parsed and created as EDR. CDR is same format use in mediation job ' description: ' Accepts a list of CDR line. This CDR is parsed and created as EDR. CDR is same format use in mediation job ' operationId: registerCdrList_1 requestBody: description: ' postData String of CDR ' content: application/json: schema: $ref: '#/components/schemas/CdrListDto' application/xml: schema: $ref: '#/components/schemas/CdrListDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/chargeCdr: post: tags: - Mediation summary: ' Same as registerCdrList, but at the same process rate the EDR created ' description: ' Same as registerCdrList, but at the same process rate the EDR created ' operationId: chargeCdr_1 requestBody: description: ' cdr String of CDR ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/reserveCdr: post: tags: - Mediation summary: ' Allows the user to reserve a CDR, this will create a new reservation entity attached to a wallet operation' description: ' 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) ' operationId: reserveCdr_1 requestBody: description: ' cdr String of CDR ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Available quantity and reservationID is ed ' content: application/json: schema: $ref: '#/components/schemas/CdrReservationResponseDto' application/xml: schema: $ref: '#/components/schemas/CdrReservationResponseDto' /billing/mediation/notifyOfRejectedCdrs: post: tags: - Mediation summary: ' Notify of rejected CDRs ' description: ' Notify of rejected CDRs ' operationId: notifyOfRejectedCdrs_1 requestBody: description: ' cdrList A list of rejected CDR lines (can be as json format string instead of csv line) ' content: application/json: schema: $ref: '#/components/schemas/CdrListDto' application/xml: schema: $ref: '#/components/schemas/CdrListDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/mediation/version: get: tags: - Mediation summary: ' Get version of application ' description: ' Get version of application ' operationId: index_39 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/activate: post: tags: - Subscription summary: ' Activate a given Subscription. ' description: ' Activate a given Subscription. ' operationId: activate_1 requestBody: description: ' subscriptionCode subscription code ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/createOrUpdate: post: tags: - Subscription summary: ' Create or update subscription information ONLY. Does not include access, services nor products ' description: ' Create or update subscription information ONLY. Does not include access, services nor products ' operationId: createOrUpdate_29 requestBody: description: ' subscriptionDto Subscription information ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/list: get: tags: - Subscription summary: ' List subscriptions matching a given criteria ' description: ' List subscriptions matching a given criteria ' operationId: listGet_5 parameters: - name: userAccountCode in: query description: ' userAccountCode The user account''s code. Deprecated in v. 4.7.2 Use query=userAccount.code:code instead ' schema: type: string - name: mergedCF in: query description: ' mergedCF Should inherited custom field values be included. Deprecated in v. 4.7.2 Use pagingAndFiltering.fields=inheritedCF instead ' schema: type: boolean - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' List of subscriptions ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' post: tags: - Subscription summary: ' List subscriptions matching a given criteria ' description: ' List subscriptions matching a given criteria ' operationId: listPost_5 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of subscriptions ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' /billing/subscription/applyProduct: post: tags: - Subscription summary: ' Apply a product on a subscription. ' description: ' Apply a product on a subscription. ' operationId: applyProduct_2 requestBody: description: ' postData ApplyProductRequestDto subscription field must be set ' content: application/json: schema: $ref: '#/components/schemas/ApplyProductRequestDto' application/xml: schema: $ref: '#/components/schemas/ApplyProductRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/instantiateServices: post: tags: - Subscription summary: ' Instantiate a Service subscription ' description: ' Instantiate a Service subscription ' operationId: instantiateServices_1 requestBody: description: ' postData Subscription''s data ' content: application/json: schema: $ref: '#/components/schemas/InstantiateServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/InstantiateServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/activateServices: post: tags: - Subscription summary: ' Activate services' description: ' 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. ' operationId: activateServices_1 requestBody: description: ' postData Activate services request''s data ' content: application/json: schema: $ref: '#/components/schemas/ActivateServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/ActivateServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/applyOneShotChargeInstance: post: tags: - Subscription summary: ' Apply one shot charge. Subscription should not be in status (RESILIATED OR CANCELLED). ' description: ' Apply one shot charge. Subscription should not be in status (RESILIATED OR CANCELLED). ' operationId: applyOneShotChargeInstance_1 requestBody: description: ' postData ApplyOneShotChargeInstanceRequestDto''s data ' content: application/json: schema: $ref: '#/components/schemas/ApplyOneShotChargeInstanceRequestDto' application/xml: schema: $ref: '#/components/schemas/ApplyOneShotChargeInstanceRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/terminate: post: tags: - Subscription summary: ' Terminate a subscription. If subscription status is RESILIATED, an error is thrown ' description: ' Terminate a subscription. If subscription status is RESILIATED, an error is thrown ' operationId: terminateSubscription_1 requestBody: description: ' postData Terminate subscription request''s data ' content: application/json: schema: $ref: '#/components/schemas/TerminateSubscriptionRequestDto' application/xml: schema: $ref: '#/components/schemas/TerminateSubscriptionRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/terminateServices: post: tags: - Subscription summary: ' Terminate a list of services. If a service is already TERMINATED, an error is thrown. ' description: ' Terminate a list of services. If a service is already TERMINATED, an error is thrown. ' operationId: terminateServices_1 requestBody: description: ' postData Terminate subscription services request''s data ' content: application/json: schema: $ref: '#/components/schemas/TerminateSubscriptionServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/TerminateSubscriptionServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/listAll: get: tags: - Subscription summary: ' Deprecated in v.4.7.2 Use /list instead. ' description: ' Deprecated in v.4.7.2 Use /list instead. ' operationId: listAll_1 parameters: - name: offset in: query description: ' offset offset ' schema: type: integer format: int32 - name: limit in: query description: ' limit number of elements in response ' schema: type: integer format: int32 - name: mergedCF in: query description: ' mergedCF true if return ' schema: type: boolean default: false - name: sortBy in: query description: ' sortBy sortby field ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder ASC/DESC ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' list of all subscriptions. ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionsListResponseDto' deprecated: true /billing/subscription: get: tags: - Subscription summary: ' Search for a subscription with a given code. ' description: ' Search for a subscription with a given code. ' operationId: findSubscription_1 parameters: - name: subscriptionCode in: query description: ' subscriptionCode The subscription''s code ' schema: type: string - name: mergedCF in: query description: ' mergedCF true if merge inherited custom fields. ' schema: type: boolean default: false - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/GetSubscriptionResponseDto' application/xml: schema: $ref: '#/components/schemas/GetSubscriptionResponseDto' put: tags: - Subscription summary: ' Updates a subscription. It cannot update a subscription with status=RESILIATED ' description: ' Updates a subscription. It cannot update a subscription with status=RESILIATED ' operationId: update_29 requestBody: description: ' postData Subscription''s data ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Subscription summary: ' Create a subscription. It does not activate it ' description: ' Create a subscription. It does not activate it ' operationId: create_29 requestBody: description: ' postData Subscription''s data ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/oneShotCharge/{subscriptionCode}/{oneshotChargeCode}: delete: tags: - Subscription summary: ' Search for a subscription with a given code. ' description: ' Search for a subscription with a given code. ' operationId: terminateOneShotCharge_1 parameters: - name: subscriptionCode in: path description: ' subscriptionCode The subscription''s code ' required: true schema: type: string - name: oneshotChargeCode in: path description: ' oneshotChargeCode one shot Charge Code ' required: true schema: type: string responses: default: description: ' A subscription ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/listOneshotChargeOthers: get: tags: - Subscription summary: ' Search for a subscription with a given code. ' description: ' Search for a subscription with a given code. ' operationId: getOneShotChargeOthers_1 parameters: - name: subscriptionCode in: query schema: type: string responses: default: description: ' list of one-shot other charges. ' content: application/json: schema: $ref: '#/components/schemas/GetOneShotChargesResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOneShotChargesResponseDto' /billing/subscription/createOrUpdatePartial: post: tags: - Subscription summary: ' Create or update subscription information WITH access, services and products' description: ' 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. ' operationId: createOrUpdateSubscriptionPartial_1 requestBody: description: ' subscriptionDto Subscription information ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/suspend: put: tags: - Subscription summary: ' Suspend an existing subscription ' description: ' Suspend an existing subscription ' operationId: suspendSubscription_1 requestBody: description: ' postData Operation subscription request''s data (contains actionDate and subscriptionCode) ' content: application/json: schema: $ref: '#/components/schemas/OperationSubscriptionRequestDto' application/xml: schema: $ref: '#/components/schemas/OperationSubscriptionRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/resume: put: tags: - Subscription summary: ' Resume an existing subscription ' description: ' Resume an existing subscription ' operationId: resumeSubscription_1 requestBody: description: ' postData Operation subscription request''s data (contains actionDate and subscriptionCode) ' content: application/json: schema: $ref: '#/components/schemas/OperationSubscriptionRequestDto' application/xml: schema: $ref: '#/components/schemas/OperationSubscriptionRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/suspendServices: put: tags: - Subscription summary: ' Suspend an existing services ' description: ' Suspend an existing services ' operationId: suspendServices_1 requestBody: description: ' postData Operation services request''s data (contains serviceToUpdate and subscriptionCode) ' content: application/json: schema: $ref: '#/components/schemas/OperationServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/OperationServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/resumeServices: put: tags: - Subscription summary: ' Resume an existing services ' description: ' Resume an existing services ' operationId: resumeServices_1 requestBody: description: ' postData Operation services request''s data (contains serviceToUpdate and subscriptionCode) ' content: application/json: schema: $ref: '#/components/schemas/OperationServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/OperationServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/updateServices: put: tags: - Subscription summary: ' Update existing services ' description: ' Update existing services ' operationId: updateServices_1 requestBody: description: ' postData Service information data ' content: application/json: schema: $ref: '#/components/schemas/UpdateServicesRequestDto' application/xml: schema: $ref: '#/components/schemas/UpdateServicesRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/serviceInstance: get: tags: - Subscription summary: ' Find service instance. ' description: ' Find service instance. ' operationId: findServiceInstance_1 parameters: - name: subscriptionCode in: query description: ' subscriptionCode Subscription code ' schema: type: string - name: serviceInstanceId in: query description: ' serviceInstanceCode Service instance code ' schema: type: integer format: int64 - name: serviceInstanceCode in: query description: ' serviceInstanceId service instance id ' schema: type: string responses: default: description: ' Service instance ' content: application/json: schema: $ref: '#/components/schemas/GetServiceInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetServiceInstanceResponseDto' /billing/subscription/serviceInstances: get: tags: - Subscription summary: ' Returns a list of service instances. ' description: ' Returns a list of service instances. ' operationId: listServiceInstance_1 parameters: - name: subscriptionCode in: query description: ' subscriptionCode subscription code ' schema: type: string - name: serviceInstanceCode in: query description: ' serviceInstanceCode service instance code. ' schema: type: string responses: default: description: ' list of service instances ' content: application/json: schema: $ref: '#/components/schemas/GetListServiceInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetListServiceInstanceResponseDto' /billing/subscription/dueDateDelay: get: tags: - Subscription summary: ' Returns the due date delay information. ' description: ' Returns the due date delay information. ' operationId: findDueDateDelay_1 parameters: - name: subscriptionCode in: query description: ' subscriptionCode - required ' schema: type: string - name: invoiceNumber in: query description: ' invoiceNumber - invoice number can be null ' schema: type: string - name: invoiceTypeCode in: query description: ' invoiceTypeCode - can be null ' schema: type: string - name: orderCode in: query description: ' orderCode - can be null ' schema: type: string responses: default: description: ' list of due date delay ' content: application/json: schema: $ref: '#/components/schemas/GetDueDateDelayResponseDto' application/xml: schema: $ref: '#/components/schemas/GetDueDateDelayResponseDto' /billing/subscription/rate: post: tags: - Subscription summary: ' Give a rate data for subscription ' description: ' Give a rate data for subscription ' operationId: rate_1 requestBody: description: ' postData post data ' content: application/json: schema: $ref: '#/components/schemas/RateSubscriptionRequestDto' application/xml: schema: $ref: '#/components/schemas/RateSubscriptionRequestDto' responses: default: description: ' list of service instances ' content: application/json: schema: $ref: '#/components/schemas/RateSubscriptionResponseDto' application/xml: schema: $ref: '#/components/schemas/RateSubscriptionResponseDto' /billing/subscription/activateForCustomer: post: tags: - Subscription summary: ' Activate a given Subscription for a customer. ' description: ' Activate a given Subscription for a customer. ' operationId: activateForCustomer_1 requestBody: description: ' postData the post data ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionForCustomerRequestDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionForCustomerRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionForCustomerResponseDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionForCustomerResponseDto' /billing/subscription/cancelSubscriptionRenewal/{subscriptionCode}: post: tags: - Subscription summary: ' Cancels the renewal term of an active subscription. ' description: ' Cancels the renewal term of an active subscription. ' operationId: cancelSubscriptionRenewal_1 parameters: - name: subscriptionCode in: path description: ' subscriptionCode code of the subscription ' required: true schema: type: string responses: default: description: ' status of the request ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/subscribeAndActivateServices: post: tags: - Subscription summary: ' Create a subscription and activate services in a single transaction. ' description: ' Create a subscription and activate services in a single transaction. ' operationId: subscribeAndActivateServices_1 requestBody: description: ' postData Subscription and services to activate data ' content: application/json: schema: $ref: '#/components/schemas/SubscriptionAndServicesToActivateRequestDto' application/xml: schema: $ref: '#/components/schemas/SubscriptionAndServicesToActivateRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/subscription/version: get: tags: - Subscription summary: ' Get version of application ' description: ' Get version of application ' operationId: index_40 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/template: get: tags: - Wallet summary: ' Search for a wallet template with a given code ' description: ' Search for a wallet template with a given code ' operationId: findWalletTemplate_1 parameters: - name: walletTemplateCode in: query description: ' walletTemplateCode The wallet template''s code ' schema: type: string responses: default: description: ' A wallet template ' content: application/json: schema: $ref: '#/components/schemas/GetWalletTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetWalletTemplateResponseDto' put: tags: - Wallet summary: ' Update an existing wallet template ' description: ' Update an existing wallet template ' operationId: updateWalletTemplate_1 requestBody: description: ' postData The wallet template''s data ' content: application/json: schema: $ref: '#/components/schemas/WalletTemplateDto' application/xml: schema: $ref: '#/components/schemas/WalletTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Wallet summary: ' Create a new wallet template ' description: ' Create a new wallet template ' operationId: createWalletTemplate_1 requestBody: description: ' postData The wallet template''s data ' content: application/json: schema: $ref: '#/components/schemas/WalletTemplateDto' application/xml: schema: $ref: '#/components/schemas/WalletTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/template/{walletTemplateCode}: delete: tags: - Wallet summary: ' Remove an existing wallet template with a given code ' description: ' Remove an existing wallet template with a given code ' operationId: removeWalletTemplate_1 parameters: - name: walletTemplateCode in: path description: ' walletTemplateCode The wallet template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/balance/current: post: tags: - Wallet summary: ' Gets the current (open or reserved) wallet balance amount at a given level and date period. In wallet operation, status=''OPEN OR RESERVED''. ' description: ' Gets the current (open or reserved) wallet balance amount at a given level and date period. In wallet operation, status=''OPEN OR RESERVED''. ' operationId: currentBalance_1 requestBody: description: ' calculateParameters Wallet balance calculation eters ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceDto' responses: default: description: ' Request processing status and balance amounts ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' /billing/wallet/balance/reserved: post: tags: - Wallet summary: ' Gets the reserved wallet balance amount at a given level and date period. In wallet operation, status=''RESERVED''. ' description: ' Gets the reserved wallet balance amount at a given level and date period. In wallet operation, status=''RESERVED''. ' operationId: reservedBalance_1 requestBody: description: ' calculateParameters Wallet balance calculation eters ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceDto' responses: default: description: ' Request processing status and balance amounts ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' /billing/wallet/balance/open: post: tags: - Wallet summary: ' Gets the open wallet balance amount at a given level and date period. In wallet operation, status=''OPEN''. ' description: ' Gets the open wallet balance amount at a given level and date period. In wallet operation, status=''OPEN''. ' operationId: openBalance_1 requestBody: description: ' calculateParameters Wallet balance calculation eters ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceDto' responses: default: description: ' Request processing status and balance amounts status ' content: application/json: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' application/xml: schema: $ref: '#/components/schemas/WalletBalanceResponseDto' /billing/wallet/reservation: put: tags: - Wallet summary: ' Updates a reservation. Same as create we just need to pass the id of the reservation. ' description: ' Updates a reservation. Same as create we just need to pass the id of the reservation. ' operationId: updateReservation_1 requestBody: description: ' postData The reservation''s data ' content: application/json: schema: $ref: '#/components/schemas/WalletReservationDto' application/xml: schema: $ref: '#/components/schemas/WalletReservationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Wallet summary: ' Create reservation for a given offer, user account, seller, provider and date. ' description: ' Create reservation for a given offer, user account, seller, provider and date. ' operationId: createReservation_1 requestBody: description: ' postData The reservation''s data ' content: application/json: schema: $ref: '#/components/schemas/WalletReservationDto' application/xml: schema: $ref: '#/components/schemas/WalletReservationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/reservation/{reservationId}: delete: tags: - Wallet summary: ' Cancel a reservation given an id. ' description: ' Cancel a reservation given an id. ' operationId: cancelReservation parameters: - name: reservationId in: path description: ' reservationId The reservation''s id ' required: true schema: type: integer format: int64 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/reservation/confirm: post: tags: - Wallet summary: ' Confirm a reservation given an id. ' description: ' Confirm a reservation given an id. ' operationId: confirmReservation requestBody: description: ' postData The reservation''s id ' content: application/json: schema: $ref: '#/components/schemas/WalletReservationDto' application/xml: schema: $ref: '#/components/schemas/WalletReservationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/operation: post: tags: - Wallet summary: ' Create a new operation ' description: ' Create a new operation ' operationId: createOperation_1 requestBody: description: ' postData The operation''s data ' content: application/json: schema: $ref: '#/components/schemas/WalletOperationDto' application/xml: schema: $ref: '#/components/schemas/WalletOperationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/operation/find: post: tags: - Wallet summary: ' Search for an operation with a given (example) code. Deprecated in v.4.7.2 ' description: ' Search for an operation with a given (example) code. Deprecated in v.4.7.2 ' operationId: findOperations_1 parameters: - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING requestBody: content: application/json: schema: $ref: '#/components/schemas/FindWalletOperationsDto' application/xml: schema: $ref: '#/components/schemas/FindWalletOperationsDto' responses: default: description: ' List of wallet operations ' content: application/json: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' deprecated: true /billing/wallet/operation/list: get: tags: - Wallet summary: ' List wallet operations matching a given criteria ' description: ' List wallet operations matching a given criteria ' operationId: listOperationsGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: withRTs in: query schema: type: boolean default: false responses: default: description: ' List of wallet operations ' content: application/json: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' post: tags: - Wallet summary: ' List wallet operations matching a given criteria ' description: ' List wallet operations matching a given criteria ' operationId: listOperationsPost_1 parameters: - name: withRTs in: query schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of wallet operations ' content: application/json: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/FindWalletOperationsResponseDto' /billing/wallet/template/createOrUpdate: post: tags: - Wallet summary: ' Create new or update an existing wallet template ' description: ' Create new or update an existing wallet template ' operationId: createOrUpdateWalletTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/WalletTemplateDto' application/xml: schema: $ref: '#/components/schemas/WalletTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /billing/wallet/version: get: tags: - Wallet summary: ' Get version of application ' description: ' Get version of application ' operationId: index_32 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessOfferModel/install: put: tags: - BusinessOfferModel summary: ' Install business offer model module. ' description: ' Install business offer model module. ' operationId: install_4 requestBody: description: ' moduleDto business offer model ' content: application/json: schema: $ref: '#/components/schemas/BusinessOfferModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessOfferModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessOfferModel/createOrUpdate: post: tags: - BusinessOfferModel summary: ' Create new or update an existing business offer model. ' description: ' Create new or update an existing business offer model. ' operationId: createOrUpdate_47 requestBody: description: ' postData The business offer model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessOfferModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessOfferModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessOfferModel/list: get: tags: - BusinessOfferModel summary: ' List business offer models. ' description: ' List business offer models. ' operationId: listGet_9 parameters: - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' A list of business offer models ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' post: tags: - BusinessOfferModel summary: ' List business offer models. ' description: ' List business offer models. ' operationId: listPost_9 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' A list of business offer models ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' /catalog/businessOfferModel/{businessOfferModelCode}: delete: tags: - BusinessOfferModel summary: ' Remove an existing business offer model with a given code. ' description: ' Remove an existing business offer model with a given code. ' operationId: remove_42 parameters: - name: businessOfferModelCode in: path description: ' businessOfferModelCode The business offer model''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessOfferModel: get: tags: - BusinessOfferModel summary: ' Remove an existing business offer model with a given code. ' description: ' Remove an existing business offer model with a given code. ' operationId: find_47 parameters: - name: businessOfferModelCode in: query description: ' businessOfferModelCode The business offer model''s code ' schema: type: string - name: loadOfferServiceTemplate in: query description: ' loadOfferServiceTemplate if true loads the services ' schema: type: boolean default: false - name: loadOfferProductTemplate in: query description: ' loadOfferProductTemplate if true loads the products ' schema: type: boolean default: false - name: loadServiceChargeTemplate in: query description: ' loadServiceChargeTemplate if true load the service charges ' schema: type: boolean default: false - name: loadProductChargeTemplate in: query description: ' loadProductChargeTemplate if true load the product charges ' schema: type: boolean default: false responses: default: description: ' A business offer model ' content: application/json: schema: $ref: '#/components/schemas/GetBusinessOfferModelResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBusinessOfferModelResponseDto' put: tags: - BusinessOfferModel summary: ' Update an existing business offer model. ' description: ' Update an existing business offer model. ' operationId: update_47 requestBody: description: ' postData The business offer model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessOfferModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessOfferModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BusinessOfferModel summary: ' Create a new business offer model. ' description: ' Create a new business offer model. ' operationId: create_47 requestBody: description: ' postData The business offer model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessOfferModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessOfferModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessOfferModel/version: get: tags: - BusinessOfferModel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_60 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessProductModel/install: put: tags: - BusinessProductModel summary: ' Install business product model module ' description: ' Install business product model module ' operationId: install requestBody: description: ' moduleDto business product model ' content: application/json: schema: $ref: '#/components/schemas/BusinessProductModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessProductModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessProductModel/createOrUpdate: post: tags: - BusinessProductModel summary: ' Create new or update an existing business product model ' description: ' Create new or update an existing business product model ' operationId: createOrUpdate_31 requestBody: description: ' postData The business product model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessProductModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessProductModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessProductModel/{businessProductModelCode}: delete: tags: - BusinessProductModel summary: ' Remove an existing business product model with a given code ' description: ' Remove an existing business product model with a given code ' operationId: remove_27 parameters: - name: businessProductModelCode in: path description: ' businessProductModelCode The business product model''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessProductModel: get: tags: - BusinessProductModel summary: ' Remove an existing business product model with a given code ' description: ' Remove an existing business product model with a given code ' operationId: find_29 parameters: - name: businessProductModelCode in: query description: ' businessProductModelCode The business product model''s code ' schema: type: string responses: default: description: ' A business product model ' content: application/json: schema: $ref: '#/components/schemas/GetBusinessProductModelResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBusinessProductModelResponseDto' put: tags: - BusinessProductModel summary: ' Update an existing business product model ' description: ' Update an existing business product model ' operationId: update_31 requestBody: description: ' postData The business product model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessProductModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessProductModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BusinessProductModel summary: ' Create a new business product model ' description: ' Create a new business product model ' operationId: create_31 requestBody: description: ' postData The business product model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessProductModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessProductModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessProductModel/list: get: tags: - BusinessProductModel summary: ' List business product models ' description: ' List business product models ' operationId: list_20 responses: default: description: ' A list of business product models ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' /catalog/businessProductModel/version: get: tags: - BusinessProductModel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_42 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessServiceModel/install: put: tags: - BusinessServiceModel summary: ' Install business offer model module ' description: ' Install business offer model module ' operationId: install_2 requestBody: description: ' moduleDto The business service model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessServiceModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessServiceModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessServiceModel/createOrUpdate: post: tags: - BusinessServiceModel summary: ' Create new or update an existing business service model ' description: ' Create new or update an existing business service model ' operationId: createOrUpdate_33 requestBody: description: ' postData The business service model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessServiceModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessServiceModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessServiceModel/{businessServiceModelCode}: delete: tags: - BusinessServiceModel summary: ' Remove an existing business service model with a given code ' description: ' Remove an existing business service model with a given code ' operationId: remove_30 parameters: - name: businessServiceModelCode in: path description: ' businessServiceModelCode The business service model''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessServiceModel: get: tags: - BusinessServiceModel summary: ' Search for a business service model with a given code ' description: ' Search for a business service model with a given code ' operationId: find_32 parameters: - name: businessServiceModelCode in: query description: ' businessServiceModelCode The business service model''s code ' schema: type: string responses: default: description: ' A business servie model ' content: application/json: schema: $ref: '#/components/schemas/GetBusinessServiceModelResponseDto' application/xml: schema: $ref: '#/components/schemas/GetBusinessServiceModelResponseDto' put: tags: - BusinessServiceModel summary: ' Update an existing business service model ' description: ' Update an existing business service model ' operationId: update_33 requestBody: description: ' postData The business service model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessServiceModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessServiceModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - BusinessServiceModel summary: ' Create a new business service model ' description: ' Create a new business service model ' operationId: create_33 requestBody: description: ' postData The business service model''s data ' content: application/json: schema: $ref: '#/components/schemas/BusinessServiceModelDto' application/xml: schema: $ref: '#/components/schemas/BusinessServiceModelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/businessServiceModel/list: get: tags: - BusinessServiceModel summary: ' List business service model ' description: ' List business service model ' operationId: list_13 responses: default: description: ' A list of business service models ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' /catalog/businessServiceModel/version: get: tags: - BusinessServiceModel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_44 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channel/createOrUpdate: post: tags: - Channel summary: ' Create new or update an existing channel ' description: ' Create new or update an existing channel ' operationId: createOrUpdate_34 requestBody: description: ' postData The channel''s data ' content: application/json: schema: $ref: '#/components/schemas/ChannelDto' application/xml: schema: $ref: '#/components/schemas/ChannelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channel: get: tags: - Channel summary: ' Search for a channel with a given code ' description: ' Search for a channel with a given code ' operationId: find_33 parameters: - name: channelCode in: query description: ' channelCode The channel''s code ' schema: type: string responses: default: description: ' A channel ' content: application/json: schema: $ref: '#/components/schemas/GetChannelResponseDto' application/xml: schema: $ref: '#/components/schemas/GetChannelResponseDto' put: tags: - Channel summary: ' Update an existing channel ' description: ' Update an existing channel ' operationId: update_34 requestBody: description: ' postData The channel''s data ' content: application/json: schema: $ref: '#/components/schemas/ChannelDto' application/xml: schema: $ref: '#/components/schemas/ChannelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Channel summary: ' Create a new channel ' description: ' Create a new channel ' operationId: create_34 requestBody: description: ' postData The channel''s data ' content: application/json: schema: $ref: '#/components/schemas/ChannelDto' application/xml: schema: $ref: '#/components/schemas/ChannelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - Channel summary: ' Remove an existing channel with a given code ' description: ' Remove an existing channel with a given code ' operationId: delete_2 parameters: - name: channelCode in: query description: ' channelCode The channel''s code ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channel/{code}/enable: post: tags: - Channel summary: ' Enable a Channel with a given code ' description: ' Enable a Channel with a given code ' operationId: enable_18 parameters: - name: code in: path description: ' code Channel code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channel/{code}/disable: post: tags: - Channel summary: ' Disable a Channel with a given code ' description: ' Disable a Channel with a given code ' operationId: disable_18 parameters: - name: code in: path description: ' code Channel code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channel/version: get: tags: - Channel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_45 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/channelsAndSegments: get: tags: - ChannelsAndSegments summary: ' Returns all the active channels list ' description: ' Returns all the active channels list ' operationId: list_15 parameters: - name: active in: query schema: type: boolean responses: default: description: ' A channel list ' content: application/json: schema: $ref: '#/components/schemas/GetListChannelsAndSegmentsResponseDto' application/xml: schema: $ref: '#/components/schemas/GetListChannelsAndSegmentsResponseDto' /catalog/channelsAndSegments/version: get: tags: - ChannelsAndSegments summary: ' Get version of application ' description: ' Get version of application ' operationId: index_46 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/chargeTemplate: get: tags: - ChargeTemplate summary: ' Search for a charge template with a given code ' description: ' Search for a charge template with a given code ' operationId: find_34 parameters: - name: chargeTemplateCode in: query description: ' chargeTemplateCode The charge template''s code ' schema: type: string responses: default: description: ' A charge template ' content: application/json: schema: $ref: '#/components/schemas/GetChargeTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetChargeTemplateResponseDto' /catalog/chargeTemplate/version: get: tags: - ChargeTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_47 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate/createOrUpdate: post: tags: - CounterTemplate summary: ' Create or update a counter Template. ' description: ' Create or update a counter Template. ' operationId: createOrUpdate_35 requestBody: description: ' postData counter template ' content: application/json: schema: $ref: '#/components/schemas/CounterTemplateDto' application/xml: schema: $ref: '#/components/schemas/CounterTemplateDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate/{counterTemplateCode}: delete: tags: - CounterTemplate summary: ' Remove counter template with a given code. ' description: ' Remove counter template with a given code. ' operationId: remove_31 parameters: - name: counterTemplateCode in: path description: ' counterTemplateCode counter template''s code ' required: true schema: type: string responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate: get: tags: - CounterTemplate summary: ' Search counter template with a given code. ' description: ' Search counter template with a given code. ' operationId: find_35 parameters: - name: counterTemplateCode in: query description: ' counterTemplateCode counter temlate''s code ' schema: type: string responses: default: description: ' counter template ' content: application/json: schema: $ref: '#/components/schemas/GetCounterTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetCounterTemplateResponseDto' put: tags: - CounterTemplate summary: ' Update counter template. ' description: ' Update counter template. ' operationId: update_35 requestBody: description: ' postData counter template ' content: application/json: schema: $ref: '#/components/schemas/CounterTemplateDto' application/xml: schema: $ref: '#/components/schemas/CounterTemplateDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CounterTemplate summary: ' Create counter template. ' description: ' Create counter template. ' operationId: create_35 requestBody: description: ' postData counter template ' content: application/json: schema: $ref: '#/components/schemas/CounterTemplateDto' application/xml: schema: $ref: '#/components/schemas/CounterTemplateDto' responses: default: description: ' action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate/{code}/enable: post: tags: - CounterTemplate summary: ' Enable a Counter template with a given code ' description: ' Enable a Counter template with a given code ' operationId: enable_5 parameters: - name: code in: path description: ' code Counter template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate/{code}/disable: post: tags: - CounterTemplate summary: ' Disable a Counter template with a given code ' description: ' Disable a Counter template with a given code ' operationId: disable_5 parameters: - name: code in: path description: ' code Counter template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/counterTemplate/version: get: tags: - CounterTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_48 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem/createOrUpdate: post: tags: - DiscountPlanItem summary: ' create/update a discount plan item. ' description: ' create/update a discount plan item. ' operationId: createOrUpdate_36 requestBody: description: ' postData discount plan item ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanItemDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanItemDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem/{discountPlanItemCode}: delete: tags: - DiscountPlanItem summary: ' remove a discount plan item by code. ' description: ' remove a discount plan item by code. ' operationId: remove_32 parameters: - name: discountPlanItemCode in: path description: ' discountPlanItemCode discount plan item ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem: get: tags: - DiscountPlanItem summary: ' Find a discount plan item with a given code. ' description: ' Find a discount plan item with a given code. ' operationId: find_36 parameters: - name: discountPlanItemCode in: query description: ' discountPlanItemCode A discount plan item''s code ' schema: type: string responses: default: description: ' A discount plan item ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanItemResponseDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanItemResponseDto' put: tags: - DiscountPlanItem summary: ' update an existed discount plan item. ' description: ' update an existed discount plan item. ' operationId: update_36 requestBody: description: ' postData A discount plan item''s data ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanItemDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanItemDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - DiscountPlanItem summary: ' Create a new discount plan item. ' description: ' Create a new discount plan item. ' operationId: create_36 requestBody: description: ' postData A discount plan item''s data ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanItemDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanItemDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem/list: get: tags: - DiscountPlanItem summary: ' List all discount plan items by current user. ' description: ' List all discount plan items by current user. ' operationId: list_16 responses: default: description: ' List of discount plan items ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanItemsResponseDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanItemsResponseDto' /catalog/discountPlanItem/{code}/enable: post: tags: - DiscountPlanItem summary: ' Enable a Discount plan item with a given code ' description: ' Enable a Discount plan item with a given code ' operationId: enable_8 parameters: - name: code in: path description: ' code Discount plan item code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem/{code}/disable: post: tags: - DiscountPlanItem summary: ' Disable a Discount plan item with a given code ' description: ' Disable a Discount plan item with a given code ' operationId: disable_8 parameters: - name: code in: path description: ' code Discount plan item code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlanItem/version: get: tags: - DiscountPlanItem summary: ' Get version of application ' description: ' Get version of application ' operationId: index_49 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlan/createOrUpdate: post: tags: - DiscountPlan summary: ' Create new or update an existing discount plan ' description: ' Create new or update an existing discount plan ' operationId: createOrUpdate_37 requestBody: description: ' postData The discount plan''s data ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlan: get: tags: - DiscountPlan summary: ' Find a discount plan with a given code ' description: ' Find a discount plan with a given code ' operationId: find_37 parameters: - name: discountPlanCode in: query description: ' discountPlanCode The discount plan''s code ' schema: type: string responses: default: description: ' Return discount plan ' content: application/json: schema: $ref: '#/components/schemas/GetDiscountPlanResponseDto' application/xml: schema: $ref: '#/components/schemas/GetDiscountPlanResponseDto' put: tags: - DiscountPlan summary: ' Update an existing discount plan ' description: ' Update an existing discount plan ' operationId: update_37 requestBody: description: ' postData The discount plan''s data ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - DiscountPlan summary: ' Create a new discount plan ' description: ' Create a new discount plan ' operationId: create_37 requestBody: description: ' postData The discount plan''s data ' content: application/json: schema: $ref: '#/components/schemas/DiscountPlanDto' application/xml: schema: $ref: '#/components/schemas/DiscountPlanDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - DiscountPlan summary: ' Remove an existing discount plan with a given code ' description: ' Remove an existing discount plan with a given code ' operationId: remove_33 parameters: - name: discountPlanCode in: query description: ' discountPlanCode The discount plan''s code ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlan/list: get: tags: - DiscountPlan summary: ' List discount plan ' description: ' List discount plan ' operationId: list_17 responses: default: description: ' A list of discount plans ' content: application/json: schema: $ref: '#/components/schemas/GetDiscountPlansResponseDto' application/xml: schema: $ref: '#/components/schemas/GetDiscountPlansResponseDto' /catalog/discountPlan/{code}/enable: post: tags: - DiscountPlan summary: ' Enable a Discount plan with a given code ' description: ' Enable a Discount plan with a given code ' operationId: enable_9 parameters: - name: code in: path description: ' code Discount plan code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlan/{code}/disable: post: tags: - DiscountPlan summary: ' Disable a Discount plan with a given code ' description: ' Disable a Discount plan with a given code ' operationId: disable_9 parameters: - name: code in: path description: ' code Discount plan code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/discountPlan/version: get: tags: - DiscountPlan summary: ' Get version of application ' description: ' Get version of application ' operationId: index_50 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplateCategory/createOrUpdate: post: tags: - OfferTemplateCategory summary: ' Create new or update an existing offer template category ' description: ' Create new or update an existing offer template category ' operationId: createOrUpdate_38 requestBody: description: ' postData The offer template category''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplateCategory: get: tags: - OfferTemplateCategory summary: ' Find a offer template category with a given code ' description: ' Find a offer template category with a given code ' operationId: find_38 parameters: - name: offerTemplateCategoryCode in: query description: ' offerTemplateCategoryCode The offer template category''s code ' schema: type: string responses: default: description: ' Return offerTemplateCategoryCodeDto containing offerTemplateCategoryCode ' content: application/json: schema: $ref: '#/components/schemas/GetOfferTemplateCategoryResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOfferTemplateCategoryResponseDto' put: tags: - OfferTemplateCategory summary: ' Update an existing offer template category ' description: ' Update an existing offer template category ' operationId: update_38 requestBody: description: ' postData The offer template category''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - OfferTemplateCategory summary: ' Create a new offer template category ' description: ' Create a new offer template category ' operationId: create_38 requestBody: description: ' postData The offer template category''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - OfferTemplateCategory summary: ' Remove an existing offer template category with a given code ' description: ' Remove an existing offer template category with a given code ' operationId: delete parameters: - name: offerTemplateCategoryCode in: query description: ' offerTemplateCategoryCode The offer template category''s code ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplateCategory/{code}/enable: post: tags: - OfferTemplateCategory summary: ' Enable a Offer template category with a given code ' description: ' Enable a Offer template category with a given code ' operationId: enable_10 parameters: - name: code in: path description: ' code Offer template category code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplateCategory/{code}/disable: post: tags: - OfferTemplateCategory summary: ' Disable a Offer template category with a given code ' description: ' Disable a Offer template category with a given code ' operationId: disable_10 parameters: - name: code in: path description: ' code Offer template category code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplateCategory/version: get: tags: - OfferTemplateCategory summary: ' Get version of application ' description: ' Get version of application ' operationId: index_51 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate/createOrUpdate: post: tags: - OfferTemplate summary: ' Create or update offer template based on a given code. ' description: ' Create or update offer template based on a given code. ' operationId: createOrUpdate_39 requestBody: description: ' postData The offer template''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate/list: get: tags: - OfferTemplate summary: ' List Offer templates matching filtering and query criteria or code and validity dates' description: ' List Offer templates matching filtering and query criteria or code and validity dates. If neither date is provided, validity dates will not be considered. If only validFrom is provided, a search will return offers valid on a given date. If only validTo date is provided, a search will return offers valid from today to a given date. ' operationId: listGet_3 parameters: - name: offerTemplateCode in: query description: ' code Offer template code for optional filtering. Deprecated in v. 4.8. Use query instead. ' schema: type: string - name: validFrom in: query description: ' validFrom Validity range from date. Deprecated in v. 4.8. Use query instead. ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Validity range to date. Deprecated in v. 4.8. Use query instead. ' schema: type: string format: date-time - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' A list of offer templates ' content: application/json: schema: $ref: '#/components/schemas/GetListOfferTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetListOfferTemplateResponseDto' post: tags: - OfferTemplate summary: ' List offerTemplates matching a given criteria ' description: ' List offerTemplates matching a given criteria ' operationId: listPost_3 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of offer templates ' content: application/json: schema: $ref: '#/components/schemas/GetListOfferTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetListOfferTemplateResponseDto' /catalog/offerTemplate/{offerTemplateCode}: delete: tags: - OfferTemplate summary: ' Remove offer template with a given code and validity dates' description: ' 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. ' operationId: remove_34 parameters: - name: offerTemplateCode in: path description: ' offerTemplateCode The offer template''s code ' required: true schema: type: string - name: validFrom in: query description: ' validFrom Offer template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Offer template validity range - to date ' schema: type: string format: date-time responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate: get: tags: - OfferTemplate summary: ' Search offer template with a given code and validity dates' description: ' Search 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 returned. ' operationId: find_39 parameters: - name: offerTemplateCode in: query description: ' offerTemplateCode The offer template''s code ' schema: type: string - name: validFrom in: query description: ' validFrom Offer template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Offer template validity range - to date ' schema: type: string format: date-time - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE - name: loadOfferServiceTemplate in: query description: ' loadOfferServiceTemplate if true loads the services ' schema: type: boolean default: false - name: loadOfferProductTemplate in: query description: ' loadOfferProductTemplate if true loads the products ' schema: type: boolean default: false - name: loadServiceChargeTemplate in: query description: ' loadServiceChargeTemplate if true load the service charges ' schema: type: boolean default: false - name: loadProductChargeTemplate in: query description: ' loadProductChargeTemplate if true load the product charges ' schema: type: boolean default: false - name: loadAllowedDiscountPlan in: query description: ' loadAllowedDiscountPlan if true load the allowed discount plan ' schema: type: boolean default: false responses: default: description: ' Return offerTemplateDto containing offerTemplate ' content: application/json: schema: $ref: '#/components/schemas/GetOfferTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOfferTemplateResponseDto' put: tags: - OfferTemplate summary: ' Update offer template. ' description: ' Update offer template. ' operationId: update_39 requestBody: description: ' postData The offer template''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - OfferTemplate summary: ' Create offer template. ' description: ' Create offer template. ' operationId: create_39 requestBody: description: ' postData The offer template''s data ' content: application/json: schema: $ref: '#/components/schemas/OfferTemplateDto' application/xml: schema: $ref: '#/components/schemas/OfferTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate/{code}/enable: post: tags: - OfferTemplate summary: ' Enable a Offer template with a given code ' description: ' Enable a Offer template with a given code ' operationId: enable_11 parameters: - name: code in: path description: ' code Offer template code ' required: true schema: type: string - name: validFrom in: query description: ' validFrom Offer template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Offer template validity range - to date ' schema: type: string format: date-time responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate/{code}/disable: post: tags: - OfferTemplate summary: ' Disable a Offer template with a given code ' description: ' Disable a Offer template with a given code ' operationId: disable_11 parameters: - name: code in: path description: ' code Offer template code ' required: true schema: type: string - name: validFrom in: query description: ' validFrom Offer template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Offer template validity range - to date ' schema: type: string format: date-time responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/offerTemplate/version: get: tags: - OfferTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_52 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate/createOrUpdate: post: tags: - OneShotChargeTemplate summary: ' Create new or update an existing. ' description: ' Create new or update an existing. ' operationId: createOrUpdate_40 requestBody: description: ' postData The exemple''s data ' content: application/json: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate/list: get: tags: - OneShotChargeTemplate summary: ' List one shot charge template with the following filters. ' description: ' List one shot charge template with the following filters. ' operationId: listOneShotChargeTemplates_1 parameters: - name: languageCode in: query description: ' languageCode language''s code ' schema: type: string - name: countryCode in: query description: ' countryCode country''s code ' schema: type: string - name: currencyCode in: query description: ' currencyCode currency''s code ' schema: type: string - name: sellerCode in: query description: ' sellerCode seller''s code ' schema: type: string - name: date in: query description: ' date application date ' schema: type: string format: date-time responses: default: description: ' list of one shot charge template ' content: application/json: schema: $ref: '#/components/schemas/OneShotChargeTemplateWithPriceListDto' application/xml: schema: $ref: '#/components/schemas/OneShotChargeTemplateWithPriceListDto' /catalog/oneShotChargeTemplate/{oneShotChargeTemplateCode}: delete: tags: - OneShotChargeTemplate summary: ' Remove one shot charge tesmplate with a given code. ' description: ' Remove one shot charge tesmplate with a given code. ' operationId: remove_35 parameters: - name: oneShotChargeTemplateCode in: path description: ' oneShotChargeTemplateCode The one shot charge template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate: get: tags: - OneShotChargeTemplate summary: ' Search one shot charge templatewith a given code. ' description: ' Search one shot charge templatewith a given code. ' operationId: find_40 parameters: - name: oneShotChargeTemplateCode in: query description: ' oneShotChargeTemplateCode The one shot charge template''s code ' schema: type: string responses: default: description: ' one shot charge template ' content: application/json: schema: $ref: '#/components/schemas/GetOneShotChargeTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetOneShotChargeTemplateResponseDto' put: tags: - OneShotChargeTemplate summary: ' Update one shot charge template. ' description: ' Update one shot charge template. ' operationId: update_40 requestBody: description: ' postData The one shot charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - OneShotChargeTemplate summary: ' Create one shot charge template. ' description: ' Create one shot charge template. ' operationId: create_40 requestBody: description: ' postData The one shot charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/OneShotChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate/{code}/enable: post: tags: - OneShotChargeTemplate summary: ' Enable a One shot charge template with a given code ' description: ' Enable a One shot charge template with a given code ' operationId: enable_12 parameters: - name: code in: path description: ' code One shot charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate/{code}/disable: post: tags: - OneShotChargeTemplate summary: ' Disable a One shot charge template with a given code ' description: ' Disable a One shot charge template with a given code ' operationId: disable_12 parameters: - name: code in: path description: ' code One shot charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/oneShotChargeTemplate/version: get: tags: - OneShotChargeTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_53 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan/createOrUpdate: post: tags: - PricePlan summary: ' Create new or update an existing price plan matrix ' description: ' Create new or update an existing price plan matrix ' operationId: createOrUpdate_41 requestBody: description: ' postData The price plan matrix''s data ' content: application/json: schema: $ref: '#/components/schemas/PricePlanMatrixDto' application/xml: schema: $ref: '#/components/schemas/PricePlanMatrixDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan/list: get: tags: - PricePlan summary: ' List price plan matrix. ' description: ' List price plan matrix. ' operationId: listPricePlanByEventCode_1 parameters: - name: eventCode in: query description: ' eventCode The charge''s code linked to price plan. ' schema: type: string responses: default: description: ' Return pricePlanMatrixes ' content: application/json: schema: $ref: '#/components/schemas/PricePlanMatrixesResponseDto' application/xml: schema: $ref: '#/components/schemas/PricePlanMatrixesResponseDto' /catalog/pricePlan/{pricePlanCode}: delete: tags: - PricePlan summary: ' Remove an existing price plan matrix with a given code ' description: ' Remove an existing price plan matrix with a given code ' operationId: remove_36 parameters: - name: pricePlanCode in: path description: ' pricePlanCode The price plan''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan: get: tags: - PricePlan summary: ' Find a price plan matrix with a given code ' description: ' Find a price plan matrix with a given code ' operationId: find_41 parameters: - name: pricePlanCode in: query description: ' pricePlanCode The price plan''s code ' schema: type: string responses: default: description: ' pricePlanMatrixDto Returns pricePlanMatrixDto containing pricePlan ' content: application/json: schema: $ref: '#/components/schemas/GetPricePlanResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPricePlanResponseDto' put: tags: - PricePlan summary: ' Update an existing price plan matrix ' description: ' Update an existing price plan matrix ' operationId: update_41 requestBody: description: ' postData The price plan matrix''s data ' content: application/json: schema: $ref: '#/components/schemas/PricePlanMatrixDto' application/xml: schema: $ref: '#/components/schemas/PricePlanMatrixDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - PricePlan summary: ' Create a new price plan matrix ' description: ' Create a new price plan matrix ' operationId: create_41 requestBody: description: ' postData The price plan matrix''s data ' content: application/json: schema: $ref: '#/components/schemas/PricePlanMatrixDto' application/xml: schema: $ref: '#/components/schemas/PricePlanMatrixDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan/{code}/enable: post: tags: - PricePlan summary: ' Enable a Price plan with a given code ' description: ' Enable a Price plan with a given code ' operationId: enable_13 parameters: - name: code in: path description: ' code Price plan code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan/{code}/disable: post: tags: - PricePlan summary: ' Disable a Price plan with a given code ' description: ' Disable a Price plan with a given code ' operationId: disable_13 parameters: - name: code in: path description: ' code Price plan code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/pricePlan/version: get: tags: - PricePlan summary: ' Get version of application ' description: ' Get version of application ' operationId: index_54 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate/createOrUpdate: post: tags: - RecurringChargeTemplate summary: ' Create new or update an existing recurring charge template ' description: ' Create new or update an existing recurring charge template ' operationId: createOrUpdate_42 requestBody: description: ' postData The recurring charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate/{recurringChargeTemplateCode}: delete: tags: - RecurringChargeTemplate summary: ' Remove an existing recurring charge template with a given code. ' description: ' Remove an existing recurring charge template with a given code. ' operationId: remove_37 parameters: - name: recurringChargeTemplateCode in: path description: ' recurringChargeTemplateCode The recurring charge template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate: get: tags: - RecurringChargeTemplate summary: ' Find a recurring charge template with a given code. ' description: ' Find a recurring charge template with a given code. ' operationId: find_42 parameters: - name: recurringChargeTemplateCode in: query description: ' recurringChargeTemplateCode The recurring charge template''s code ' schema: type: string responses: default: description: ' Return a recurringChargeTemplate ' content: application/json: schema: $ref: '#/components/schemas/GetRecurringChargeTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetRecurringChargeTemplateResponseDto' put: tags: - RecurringChargeTemplate summary: ' Update an existing recurring charge template. ' description: ' Update an existing recurring charge template. ' operationId: update_42 requestBody: description: ' postData The recurring charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - RecurringChargeTemplate summary: ' Create a new recurring charge template. ' description: ' Create a new recurring charge template. ' operationId: create_42 requestBody: description: ' postData The recurring charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/RecurringChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate/{code}/enable: post: tags: - RecurringChargeTemplate summary: ' Enable a Recurring charge template with a given code ' description: ' Enable a Recurring charge template with a given code ' operationId: enable_14 parameters: - name: code in: path description: ' code Recurring charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate/{code}/disable: post: tags: - RecurringChargeTemplate summary: ' Disable a Recurring charge template with a given code ' description: ' Disable a Recurring charge template with a given code ' operationId: disable_14 parameters: - name: code in: path description: ' code Recurring charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/recurringChargeTemplate/version: get: tags: - RecurringChargeTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_55 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate/createOrUpdate: post: tags: - ServiceTemplate summary: ' Create new or update an existing service template ' description: ' Create new or update an existing service template ' operationId: createOrUpdate_43 requestBody: description: ' postData The service template''s data ' content: application/json: schema: $ref: '#/components/schemas/ServiceTemplateDto' application/xml: schema: $ref: '#/components/schemas/ServiceTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate/{serviceTemplateCode}: delete: tags: - ServiceTemplate summary: ' Remove service template with a given code. ' description: ' Remove service template with a given code. ' operationId: remove_38 parameters: - name: serviceTemplateCode in: path description: ' serviceTemplateCode The service template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate: get: tags: - ServiceTemplate summary: ' Find a service template with a given code. ' description: ' Find a service template with a given code. ' operationId: find_43 parameters: - name: serviceTemplateCode in: query description: ' serviceTemplateCode The service template''s code ' schema: type: string - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' Return serviceTemplate ' content: application/json: schema: $ref: '#/components/schemas/GetServiceTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetServiceTemplateResponseDto' put: tags: - ServiceTemplate summary: ' Update an existing service template. ' description: ' Update an existing service template. ' operationId: update_43 requestBody: description: ' postData The service template''s data ' content: application/json: schema: $ref: '#/components/schemas/ServiceTemplateDto' application/xml: schema: $ref: '#/components/schemas/ServiceTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - ServiceTemplate summary: ' Create a new service template. ' description: ' Create a new service template. ' operationId: create_43 requestBody: description: ' postData The service template''s data ' content: application/json: schema: $ref: '#/components/schemas/ServiceTemplateDto' application/xml: schema: $ref: '#/components/schemas/ServiceTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate/list: get: tags: - ServiceTemplate summary: ' Gets a service template list widh . ' description: ' Gets a service template list widh . ' operationId: list_18 requestBody: description: ' pagingAndFiltering PagingAndFiltering config. ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' Return serviceTemplate list ' content: application/json: schema: $ref: '#/components/schemas/GetListServiceTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetListServiceTemplateResponseDto' /catalog/serviceTemplate/{code}/enable: post: tags: - ServiceTemplate summary: ' Enable a Service template with a given code ' description: ' Enable a Service template with a given code ' operationId: enable_15 parameters: - name: code in: path description: ' code Service template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate/{code}/disable: post: tags: - ServiceTemplate summary: ' Disable a Service template with a given code ' description: ' Disable a Service template with a given code ' operationId: disable_15 parameters: - name: code in: path description: ' code Service template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/serviceTemplate/version: get: tags: - ServiceTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_56 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/triggeredEdr/createOrUpdate: post: tags: - TriggeredEdr summary: ' Create new or update an existing triggered edr template ' description: ' Create new or update an existing triggered edr template ' operationId: createOrUpdate_44 requestBody: description: ' postData The triggered edr template''s data ' content: application/json: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' application/xml: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/triggeredEdr/{triggeredEdrCode}: delete: tags: - TriggeredEdr summary: ' Remove an existing triggered edr template with a given code. ' description: ' Remove an existing triggered edr template with a given code. ' operationId: remove_39 parameters: - name: triggeredEdrCode in: path description: ' triggeredEdrCode The triggered edr''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/triggeredEdr: get: tags: - TriggeredEdr summary: ' Find triggered edr with a given code. ' description: ' Find triggered edr with a given code. ' operationId: find_44 parameters: - name: triggeredEdrCode in: query description: ' triggeredEdrCode The triggered edr''s code ' schema: type: string responses: default: description: ' Returns triggeredEdrTemplate ' content: application/json: schema: $ref: '#/components/schemas/GetTriggeredEdrResponseDto' application/xml: schema: $ref: '#/components/schemas/GetTriggeredEdrResponseDto' put: tags: - TriggeredEdr summary: ' Update an existing triggered edr. template ' description: ' Update an existing triggered edr. template ' operationId: update_44 requestBody: description: ' postData The triggered edr. template''s data ' content: application/json: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' application/xml: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - TriggeredEdr summary: ' Create a new triggered edr. template ' description: ' Create a new triggered edr. template ' operationId: create_44 requestBody: description: ' postData The triggered edr. template''s data ' content: application/json: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' application/xml: schema: $ref: '#/components/schemas/TriggeredEdrTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/triggeredEdr/version: get: tags: - TriggeredEdr summary: ' Get version of application ' description: ' Get version of application ' operationId: index_57 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate/createOrUpdate: post: tags: - UsageChargeTemplate summary: ' Create new or update an existing charge template with a given code. ' description: ' Create new or update an existing charge template with a given code. ' operationId: createOrUpdate_45 requestBody: description: ' postData The usage charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate/{usageChargeTemplateCode}: delete: tags: - UsageChargeTemplate summary: ' Remove usage charge template with a given code. ' description: ' Remove usage charge template with a given code. ' operationId: remove_40 parameters: - name: usageChargeTemplateCode in: path description: ' usageChargeTemplateCode The charge template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate: get: tags: - UsageChargeTemplate summary: ' Find an existing usage charge template with a given code. ' description: ' Find an existing usage charge template with a given code. ' operationId: find_45 parameters: - name: usageChargeTemplateCode in: query description: ' usageChargeTemplateCode The charge template''s code ' schema: type: string responses: default: description: ' Returns a usageChargeTemplate ' content: application/json: schema: $ref: '#/components/schemas/GetUsageChargeTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/GetUsageChargeTemplateResponseDto' put: tags: - UsageChargeTemplate summary: ' Update usage charge template. ' description: ' Update usage charge template. ' operationId: update_45 requestBody: description: ' postData The usage charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - UsageChargeTemplate summary: ' Create new usage charge template. ' description: ' Create new usage charge template. ' operationId: create_45 requestBody: description: ' postData The usage charge template''s data ' content: application/json: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/UsageChargeTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate/{code}/enable: post: tags: - UsageChargeTemplate summary: ' Enable a Usage charge template with a given code ' description: ' Enable a Usage charge template with a given code ' operationId: enable_16 parameters: - name: code in: path description: ' code Usage charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate/{code}/disable: post: tags: - UsageChargeTemplate summary: ' Disable a Usage charge template with a given code ' description: ' Disable a Usage charge template with a given code ' operationId: disable_16 parameters: - name: code in: path description: ' code Usage charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalog/usageChargeTemplate/version: get: tags: - UsageChargeTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_58 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /Communication/inbound: post: tags: - Communication summary: ' Receives inbound communication from external source given the rest url above' description: ' Receives inbound communication from external source given the rest url above. MEVEO handles it by throwing an inbount communication event with the communicationRequestDto. ' operationId: inboundCommunication_1 requestBody: description: ' communicationRequestDto communication request ' content: application/json: schema: $ref: '#/components/schemas/CommunicationRequestDto' application/xml: schema: $ref: '#/components/schemas/CommunicationRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /Communication/version: get: tags: - Communication summary: ' Get version of application ' description: ' Get version of application ' operationId: index_63 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/emailTemplate/createOrUpdate: post: tags: - EmailTemplate summary: ' Create new or update an existing email template by dto ' description: ' Create new or update an existing email template by dto ' operationId: createOrUpdate_49 requestBody: description: ' emailTemplateDto The email template''s data ' content: application/json: schema: $ref: '#/components/schemas/EmailTemplateDto' application/xml: schema: $ref: '#/components/schemas/EmailTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/emailTemplate/{code}: delete: tags: - EmailTemplate summary: ' remove an emailTemplate by code ' description: ' remove an emailTemplate by code ' operationId: remove_44 parameters: - name: code in: path description: ' code The email template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/emailTemplate: get: tags: - EmailTemplate summary: ' Find an email template with a given code ' description: ' Find an email template with a given code ' operationId: find_49 parameters: - name: code in: query description: ' code The email template''s code ' schema: type: string responses: default: description: ' Returns an email template ' content: application/json: schema: $ref: '#/components/schemas/EmailTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/EmailTemplateResponseDto' put: tags: - EmailTemplate summary: "\t update an emailTemplate by dto\t " description: "\t update an emailTemplate by dto\t " operationId: update_49 requestBody: description: " emailTemplateDto The email template's data \t " content: application/json: schema: $ref: '#/components/schemas/EmailTemplateDto' application/xml: schema: $ref: '#/components/schemas/EmailTemplateDto' responses: default: description: " Request processing status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - EmailTemplate summary: "\t Create an email template by dto\t " description: "\t Create an email template by dto\t " operationId: create_49 requestBody: description: " emailTemplateDto The email template's data\t " content: application/json: schema: $ref: '#/components/schemas/EmailTemplateDto' application/xml: schema: $ref: '#/components/schemas/EmailTemplateDto' responses: default: description: " Request processing status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/emailTemplate/list: get: tags: - EmailTemplate summary: ' List email templates ' description: ' List email templates ' operationId: list_22 responses: default: description: ' List of email templates ' content: application/json: schema: $ref: '#/components/schemas/EmailTemplatesResponseDto' application/xml: schema: $ref: '#/components/schemas/EmailTemplatesResponseDto' /communication/emailTemplate/version: get: tags: - EmailTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_59 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/meveoInstance/createOrUpdate: post: tags: - MeveoInstance summary: ' CreateOrUpdate a meveoInstance by dto ' description: ' CreateOrUpdate a meveoInstance by dto ' operationId: createOrUpdate_46 requestBody: description: ' meveoInstanceDto meveo Instance data ' content: application/json: schema: $ref: '#/components/schemas/MeveoInstanceDto' application/xml: schema: $ref: '#/components/schemas/MeveoInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/meveoInstance/{code}: delete: tags: - MeveoInstance summary: ' Remove a meveoInstance by code ' description: ' Remove a meveoInstance by code ' operationId: remove_41 parameters: - name: code in: path description: ' code the code of the meveo instance ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/meveoInstance: get: tags: - MeveoInstance summary: ' Find a meveoInstance by code ' description: ' Find a meveoInstance by code ' operationId: find_46 parameters: - name: code in: query description: ' code the code of the meveo instance ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/MeveoInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/MeveoInstanceResponseDto' put: tags: - MeveoInstance summary: "\t Update a meveoInstance by dto\t " description: "\t Update a meveoInstance by dto\t " operationId: update_46 requestBody: description: " meveoInstanceDto\t " content: application/json: schema: $ref: '#/components/schemas/MeveoInstanceDto' application/xml: schema: $ref: '#/components/schemas/MeveoInstanceDto' responses: default: description: " Request processing status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - MeveoInstance summary: "\t Create a meveoInstance by dto.\t " description: "\t Create a meveoInstance by dto.\t " operationId: create_46 requestBody: description: " meveoInstanceDto meveo instance\t " content: application/json: schema: $ref: '#/components/schemas/MeveoInstanceDto' application/xml: schema: $ref: '#/components/schemas/MeveoInstanceDto' responses: default: description: " action status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /communication/meveoInstance/list: get: tags: - MeveoInstance summary: ' List meveoInstances ' description: ' List meveoInstances ' operationId: list_19 responses: default: description: ' List of Meveo Instances ' content: application/json: schema: $ref: '#/components/schemas/MeveoInstancesResponseDto' application/xml: schema: $ref: '#/components/schemas/MeveoInstancesResponseDto' /communication/meveoInstance/version: get: tags: - MeveoInstance summary: ' Get version of application ' description: ' Get version of application ' operationId: index_61 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /addressbook/createAll: get: tags: - AddressBook summary: ' Create All addressbook ' description: ' Create All addressbook ' operationId: createAll_1 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /addressbook/addContact: get: tags: - AddressBook summary: ' Create a new contact address for a contact code ' description: ' Create a new contact address for a contact code ' operationId: addContact_1 parameters: - name: addressbookCode in: query description: ' addrCode The address book code ' schema: type: string - name: contactCode in: query description: ' ctCode The contact code ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /addressbook: get: tags: - AddressBook summary: ' Find a AddressBook with a given code and from ' description: ' Find a AddressBook with a given code and from ' operationId: find_51 parameters: - name: code in: query description: ' code The address book code ' schema: type: string - name: from in: query description: ' from The from information ' schema: type: string responses: default: description: ' GetAddressBookResponse data ' content: application/json: schema: $ref: '#/components/schemas/GetAddressBookResponseDto' application/xml: schema: $ref: '#/components/schemas/GetAddressBookResponseDto' /addressbook/list: get: tags: - AddressBook summary: ' List of address ' description: ' List of address ' operationId: list_23 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /addressbook/version: get: tags: - AddressBook summary: ' Get version of application ' description: ' Get version of application ' operationId: index_65 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact/createOrUpdate: post: tags: - Contact summary: ' Create or update a CRM contact ' description: ' Create or update a CRM contact ' operationId: createOrUpdate_50 requestBody: description: ' postData The contact data ' content: application/json: schema: $ref: '#/components/schemas/ContactDto' application/xml: schema: $ref: '#/components/schemas/ContactDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact/list: get: tags: - Contact summary: ' List contacts matching a given criteria ' description: ' List contacts matching a given criteria ' operationId: listGet_10 parameters: - name: query in: query description: ' query Search criteria ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING - name: inheritCF in: query description: ' inheritCF Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE. ' schema: type: string enum: - INHERIT_NONE - INHERIT_NO_MERGE - INHERIT_MERGED - ACCUMULATED default: INHERIT_NO_MERGE responses: default: description: ' List of contacts ' content: application/json: schema: $ref: '#/components/schemas/ContactsResponseDto' application/xml: schema: $ref: '#/components/schemas/ContactsResponseDto' post: tags: - Contact summary: ' Retrieve a list by using paging and filter option ' description: ' Retrieve a list by using paging and filter option ' operationId: listPost_10 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ContactsResponseDto' application/xml: schema: $ref: '#/components/schemas/ContactsResponseDto' /contact/{code}/{tag}: put: tags: - Contact summary: ' Add a tag to a contact with his code ' description: ' Add a tag to a contact with his code ' operationId: addTag_1 parameters: - name: code in: path description: ' code The code of the Contact. ' required: true schema: type: string - name: tag in: path description: ' tag The tag to add to the contact ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - Contact summary: ' Delete a tag to a contact with his code ' description: ' Delete a tag to a contact with his code ' operationId: removeTag_1 parameters: - name: code in: path description: ' code The code of the Contact. ' required: true schema: type: string - name: tag in: path description: ' tag The tag to add to the contact ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact/importCSVText: post: tags: - Contact summary: ' Import the contact list to a CSV file text ' description: ' Import the contact list to a CSV file text ' operationId: importCSVText_1 requestBody: description: ' context The context information text ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ContactsResponseDto' application/xml: schema: $ref: '#/components/schemas/ContactsResponseDto' /contact/importCSVFile: post: tags: - Contact summary: ' Import the contact list from a file ' description: ' Import the contact list from a file ' operationId: importCSVFile_1 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact/{code}: delete: tags: - Contact summary: ' Delete a contact with a given code ' description: ' Delete a contact with a given code ' operationId: remove_45 parameters: - name: code in: path description: ' code The code of the contact ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact: get: tags: - Contact summary: ' Find a contact with a given code ' description: ' Find a contact with a given code ' operationId: find_48 parameters: - name: code in: query description: ' code The code of the contact ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/GetContactResponseDto' application/xml: schema: $ref: '#/components/schemas/GetContactResponseDto' put: tags: - Contact summary: ' Update a contact CRM informatopn ' description: ' Update a contact CRM informatopn ' operationId: update_50 requestBody: description: ' postData The contact data information ' content: application/json: schema: $ref: '#/components/schemas/ContactDto' application/xml: schema: $ref: '#/components/schemas/ContactDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Contact summary: ' Create a new CRM Contact ' description: ' Create a new CRM Contact ' operationId: create_50 requestBody: description: ' postData The contact data ' content: application/json: schema: $ref: '#/components/schemas/ContactDto' application/xml: schema: $ref: '#/components/schemas/ContactDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /contact/version: get: tags: - Contact summary: ' Get version of application ' description: ' Get version of application ' operationId: index_62 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/{customEntityTemplateCode}/createOrUpdate: post: tags: - CustomEntityInstance summary: ' Create new or update an existing custom entity instance with a given code. ' description: ' Create new or update an existing custom entity instance with a given code. ' operationId: createOrUpdate_53 parameters: - name: customEntityTemplateCode in: path description: ' dto The custom entity instance''s data ' required: true schema: type: string requestBody: description: ' customEntityTemplateCode code of custome entity template. ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/{customEntityTemplateCode}/{code}: get: tags: - CustomEntityInstance summary: ' Find a #### with a given (exemple) code . ' description: ' Find a #### with a given (exemple) code . ' operationId: find_53 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string - name: code in: path description: ' code The custom entity instance''s code ' required: true schema: type: string responses: default: description: ' Return a customEntityInstance ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityInstanceResponseDto' delete: tags: - CustomEntityInstance summary: ' Remove an existing custom entity instance with a given code from a custom entity template given by code ' description: ' Remove an existing custom entity instance with a given code from a custom entity template given by code ' operationId: remove_48 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string - name: code in: path description: ' code The custom entity instance''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/{customEntityTemplateCode}: put: tags: - CustomEntityInstance summary: ' Update an existing custom entity instance using a custom entity template ' description: ' Update an existing custom entity instance using a custom entity template ' operationId: update_53 parameters: - name: customEntityTemplateCode in: path description: ' dto The custom entity instance''s data ' required: true schema: type: string requestBody: description: ' customEntityTemplateCode The custom entity template''s code ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CustomEntityInstance summary: ' Create a new custom entity instance using a custom entity template. ' description: ' Create a new custom entity instance using a custom entity template. ' operationId: create_52 parameters: - name: customEntityTemplateCode in: path description: ' dto The custom entity instance''s data ' required: true schema: type: string requestBody: description: ' customEntityTemplateCode The custom entity template''s code ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/list/{customEntityTemplateCode}: get: tags: - CustomEntityInstance summary: ' List custom entity instances. ' description: ' List custom entity instances. ' operationId: list_25 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity instance''s code ' required: true schema: type: string responses: default: description: ' A list of custom entity instances ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityInstancesResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityInstancesResponseDto' /customEntityInstance/{customEntityTemplateCode}/{code}/enable: post: tags: - CustomEntityInstance summary: ' Enable a Custom entity instance with a given code ' description: ' Enable a Custom entity instance with a given code ' operationId: enable_20 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string - name: code in: path description: ' code Custom entity instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/{customEntityTemplateCode}/{code}/disable: post: tags: - CustomEntityInstance summary: ' Disable a Custom entity instance with a given code ' description: ' Disable a Custom entity instance with a given code ' operationId: disable_21 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string - name: code in: path description: ' code Custom entity instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customEntityInstance/version: get: tags: - CustomEntityInstance summary: ' Get version of application ' description: ' Get version of application ' operationId: index_69 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate/createOrUpdate: post: tags: - CustomFieldTemplate summary: ' Define new or update existing custom field definition ' description: ' Define new or update existing custom field definition ' operationId: createOrUpdate_48 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}: delete: tags: - CustomFieldTemplate summary: ' Remove custom field definition given its code and entity it applies to ' description: ' Remove custom field definition given its code and entity it applies to ' operationId: remove_43 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate: get: tags: - CustomFieldTemplate summary: ' Get custom field definition ' description: ' Get custom field definition ' operationId: find_50 parameters: - name: customFieldTemplateCode in: query description: ' customFieldTemplateCode Custom field template code ' schema: type: string - name: appliesTo in: query description: ' appliesTo Entity it applies to ' schema: type: string responses: default: description: ' instance of GetCustomFieldTemplateReponseDto ' content: application/json: schema: $ref: '#/components/schemas/GetCustomFieldTemplateReponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomFieldTemplateReponseDto' put: tags: - CustomFieldTemplate summary: ' Update existing custom field definition ' description: ' Update existing custom field definition ' operationId: update_48 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CustomFieldTemplate summary: ' Define a new custom field ' description: ' Define a new custom field ' operationId: create_48 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}/enable: post: tags: - CustomFieldTemplate summary: ' Enable a Custom field template with a given code ' description: ' Enable a Custom field template with a given code ' operationId: enable_17 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}/disable: post: tags: - CustomFieldTemplate summary: ' Disable a Custom field template with a given code ' description: ' Disable a Custom field template with a given code ' operationId: disable_17 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customFieldTemplate/version: get: tags: - CustomFieldTemplate summary: ' Get version of application ' description: ' Get version of application ' operationId: index_64 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customTable/createOrUpdate: post: tags: - CustomTable summary: ' Append or update data in a custom table ' description: ' Append or update data in a custom table ' operationId: createOrUpdate_51 requestBody: description: ' dto Custom table data. ''id'' field is used to identify an existing record. Presence of ''id'' field will be treated as update operation. ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customTable: put: tags: - CustomTable summary: ' Update existing data in a custom table ' description: ' Update existing data in a custom table ' operationId: update_51 requestBody: description: ' dto Custom table data. ''id'' field is used to identify an existing record. ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CustomTable summary: ' Append data to a custom table ' description: ' Append data to a custom table ' operationId: append_1 requestBody: description: ' dto Custom table data ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - CustomTable summary: ' Remove an existing data from a custom table. ' description: ' Remove an existing data from a custom table. ' operationId: remove_46 requestBody: description: ' dto Custom table data. ''id'' field is used to identify an existing record. If no ''id'' values are passed will delete all the records in a table. ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customTable/list/{customTableCode}: post: tags: - CustomTable summary: ' Search in custom tables ' description: ' Search in custom tables ' operationId: list_21 parameters: - name: customTableCode in: path description: ' customTableCode Custom table code - can be either db table''s name or a custom entity template code ' required: true schema: type: string requestBody: description: ' pagingAndFiltering Paging and search criteria ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' Custom table data ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataResponseDto' /customTable/enable: post: tags: - CustomTable summary: ' Mark records as disabled in a custom table. Applies only to those custom tables that contain a field ''disabled'' ' description: ' Mark records as disabled in a custom table. Applies only to those custom tables that contain a field ''disabled'' ' operationId: disable_19 requestBody: description: ' dto Custom table data. ''id'' field is used to identify an existing record. ' content: application/json: schema: $ref: '#/components/schemas/CustomTableDataDto' application/xml: schema: $ref: '#/components/schemas/CustomTableDataDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /customTable/version: get: tags: - CustomTable summary: ' Get version of application ' description: ' Get version of application ' operationId: index_66 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field: get: tags: - EntityCustomization summary: ' Get custom field definition ' description: ' Get custom field definition ' operationId: findField_1 parameters: - name: customFieldTemplateCode in: query description: ' customFieldTemplateCode Custom field template code ' schema: type: string - name: appliesTo in: query description: ' appliesTo Entity custom field applies to ' schema: type: string responses: default: description: ' instance of GetCustomFieldTemplateReponseDto. ' content: application/json: schema: $ref: '#/components/schemas/GetCustomFieldTemplateReponseDto' application/xml: schema: $ref: '#/components/schemas/GetCustomFieldTemplateReponseDto' put: tags: - EntityCustomization summary: ' Update existing custom field definition ' description: ' Update existing custom field definition ' operationId: updateField_1 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - EntityCustomization summary: ' Define a new custom field ' description: ' Define a new custom field ' operationId: createField_1 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/entity/list: get: tags: - EntityCustomization summary: ' List custom entity templates. ' description: ' List custom entity templates. ' operationId: listEntityTemplates_1 parameters: - name: customEntityTemplateCode in: query description: ' customEntityTemplateCode An optional and partial custom entity template code ' schema: type: string responses: default: description: ' instance of CustomEntityTemplatesResponseDto ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplatesResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplatesResponseDto' /entityCustomization/entity/createOrUpdate: post: tags: - EntityCustomization summary: ' Define new or update existing custom entity template definition ' description: ' Define new or update existing custom entity template definition ' operationId: createOrUpdateEntityTemplate_1 requestBody: description: ' dto The custom entity instance''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/cet/createOrUpdate: post: tags: - EntityCustomization summary: ' To be sure the compatibility of above method we will create a new one. Define new or update existing custom entity template definition ' description: ' To be sure the compatibility of above method we will create a new one. Define new or update existing custom entity template definition ' operationId: createOrUpdateCustumizedEntityTemplate_1 requestBody: description: ' dto The custom entity instance''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/entity/{code}/enable: post: tags: - EntityCustomization summary: ' Enable a Custom entity template with a given code ' description: ' Enable a Custom entity template with a given code ' operationId: enableEntityTemplate_1 parameters: - name: code in: path description: ' code Custom entity template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/entity: put: tags: - EntityCustomization summary: ' Update custom entity template definition ' description: ' Update custom entity template definition ' operationId: updateEntityTemplate_1 requestBody: description: ' dto The custom entity instance''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - EntityCustomization summary: ' Define a new custom entity template including fields and applicable actions ' description: ' Define a new custom entity template including fields and applicable actions ' operationId: createEntityTemplate_1 requestBody: description: ' dto The custom entity instance''s data ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/entity/{customEntityTemplateCode}: get: tags: - EntityCustomization summary: ' Get custom entity template definition including its fields and applicable actions ' description: ' Get custom entity template definition including its fields and applicable actions ' operationId: findEntityTemplate_1 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string responses: default: description: ' instance of CustomEntityTemplateResponseDto ' content: application/json: schema: $ref: '#/components/schemas/CustomEntityTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/CustomEntityTemplateResponseDto' delete: tags: - EntityCustomization summary: ' Remove custom entity template definition given its code ' description: ' Remove custom entity template definition given its code ' operationId: removeEntityTemplate_1 parameters: - name: customEntityTemplateCode in: path description: ' customEntityTemplateCode The custom entity template''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/entity/{code}/disable: post: tags: - EntityCustomization summary: ' Disable a Custom entity template with a given code ' description: ' Disable a Custom entity template with a given code ' operationId: disableEntityTemplate_1 parameters: - name: code in: path description: ' code Custom entity template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/customize: put: tags: - EntityCustomization summary: ' Customize a standard Meveo entity definition by adding fields and/or custom actions ' description: ' Customize a standard Meveo entity definition by adding fields and/or custom actions ' operationId: customizeEntity_1 requestBody: description: ' dto The custom entity instance''s data ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomizationDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomizationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/customize/{customizedEntityClass}: get: tags: - EntityCustomization summary: ' Get customizations made on a standard Meveo entity given its class ' description: ' Get customizations made on a standard Meveo entity given its class ' operationId: findEntityCustomizations_1 parameters: - name: customizedEntityClass in: path description: ' customizedEntityClass Standard Meveo entity class name ' required: true schema: type: string responses: default: description: ' instance of EntityCustomizationResponseDto ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomizationResponseDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomizationResponseDto' /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}: delete: tags: - EntityCustomization summary: ' Remove custom field definition given its code and entity it applies to ' description: ' Remove custom field definition given its code and entity it applies to ' operationId: removeField_1 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity custom field applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field/createOrUpdate: post: tags: - EntityCustomization summary: ' Define new or update existing custom field definition ' description: ' Define new or update existing custom field definition ' operationId: createOrUpdateField_1 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' application/xml: schema: $ref: '#/components/schemas/CustomFieldTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}/enable: post: tags: - EntityCustomization summary: ' Enable a Custom field template with a given code ' description: ' Enable a Custom field template with a given code ' operationId: enableField_1 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}/disable: post: tags: - EntityCustomization summary: ' Disable a Custom field template with a given code ' description: ' Disable a Custom field template with a given code ' operationId: disableField_1 parameters: - name: customFieldTemplateCode in: path description: ' customFieldTemplateCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/action: get: tags: - EntityCustomization summary: ' Get entity action definition ' description: ' Get entity action definition ' operationId: findAction_1 parameters: - name: actionCode in: query description: ' actionCode Entity action code ' schema: type: string - name: appliesTo in: query description: ' appliesTo Entity that action applies to ' schema: type: string responses: default: description: ' instance of EntityCustomActionResponseDto ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomActionResponseDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomActionResponseDto' put: tags: - EntityCustomization summary: ' Update existing entity action definition ' description: ' Update existing entity action definition ' operationId: updateAction_1 requestBody: description: ' dto posted data to API ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomActionDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomActionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - EntityCustomization summary: ' Define a new entity action ' description: ' Define a new entity action ' operationId: createAction_1 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomActionDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomActionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/action/{actionCode}/{appliesTo}: delete: tags: - EntityCustomization summary: ' Remove entity action definition given its code and entity it applies to ' description: ' Remove entity action definition given its code and entity it applies to ' operationId: removeAction_1 parameters: - name: actionCode in: path description: ' actionCode Entity action code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity that action applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/action/createOrUpdate: post: tags: - EntityCustomization summary: ' Define new or update existing entity action definition ' description: ' Define new or update existing entity action definition ' operationId: createOrUpdateAction_1 requestBody: description: ' dto posted data to API ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomActionDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomActionDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field/{actionCode}/{appliesTo}/enable: post: tags: - EntityCustomization summary: ' Enable a Entity action with a given code ' description: ' Enable a Entity action with a given code ' operationId: enableAction_1 parameters: - name: actionCode in: path description: ' actionCode Custom field template code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/field/{actionCode}/{appliesTo}/disable: post: tags: - EntityCustomization summary: ' Disable a Entity action with a given code ' description: ' Disable a Entity action with a given code ' operationId: disableAction_1 parameters: - name: actionCode in: path description: ' actionCode Entity action code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/listBusinessEntityForCFVByCode: get: tags: - EntityCustomization summary: ' Returns a List of BusinessEntities given a CustomFieldTemplate code' description: ' 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. ' operationId: listBusinessEntityForCFVByCode_1 parameters: - name: code in: query description: ' code CFT code ' schema: type: string - name: wildcode in: query description: ' wildcode code filter ' schema: type: string responses: default: description: ' instance of BusinessEntityResponseDto ' content: application/json: schema: $ref: '#/components/schemas/BusinessEntityResponseDto' application/xml: schema: $ref: '#/components/schemas/BusinessEntityResponseDto' /entityCustomization/entity/listELFiltered: get: tags: - EntityCustomization summary: ' Returns a list of filtered CustomFieldTemplate of an entity. The list of entity is evaluted againsts the entity with the given code. ' description: ' Returns a list of filtered CustomFieldTemplate of an entity. The list of entity is evaluted againsts the entity with the given code. ' operationId: listELFiltered_1 parameters: - name: appliesTo in: query description: ' appliesTo - the type of entity to which the CFT applies. eg OfferTemplate ServiceTemplate. ' schema: type: string - name: entityCode in: query description: ' entityCode - code of the entity ' schema: type: string responses: default: description: ' instance of EntityCustomizationResponseDto ' content: application/json: schema: $ref: '#/components/schemas/EntityCustomizationResponseDto' application/xml: schema: $ref: '#/components/schemas/EntityCustomizationResponseDto' /entityCustomization/entity/action/execute/{actionCode}/{appliesTo}/{entityCode}: post: tags: - EntityCustomization summary: ' Execute and action of a given entity ' description: ' Execute and action of a given entity ' operationId: execute_2 parameters: - name: actionCode in: path description: ' actionCode Action code ' required: true schema: type: string - name: appliesTo in: path description: ' appliesTo Entity it applies to ' required: true schema: type: string - name: entityCode in: path description: ' entityCode Entity code to execute action on ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /entityCustomization/version: get: tags: - EntityCustomization summary: ' Get version of application ' description: ' Get version of application ' operationId: index_67 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /document/sign/procedures: post: tags: - DocumentSign summary: ' Creates the procedure. ' description: ' Creates the procedure. ' operationId: createProcedure_1 requestBody: description: ' postData the post data ' content: application/json: schema: $ref: '#/components/schemas/CreateProcedureRequestDto' application/xml: schema: $ref: '#/components/schemas/CreateProcedureRequestDto' responses: default: description: ' the sign procedure response dto ' content: application/json: schema: $ref: '#/components/schemas/SignProcedureResponseDto' application/xml: schema: $ref: '#/components/schemas/SignProcedureResponseDto' /document/sign/procedures/{id}: get: tags: - DocumentSign summary: ' Gets the procedure by id. ' description: ' Gets the procedure by id. ' operationId: getProcedureById_1 parameters: - name: id in: path description: ' id the id ' required: true schema: type: string responses: default: description: ' the procedure by id ' content: application/json: schema: $ref: '#/components/schemas/SignProcedureResponseDto' application/xml: schema: $ref: '#/components/schemas/SignProcedureResponseDto' /document/sign/procedures/{id}/status: get: tags: - DocumentSign summary: ' Gets the procedure status by id. ' description: ' Gets the procedure status by id. ' operationId: getProcedureStatusById_1 parameters: - name: id in: path description: ' id the id ' required: true schema: type: string responses: default: description: ' the procedure status by id ' content: application/json: schema: $ref: '#/components/schemas/RawResponseDto' application/xml: schema: $ref: '#/components/schemas/RawResponseDto' /document/sign/files/{id}/download: get: tags: - DocumentSign summary: ' Download the files with the given id ' description: ' Download the files with the given id ' operationId: downloadFileById_1 parameters: - name: id in: path description: ' id The id ' required: true schema: type: string responses: default: description: ' the file by id ' content: application/json: schema: $ref: '#/components/schemas/SignFileResponseDto' application/xml: schema: $ref: '#/components/schemas/SignFileResponseDto' /document/sign/version: get: tags: - DocumentSign summary: ' Get version of application ' description: ' Get version of application ' operationId: index_71 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /document/pdf: post: tags: - PDFDocument summary: ' Generate PDF document. ' description: ' Generate PDF document. ' operationId: generatePDF_1 requestBody: description: ' postData the post data ' content: application/json: schema: $ref: '#/components/schemas/PDFDocumentRequestDto' application/xml: schema: $ref: '#/components/schemas/PDFDocumentRequestDto' responses: default: description: ' the PDF contarct response dto ' content: application/json: schema: $ref: '#/components/schemas/PDFDocumentResponseDto' application/xml: schema: $ref: '#/components/schemas/PDFDocumentResponseDto' /document/pdf/version: get: tags: - PDFDocument summary: ' Get version of application ' description: ' Get version of application ' operationId: index_68 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/createOrUpdate: post: tags: - Chart summary: ' Create new or update an existing chart with a given code ' description: ' Create new or update an existing chart with a given code ' operationId: createOrUpdate_54 requestBody: description: ' postData The chart''s data ' content: application/json: schema: $ref: '#/components/schemas/ChartDto' application/xml: schema: $ref: '#/components/schemas/ChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/bar: put: tags: - Chart summary: ' Update an existing bar chart ' description: ' Update an existing bar chart ' operationId: updateBarChart_1 requestBody: description: ' postData The bar chart''s data ' content: application/json: schema: $ref: '#/components/schemas/BarChartDto' application/xml: schema: $ref: '#/components/schemas/BarChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Chart summary: ' Create a new bar chart ' description: ' Create a new bar chart ' operationId: createBarChart_1 requestBody: description: ' postData The bar chart''s data ' content: application/json: schema: $ref: '#/components/schemas/BarChartDto' application/xml: schema: $ref: '#/components/schemas/BarChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/pie: put: tags: - Chart summary: ' Update an existing pie chart ' description: ' Update an existing pie chart ' operationId: updatePieChart_1 requestBody: description: ' postData The pie chart''s data ' content: application/json: schema: $ref: '#/components/schemas/PieChartDto' application/xml: schema: $ref: '#/components/schemas/PieChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Chart summary: ' Create a new pie chart ' description: ' Create a new pie chart ' operationId: createPieChart_1 requestBody: description: ' postData The pie chart''s data ' content: application/json: schema: $ref: '#/components/schemas/PieChartDto' application/xml: schema: $ref: '#/components/schemas/PieChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/line: put: tags: - Chart summary: ' Update an existing line chart ' description: ' Update an existing line chart ' operationId: updateLineChart_1 requestBody: description: ' postData The line chart''s data ' content: application/json: schema: $ref: '#/components/schemas/LineChartDto' application/xml: schema: $ref: '#/components/schemas/LineChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Chart summary: ' Create a new line chart ' description: ' Create a new line chart ' operationId: createLineChart_1 requestBody: description: ' postData The line chart''s data ' content: application/json: schema: $ref: '#/components/schemas/LineChartDto' application/xml: schema: $ref: '#/components/schemas/LineChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart: get: tags: - Chart summary: ' Find a chart with a given code ' description: ' Find a chart with a given code ' operationId: find_55 parameters: - name: chartCode in: query description: ' chartCode The chart''s code ' schema: type: string responses: default: description: ' Get Chart Response ' content: application/json: schema: $ref: '#/components/schemas/GetChartResponse' application/xml: schema: $ref: '#/components/schemas/GetChartResponse' put: tags: - Chart summary: ' Update an existing chart ' description: ' Update an existing chart ' operationId: update_55 requestBody: description: ' postData The chart''s data ' content: application/json: schema: $ref: '#/components/schemas/ChartDto' application/xml: schema: $ref: '#/components/schemas/ChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Chart summary: ' Create a new chart ' description: ' Create a new chart ' operationId: create_54 requestBody: description: ' postData The chart''s data ' content: application/json: schema: $ref: '#/components/schemas/ChartDto' application/xml: schema: $ref: '#/components/schemas/ChartDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - Chart summary: ' Remove an existing chart with a given code ' description: ' Remove an existing chart with a given code ' operationId: remove_50 parameters: - name: chartCode in: query description: ' chartCode The chart''s code ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/{code}/enable: post: tags: - Chart summary: ' Enable a Chart with a given code ' description: ' Enable a Chart with a given code ' operationId: enable_22 parameters: - name: code in: path description: ' code Chart code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/{code}/disable: post: tags: - Chart summary: ' Disable a Chart with a given code ' description: ' Disable a Chart with a given code ' operationId: disable_23 parameters: - name: code in: path description: ' code Chart code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /chart/version: get: tags: - Chart summary: ' Get version of application ' description: ' Get version of application ' operationId: index_73 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /measurableQuantity/findMVByDateAndPeriod: get: tags: - MeasurableQuantity summary: ' Find a Measurable value during a period of date and period ' description: ' Find a Measurable value during a period of date and period ' operationId: findMVByDateAndPeriod_1 parameters: - name: code in: query description: ' code code of mesurable value. ' schema: type: string - name: fromDate in: query description: ' fromDate format yyyy-MM-dd''T''HH:mm:ss or yyyy-MM-dd ' schema: type: string format: date-time - name: toDate in: query description: ' toDate format yyyy-MM-dd''T''HH:mm:ss or yyyy-MM-dd ' schema: type: string format: date-time - name: period in: query description: ' period period in which mesurable value is calculated. ' schema: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY - name: mqCode in: query description: ' mqCode Measureable quantity''s code ' schema: type: string responses: default: description: ' mesurable value by date and period. ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /measurableQuantity/{code}: delete: tags: - MeasurableQuantity summary: ' Remove Measurable quantity with a given code. ' description: ' Remove Measurable quantity with a given code. ' operationId: remove_47 parameters: - name: code in: path description: ' code Measurable quantity''s code ' required: true schema: type: string responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /measurableQuantity: get: tags: - MeasurableQuantity summary: ' Get Measurable quantity from a given code. ' description: ' Get Measurable quantity from a given code. ' operationId: find_52 parameters: - name: code in: query description: ' code Measureable quantity''s code ' schema: type: string responses: default: description: ' Measurable Quantity Response data ' content: application/json: schema: $ref: '#/components/schemas/GetMeasurableQuantityResponse' application/xml: schema: $ref: '#/components/schemas/GetMeasurableQuantityResponse' put: tags: - MeasurableQuantity summary: ' Update Measurable quantity from mesearable quantities. ' description: ' Update Measurable quantity from mesearable quantities. ' operationId: update_52 requestBody: description: ' postData posted data. ' content: application/json: schema: $ref: '#/components/schemas/MeasurableQuantityDto' application/xml: schema: $ref: '#/components/schemas/MeasurableQuantityDto' responses: default: description: ' actions status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - MeasurableQuantity summary: ' Create a Measurable quantity. ' description: ' Create a Measurable quantity. ' operationId: create_51 requestBody: description: ' postData posted data to API ' content: application/json: schema: $ref: '#/components/schemas/MeasurableQuantityDto' application/xml: schema: $ref: '#/components/schemas/MeasurableQuantityDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /measurableQuantity/list: get: tags: - MeasurableQuantity summary: ' List Measurable quantity with a given code. ' description: ' List Measurable quantity with a given code. ' operationId: list_26 responses: default: description: ' A list of measurable quantities ' content: application/json: schema: $ref: '#/components/schemas/GetListMeasurableQuantityResponse' application/xml: schema: $ref: '#/components/schemas/GetListMeasurableQuantityResponse' /measurableQuantity/{code}/enable: post: tags: - MeasurableQuantity summary: ' Enable a Measurable quantity with a given code ' description: ' Enable a Measurable quantity with a given code ' operationId: enable_19 parameters: - name: code in: path description: ' code Measurable quantity code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /measurableQuantity/{code}/disable: post: tags: - MeasurableQuantity summary: ' Disable a Measurable quantity with a given code ' description: ' Disable a Measurable quantity with a given code ' operationId: disable_20 parameters: - name: code in: path description: ' code Measurable quantity code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /measurableQuantity/version: get: tags: - MeasurableQuantity summary: ' Get version of application ' description: ' Get version of application ' operationId: index_70 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /filteredList/listByFilter: post: tags: - FilteredList summary: ' Execute a filter to retrieve a list of entities ' description: ' Execute a filter to retrieve a list of entities ' operationId: listByFilter_1 parameters: - name: from in: query description: ' from Pagination - starting record ' schema: type: integer format: int32 - name: size in: query description: ' size Pagination - number of records per page ' schema: type: integer format: int32 requestBody: description: ' filter - if the code is set we lookup the filter in DB else we parse the inputXml to create a transient filter ' content: application/json: schema: $ref: '#/components/schemas/FilterDto' application/xml: schema: $ref: '#/components/schemas/FilterDto' responses: default: description: ' Response ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /filteredList/searchByField: get: tags: - FilteredList summary: ' Execute a search in Elastic Search on given fields for given values' description: ' 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 ' operationId: searchByField_1 parameters: - name: classnamesOrCetCodes in: query description: ' Execute a search in Elastic Search on given fields for given values. Query values by field are passed in extra query eters in a form of fieldName=valueToMatch ' schema: type: array items: type: string - name: from in: query description: ' classnamesOrCetCodes Entity classes to match - full class name ' schema: type: integer format: int32 - name: size in: query description: ' from Pagination - starting record ' schema: type: integer format: int32 - name: sortField in: query description: ' size Pagination - number of records per page ' schema: type: string - name: sortOrder in: query description: ' sortField Pagination - field used to sort the results ' schema: type: string enum: - asc - desc responses: default: description: ' Response object that contains JSON results in String format ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /filteredList/reindex: get: tags: - FilteredList summary: ' Clean and reindex Elastic Search repository ' description: ' Clean and reindex Elastic Search repository ' operationId: reindex_1 responses: default: description: ' Request processing status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /filteredList/fullSearch: get: tags: - FilteredList summary: ' Execute a search in Elastic Search on all fields (_all field) and all entity types Deprecated in v. 6.2. Use /search instead ' description: ' Execute a search in Elastic Search on all fields (_all field) and all entity types Deprecated in v. 6.2. Use /search instead ' operationId: fullSearch_1 parameters: - name: query in: query description: ' query Query - words (will be joined by AND) or query expression (+word1 - word2) ' schema: type: string - name: category in: query description: ' category search by category that is directly taken from the name of the entity found in entityMapping. property of elasticSearchConfiguration.json. e.g. CustomerCustomerAccount AccountOperation etc. See elasticSearchConfiguration.json entityMapping keys for a list of categories. ' schema: type: string - name: from in: query description: ' from Pagination - starting record ' schema: type: integer format: int32 - name: size in: query description: ' size Pagination - number of records per page ' schema: type: integer format: int32 - name: sortField in: query description: ' sortField Pagination - field used to sort the results ' schema: type: string - name: sortOrder in: query description: ' sortOrder Pagination - ASC or DESC order of the results ' schema: type: string enum: - asc - desc responses: default: description: ' Response object that contains JSON results in String format ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 deprecated: true /filteredList/search: get: tags: - FilteredList summary: ' Execute a search in Elastic Search on all fields (_all field) ' description: ' Execute a search in Elastic Search on all fields (_all field) ' operationId: search_1 parameters: - name: classnamesOrCetCodes in: query description: ' classnamesOrCetCodes Entity classes to match - full class name ' schema: type: array items: type: string - name: query in: query description: ' query Query - words (will be joined by AND) or query expression (+word1 - word2) ' schema: type: string - name: from in: query description: ' from Pagination - starting record ' schema: type: integer format: int32 - name: size in: query description: ' size Pagination - number of records per page ' schema: type: integer format: int32 - name: sortField in: query description: ' sortField Pagination - field used to sort the results ' schema: type: string - name: sortOrder in: query description: ' sortOrder Pagination - ASC or DESC order of the results ' schema: type: string enum: - asc - desc responses: default: description: ' Response object that contains JSON results in String format ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /filteredList/version: get: tags: - FilteredList summary: ' Get version of application ' description: ' Get version of application ' operationId: index_74 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /finance/reportExtracts/createOrUpdate: post: tags: - ReportExtract summary: ' Create / update a report extract with the given data. ' description: ' Create / update a report extract with the given data. ' operationId: createOrUpdate_55 requestBody: description: ' postData ReportExtract DTO representation ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractDto' responses: default: description: ' status of the call ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /finance/reportExtracts/executionHistory/list: get: tags: - ReportExtract summary: ' Returns a list of filtered and paginated report extract execution history. ' description: ' Returns a list of filtered and paginated report extract execution history. ' operationId: listReportExtractRunHistoryGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: DESCENDING responses: default: description: ' list of ReportExtract run history ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractExecutionResultsResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractExecutionResultsResponseDto' post: tags: - ReportExtract summary: ' Returns a list of filtered and paginated ReportExtract. ' description: ' Returns a list of filtered and paginated ReportExtract. ' operationId: listPost_8 requestBody: description: ' pagingAndFiltering managed filtering and paging ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' list of ReportExtract ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractsResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractsResponseDto' /finance/reportExtracts/executionHistory: get: tags: - ReportExtract summary: ' Finds and returns the ReportExtract history of a given id. ' description: ' Finds and returns the ReportExtract history of a given id. ' operationId: findReportExtractHistory_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' report extract execution detail ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractExecutionResultResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractExecutionResultResponseDto' /finance/reportExtracts/list: get: tags: - ReportExtract summary: ' Returns a paginated list of ReportExtract. ' description: ' Returns a paginated list of ReportExtract. ' operationId: listGet_11 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: code - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: DESCENDING responses: default: description: ' list of ReportExtract ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractsResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractsResponseDto' /finance/reportExtracts/run: post: tags: - ReportExtract summary: ' Runs a report extract with the given parameter. ' description: ' Runs a report extract with the given parameter. ' operationId: runReport_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/RunReportExtractDto' application/xml: schema: $ref: '#/components/schemas/RunReportExtractDto' responses: default: description: ' status of the call ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractExecutionResultResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractExecutionResultResponseDto' /finance/reportExtracts: get: tags: - ReportExtract summary: ' Search for a report extract with a given code. ' description: ' Search for a report extract with a given code. ' operationId: find_56 parameters: - name: reportExtractCode in: query schema: type: string responses: default: description: ' matched report extract ' content: application/json: schema: $ref: '#/components/schemas/ReportExtractResponseDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractResponseDto' post: tags: - ReportExtract summary: "\t Creates a report extract with the given data.\t \t " description: "\t Creates a report extract with the given data.\t \t " operationId: create_53 requestBody: description: " postData ReportExtract DTO representation\t " content: application/json: schema: $ref: '#/components/schemas/ReportExtractDto' application/xml: schema: $ref: '#/components/schemas/ReportExtractDto' responses: default: description: " status of the call\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - ReportExtract summary: ' Delete a Report Extract with a given code. ' description: ' Delete a Report Extract with a given code. ' operationId: remove_51 requestBody: description: ' reportExtractCode code of the ReportExtract ' content: application/json: schema: type: string application/xml: schema: type: string responses: default: description: ' status of the call ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /finance/reportExtracts/{code}/enable: post: tags: - ReportExtract summary: ' Enable a Report extract with a given code ' description: ' Enable a Report extract with a given code ' operationId: enable_23 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /finance/reportExtracts/{code}/disable: post: tags: - ReportExtract summary: ' Disable a Report extract with a given code ' description: ' Disable a Report extract with a given code ' operationId: disable_24 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /finance/reportExtracts/version: get: tags: - ReportExtract summary: ' Get version of application ' description: ' Get version of application ' operationId: index_75 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/createOrUpdate: post: tags: - GenericWorkflow summary: ' Create new or update an existing workflow with a given code ' description: ' Create new or update an existing workflow with a given code ' operationId: createOrUpdate_56 requestBody: description: ' genericWorkflowDto The workflow''s data ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/findByEntity: get: tags: - GenericWorkflow summary: ' Find a workflow by entity ' description: ' Find a workflow by entity ' operationId: findByEntity_1 parameters: - name: baseEntityName in: query description: ' baseEntityName ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowsResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowsResponseDto' /admin/genericWorkflow/history: get: tags: - GenericWorkflow summary: ' Find workflow history ' description: ' Find workflow history ' operationId: findHistory_1 parameters: - name: entityInstanceCode in: query description: ' entityInstanceCode ' schema: type: string - name: workflowCode in: query description: ' workflowCode ' schema: type: string - name: fromStatus in: query description: ' fromStatus ' schema: type: string - name: toStatus in: query description: ' toStatus ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/WorkflowInsHistoryResponseDto' application/xml: schema: $ref: '#/components/schemas/WorkflowInsHistoryResponseDto' /admin/genericWorkflow/{code}: delete: tags: - GenericWorkflow summary: ' Remove an existing workflow with a given code ' description: ' Remove an existing workflow with a given code ' operationId: remove_52 parameters: - name: code in: path description: ' code The workflow''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow: get: tags: - GenericWorkflow summary: ' Find a workflow with a given code ' description: ' Find a workflow with a given code ' operationId: find_57 parameters: - name: code in: query description: ' code The workflow''s code ' schema: type: string responses: default: description: ' Generic Work flow Response data ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowResponseDto' put: tags: - GenericWorkflow summary: ' Update an existing workflow ' description: ' Update an existing workflow ' operationId: update_56 requestBody: description: ' genericWorkflowDto The workflow''s data ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - GenericWorkflow summary: ' Create a new workflow ' description: ' Create a new workflow ' operationId: create_56 requestBody: description: ' genericWorkflowDto The workflow''s data ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/execute: post: tags: - GenericWorkflow summary: ' Execute a workflow ' description: ' Execute a workflow ' operationId: execute_3 parameters: - name: baseEntityName in: query description: ' baseEntityName ' schema: type: string - name: entityInstanceCode in: query description: ' entityInstanceCode ' schema: type: string - name: workflowCode in: query description: ' workflowCode ' schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/list: get: tags: - GenericWorkflow summary: ' List of workflows. ' description: ' List of workflows. ' operationId: list_27 responses: default: description: ' A list of workflow ' content: application/json: schema: $ref: '#/components/schemas/GenericWorkflowsResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericWorkflowsResponseDto' /admin/genericWorkflow/{code}/enable: post: tags: - GenericWorkflow summary: ' Enable a Workflow with a given code ' description: ' Enable a Workflow with a given code ' operationId: enable_24 parameters: - name: code in: path description: ' code Workflow code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/{code}/disable: post: tags: - GenericWorkflow summary: ' Disable a Workflow with a given code ' description: ' Disable a Workflow with a given code ' operationId: disable_25 parameters: - name: code in: path description: ' code Workflow code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /admin/genericWorkflow/version: get: tags: - GenericWorkflow summary: ' Get version of application ' description: ' Get version of application ' operationId: index_76 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /hierarchy/userGroupLevel/createOrUpdate: post: tags: - UserHierarchyLevel summary: ' Create new or update an existing user hierarchy level with a given code ' description: ' Create new or update an existing user hierarchy level with a given code ' operationId: createOrUpdate_57 requestBody: description: ' postData The user hierarchy level''s data ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /hierarchy/userGroupLevel/list: get: tags: - UserHierarchyLevel summary: ' List user hierarchy levels matching a given criteria ' description: ' List user hierarchy levels matching a given criteria ' operationId: listGet_12 parameters: - name: query in: query description: ' query Search criteria. Query is composed of the following: filterKey1:filterValue1|filterKey2:filterValue2 ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma. Specify childLevels in fields to include the child levels of user hierarchy level. ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' A list of user hierarchy levels ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelsDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelsDto' post: tags: - UserHierarchyLevel summary: ' List user hierarchy levels matching a given criteria ' description: ' List user hierarchy levels matching a given criteria ' operationId: listPost_12 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria. Specify childLevels in fields to include the child levels of user hierarchy level. ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' A list of user hierarchy levels ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelsDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelsDto' /hierarchy/userGroupLevel/{hierarchyLevelCode}: delete: tags: - UserHierarchyLevel summary: ' Remove an existing hierarchy level with a given code ' description: ' Remove an existing hierarchy level with a given code ' operationId: remove_53 parameters: - name: hierarchyLevelCode in: path description: ' hierarchyLevelCode The hierarchy level''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /hierarchy/userGroupLevel: get: tags: - UserHierarchyLevel summary: ' Search for a user group level with a given code. ' description: ' Search for a user group level with a given code. ' operationId: find_58 parameters: - name: hierarchyLevelCode in: query description: ' hierarchyLevelCode the code to string ' schema: type: string responses: default: description: ' the UserHierarchyLevel given the hierarchyCode ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelResponseDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelResponseDto' put: tags: - UserHierarchyLevel summary: ' Update an existing user hierarchy level ' description: ' Update an existing user hierarchy level ' operationId: update_57 requestBody: description: ' postData The user hierarchy level''s data ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - UserHierarchyLevel summary: ' Create a new user hierarchy level ' description: ' Create a new user hierarchy level ' operationId: create_57 requestBody: description: ' postData The user hierarchy level''s data ' content: application/json: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' application/xml: schema: $ref: '#/components/schemas/UserHierarchyLevelDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /hierarchy/userGroupLevel/version: get: tags: - UserHierarchyLevel summary: ' Get version of application ' description: ' Get version of application ' operationId: index_77 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /importExport/importData: post: tags: - ImportExport summary: ' Send a file to be imported. ImportExportResponseDto.executionId contains ' description: ' Send a file to be imported. ImportExportResponseDto.executionId contains ' operationId: importData_1 requestBody: description: ' input file containing a list of object for import ' content: multipart/form-data: schema: $ref: '#/components/schemas/MultipartFormDataInput' responses: default: description: ' As import is async process, ImportExportResponseDto.executionId contains and ID to be used to query for execution results via a call to/importExport/checkImportDataResult?id=.. ' content: application/json: schema: $ref: '#/components/schemas/ImportExportResponseDto' application/xml: schema: $ref: '#/components/schemas/ImportExportResponseDto' /importExport/checkImportDataResult: get: tags: - ImportExport summary: ' Check for execution results for a given execution identifier ' description: ' Check for execution results for a given execution identifier ' operationId: checkImportDataResult_1 parameters: - name: executionId in: query description: ' executionId Returned in /importExport/importData call ' schema: type: string responses: default: description: ' the execution result ' content: application/json: schema: $ref: '#/components/schemas/ImportExportResponseDto' application/xml: schema: $ref: '#/components/schemas/ImportExportResponseDto' /importExport/version: get: tags: - ImportExport summary: ' Get version of application ' description: ' Get version of application ' operationId: index_78 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoice/validate: post: tags: - Invoice summary: ' Validate an invoice based on the invoice id. ' description: ' Validate an invoice based on the invoice id. ' operationId: validate_1 requestBody: content: application/json: schema: type: object properties: invoiceId: type: integer format: int64 application/xml: schema: type: object properties: invoiceId: type: integer format: int64 responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoice/cancel: post: tags: - Invoice summary: ' Cancel an invoice based on invoice id. ' description: ' Cancel an invoice based on invoice id. ' operationId: cancel_1 requestBody: description: ' invoiceId Invoice id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoice/list: get: tags: - Invoice summary: ' List invoices matching a given criteria. ' description: ' List invoices matching a given criteria. ' operationId: listGet_13 parameters: - name: query in: query description: ' query Search criteria. Query is composed of the following: filterKey1:filterValue1|filterKey2:filterValue2 ' schema: type: string - name: fields in: query description: ' fields Data retrieval options/fieldnames separated by a comma. Specify transactions in fields to include transactions and pdf to generate/include PDF document ' schema: type: string - name: offset in: query description: ' offset Pagination - from record number ' schema: type: integer format: int32 - name: limit in: query description: ' limit Pagination - number of records to retrieve ' schema: type: integer format: int32 - name: sortBy in: query description: ' sortBy Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields. ' schema: type: string default: id - name: sortOrder in: query description: ' sortOrder Sorting - sort order. ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An invoice list ' content: application/json: schema: $ref: '#/components/schemas/InvoicesDto' application/xml: schema: $ref: '#/components/schemas/InvoicesDto' post: tags: - Invoice summary: ' List invoices matching a given criteria. ' description: ' List invoices matching a given criteria. ' operationId: listPost_13 requestBody: description: ' pagingAndFiltering Pagination and filtering criteria. Specify transactions in fields to include transactions and pdf to generate/include PDF document ' content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An invoice list ' content: application/json: schema: $ref: '#/components/schemas/InvoicesDto' application/xml: schema: $ref: '#/components/schemas/InvoicesDto' /invoice: get: tags: - Invoice summary: ' Search for an invoice given an invoice id or invoice number and invoice type. ' description: ' Search for an invoice given an invoice id or invoice number and invoice type. ' operationId: findInvoiceByIdOrType_1 parameters: - name: id in: query description: ' id invoice id ' schema: type: integer format: int64 - name: invoiceNumber in: query description: ' invoiceNumber invoice number ' schema: type: string - name: invoiceType in: query description: ' invoiceType invoice type ' schema: type: string - name: includeTransactions in: query description: ' includeTransactions Should transactions associated to an invoice be listed ' schema: type: boolean - name: includePdf in: query description: ' includePdf true if we want to generate/include pdf ' schema: type: boolean - name: includeXml in: query description: ' includeXml true if we want to generate/include xml ' schema: type: boolean responses: default: description: ' instance of GetInvoiceResponseDto ' content: application/json: schema: $ref: '#/components/schemas/GetInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetInvoiceResponseDto' post: tags: - Invoice summary: ' Create invoice. Invoice number depends on invoice type ' description: ' Create invoice. Invoice number depends on invoice type ' operationId: create_58 requestBody: description: ' invoiceDto invoice dto ' content: application/json: schema: $ref: '#/components/schemas/InvoiceDto' application/xml: schema: $ref: '#/components/schemas/InvoiceDto' responses: default: description: ' created invoice ' content: application/json: schema: $ref: '#/components/schemas/CreateInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/CreateInvoiceResponseDto' /invoice/generateInvoice: post: tags: - Invoice summary: ' Launch all the invoicing process for a given billingAccount, that''s mean' description: ' Launch all the invoicing process for a given billingAccount, that''s mean. ' operationId: generateInvoice_1 requestBody: description: ' generateInvoiceRequestDto Contains the code of the billing account invoicing and last transaction date ' content: application/json: schema: $ref: '#/components/schemas/GenerateInvoiceRequestDto' application/xml: schema: $ref: '#/components/schemas/GenerateInvoiceRequestDto' responses: default: description: ' invoice response ' content: application/json: schema: $ref: '#/components/schemas/GenerateInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GenerateInvoiceResponseDto' /invoice/getXMLInvoice: post: tags: - Invoice summary: ' Finds an invoice based on its invoice number and return it as xml string. ' description: ' Finds an invoice based on its invoice number and return it as xml string. ' operationId: findXMLInvoice_2 requestBody: description: ' invoiceId invoice''s id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' xml invoice ' content: application/json: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' /invoice/fetchXMLInvoice: post: tags: - Invoice summary: ' Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string. ' description: ' Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string. ' operationId: findXMLInvoice requestBody: description: ' xmlInvoiceRequestDto contains invoice number and optionally an invoice type ' content: application/json: schema: $ref: '#/components/schemas/GetXmlInvoiceRequestDto' application/xml: schema: $ref: '#/components/schemas/GetXmlInvoiceRequestDto' responses: default: description: ' xml invoice ' content: application/json: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' /invoice/getXMLInvoiceWithType: post: tags: - Invoice summary: ' Finds an invoice based on invoice number and invoice type. It returns the result as xml string ' description: ' Finds an invoice based on invoice number and invoice type. It returns the result as xml string ' operationId: findXMLInvoiceWithType_1 requestBody: description: ' invoiceId invoice''s id. ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' xml invoice ' content: application/json: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetXmlInvoiceResponseDto' /invoice/getPdfInvoice: post: tags: - Invoice summary: ' Finds an invoice based on invoice number and return it as pdf as byte []' description: ' 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. ' operationId: findPdfInvoice_2 requestBody: description: ' invoiceId invoice''s id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' pdf invoice ' content: application/json: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' /invoice/fetchPdfInvoice: post: tags: - Invoice summary: ' Finds an invoice based on invoice number and optionally an invoice type and return it as pdf as byte []' description: ' 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. ' operationId: findPdfInvoice requestBody: description: ' pdfInvoiceRequestDto contains an invoice number and optionally an invoice type ' content: application/json: schema: $ref: '#/components/schemas/GetPdfInvoiceRequestDto' application/xml: schema: $ref: '#/components/schemas/GetPdfInvoiceRequestDto' responses: default: description: ' pdf invoice ' content: application/json: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' /invoice/getPdfInvoiceWithType: post: tags: - Invoice summary: ' Finds an invoice based on invoice number and invoice type and return it as pdf as byte []' description: ' 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. ' operationId: findPdfInvoiceWithType_1 requestBody: description: ' invoiceId invoice''s id ' content: application/json: schema: type: integer format: int64 application/xml: schema: type: integer format: int64 responses: default: description: ' pdf invoice ' content: application/json: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GetPdfInvoiceResponseDto' /invoice/listPresentInAR: get: tags: - Invoice summary: ' List invoices with account operation for a given customer account Deprecated in v' description: ' 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 ' operationId: listPresentInAR_1 parameters: - name: customerAccountCode in: query description: ' customerAccountCode Customer account code ' schema: type: string - name: includePdf in: query description: ' includePdf true if we want to generate/include pdf ' schema: type: boolean responses: default: description: ' List of invoices ' content: application/json: schema: $ref: '#/components/schemas/CustomerInvoicesResponse' application/xml: schema: $ref: '#/components/schemas/CustomerInvoicesResponse' deprecated: true /invoice/generateDraftInvoice: post: tags: - Invoice summary: ' Generate a Draft invoice ' description: ' Generate a Draft invoice ' operationId: generateDraftInvoice_1 requestBody: description: ' generateInvoiceRequestDto Post data ' content: application/json: schema: $ref: '#/components/schemas/GenerateInvoiceRequestDto' application/xml: schema: $ref: '#/components/schemas/GenerateInvoiceRequestDto' responses: default: description: ' action status. ' content: application/json: schema: $ref: '#/components/schemas/GenerateInvoiceResponseDto' application/xml: schema: $ref: '#/components/schemas/GenerateInvoiceResponseDto' /invoice/sendByEmail: post: tags: - Invoice summary: ' Send invoice by Email. ' description: ' Send invoice by Email. ' operationId: sendByEmail_1 requestBody: description: ' invoiceDto the invoice DTO ' content: application/json: schema: $ref: '#/components/schemas/InvoiceDto' application/xml: schema: $ref: '#/components/schemas/InvoiceDto' responses: default: description: ' SUCCESS if sent, FAIL else ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /invoice/listInvoiceByCustomerAccount: get: tags: - Invoice summary: ' Search for a list of invoices given a customer account code' description: ' 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 ' operationId: find_59 parameters: - name: customerAccountCode in: query description: ' customerAccountCode Customer account code ' schema: type: string - name: returnPdf in: query description: ' returnPdf true if we want to generate pdf ' schema: type: boolean responses: default: description: ' customer invoice. ' content: application/json: schema: $ref: '#/components/schemas/CustomerInvoicesResponse' application/xml: schema: $ref: '#/components/schemas/CustomerInvoicesResponse' deprecated: true /invoice/version: get: tags: - Invoice summary: ' Get version of application ' description: ' Get version of application ' operationId: index_79 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/createOrUpdate: post: tags: - JobInstance summary: ' Create new or update an existing job instance with a given code ' description: ' Create new or update an existing job instance with a given code ' operationId: createOrUpdate_60 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/{jobInstanceCode}: delete: tags: - JobInstance summary: ' Remove an existing job instance with a given code ' description: ' Remove an existing job instance with a given code ' operationId: remove_55 parameters: - name: jobInstanceCode in: path description: ' jobInstanceCode The job instance''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/update: post: tags: - JobInstance summary: ' Update an existing job instance ' description: ' Update an existing job instance ' operationId: update_60 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance: get: tags: - JobInstance summary: ' Find a job instance with a given code ' description: ' Find a job instance with a given code ' operationId: find_62 parameters: - name: jobInstanceCode in: query description: ' jobInstanceCode The job instance''s code ' schema: type: string responses: default: description: ' Job Instance Response data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceResponseDto' /jobInstance/create: post: tags: - JobInstance summary: ' Create a new job instance ' description: ' Create a new job instance ' operationId: create_61 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/{code}/enable: post: tags: - JobInstance summary: ' Enable a Job instance with a given code ' description: ' Enable a Job instance with a given code ' operationId: enable_26 parameters: - name: code in: path description: ' code Job instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/{code}/disable: post: tags: - JobInstance summary: ' Disable a Job instance with a given code ' description: ' Disable a Job instance with a given code ' operationId: disable_27 parameters: - name: code in: path description: ' code Job instance code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /jobInstance/version: get: tags: - JobInstance summary: ' Get version of application ' description: ' Get version of application ' operationId: index_82 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/createOrUpdate: post: tags: - Job summary: ' Create new or update an existing job instance with a given code ' description: ' Create new or update an existing job instance with a given code ' operationId: createOrUpdate_21 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/timer: get: tags: - Job summary: ' Find a timer with a given code ' description: ' Find a timer with a given code ' operationId: findTimer_1 parameters: - name: timerCode in: query description: ' timerCode The timer''s code ' schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityResponseDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityResponseDto' put: tags: - Job summary: ' Update an existing timer entity ' description: ' Update an existing timer entity ' operationId: updateTimer_1 requestBody: description: ' postData The timer entity''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Job summary: ' Create a new timer entity ' description: ' Create a new timer entity ' operationId: createTimer_1 requestBody: description: ' postData The timer entity''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/timer/createOrUpdate: post: tags: - Job summary: ' Create new or update an existing timer entity with a given code ' description: ' Create new or update an existing timer entity with a given code ' operationId: createOrUpdateTimer_1 requestBody: description: ' postData The timer entity''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/timer/{timerCode}: delete: tags: - Job summary: ' Remove an existing timer with a given code ' description: ' Remove an existing timer with a given code ' operationId: removeTimer_1 parameters: - name: timerCode in: path description: ' timerCode The timer''s code ' required: true schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/jobReport: get: tags: - Job summary: ' Find a job execution result with a given id ' description: ' Find a job execution result with a given id ' operationId: findJobExecutionResult_1 parameters: - name: code in: query description: ' code string to match the code of the JobInstance ' schema: type: string - name: id in: query description: ' jobExecutionResultId A jobExecutionResultId ' schema: type: integer format: int64 responses: default: description: ' object containing the JobExecutionResultImpl ' content: application/json: schema: $ref: '#/components/schemas/JobExecutionResultResponseDto' application/xml: schema: $ref: '#/components/schemas/JobExecutionResultResponseDto' /job/listCategories: get: tags: - Job summary: ' List job categories ' description: ' List job categories ' operationId: listCategories_1 responses: default: description: ' object containing the list of job categories ' content: application/json: schema: $ref: '#/components/schemas/JobCategoriesResponseDto' application/xml: schema: $ref: '#/components/schemas/JobCategoriesResponseDto' /job/{jobInstanceCode}: delete: tags: - Job summary: ' Remove an existing job instance with a given code ' description: ' Remove an existing job instance with a given code ' operationId: remove_19 parameters: - name: jobInstanceCode in: path description: ' jobInstanceCode The job instance''s code ' required: true schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job: get: tags: - Job summary: ' Find a job instance with a given code ' description: ' Find a job instance with a given code ' operationId: find_20 parameters: - name: jobInstanceCode in: query description: ' jobInstanceCode string to match the code of JobInstance ' schema: type: string responses: default: description: ' object containing the matched JobInstance ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceResponseDto' put: tags: - Job summary: ' Update an existing job instance ' description: ' Update an existing job instance ' operationId: update_20 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/execute: post: tags: - Job summary: ' Execute a given job instance info ' description: ' Execute a given job instance info ' operationId: execute_4 requestBody: description: ' postData job instance info''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceInfoDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceInfoDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/JobExecutionResultResponseDto' application/xml: schema: $ref: '#/components/schemas/JobExecutionResultResponseDto' /job/create: post: tags: - Job summary: ' Create a new job instance ' description: ' Create a new job instance ' operationId: create_20 requestBody: description: ' postData The job instance''s data ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceDto' responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/stop/{jobInstanceCode}: post: tags: - Job summary: ' Stop a given job instance info ' description: ' Stop a given job instance info ' operationId: stop_1 parameters: - name: jobInstanceCode in: path description: ' jobInstanceCode job instance code ' required: true schema: type: string responses: default: description: ' request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /job/list: get: tags: - Job summary: ' Deprecated in v.4.7.2 Use /list instead. ' description: ' Deprecated in v.4.7.2 Use /list instead. ' operationId: list_28 parameters: - name: offset in: query description: ' offset offset ' schema: type: integer format: int32 - name: limit in: query description: ' limit number of elements in response ' schema: type: integer format: int32 - name: mergedCF in: query description: ' mergedCF true if return ' schema: type: boolean default: false - name: sortBy in: query description: ' sortBy sortby field ' schema: type: string default: code - name: sortOrder in: query description: ' sortOrder ASC/DESC ' schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' list of all subscriptions. ' content: application/json: schema: $ref: '#/components/schemas/JobInstanceListResponseDto' application/xml: schema: $ref: '#/components/schemas/JobInstanceListResponseDto' /job/version: get: tags: - Job summary: ' Get version of application ' description: ' Get version of application ' operationId: index_25 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity/createOrUpdate: post: tags: - TimerEntity summary: ' Create new or update an existing timer schedule with a given code ' description: ' Create new or update an existing timer schedule with a given code ' operationId: createOrUpdate_58 requestBody: description: ' postData The timer schedule''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity/update: post: tags: - TimerEntity summary: ' Update an existing timer schedule ' description: ' Update an existing timer schedule ' operationId: update_58 requestBody: description: ' postData The timer schedule''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity: get: tags: - TimerEntity summary: ' Find a timer schedule with a given code ' description: ' Find a timer schedule with a given code ' operationId: find_60 parameters: - name: timerEntityCode in: query description: ' timerEntityCode The timer schedule''s code ' schema: type: string responses: default: description: ' Return timerEntity ' content: application/json: schema: $ref: '#/components/schemas/GetTimerEntityResponseDto' application/xml: schema: $ref: '#/components/schemas/GetTimerEntityResponseDto' /timerEntity/create: post: tags: - TimerEntity summary: ' Create a new timer schedule ' description: ' Create a new timer schedule ' operationId: create_59 requestBody: description: ' postData The timer schedule''s data ' content: application/json: schema: $ref: '#/components/schemas/TimerEntityDto' application/xml: schema: $ref: '#/components/schemas/TimerEntityDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity/{code}/enable: post: tags: - TimerEntity summary: ' Enable a Timer schedule with a given code ' description: ' Enable a Timer schedule with a given code ' operationId: enable_4 parameters: - name: code in: path description: ' code Timer schedule code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity/{code}/disable: post: tags: - TimerEntity summary: ' Disable a Timer schedule with a given code ' description: ' Disable a Timer schedule with a given code ' operationId: disable_4 parameters: - name: code in: path description: ' code Timer schedule code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /timerEntity/version: get: tags: - TimerEntity summary: ' Get version of application ' description: ' Get version of application ' operationId: index_80 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/install: put: tags: - Module summary: ' Install Meveo module ' description: ' Install Meveo module ' operationId: install_5 requestBody: content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDto' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/createOrUpdate: post: tags: - Module summary: ' Create new or update an existing Meveo module ' description: ' Create new or update an existing Meveo module ' operationId: createOrUpdate_61 requestBody: content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDto' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/enable: get: tags: - Module summary: ' Enable a Meveo''s module with a given code ' description: ' Enable a Meveo''s module with a given code ' operationId: enableGet_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/disable: get: tags: - Module summary: ' Disable a Meveo''s module with a given code ' description: ' Disable a Meveo''s module with a given code ' operationId: disableGet_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/uninstall: get: tags: - Module summary: ' uninstall a Meveo''s module with a given code ' description: ' uninstall a Meveo''s module with a given code ' operationId: uninstall_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module: get: tags: - Module summary: ' Find a Meveo''s module with a given code ' description: ' Find a Meveo''s module with a given code ' operationId: get_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Meveo module DTO Response. ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtoResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtoResponse' put: tags: - Module summary: ' Update an existing Meveo module ' description: ' Update an existing Meveo module ' operationId: update_61 requestBody: content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDto' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Module summary: ' Create a new meveo module ' description: ' Create a new meveo module ' operationId: create_62 requestBody: content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDto' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/{code}: delete: tags: - Module summary: ' Remove an existing module with a given code ' description: ' Remove an existing module with a given code ' operationId: delete_3 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/list: get: tags: - Module summary: ' List all Meveo''s modules ' description: ' List all Meveo''s modules ' operationId: list_29 responses: default: description: ' A list of Meveo''s modules ' content: application/json: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/MeveoModuleDtosResponse' /module/{code}/enable: post: tags: - Module summary: ' Enable a Opencell module with a given code ' description: ' Enable a Opencell module with a given code ' operationId: enable_27 parameters: - name: code in: path description: ' code Opencell module code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/{code}/disable: post: tags: - Module summary: ' Disable a Opencell module with a given code ' description: ' Disable a Opencell module with a given code ' operationId: disable_28 parameters: - name: code in: path description: ' code Opencell module code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /module/version: get: tags: - Module summary: ' Get version of application ' description: ' Get version of application ' operationId: index_83 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email/createOrUpdate: post: tags: - EmailNotification summary: ' Create new or update an existing email notification with a given code ' description: ' Create new or update an existing email notification with a given code ' operationId: createOrUpdate_65 requestBody: description: ' postData The email notification''s data ' content: application/json: schema: $ref: '#/components/schemas/EmailNotificationDto' application/xml: schema: $ref: '#/components/schemas/EmailNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email/{notificationCode}: delete: tags: - EmailNotification summary: ' Remove an existing email notification with a given code ' description: ' Remove an existing email notification with a given code ' operationId: remove_59 parameters: - name: notificationCode in: path description: ' notificationCode The email notification''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email: get: tags: - EmailNotification summary: ' Find a email notification with a given code ' description: ' Find a email notification with a given code ' operationId: find_66 parameters: - name: notificationCode in: query description: ' notificationCode The email notification''s code ' schema: type: string responses: default: description: ' Email Notification Response data ' content: application/json: schema: $ref: '#/components/schemas/GetEmailNotificationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetEmailNotificationResponseDto' put: tags: - EmailNotification summary: ' Update an existing email notification ' description: ' Update an existing email notification ' operationId: update_65 requestBody: description: ' postData The email notification''s data ' content: application/json: schema: $ref: '#/components/schemas/EmailNotificationDto' application/xml: schema: $ref: '#/components/schemas/EmailNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - EmailNotification summary: ' Create a new email notification ' description: ' Create a new email notification ' operationId: create_66 requestBody: description: ' postData The email notification''s data ' content: application/json: schema: $ref: '#/components/schemas/EmailNotificationDto' application/xml: schema: $ref: '#/components/schemas/EmailNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email/{code}/enable: post: tags: - EmailNotification summary: ' Enable a Email notification with a given code ' description: ' Enable a Email notification with a given code ' operationId: enable_31 parameters: - name: code in: path description: ' code Email notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email/{code}/disable: post: tags: - EmailNotification summary: ' Disable a Email notification with a given code ' description: ' Disable a Email notification with a given code ' operationId: disable_32 parameters: - name: code in: path description: ' code Email notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/email/version: get: tags: - EmailNotification summary: ' Get version of application ' description: ' Get version of application ' operationId: index_87 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger/createOrUpdate: post: tags: - JobTrigger summary: ' Create new or update an existing job trigger with a given code ' description: ' Create new or update an existing job trigger with a given code ' operationId: createOrUpdate_59 requestBody: description: ' postData The job trigger''s data ' content: application/json: schema: $ref: '#/components/schemas/JobTriggerDto' application/xml: schema: $ref: '#/components/schemas/JobTriggerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger/{notificationCode}: delete: tags: - JobTrigger summary: ' Remove an existing job trigger with a given code ' description: ' Remove an existing job trigger with a given code ' operationId: remove_54 parameters: - name: notificationCode in: path description: ' notificationCode The job trigger''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger: get: tags: - JobTrigger summary: ' Find a job trigger with a given code ' description: ' Find a job trigger with a given code ' operationId: find_61 parameters: - name: notificationCode in: query description: ' notificationCode The job trigger''s code ' schema: type: string responses: default: description: ' Job Trigger Response data ' content: application/json: schema: $ref: '#/components/schemas/GetJobTriggerResponseDto' application/xml: schema: $ref: '#/components/schemas/GetJobTriggerResponseDto' put: tags: - JobTrigger summary: ' Update an existing job trigger ' description: ' Update an existing job trigger ' operationId: update_59 requestBody: description: ' postData The job trigger''s data ' content: application/json: schema: $ref: '#/components/schemas/JobTriggerDto' application/xml: schema: $ref: '#/components/schemas/JobTriggerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - JobTrigger summary: ' Create a new job trigger ' description: ' Create a new job trigger ' operationId: create_60 requestBody: description: ' postData The job trigger''s data ' content: application/json: schema: $ref: '#/components/schemas/JobTriggerDto' application/xml: schema: $ref: '#/components/schemas/JobTriggerDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger/{code}/enable: post: tags: - JobTrigger summary: ' Enable a Job execution trigger notification with a given code ' description: ' Enable a Job execution trigger notification with a given code ' operationId: enable_25 parameters: - name: code in: path description: ' code Job execution trigger notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger/{code}/disable: post: tags: - JobTrigger summary: ' Disable a Job execution trigger notification with a given code ' description: ' Disable a Job execution trigger notification with a given code ' operationId: disable_26 parameters: - name: code in: path description: ' code Job execution trigger notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/jobTrigger/version: get: tags: - JobTrigger summary: ' Get version of application ' description: ' Get version of application ' operationId: index_81 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/createOrUpdate: post: tags: - Notification summary: ' Create new or update an existing notification with a given code ' description: ' Create new or update an existing notification with a given code ' operationId: createOrUpdate_62 requestBody: description: ' postData The notification''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptNotificationDto' application/xml: schema: $ref: '#/components/schemas/ScriptNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/listNotificationHistory: get: tags: - Notification summary: ' List the notification history ' description: ' List the notification history ' operationId: listNotificationHistory_1 responses: default: description: ' Notification history list ' content: application/json: schema: $ref: '#/components/schemas/NotificationHistoriesResponseDto' application/xml: schema: $ref: '#/components/schemas/NotificationHistoriesResponseDto' /notification/listInboundRequest: get: tags: - Notification summary: ' List inbound requests ' description: ' List inbound requests ' operationId: listInboundRequest_1 responses: default: description: ' A list of inbound requests ' content: application/json: schema: $ref: '#/components/schemas/InboundRequestsResponseDto' application/xml: schema: $ref: '#/components/schemas/InboundRequestsResponseDto' /notification/{notificationCode}: delete: tags: - Notification summary: ' Remove an existing notification with a given code ' description: ' Remove an existing notification with a given code ' operationId: remove_56 parameters: - name: notificationCode in: path description: ' notificationCode The notification''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification: get: tags: - Notification summary: ' Find a notification with a given code ' description: ' Find a notification with a given code ' operationId: find_63 parameters: - name: notificationCode in: query description: ' notificationCode The notification''s code ' schema: type: string responses: default: description: ' Script notification information ' content: application/json: schema: $ref: '#/components/schemas/GetScriptNotificationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetScriptNotificationResponseDto' put: tags: - Notification summary: ' Update an existing notification ' description: ' Update an existing notification ' operationId: update_62 requestBody: description: ' postData The notification''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptNotificationDto' application/xml: schema: $ref: '#/components/schemas/ScriptNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Notification summary: ' Create a new notification ' description: ' Create a new notification ' operationId: create_63 requestBody: description: ' postData The notification''s data ' content: application/json: schema: $ref: '#/components/schemas/ScriptNotificationDto' application/xml: schema: $ref: '#/components/schemas/ScriptNotificationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/{code}/enable: post: tags: - Notification summary: ' Enable a Script type notification with a given code ' description: ' Enable a Script type notification with a given code ' operationId: enable_28 parameters: - name: code in: path description: ' code Script type notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/{code}/disable: post: tags: - Notification summary: ' Disable a Script type notification with a given code ' description: ' Disable a Script type notification with a given code ' operationId: disable_29 parameters: - name: code in: path description: ' code Script type notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/version: get: tags: - Notification summary: ' Get version of application ' description: ' Get version of application ' operationId: index_84 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook/createOrUpdate: post: tags: - WebHookNotification summary: ' Create new or update an existing web hook notification with a given code ' description: ' Create new or update an existing web hook notification with a given code ' operationId: createOrUpdate_63 requestBody: description: ' postData The web hook notification''s data ' content: application/json: schema: $ref: '#/components/schemas/WebHookDto' application/xml: schema: $ref: '#/components/schemas/WebHookDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook/{notificationCode}: delete: tags: - WebHookNotification summary: ' Remove an existing web hook notification with a given code ' description: ' Remove an existing web hook notification with a given code ' operationId: remove_57 parameters: - name: notificationCode in: path description: ' notificationCode The web hook notification''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook: get: tags: - WebHookNotification summary: ' Find a web hook notification with a given code ' description: ' Find a web hook notification with a given code ' operationId: find_64 parameters: - name: notificationCode in: query description: ' notificationCode The web hook notification''s code ' schema: type: string responses: default: description: ' WebHook Notification Response data ' content: application/json: schema: $ref: '#/components/schemas/GetWebHookNotificationResponseDto' application/xml: schema: $ref: '#/components/schemas/GetWebHookNotificationResponseDto' put: tags: - WebHookNotification summary: ' Update an existing web hook notification ' description: ' Update an existing web hook notification ' operationId: update_63 requestBody: description: ' postData The web hook notification''s data ' content: application/json: schema: $ref: '#/components/schemas/WebHookDto' application/xml: schema: $ref: '#/components/schemas/WebHookDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - WebHookNotification summary: ' Create a new web hook notification ' description: ' Create a new web hook notification ' operationId: create_64 requestBody: description: ' postData The web hook notification''s data ' content: application/json: schema: $ref: '#/components/schemas/WebHookDto' application/xml: schema: $ref: '#/components/schemas/WebHookDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook/{code}/enable: post: tags: - WebHookNotification summary: ' Enable a Webhook notification with a given code ' description: ' Enable a Webhook notification with a given code ' operationId: enable_29 parameters: - name: code in: path description: ' code Webhook notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook/{code}/disable: post: tags: - WebHookNotification summary: ' Disable a Webhook notification with a given code ' description: ' Disable a Webhook notification with a given code ' operationId: disable_30 parameters: - name: code in: path description: ' code Webhook notification code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /notification/webhook/version: get: tags: - WebHookNotification summary: ' Get version of application ' description: ' Get version of application ' operationId: index_85 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/list: get: tags: - AccountOperation summary: ' List account operations matching a given criteria ' description: ' List account operations matching a given criteria ' operationId: listGet_14 parameters: - name: customerAccountCode in: query schema: type: string - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: DESCENDING responses: default: description: ' A list of account operations ' content: application/json: schema: $ref: '#/components/schemas/AccountOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountOperationsResponseDto' post: tags: - AccountOperation summary: ' List account operations matching a given criteria ' description: ' List account operations matching a given criteria ' operationId: listPost_14 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' List of account operations ' content: application/json: schema: $ref: '#/components/schemas/AccountOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountOperationsResponseDto' /accountOperation/updatePaymentMethod: put: tags: - AccountOperation summary: ' Update payment method for all customerAccount AO''s if customerAccountCode is set.Or single AO if aoId is set. ' description: ' Update payment method for all customerAccount AO''s if customerAccountCode is set.Or single AO if aoId is set. ' operationId: updatePaymentMethod_2 parameters: - name: customerAccountCode in: query schema: type: string - name: aoId in: query schema: type: integer format: int64 - name: paymentMethod in: query schema: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/matchOperations: post: tags: - AccountOperation summary: ' Match operations ' description: ' Match operations ' operationId: matchOperations_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/MatchOperationRequestDto' application/xml: schema: $ref: '#/components/schemas/MatchOperationRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/unMatchingOperations: post: tags: - AccountOperation summary: ' Unmatching operations ' description: ' Unmatching operations ' operationId: unMatchingOperations_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/UnMatchingOperationRequestDto' application/xml: schema: $ref: '#/components/schemas/UnMatchingOperationRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/addLitigation: post: tags: - AccountOperation summary: ' Add a new litigation ' description: ' Add a new litigation ' operationId: addLitigation_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/LitigationRequestDto' application/xml: schema: $ref: '#/components/schemas/LitigationRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/cancelLitigation: post: tags: - AccountOperation summary: ' Cancel a litigation ' description: ' Cancel a litigation ' operationId: cancelLitigation_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/LitigationRequestDto' application/xml: schema: $ref: '#/components/schemas/LitigationRequestDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/{accountOperationId}/listMatchedOperations: get: tags: - AccountOperation summary: ' List matched operations for a given account operation ' description: ' List matched operations for a given account operation ' operationId: listMatchedOperations_1 parameters: - name: accountOperationId in: path required: true schema: type: integer format: int64 responses: default: description: ' A list of matched operations ' content: application/json: schema: $ref: '#/components/schemas/MatchedOperationsResponseDto' application/xml: schema: $ref: '#/components/schemas/MatchedOperationsResponseDto' /accountOperation: get: tags: - AccountOperation summary: ' Finds an accountOperation given an id. ' description: ' Finds an accountOperation given an id. ' operationId: find_69 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' Account operation response ' content: application/json: schema: $ref: '#/components/schemas/AccountOperationResponseDto' application/xml: schema: $ref: '#/components/schemas/AccountOperationResponseDto' post: tags: - AccountOperation summary: ' Create a new account operation ' description: ' Create a new account operation ' operationId: create_71 requestBody: description: ' postData The account operation''s data ' content: application/json: schema: $ref: '#/components/schemas/AccountOperationDto' application/xml: schema: $ref: '#/components/schemas/AccountOperationDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /accountOperation/version: get: tags: - AccountOperation summary: ' Get version of application ' description: ' Get version of application ' operationId: index_94 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/creditCategory/createOrUpdate: post: tags: - CreditCategory summary: ' Create or update a credit category payment ' description: ' Create or update a credit category payment ' operationId: createOrUpdate_67 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditCategoryDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/creditCategory/{creditCategoryCode}: delete: tags: - CreditCategory summary: ' Delete a credit category with his given code ' description: ' Delete a credit category with his given code ' operationId: remove_61 parameters: - name: creditCategoryCode in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/creditCategory: get: tags: - CreditCategory summary: ' Get a credit category payment with a credit category code ' description: ' Get a credit category payment with a credit category code ' operationId: find_65 parameters: - name: creditCategoryCode in: query schema: type: string responses: default: description: ' Credit Category Response data ' content: application/json: schema: $ref: '#/components/schemas/CreditCategoryResponseDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoryResponseDto' put: tags: - CreditCategory summary: ' Update a credit category payment ' description: ' Update a credit category payment ' operationId: update_68 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditCategoryDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - CreditCategory summary: ' Create a new credit category ' description: ' Create a new credit category ' operationId: create_65 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditCategoryDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoryDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/creditCategory/list: get: tags: - CreditCategory summary: ' Retrieve the list of credit category paiement ' description: ' Retrieve the list of credit category paiement ' operationId: list_33 responses: default: description: ' List of Credit Categories ' content: application/json: schema: $ref: '#/components/schemas/CreditCategoriesResponseDto' application/xml: schema: $ref: '#/components/schemas/CreditCategoriesResponseDto' /payment/creditCategory/version: get: tags: - CreditCategory summary: ' Get version of application ' description: ' Get version of application ' operationId: index_86 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/ddrequestLotOp: post: tags: - DDRequestLotOp summary: "\t Create a ddrequestLotOp by dto\t " description: "\t Create a ddrequestLotOp by dto\t " operationId: create_67 requestBody: description: " dto DDRequestLotOp Dto\t " content: application/json: schema: $ref: '#/components/schemas/DDRequestLotOpDto' application/xml: schema: $ref: '#/components/schemas/DDRequestLotOpDto' responses: default: description: " Action status\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/ddrequestLotOp/list: get: tags: - DDRequestLotOp summary: ' List ddrequestLotOps by fromDueDate,toDueDate,status ' description: ' List ddrequestLotOps by fromDueDate,toDueDate,status ' operationId: list_10 parameters: - name: fromDueDate in: query description: ' fromDueDate Start of search due date interval ' schema: type: string format: date-time - name: toDueDate in: query description: ' toDueDate End of search due date interval ' schema: type: string format: date-time - name: status in: query description: ' status DDRequestOp status ' schema: type: string enum: - WAIT - PROCESSED - ERROR responses: default: description: ' DDRequestLotOps response ' content: application/json: schema: $ref: '#/components/schemas/DDRequestLotOpsResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestLotOpsResponseDto' /payment/ddrequestLotOp/version: get: tags: - DDRequestLotOp summary: ' Get version of application ' description: ' Get version of application ' operationId: index_88 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /iban/validate: get: tags: - IBan summary: ' validate the iban and/or bic ' description: ' validate the iban and/or bic ' operationId: validate_2 parameters: - name: iban in: query description: ' iban the International Bank Account Number to validate ' schema: type: string - name: bic in: query description: ' bic the Bank Identifier Code to validate ' schema: type: string responses: default: description: ' the status of the validation ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /iban/version: get: tags: - IBan summary: ' Get version of application ' description: ' Get version of application ' operationId: index_89 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/ddRequestBuilder: get: tags: - Payment summary: ' Retrieve ddRequest builder by its code. ' description: ' Retrieve ddRequest builder by its code. ' operationId: findDDRequestBuilder_1 parameters: - name: code in: query schema: type: string responses: default: description: ' ddRequest builder DTO ' content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' put: tags: - Payment summary: ' Update existing ddRequest builder. ' description: ' Update existing ddRequest builder. ' operationId: updateDDRequestBuilder_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderDto' responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Add a new ddRequest builder. ' description: ' Add a new ddRequest builder. ' operationId: addDDRequestBuilder_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderDto' responses: default: description: ' the ddRequestBuilder dto created ' content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' delete: tags: - Payment summary: ' Remove ddRequest builder. ' description: ' Remove ddRequest builder. ' operationId: removeDDRequestBuilder_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/ddRequestBuilder/list: get: tags: - Payment summary: ' List DDRequest Builders matching a given criteria ' description: ' List DDRequest Builders matching a given criteria ' operationId: listDDRequestBuildersGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An ddRequest builder list ' content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' post: tags: - Payment summary: ' List DDRequest Builders matching a given criteria. ' description: ' List DDRequest Builders matching a given criteria. ' operationId: listDDRequestBuildersPost_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An ddRequest builder list ' content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' /payment/ddRequestBuilder/createOrUpdate: post: tags: - Payment summary: ' Create or update ddRequest builder. ' description: ' Create or update ddRequest builder. ' operationId: createOrUpdateDDRequestBuilder_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderDto' responses: default: description: ' the ddRequestBuilder dto created ' content: application/json: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' application/xml: schema: $ref: '#/components/schemas/DDRequestBuilderResponseDto' /payment/ddRequestBuilder/{code}/enable: post: tags: - Payment summary: ' Enable a ddRequest builder with a given code ' description: ' Enable a ddRequest builder with a given code ' operationId: enableDDRequestBuilder_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/ddRequestBuilder/{code}/disable: post: tags: - Payment summary: ' Disable a ddRequest builder with a given code ' description: ' Disable a ddRequest builder with a given code ' operationId: disableDDRequestBuilder_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/getHostedCheckoutUrl: get: tags: - Payment summary: ' Get the Hosted Checkout URL for payment. ' description: ' Get the Hosted Checkout URL for payment. ' operationId: getHostedCheckoutUrl_1 parameters: - name: ca in: query schema: type: string - name: returnUrl in: query schema: type: string - name: locale in: query schema: type: string default: fr_FR - name: amount in: query schema: type: string default: "100" - name: currencyCode in: query schema: type: string default: EUR - name: authorizationMode in: query schema: type: string default: FINAL_AUTHORIZATION - name: countryCode in: query schema: type: string default: fr - name: skipAuthentication in: query schema: type: boolean default: false - name: gatewayPaymentName in: query schema: type: string default: INGENICO_GC - name: variant in: query schema: type: string default: "101" responses: default: description: ' the PaymentHostedCheckoutResponseDto ' content: application/json: schema: $ref: '#/components/schemas/PaymentHostedCheckoutResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentHostedCheckoutResponseDto' /payment/paymentScheduleTemplate/createOrUpdate: post: tags: - Payment summary: ' Create or update payment Schedules template. ' description: ' Create or update payment Schedules template. ' operationId: createOrUpdatePaymentScheduleTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentScheduleTemplate: get: tags: - Payment summary: ' find payment Schedules template. ' description: ' find payment Schedules template. ' operationId: findPaymentScheduleTemplate_1 parameters: - name: paymentScheduleTemplateCode in: query schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplateResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplateResponseDto' put: tags: - Payment summary: ' Create payment Schedules template. ' description: ' Create payment Schedules template. ' operationId: updatePaymentScheduleTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Create payment Schedules template. ' description: ' Create payment Schedules template. ' operationId: createPaymentScheduleTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplateDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' delete: tags: - Payment summary: ' remove payment Schedules template. ' description: ' remove payment Schedules template. ' operationId: removePaymentScheduleTemplate_1 parameters: - name: paymentScheduleTemplateCode in: query schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentScheduleTemplate/list: get: tags: - Payment summary: ' List PaymentScheduleTemplate matching a given criteria ' description: ' List PaymentScheduleTemplate matching a given criteria ' operationId: listPaymentScheduleTemplate parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An paymentScheduleTemplate dto list ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplatesDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplatesDto' post: tags: - Payment summary: ' List PaymentScheduleTemplate matching a given criteria ' description: ' List PaymentScheduleTemplate matching a given criteria ' operationId: listPaymentScheduleTemplate_2 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An paymentScheduleTemplate dto list ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleTemplatesDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleTemplatesDto' /payment/paymentScheduleInstance: get: tags: - Payment summary: ' Find PaymentScheduleInstance by ID ' description: ' Find PaymentScheduleInstance by ID ' operationId: findPaymentScheduleInstance_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' A paymentScheduleInstance dto ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstanceResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstanceResponseDto' put: tags: - Payment summary: ' Update payment Schedules instance. ' description: ' Update payment Schedules instance. ' operationId: updatePaymentScheduleInstance_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentScheduleInstance/list: get: tags: - Payment summary: ' List paymentScheduleInstance matching a given criteria ' description: ' List paymentScheduleInstance matching a given criteria ' operationId: listPaymentScheduleInstance_2 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An paymentScheduleInstance dto list ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstancesDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstancesDto' post: tags: - Payment summary: ' List PaymentScheduleInstance matching a given criteria ' description: ' List PaymentScheduleInstance matching a given criteria ' operationId: listPaymentScheduleInstance_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An PaymentScheduleInstance dto list ' content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstancesDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstancesDto' /payment/paymentScheduleInstance/terminate: put: tags: - Payment summary: ' Terminate payment Schedules instance. ' description: ' Terminate payment Schedules instance. ' operationId: terminatePaymentScheduleInstance_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentScheduleInstance/cancel: put: tags: - Payment summary: ' Cancel payment Schedules instance. ' description: ' Cancel payment Schedules instance. ' operationId: cancelPaymentScheduleInstance_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' application/xml: schema: $ref: '#/components/schemas/PaymentScheduleInstanceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/cardPaymentMethod: get: tags: - Payment summary: ' Retrieve card payment method by its id. ' description: ' Retrieve card payment method by its id. ' operationId: findCardPaymentMethod_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' Card payment DTO ' content: application/json: schema: $ref: '#/components/schemas/CardPaymentMethodTokenDto' application/xml: schema: $ref: '#/components/schemas/CardPaymentMethodTokenDto' put: tags: - Payment summary: ' Update existing card payment method. ' description: ' Update existing card payment method. ' operationId: updateCardPaymentMethod_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/CardPaymentMethodDto' application/xml: schema: $ref: '#/components/schemas/CardPaymentMethodDto' responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Add a new card payment method. It will be marked as preferred. ' description: ' Add a new card payment method. It will be marked as preferred. ' operationId: addCardPaymentMethod_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/CardPaymentMethodDto' application/xml: schema: $ref: '#/components/schemas/CardPaymentMethodDto' responses: default: description: ' Token id in payment gateway ' content: application/json: schema: $ref: '#/components/schemas/CardPaymentMethodTokenDto' application/xml: schema: $ref: '#/components/schemas/CardPaymentMethodTokenDto' delete: tags: - Payment summary: ' Remove card payment method. If it was marked as preferred, some other payment method will be marked as preferred ' description: ' Remove card payment method. If it was marked as preferred, some other payment method will be marked as preferred ' operationId: removeCardPaymentMethod_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentMethod: get: tags: - Payment summary: ' Retrieve payment method by its id. ' description: ' Retrieve payment method by its id. ' operationId: findPaymentMethod_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' payment DTO ' content: application/json: schema: $ref: '#/components/schemas/PaymentMethodTokenDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodTokenDto' put: tags: - Payment summary: ' Update existing payment method. ' description: ' Update existing payment method. ' operationId: updatePaymentMethod requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethodDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodDto' responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Add a new payment method. It will be marked as preferred. ' description: ' Add a new payment method. It will be marked as preferred. ' operationId: addPaymentMethod_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethodDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodDto' responses: default: description: ' Token id in payment gateway ' content: application/json: schema: $ref: '#/components/schemas/PaymentMethodTokenDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodTokenDto' delete: tags: - Payment summary: ' Remove payment method. If it was marked as preferred, some other payment method will be marked as preferred ' description: ' Remove payment method. If it was marked as preferred, some other payment method will be marked as preferred ' operationId: removePaymentMethod_1 parameters: - name: id in: query schema: type: integer format: int64 responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentMethod/list: get: tags: - Payment summary: ' List Payment Methods matching a given criteria ' description: ' List Payment Methods matching a given criteria ' operationId: listPaymentMethodGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An payment method list ' content: application/json: schema: $ref: '#/components/schemas/PaymentMethodTokensDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodTokensDto' post: tags: - Payment summary: ' List Payment Methods matching a given criteria ' description: ' List Payment Methods matching a given criteria ' operationId: listPaymentMethodPost_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An payment method list ' content: application/json: schema: $ref: '#/components/schemas/PaymentMethodTokensDto' application/xml: schema: $ref: '#/components/schemas/PaymentMethodTokensDto' /payment/paymentMethod/{id}/enable: post: tags: - Payment summary: ' Enable a Payment method with a given id ' description: ' Enable a Payment method with a given id ' operationId: enablePaymentMethod_1 parameters: - name: id in: path required: true schema: type: integer format: int64 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentMethod/{id}/disable: post: tags: - Payment summary: ' Disable a Payment method with a given id ' description: ' Disable a Payment method with a given id ' operationId: disablePaymentMethod_1 parameters: - name: id in: path required: true schema: type: integer format: int64 responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway: get: tags: - Payment summary: ' Retrieve payment gateway by its code. ' description: ' Retrieve payment gateway by its code. ' operationId: findPaymentGateway_1 parameters: - name: code in: query schema: type: string responses: default: description: ' payment DTO ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' put: tags: - Payment summary: ' Update existing payment gateway. ' description: ' Update existing payment gateway. ' operationId: updatePaymentGateway_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayDto' responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Add a new payment gateway. ' description: ' Add a new payment gateway. ' operationId: addPaymentGateway_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayDto' responses: default: description: ' the paymentGateway dto created ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' delete: tags: - Payment summary: ' Remove payment gateway. ' description: ' Remove payment gateway. ' operationId: removePaymentGateway_1 parameters: - name: code in: query schema: type: string responses: default: description: ' Action status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/list: get: tags: - Payment summary: ' List payment gateways matching a given criteria ' description: ' List payment gateways matching a given criteria ' operationId: listPaymentGatewaysGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An payment gateway list ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' post: tags: - Payment summary: ' List payment gateways matching a given criteria. ' description: ' List payment gateways matching a given criteria. ' operationId: listPaymentGatewaysPost_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An payment gateway list ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' /payment/cardPaymentMethod/list: get: tags: - Payment summary: ' List available card payment methods for a given customer account identified either by id or by code. ' description: ' List available card payment methods for a given customer account identified either by id or by code. ' operationId: listCardPaymentMethods_1 parameters: - name: customerAccountId in: query schema: type: integer format: int64 - name: customerAccountCode in: query schema: type: string responses: default: description: ' A list of card payment methods ' content: application/json: schema: $ref: '#/components/schemas/CardPaymentMethodTokensDto' application/xml: schema: $ref: '#/components/schemas/CardPaymentMethodTokensDto' /payment/paymentGateway/createOrUpdate: post: tags: - Payment summary: ' Create or update payment gateway. ' description: ' Create or update payment gateway. ' operationId: createOrUpdatePaymentGateway_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayDto' responses: default: description: ' the paymentGateway dto created ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayResponseDto' /payment/paymentGateway/{code}/enable: post: tags: - Payment summary: ' Enable a Payment gateway with a given code ' description: ' Enable a Payment gateway with a given code ' operationId: enablePaymentGateway_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/{code}/disable: post: tags: - Payment summary: ' Disable a Payment gateway with a given code ' description: ' Disable a Payment gateway with a given code ' operationId: disablePaymentGateway_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/rumSequence: put: tags: - Payment summary: ' Updates a RUM sequence associated to the given payment gateway. ' description: ' Updates a RUM sequence associated to the given payment gateway. ' operationId: updateRumSequence_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - Payment summary: ' Creates a RUM sequence associated to the given payment gateway. ' description: ' Creates a RUM sequence associated to the given payment gateway. ' operationId: createRumSequence_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/rumSequence/{code}: get: tags: - Payment summary: ' Finds the RUM sequence with the specified code. ' description: ' Finds the RUM sequence with the specified code. ' operationId: findRumSequence_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceResponseDto' application/xml: schema: $ref: '#/components/schemas/PaymentGatewayRumSequenceResponseDto' delete: tags: - Payment summary: ' Deletes the RUM sequence with the specified code. ' description: ' Deletes the RUM sequence with the specified code. ' operationId: deleteRumSequence_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/paymentGateway/rumSequence/{code}/next: post: tags: - Payment summary: "\t Generates the next RUM sequence number.\t " description: "\t Generates the next RUM sequence number.\t " operationId: getNextPaymentGatewayRumSequenceNumber_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: " sequence value dto\t " content: application/json: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' /payment/history/list: get: tags: - Payment summary: ' List Payment matching a given criteria. ' description: ' List Payment matching a given criteria. ' operationId: listPaymentHistoryGet_1 parameters: - name: query in: query schema: type: string - name: fields in: query schema: type: string - name: offset in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 - name: sortBy in: query schema: type: string default: id - name: sortOrder in: query schema: type: string enum: - ASCENDING - DESCENDING default: ASCENDING responses: default: description: ' An invoice list ' content: application/json: schema: $ref: '#/components/schemas/PaymentHistoriesDto' application/xml: schema: $ref: '#/components/schemas/PaymentHistoriesDto' post: tags: - Payment summary: ' List invoices matching a given criteria. ' description: ' List invoices matching a given criteria. ' operationId: listPaymentHistoryPost_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' An invoice list ' content: application/json: schema: $ref: '#/components/schemas/PaymentHistoriesDto' application/xml: schema: $ref: '#/components/schemas/PaymentHistoriesDto' /payment: post: tags: - Payment summary: ' Creates automated payment. It also process if a payment is matching or not ' description: ' Creates automated payment. It also process if a payment is matching or not ' operationId: createPayment_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentDto' application/xml: schema: $ref: '#/components/schemas/PaymentDto' responses: default: description: ' payment action status ' content: application/json: schema: $ref: '#/components/schemas/PaymentActionStatus' application/xml: schema: $ref: '#/components/schemas/PaymentActionStatus' /payment/create: post: tags: - Payment summary: ' Creates automated payment. It also process if a payment is matching or not Deprecated and replaced by reatePayment using /payment path ' description: ' Creates automated payment. It also process if a payment is matching or not Deprecated and replaced by reatePayment using /payment path ' operationId: create_68 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentDto' application/xml: schema: $ref: '#/components/schemas/PaymentDto' responses: default: description: ' payment action status ' content: application/json: schema: $ref: '#/components/schemas/PaymentActionStatus' application/xml: schema: $ref: '#/components/schemas/PaymentActionStatus' /payment/customerPayment: get: tags: - Payment summary: ' Returns a list of account operations along with the balance of a customer. ' description: ' Returns a list of account operations along with the balance of a customer. ' operationId: list_30 parameters: - name: customerAccountCode in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PagingAndFiltering' application/xml: schema: $ref: '#/components/schemas/PagingAndFiltering' responses: default: description: ' list of customer''s response. ' content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentsResponse' application/xml: schema: $ref: '#/components/schemas/CustomerPaymentsResponse' /payment/version: get: tags: - Payment summary: ' Get version of application ' description: ' Get version of application ' operationId: index_90 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule/createOrUpdate: post: tags: - RevenueRecognitionRules summary: ' Create new or update an existing revenue recognition rule with a given code ' description: ' Create new or update an existing revenue recognition rule with a given code ' operationId: createOrUpdate_64 requestBody: description: ' postData The revenue recognition rule''s data ' content: application/json: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' application/xml: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule/{revenueRecognitionRuleCode}: delete: tags: - RevenueRecognitionRules summary: ' Remove an existing revenue recognition rule with a given code ' description: ' Remove an existing revenue recognition rule with a given code ' operationId: remove_58 parameters: - name: revenueRecognitionRuleCode in: path description: ' revenueRecognitionRuleCode The revenue recognition rule''s code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule: get: tags: - RevenueRecognitionRules summary: ' Find a revenue recognition rule with a given code ' description: ' Find a revenue recognition rule with a given code ' operationId: find_67 parameters: - name: revenueRecognitionRuleCode in: query description: ' revenueRecognitionRuleCode The revenue recognition rule''s code ' schema: type: string responses: default: description: ' Revenue recognition rules results ' content: application/json: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDtoResponse' application/xml: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDtoResponse' put: tags: - RevenueRecognitionRules summary: ' Update an existing revenue recognition rule ' description: ' Update an existing revenue recognition rule ' operationId: update_64 requestBody: description: ' postData The revenue recognition rule''s data ' content: application/json: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' application/xml: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' post: tags: - RevenueRecognitionRules summary: ' Create a new revenue recognition rule ' description: ' Create a new revenue recognition rule ' operationId: create_69 requestBody: description: ' postData The revenue recognition rule''s data ' content: application/json: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' application/xml: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDto' responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule/list: post: tags: - RevenueRecognitionRules summary: ' List of revenue recognition rules. ' description: ' List of revenue recognition rules. ' operationId: list_31 responses: default: description: ' A list of revenue recognition rules ' content: application/json: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDtosResponse' application/xml: schema: $ref: '#/components/schemas/RevenueRecognitionRuleDtosResponse' /revenueRecognitionRule/{code}/enable: post: tags: - RevenueRecognitionRules summary: ' Enable a Revenue recognition rule with a given code ' description: ' Enable a Revenue recognition rule with a given code ' operationId: enable_32 parameters: - name: code in: path description: ' code Revenue recognition rule code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule/{code}/disable: post: tags: - RevenueRecognitionRules summary: ' Disable a Revenue recognition rule with a given code ' description: ' Disable a Revenue recognition rule with a given code ' operationId: disable_33 parameters: - name: code in: path description: ' code Revenue recognition rule code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /revenueRecognitionRule/version: get: tags: - RevenueRecognitionRules summary: ' Get version of application ' description: ' Get version of application ' operationId: index_91 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/rumSequences/nextMandateNumber: post: tags: - RumSequence summary: "\t Calculates and returns the next value of the mandate number.\t\ \ \t " description: "\t Calculates and returns the next value of the mandate number.\t\ \ \t " operationId: getNextMandateNumber_1 responses: default: description: " next mandate value\t " content: application/json: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceValueResponseDto' /payment/rumSequences: put: tags: - RumSequence summary: "\t Update the Provider's RUM sequence configuration.\t \t " description: "\t Update the Provider's RUM sequence configuration.\t \t " operationId: update_66 requestBody: content: application/json: schema: $ref: '#/components/schemas/GenericSequenceDto' application/xml: schema: $ref: '#/components/schemas/GenericSequenceDto' responses: default: description: " status of the operation\t " content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /payment/rumSequences/version: get: tags: - RumSequence summary: ' Get version of application ' description: ' Get version of application ' operationId: index_92 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /catalogManagement/category/{code}: get: tags: - Catalog summary: ' Get a single category by its code ' description: ' Get a single category by its code ' operationId: getCategory_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Single category information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/category: get: tags: - Catalog summary: ' Get a list of categories ' description: ' Get a list of categories ' operationId: findCategories_1 responses: default: description: ' A list of categories ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productOffering: get: tags: - Catalog summary: ' Get a list of product offerings optionally filtering by some criteria ' description: ' Get a list of product offerings optionally filtering by some criteria ' operationId: findProductOfferings_1 parameters: - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' A list of product offerings matching search criteria ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productOffering/{id}: get: tags: - Catalog summary: ' Get details of a single Product template and validity dates' description: ' 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. ' operationId: getProductOffering_1 parameters: - name: id in: path required: true schema: type: string - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' Single product offering ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productSpecification: get: tags: - Catalog summary: ' Get a list of product specifications optionally filtering by some criteria ' description: ' Get a list of product specifications optionally filtering by some criteria ' operationId: findProductSpecifications_1 responses: default: description: ' A list of product specifications matching search criteria ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productSpecification/{id}: get: tags: - Catalog summary: ' Get details of a single product ' description: ' Get details of a single product ' operationId: getProductSpecification_1 parameters: - name: id in: path required: true schema: type: string - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' A single product specification ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/createOfferFromBOM: post: tags: - Catalog summary: ' Create offer from BOM definition ' description: ' Create offer from BOM definition ' operationId: createOfferFromBOM_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/BomOfferDto' application/xml: schema: $ref: '#/components/schemas/BomOfferDto' responses: default: description: ' Response of the create offer BOM ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/createServiceFromBSM: post: tags: - Catalog summary: ' Create service from BSM definition ' description: ' Create service from BSM definition ' operationId: createServiceFromBSM_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/BsmServiceDto' application/xml: schema: $ref: '#/components/schemas/BsmServiceDto' responses: default: description: ' Response of the create Service BSM ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/createProductFromBPM: post: tags: - Catalog summary: ' Create product from BPM definition ' description: ' Create product from BPM definition ' operationId: createProductFromBPM_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/BpmProductDto' application/xml: schema: $ref: '#/components/schemas/BpmProductDto' responses: default: description: ' Response of the create Service BPM ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate/{code}: get: tags: - Catalog summary: ' Get a single productTemplate by its code and validity dates' description: ' Get a single productTemplate by its code and validity dates. If no validity dates are provided, a product template valid on a current date will be deleted. ' operationId: getProductTemplate_1 parameters: - name: code in: path required: true schema: type: string - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' Single productTemplate information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 delete: tags: - Catalog summary: ' Delete a single productTemplate by its code and validity dates' description: ' Delete a single productTemplate by its code and validity dates. If no validity dates are provided, a product template valid on a current date will be deleted. ' operationId: removeProductTemplate_1 parameters: - name: code in: path required: true schema: type: string - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' Response of the remove action ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate: put: tags: - Catalog summary: ' Update product template ' description: ' Update product template ' operationId: updateProductTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductTemplateDto' responses: default: description: ' Response of the update Product Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 post: tags: - Catalog summary: ' Create product template ' description: ' Create product template ' operationId: createProductTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductTemplateDto' responses: default: description: ' Response of the create Product Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate/createOrUpdate: post: tags: - Catalog summary: ' Create or update product template ' description: ' Create or update product template ' operationId: createOrUpdateProductTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductTemplateDto' responses: default: description: ' Response of the create Product Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate/list: get: tags: - Catalog summary: ' List all product templates optionally filtering by code and validity dates' description: ' 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. ' operationId: listProductTemplate_1 parameters: - name: code in: query schema: type: string - name: validFrom in: query schema: type: string format: date-time - name: validTo in: query schema: type: string format: date-time responses: default: description: ' A list of product templates ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate/{code}/enable: post: tags: - Catalog summary: ' Enable a Product template with a given code ' description: ' Enable a Product template with a given code ' operationId: enableProductTemplate_1 parameters: - name: code in: path description: ' code Product template code ' required: true schema: type: string - name: validFrom in: query description: ' validFrom Product template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Product template validity range - to date ' schema: type: string format: date-time responses: default: description: ' Request processing status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productTemplate/{code}/disable: post: tags: - Catalog summary: ' Disable a Product template with a given code ' description: ' Disable a Product template with a given code ' operationId: disableProductTemplate_1 parameters: - name: code in: path description: ' code Product template code ' required: true schema: type: string - name: validFrom in: query description: ' validFrom Product template validity range - from date ' schema: type: string format: date-time - name: validTo in: query description: ' validTo Product template validity range - to date ' schema: type: string format: date-time responses: default: description: ' Request processing status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate/{code}: get: tags: - Catalog summary: ' Get a single productChargeTemplate by its code ' description: ' Get a single productChargeTemplate by its code ' operationId: getProductChargeTemplate_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Single productChargeTemplate information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 delete: tags: - Catalog summary: ' Delete a single productChargeTemplate by its code ' description: ' Delete a single productChargeTemplate by its code ' operationId: removeProductChargeTemplate_1 parameters: - name: code in: path required: true schema: type: string responses: default: description: ' Response of the delete action ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate: put: tags: - Catalog summary: ' Update product charge template ' description: ' Update product charge template ' operationId: updateProductChargeTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' responses: default: description: ' Response of the update Product Charge Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 post: tags: - Catalog summary: ' Create product charge template ' description: ' Create product charge template ' operationId: createProductChargeTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' responses: default: description: ' Response of the create Product Charge Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate/createOrUpdate: post: tags: - Catalog summary: ' Create or update product charge template ' description: ' Create or update product charge template ' operationId: createOrUpdateProductChargeTemplate_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' application/xml: schema: $ref: '#/components/schemas/ProductChargeTemplateDto' responses: default: description: ' Response of the create or update Product Charge Template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate/list: get: tags: - Catalog summary: ' List all productChargeTemplates ' description: ' List all productChargeTemplates ' operationId: listProductChargeTemplate_1 responses: default: description: ' List of charge template ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate/{code}/enable: post: tags: - Catalog summary: ' Enable a Product charge template with a given code ' description: ' Enable a Product charge template with a given code ' operationId: enableProductChargeTemplate_1 parameters: - name: code in: path description: ' code Product charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/productChargeTemplate/{code}/disable: post: tags: - Catalog summary: ' Disable a Product charge template with a given code ' description: ' Disable a Product charge template with a given code ' operationId: disableProductChargeTemplate_1 parameters: - name: code in: path description: ' code Product charge template code ' required: true schema: type: string responses: default: description: ' Request processing status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /catalogManagement/version: get: tags: - Catalog summary: ' Get version of application ' description: ' Get version of application ' operationId: index_95 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /orderManagement/productOrder: get: tags: - Order summary: ' Get a list of product orders optionaly filtered by some criteria ' description: ' Get a list of product orders optionaly filtered by some criteria ' operationId: findProductOrders_1 responses: default: description: ' A list of product orders matching search criteria ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 post: tags: - Order summary: ' Place a new product order ' description: ' Place a new product order ' operationId: createProductOrder_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductOrder' application/xml: schema: $ref: '#/components/schemas/ProductOrder' responses: default: description: ' Product order information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /orderManagement/productOrder/{orderId}: get: tags: - Order summary: ' Get details of a single product order ' description: ' Get details of a single product order ' operationId: getProductOrder_1 parameters: - name: orderId in: path required: true schema: type: string responses: default: description: ' Response of the request ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 delete: tags: - Order summary: ' Delete a product order ' description: ' Delete a product order ' operationId: deleteProductOrder_1 parameters: - name: orderId in: path required: true schema: type: string responses: default: description: ' Response of the delete request ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /orderManagement/productOrder/{id}: patch: tags: - Order summary: ' Modify partially a product order ' description: ' Modify partially a product order ' operationId: updateProductOrder_1 parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductOrder' application/xml: schema: $ref: '#/components/schemas/ProductOrder' responses: default: description: ' An updated product order information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /orderManagement/productOrder/{orderId}/applicableDueDateDelay: get: tags: - Order summary: ' Evaluate and return the dueDateDelayEL. It checks the EL in this order: Order, CustomerAccount, BillingCycle. ' description: ' Evaluate and return the dueDateDelayEL. It checks the EL in this order: Order, CustomerAccount, BillingCycle. ' operationId: applicableDueDateDelay_1 parameters: - name: orderId in: path required: true schema: type: string responses: default: description: ' Response of the due date delay ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /orderManagement/productOrder/{orderId}/simpleDueDateDelay: put: tags: - Order summary: ' Updates the dueDateDelayEL of an Order. ' description: ' Updates the dueDateDelayEL of an Order. ' operationId: simpleDueDateDelay_1 parameters: - name: orderId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicableDueDateDelayDto' application/xml: schema: $ref: '#/components/schemas/ApplicableDueDateDelayDto' responses: default: description: ' Response of the update request ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /quoteManagement/productQuote/{quoteId}: get: tags: - Quote summary: ' Get details of a single product quote ' description: ' Get details of a single product quote ' operationId: getProductQuote_1 parameters: - name: quoteId in: path required: true schema: type: string responses: default: description: ' quote response ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 delete: tags: - Quote summary: ' Delete a product quote. ' description: ' Delete a product quote. ' operationId: deleteProductQuote_1 parameters: - name: quoteId in: path required: true schema: type: string responses: default: description: ' Response status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /quoteManagement/productQuote: get: tags: - Quote summary: ' Get a list of product quotes optionally filtered by some criteria ' description: ' Get a list of product quotes optionally filtered by some criteria ' operationId: findProductQuotes_1 responses: default: description: ' A list of product quotes matching search criteria ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 post: tags: - Quote summary: ' Place a new product quote ' description: ' Place a new product quote ' operationId: createProductQuote_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductQuote' application/xml: schema: $ref: '#/components/schemas/ProductQuote' responses: default: description: ' Product quote information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /quoteManagement/productQuote/{id}: patch: tags: - Quote summary: ' Modify partially a product quote ' description: ' Modify partially a product quote ' operationId: updateProductQuote_1 parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductQuote' application/xml: schema: $ref: '#/components/schemas/ProductQuote' responses: default: description: ' An updated product quote information ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /quoteManagement/productQuote/placeOrder/{quoteId}: post: tags: - Quote summary: ' Place an order based on a product quote. ' description: ' Place an order based on a product quote. ' operationId: placeOrder_1 parameters: - name: quoteId in: path required: true schema: type: string responses: default: description: ' Response status ' content: application/json: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 application/xml: schema: type: object properties: metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object entity: type: object status: type: integer format: int32 /orderManagement/productOrder/version: get: tags: - Order summary: ' Get version of application ' description: ' Get version of application ' operationId: index_93 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' /quoteManagement/productQuote/version: get: tags: - Quote summary: ' Get version of application ' description: ' Get version of application ' operationId: index_96 responses: default: description: ' Action status with version number as a message ' content: application/json: schema: $ref: '#/components/schemas/ActionStatus' application/xml: schema: $ref: '#/components/schemas/ActionStatus' components: schemas: ActionStatus: required: - message - status type: object properties: status: type: string enum: - SUCCESS - FAIL errorCode: type: string enum: - ENTITY_DOES_NOT_EXISTS_EXCEPTION - ENTITY_NOT_ALLOWED_EXCEPTION - ENTITY_ALREADY_EXISTS_EXCEPTION - DELETE_REFERENCED_ENTITY_EXCEPTION - MISSING_PARAMETER - INVALID_PARAMETER - INVALID_ENUM_VALUE - DUPLICATE_ACCESS - INSUFFICIENT_BALANCE - GENERIC_API_EXCEPTION - BUSINESS_API_EXCEPTION - AUTHENTICATION_AUTHORIZATION_EXCEPTION - ACTION_FORBIDDEN - INVALID_IMAGE_DATA message: type: string entityId: type: integer format: int64 entityCode: type: string getjson: type: string BillingCycleDto: required: - calendar - dueDateDelay - invoiceDateDelay type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string billingTemplateName: type: string billingTemplateNameEL: type: string invoiceDateDelay: type: integer format: int32 dueDateDelay: type: integer format: int32 dueDateDelayEL: type: string dueDateDelayELSpark: type: string invoiceDateProductionDelay: type: integer format: int32 transactionDateDelay: type: integer format: int32 calendar: type: string invoicingThreshold: type: number invoiceTypeCode: type: string invoiceTypeEl: type: string invoiceTypeElSpark: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' type: type: string enum: - BILLINGACCOUNT - SUBSCRIPTION - ORDER referenceDate: type: string enum: - TODAY - NEXT_INVOICE_DATE - LAST_TRANSACTION_DATE - END_DATE scriptInstanceCode: type: string dueDateDelaySpark: type: string writeOnly: true xml: name: BillingCycle CustomFieldDto: type: object properties: code: type: string xml: attribute: true description: type: string xml: attribute: true fieldType: type: string enum: - STRING - DATE - LONG - DOUBLE - LIST - ENTITY - TEXT_AREA - CHILD_ENTITY - MULTI_VALUE - BOOLEAN languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' valueDate: type: string format: date-time xml: attribute: true valuePeriodStartDate: type: string format: date-time xml: attribute: true valuePeriodEndDate: type: string format: date-time xml: attribute: true valuePeriodPriority: type: integer format: int32 xml: attribute: true stringValue: type: string dateValue: type: string format: date-time longValue: type: integer format: int64 doubleValue: type: number format: double booleanValue: type: boolean listValue: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomFieldValueDto' mapValue: type: object additionalProperties: $ref: '#/components/schemas/CustomFieldValueDto' entityReferenceValue: $ref: '#/components/schemas/EntityReferenceDto' valueConverted: type: object indexType: type: string enum: - STORE_ONLY - INDEX - INDEX_NOT_ANALYZE fileValue: type: string formattedValue: $ref: '#/components/schemas/CustomFieldFormattedValueDto' empty: type: boolean xml: name: CustomField CustomFieldFormattedValueDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string singleValue: type: string listValue: type: array items: type: string mapValue: type: object additionalProperties: type: string xml: name: AuditableEntity CustomFieldValueDto: type: object properties: value: type: object empty: type: boolean xml: name: CustomFieldValue CustomFieldsDto: type: object properties: customField: type: array items: $ref: '#/components/schemas/CustomFieldDto' inheritedCustomField: type: array items: $ref: '#/components/schemas/CustomFieldDto' empty: type: boolean xml: name: CustomFields EntityReferenceDto: type: object properties: classname: type: string xml: attribute: true code: type: string xml: attribute: true empty: type: boolean xml: name: EntityReference LanguageDescriptionDto: type: object properties: languageCode: type: string description: type: string xml: name: LanguageDescription GetBillingCycleResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' billingCycle: $ref: '#/components/schemas/BillingCycleDto' xml: name: GetBillingCycleResponse CalendarDateIntervalDto: type: object properties: intervalBegin: type: integer format: int32 xml: attribute: true intervalEnd: type: integer format: int32 xml: attribute: true xml: name: CalendarDateInterval CalendarDto: required: - calendarType type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string calendarType: type: string enum: - YEARLY - DAILY - PERIOD - INTERVAL - INTERSECT - UNION - BANKING days: type: array items: $ref: '#/components/schemas/DayInYearDto' hours: type: array items: $ref: '#/components/schemas/HourInDayDto' periodLength: type: integer format: int32 periodUnit: type: string enum: - MONTH - DAY_OF_MONTH - HOUR_OF_DAY - MINUTE - SECOND nbPeriods: type: integer format: int32 joinCalendar1Code: type: string joinCalendar2Code: type: string intervalType: type: string enum: - DAY - HOUR - WDAY intervals: type: array items: $ref: '#/components/schemas/CalendarDateIntervalDto' weekendBegin: type: integer format: int32 weekendEnd: type: integer format: int32 endDate: type: string format: date-time startDate: type: string format: date-time holidays: type: array items: $ref: '#/components/schemas/CalendarHolidayDto' CalendarHolidayDto: type: object properties: holidayBegin: type: integer format: int32 xml: attribute: true holidayEnd: type: integer format: int32 xml: attribute: true xml: name: CalendarHoliday DayInYearDto: type: object properties: day: type: integer format: int32 xml: attribute: true month: type: string xml: attribute: true enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER xml: name: DayInYear HourInDayDto: type: object properties: hour: type: integer format: int32 xml: attribute: true min: type: integer format: int32 xml: attribute: true xml: name: HourInDay BankingDateStatusDto: type: object properties: date: type: string format: date-time isWorkingDate: type: boolean writeOnly: true workingDate: type: boolean BankingDateStatusResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' bankingDateStatus: $ref: '#/components/schemas/BankingDateStatusDto' xml: name: BankingDateStatusResponse GetCalendarResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' calendar: $ref: '#/components/schemas/CalendarDto' xml: name: GetCalendarResponse CalendarsDto: type: object properties: calendar: type: array items: $ref: '#/components/schemas/CalendarDto' xml: name: Calendars ListCalendarResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' calendars: $ref: '#/components/schemas/CalendarsDto' xml: name: ListCalendarResponse CountryIsoDto: required: - currencyCode - languageCode type: object properties: countryCode: type: string xml: attribute: true description: type: string xml: attribute: true languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' currencyCode: type: string languageCode: type: string xml: name: CountryIso GetCountryIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' country: $ref: '#/components/schemas/CountryIsoDto' xml: name: GetCountryIsoResponse GetCountriesIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' countries: type: array items: $ref: '#/components/schemas/CountryIsoDto' xml: name: GetCountriesIsoResponse CountryDto: required: - currencyCode type: object properties: countryCode: type: string xml: attribute: true name: type: string xml: attribute: true currencyCode: type: string languageCode: type: string disabled: type: boolean xml: name: Country GetTradingCountryResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' country: $ref: '#/components/schemas/CountryDto' xml: name: GetTradingCountryResponse CurrencyIsoDto: type: object properties: code: type: string xml: attribute: true description: type: string xml: name: CurrencyIso GetCurrencyIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' currency: $ref: '#/components/schemas/CurrencyIsoDto' xml: name: GetCurrencyIsoResponse GetCurrenciesIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' currencies: type: array items: $ref: '#/components/schemas/CurrencyIsoDto' xml: name: GetCurrenciesIsoResponse CurrencyDto: type: object properties: code: type: string xml: attribute: true description: type: string disabled: type: boolean xml: name: Currency GetTradingCurrencyResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' currency: $ref: '#/components/schemas/CurrencyDto' xml: name: GetTradingCurrencyResponse FilterDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean shared: type: boolean inputXml: type: string xml: name: Filter GetFilterResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' filter: $ref: '#/components/schemas/FilterDto' xml: name: GetFilterResponseDto InvoiceCategoryDto: required: - occTemplateCode type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' occTemplateCode: type: string occTemplateNegativeCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: InvoiceCategory GetInvoiceCategoryResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceCategory: $ref: '#/components/schemas/InvoiceCategoryDto' xml: name: GetInvoiceCategoryResponse InvoiceSequenceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string sequenceSize: type: integer format: int32 currentInvoiceNb: type: integer format: int64 xml: name: InvoiceSequence GetInvoiceSequenceResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceSequenceDto: $ref: '#/components/schemas/InvoiceSequenceDto' xml: name: GetInvoiceSequenceResponse GetInvoiceSequencesResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceSequencesDto: $ref: '#/components/schemas/InvoiceSequencesDto' xml: name: GetInvoiceSequencesResponse InvoiceSequencesDto: type: object properties: invoiceSequences: type: array items: $ref: '#/components/schemas/InvoiceSequenceDto' xml: name: InvoiceSequences InvoiceSubCategoryCountryDto: required: - invoiceSubCategory type: object properties: invoiceSubCategory: type: string sellingCountry: type: string country: type: string tax: type: string taxCodeEL: type: string taxCodeELSpark: type: string discountCode: type: string filterEL: type: string startValidityDate: type: string format: date-time endValidityDate: type: string format: date-time priority: type: integer format: int32 xml: name: InvoiceSubCategoryCountry GetInvoiceSubCategoryCountryResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceSubCategoryCountryDto: $ref: '#/components/schemas/InvoiceSubCategoryCountryDto' xml: name: GetInvoiceSubCategoryCountryResponse InvoiceSubCategoryDto: required: - accountingCode - invoiceCategory - occTemplateCode type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string invoiceCategory: type: string accountingCode: type: string languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' taxScriptScode: type: string occTemplateCode: type: string occTemplateNegativeCode: type: string xml: name: InvoiceSubCategory GetInvoiceSubCategoryResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategoryDto' xml: name: GetInvoiceSubCategoryResponse InvoiceTypeDto: required: - occTemplateCode type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string occTemplateCode: type: string occTemplateNegativeCode: type: string occTemplateCodeEl: type: string occTemplateNegativeCodeEl: type: string customInvoiceXmlScriptInstanceCode: type: string sequenceDto: $ref: '#/components/schemas/SequenceDto' sellerSequences: type: object additionalProperties: $ref: '#/components/schemas/SequenceDto' xml: wrapped: true appliesTo: type: array items: type: string matchingAuto: type: boolean invoiceAccountable: type: boolean billingTemplateName: type: string pdfFilenameEL: type: string xmlFilenameEL: type: string billingTemplateNameEL: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' useSelfSequence: type: boolean mailingType: type: string emailTemplateCode: type: string xml: name: InvoiceType SequenceDto: type: object properties: prefixEL: type: string invoiceSequenceCode: type: string sequenceSize: type: integer format: int32 currentInvoiceNb: type: integer format: int64 GetInvoiceTypeResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceTypeDto: $ref: '#/components/schemas/InvoiceTypeDto' xml: name: GetInvoiceTypeResponse GetInvoiceTypesResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceTypesDto: $ref: '#/components/schemas/InvoiceTypesDto' xml: name: GetInvoiceTypesResponse InvoiceTypesDto: type: object properties: invoiceTypes: type: array items: $ref: '#/components/schemas/InvoiceTypeDto' xml: name: InvoiceTypes LanguageIsoDto: type: object properties: code: type: string xml: attribute: true description: type: string xml: name: LanguageIso GetLanguageIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' language: $ref: '#/components/schemas/LanguageIsoDto' xml: name: GetLanguageIsoResponse GetLanguagesIsoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' languages: type: array items: $ref: '#/components/schemas/LanguageIsoDto' xml: name: GetLanguagesIsoResponse LanguageDto: type: object properties: code: type: string xml: attribute: true description: type: string disabled: type: boolean xml: name: Language GetTradingLanguageResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' language: $ref: '#/components/schemas/LanguageDto' xml: name: GetTradingLanguageResponse OccTemplateDto: required: - accountingCode - occCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string accountingCode: type: string accountCode: type: string occCategory: type: string enum: - DEBIT - CREDIT accountCodeClientSide: type: string xml: name: OCCTemplate GetOccTemplatesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' occTemplates: $ref: '#/components/schemas/OccTemplatesDto' xml: name: GetOccTemplatesResponse OccTemplatesDto: type: object properties: occTemplate: type: array items: $ref: '#/components/schemas/OccTemplateDto' xml: name: OCCTemplates PagingAndFiltering: type: object properties: fullTextFilter: type: string filters: type: object additionalProperties: type: object fields: type: string offset: type: integer format: int32 limit: type: integer format: int32 sortBy: type: string sortOrder: type: string enum: - ASCENDING - DESCENDING totalNumberOfRecords: type: integer format: int32 loadReferenceDepth: type: integer format: int32 GetOccTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' occTemplate: $ref: '#/components/schemas/OccTemplateDto' xml: name: GetOccTemplateResponse PdfInvoiceResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' pdfInvoice: type: array items: type: string format: byte xml: name: PdfInvoiceResponse PermissionDto: type: object properties: permission: type: string xml: attribute: true name: type: string xml: attribute: true xml: name: Permission PermissionResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' permissionsDto: $ref: '#/components/schemas/PermissionsDto' xml: name: SellerResponse PermissionsDto: type: object properties: permission: type: array items: $ref: '#/components/schemas/PermissionDto' BankCoordinatesDto: required: - accountNumber - accountOwner - bankCode - bankName - bic - branchCode - iban - key type: object properties: bankCode: maxLength: 5 minLength: 0 type: string branchCode: maxLength: 5 minLength: 0 type: string accountNumber: maxLength: 11 minLength: 0 type: string key: maxLength: 2 minLength: 0 type: string iban: maxLength: 34 minLength: 0 type: string bic: maxLength: 11 minLength: 0 type: string accountOwner: maxLength: 50 minLength: 0 type: string bankName: maxLength: 50 minLength: 0 type: string bankId: maxLength: 50 minLength: 0 type: string issuerNumber: maxLength: 50 minLength: 0 type: string issuerName: maxLength: 50 minLength: 0 type: string ics: maxLength: 35 minLength: 0 type: string empty: type: boolean xml: name: BankCoordinates InvoiceConfigurationDto: type: object properties: displaySubscriptions: type: boolean displayServices: type: boolean displayOffers: type: boolean displayEdrs: type: boolean displayProvider: type: boolean displayCfAsXML: type: boolean displayPricePlans: type: boolean displayDetail: type: boolean displayChargesPeriods: type: boolean displayBillingCycle: type: boolean displayFreeTransacInInvoice: type: boolean displayOrders: type: boolean currentInvoiceNb: type: integer format: int64 xml: name: InvoiceConfiguration ProviderDto: type: object properties: code: type: string xml: attribute: true description: type: string currency: type: string country: type: string language: type: string multiCurrency: type: boolean multiCountry: type: boolean multiLanguage: type: boolean userAccount: type: string enterprise: type: boolean levelDuplication: type: boolean rounding: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP invoiceRounding: type: integer format: int32 invoiceRoundingMode: type: string enum: - NEAREST - DOWN - UP prepaidReservationExpirationDelayinMillisec: type: integer format: int64 discountAccountingCode: type: string email: type: string bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' recognizeRevenue: type: boolean invoiceConfiguration: $ref: '#/components/schemas/InvoiceConfigurationDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: Provider CountriesDto: type: object properties: country: type: array items: $ref: '#/components/schemas/CountryDto' xml: name: Countries CurrenciesDto: type: object properties: currency: type: array items: $ref: '#/components/schemas/CurrencyDto' xml: name: Currencies GetTradingConfigurationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' countries: $ref: '#/components/schemas/CountriesDto' currencies: $ref: '#/components/schemas/CurrenciesDto' languages: $ref: '#/components/schemas/LanguagesDto' xml: name: GetTradingConfigurationResponse LanguagesDto: type: object properties: language: type: array items: $ref: '#/components/schemas/LanguageDto' xml: name: Languages BillingCyclesDto: type: object properties: billingCycle: type: array items: $ref: '#/components/schemas/BillingCycleDto' xml: name: BillingCycles GetInvoicingConfigurationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' calendars: $ref: '#/components/schemas/CalendarsDto' taxes: $ref: '#/components/schemas/TaxesDto' invoiceCategories: $ref: '#/components/schemas/InvoiceCategoriesDto' invoiceSubCategories: $ref: '#/components/schemas/InvoiceSubCategoriesDto' billingCycles: $ref: '#/components/schemas/BillingCyclesDto' terminationReasons: $ref: '#/components/schemas/TerminationReasonsDto' xml: name: GetInvoicingConfigurationResponse InvoiceCategoriesDto: type: object properties: invoiceCategory: type: array items: $ref: '#/components/schemas/InvoiceCategoryDto' xml: name: InvoiceCategories InvoiceSubCategoriesDto: type: object properties: invoiceSubCategory: type: array items: $ref: '#/components/schemas/InvoiceSubCategoryDto' xml: name: InvoiceSubCategories TaxDto: required: - percent type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string percent: type: number accountingCode: type: string languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: Tax TaxesDto: type: object properties: tax: type: array items: $ref: '#/components/schemas/TaxDto' xml: name: Taxes TerminationReasonDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string applyAgreement: type: boolean applyReimbursment: type: boolean applyTerminationCharges: type: boolean xml: name: TerminationReasonDto TerminationReasonsDto: type: object properties: terminationReason: type: array items: $ref: '#/components/schemas/TerminationReasonDto' xml: name: TerminationReasonDto CustomerBrandDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string xml: name: CustomerBrand CustomerBrandsDto: type: object properties: customerBrand: type: array items: $ref: '#/components/schemas/CustomerBrandDto' xml: name: CustomerBrands CustomerCategoriesDto: type: object properties: customerCategory: type: array items: $ref: '#/components/schemas/CustomerCategoryDto' xml: name: CustomerCategories CustomerCategoryDto: required: - accountingCode type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string exoneratedFromTaxes: type: boolean exonerationTaxEl: type: string exonerationTaxElSpark: type: string exonerationReason: type: string accountingCode: type: string xml: name: CustomerCategory GetCustomerConfigurationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customerBrands: $ref: '#/components/schemas/CustomerBrandsDto' customerCategories: $ref: '#/components/schemas/CustomerCategoriesDto' titles: $ref: '#/components/schemas/TitlesDto' xml: name: GetCustomerConfigurationResponse TitleDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string isCompany: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' xml: name: Title TitlesDto: type: object properties: title: type: array items: $ref: '#/components/schemas/TitleDto' xml: name: Titles CreditCategoriesDto: type: object properties: creditCategory: type: array items: $ref: '#/components/schemas/CreditCategoryDto' xml: name: CreditCategories CreditCategoryDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string xml: name: CreditCategory GetCustomerAccountConfigurationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paymentMethods: type: array items: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD creditCategories: $ref: '#/components/schemas/CreditCategoriesDto' xml: name: GetCustomerAccountConfigurationResponse GetProviderResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' provider: $ref: '#/components/schemas/ProviderDto' xml: name: GetProviderResponse ProvidersDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' providers: type: array xml: wrapped: true items: $ref: '#/components/schemas/ProviderDto' xml: name: Providers QueryResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' result: type: string RoleDto: type: object properties: name: type: string xml: attribute: true description: type: string xml: attribute: true permission: type: array xml: name: permissions wrapped: true items: $ref: '#/components/schemas/PermissionDto' roles: type: array xml: wrapped: true items: $ref: '#/components/schemas/RoleDto' securedEntities: type: array xml: name: accessibleEntities wrapped: true items: $ref: '#/components/schemas/SecuredEntityDto' xml: name: Role SecuredEntityDto: type: object properties: code: type: string xml: attribute: true entityClass: type: string xml: attribute: true xml: name: SecuredEntity RolesDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' roles: type: array xml: wrapped: true items: $ref: '#/components/schemas/RoleDto' xml: name: Roles GetRoleResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' roleDto: $ref: '#/components/schemas/RoleDto' xml: name: GetRoleResponse ScriptInstanceErrorDto: required: - message type: object properties: lineNumber: type: integer format: int64 xml: attribute: true columnNumber: type: integer format: int64 xml: attribute: true message: type: string xml: name: ScriptInstanceError ScriptInstanceReponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' compilationErrors: type: array items: $ref: '#/components/schemas/ScriptInstanceErrorDto' xml: name: ScriptInstanceResponse ScriptInstanceDto: required: - script type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean type: type: string enum: - scriptSourceTypeEnum.JAVA reuse: type: boolean script: type: string executionRoles: type: array items: $ref: '#/components/schemas/RoleDto' sourcingRoles: type: array items: $ref: '#/components/schemas/RoleDto' scriptInstanceCategoryCode: type: string codeOnly: type: boolean xml: name: ScriptInstance GetScriptInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' scriptInstance: $ref: '#/components/schemas/ScriptInstanceDto' xml: name: GetScriptInstanceResponse AccessDto: required: - subscription type: object properties: code: type: string xml: attribute: true subscription: type: string startDate: type: string format: date-time endDate: type: string format: date-time customFields: $ref: '#/components/schemas/CustomFieldsDto' disabled: type: boolean xml: name: Access AccessesDto: type: object properties: access: type: array items: $ref: '#/components/schemas/AccessDto' AccountOperationDto: type: object properties: id: type: integer format: int64 dueDate: type: string format: date-time type: type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: type: string accountCode: type: string accountingCode: type: string accountCodeClientSide: type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number matchingStatus: type: string enum: - O - L - P - C - I - R occCode: type: string occDescription: type: string customerAccount: type: string excludedFromDunning: type: boolean orderNumber: type: string matchingAmounts: $ref: '#/components/schemas/MatchingAmountsDto' otherCreditAndCharge: $ref: '#/components/schemas/OtherCreditAndChargeDto' recordedInvoice: $ref: '#/components/schemas/RecordedInvoiceDto' rejectedPayment: $ref: '#/components/schemas/RejectedPaymentDto' bankLot: type: string bankReference: type: string bankCollectionDate: type: string format: date-time depositDate: type: string format: date-time paymentMethod: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' paymentInfo: type: string paymentInfo1: type: string paymentInfo2: type: string paymentInfo3: type: string paymentInfo4: type: string paymentInfo5: type: string paymentInfo6: type: string billingAccountName: type: string xml: name: AccountOperation AdditionalDetailsDto: type: object properties: companyName: type: string position: type: string instantMessengers: type: string AddressDto: type: object properties: address1: type: string address2: type: string address3: type: string zipCode: type: string city: type: string country: type: string state: type: string xml: name: Address BillingAccountDto: required: - billingCycle - country - customerAccount - language type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' jobTitle: type: string businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' loaded: type: boolean vatNo: type: string registrationNo: type: string contactInformation: $ref: '#/components/schemas/ContactInformationDto' customerAccount: type: string billingCycle: type: string country: type: string language: type: string nextInvoiceDate: type: string format: date-time subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time electronicBilling: type: boolean status: type: string enum: - ACTIVE - CANCELED - TERMINATED - CLOSED statusDate: type: string format: date-time terminationReason: type: string email: type: string invoices: type: array items: $ref: '#/components/schemas/InvoiceDto' invoicingThreshold: type: number phone: type: string minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' paymentTerms: type: string userAccounts: $ref: '#/components/schemas/UserAccountsDto' discountPlansForInstantiation: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' discountPlansForTermination: type: array xml: wrapped: true items: type: string xml: name: discountPlanForTermination discountPlanInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanInstanceDto' mailingType: type: string emailTemplate: type: string ccedEmails: type: string BillingAccountsDto: type: object properties: billingAccount: type: array items: $ref: '#/components/schemas/BillingAccountDto' BusinessEntityDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string xml: name: AuditableEntity CategoryInvoiceAgregateDto: required: - categoryInvoiceCode - listSubCategoryInvoiceAgregateDto type: object properties: categoryInvoiceCode: type: string description: type: string userAccountCode: type: string itemNumber: type: integer format: int32 amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number listSubCategoryInvoiceAgregateDto: type: array xml: wrapped: true items: $ref: '#/components/schemas/SubCategoryInvoiceAgregateDto' discountAggregates: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountInvoiceAggregateDto' xml: name: CategoryInvoiceAgregate ContactInformationDto: type: object properties: email: type: string phone: type: string mobile: type: string fax: type: string CustomerAccountDto: required: - currency - customer - language type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' jobTitle: type: string businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' loaded: type: boolean vatNo: type: string registrationNo: type: string contactInformation: $ref: '#/components/schemas/ContactInformationDto' customer: type: string currency: type: string language: type: string status: type: string enum: - ACTIVE - CLOSE creditCategory: type: string dateStatus: type: string format: date-time dateDunningLevel: type: string format: date-time dunningLevel: type: string enum: - R0 - R1 - R2 - R3 - R4 mandateIdentification: type: string mandateDate: type: string format: date-time balance: type: number totalInvoiceBalance: type: number accountBalance: type: number creditBalance: type: number terminationDate: type: string format: date-time dueDateDelayEL: type: string dueDateDelayELSpark: type: string paymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodDto' excludedFromPayment: type: boolean paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD billingAccounts: $ref: '#/components/schemas/BillingAccountsDto' accountOperations: type: array items: $ref: '#/components/schemas/AccountOperationDto' CustomerAccountsDto: type: object properties: customerAccount: type: array items: $ref: '#/components/schemas/CustomerAccountDto' CustomerDto: required: - customerCategory - seller type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' jobTitle: type: string businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' loaded: type: boolean vatNo: type: string registrationNo: type: string contactInformation: $ref: '#/components/schemas/ContactInformationDto' customerCategory: type: string customerBrand: type: string seller: type: string mandateIdentification: type: string mandateDate: type: string format: date-time customerAccounts: $ref: '#/components/schemas/CustomerAccountsDto' additionalDetails: $ref: '#/components/schemas/AdditionalDetailsDto' xml: name: Customer CustomersDto: type: object properties: customer: type: array items: $ref: '#/components/schemas/CustomerDto' totalNumberOfRecords: type: integer format: int64 DiscountInvoiceAggregateDto: required: - invoiceSubCategoryCode type: object properties: itemNumber: type: integer format: int32 accountingCode: type: string description: type: string taxCode: type: string taxPercent: type: number quantity: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number invoiceSubCategoryCode: type: string userAccountCode: type: string ratedTransactions: type: array xml: wrapped: true items: $ref: '#/components/schemas/RatedTransactionDto' discountPlanItemCode: type: string discountPercent: type: number xml: name: DiscountInvoiceAggregate DiscountPlanDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time defaultDuration: type: integer format: int32 durationUnit: type: string enum: - MONTH - DAY customFields: $ref: '#/components/schemas/CustomFieldsDto' discountPlanItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanItemDto' xml: name: DiscountPlan DiscountPlanInstanceDto: type: object properties: discountPlan: type: string billingAccount: type: string subscription: type: string startDate: type: string format: date-time endDate: type: string format: date-time customFields: $ref: '#/components/schemas/CustomFieldsDto' DiscountPlanItemDto: required: - code - discountPlanCode type: object properties: code: type: string xml: attribute: true discountPlanCode: type: string invoiceCategoryCode: type: string invoiceSubCategoryCode: type: string accountingCode: type: string expressionEl: type: string expressionElSpark: type: string disabled: type: boolean discountPlanItemType: type: string enum: - PERCENTAGE - FIXED discountValue: type: number discountValueEL: type: string discountValueElSpark: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: DiscountPlanItem InvoiceDto: required: - billingAccountCode - categoryInvoiceAgregates - dueDate - invoiceDate - invoiceMode - invoiceType - taxAggregates type: object properties: invoiceId: type: integer format: int64 invoiceType: type: string billingAccountCode: type: string sellerCode: type: string subscriptionCode: type: string orderNumber: type: string dueDate: type: string format: date-time invoiceDate: type: string format: date-time categoryInvoiceAgregates: type: array xml: wrapped: true items: $ref: '#/components/schemas/CategoryInvoiceAgregateDto' taxAggregates: type: array xml: wrapped: true items: $ref: '#/components/schemas/TaxInvoiceAggregateDto' listInvoiceIdToLink: type: array xml: wrapped: true items: type: integer format: int64 xml: name: invoiceIdToLink invoiceNumber: type: string discount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD xmlFilename: type: string xml: type: string pdfFilename: type: string pdf: type: array items: type: string format: byte autoValidation: type: boolean returnXml: type: boolean returnPdf: type: boolean includeBalance: type: boolean recordedInvoiceDto: $ref: '#/components/schemas/RecordedInvoiceDto' netToPay: type: number invoiceMode: type: string enum: - AGGREGATED - DETAILLED customFields: $ref: '#/components/schemas/CustomFieldsDto' dueBalance: type: number checkAlreadySent: type: boolean overrideEmail: type: string sentByEmail: type: boolean draft: type: boolean xml: name: Invoice MatchingAmountDto: type: object properties: matchingCode: type: string matchingAmount: type: number matchingCodes: $ref: '#/components/schemas/MatchingCodesDto' xml: name: MatchingAmount MatchingAmountsDto: type: object properties: matchingAmount: type: array items: $ref: '#/components/schemas/MatchingAmountDto' xml: name: MatchingAmounts MatchingCodeDto: type: object properties: code: type: string matchingType: type: string enum: - A - M - A_TIP - A_DERICT_DEBIT matchingDate: type: string format: date-time matchingAmountCredit: type: number matchingAmountDebit: type: number xml: name: MatchingCode MatchingCodesDto: type: object properties: matchingCode: type: array items: $ref: '#/components/schemas/MatchingCodeDto' xml: name: MatchingCodes NameDto: required: - lastName type: object properties: title: type: string firstName: type: string lastName: type: string xml: name: Name OtherCreditAndChargeDto: type: object properties: id: type: integer format: int64 dueDate: type: string format: date-time type: type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: type: string accountCode: type: string accountingCode: type: string accountCodeClientSide: type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number matchingStatus: type: string enum: - O - L - P - C - I - R occCode: type: string occDescription: type: string customerAccount: type: string excludedFromDunning: type: boolean orderNumber: type: string matchingAmounts: $ref: '#/components/schemas/MatchingAmountsDto' otherCreditAndCharge: $ref: '#/components/schemas/OtherCreditAndChargeDto' recordedInvoice: $ref: '#/components/schemas/RecordedInvoiceDto' rejectedPayment: $ref: '#/components/schemas/RejectedPaymentDto' bankLot: type: string bankReference: type: string bankCollectionDate: type: string format: date-time depositDate: type: string format: date-time paymentMethod: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' paymentInfo: type: string paymentInfo1: type: string paymentInfo2: type: string paymentInfo3: type: string paymentInfo4: type: string paymentInfo5: type: string paymentInfo6: type: string billingAccountName: type: string operationDate: type: string format: date-time xml: name: AccountOperation PaymentMethodDto: required: - paymentMethodType type: object properties: paymentMethodType: type: string xml: attribute: true enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD id: type: integer format: int64 disabled: type: boolean alias: type: string preferred: type: boolean customerAccountCode: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' mandateIdentification: type: string mandateDate: type: string format: date-time cardType: type: string enum: - VISA - MASTERCARD - AMERICAN_EXPRESS - CB owner: type: string monthExpiration: type: integer format: int32 yearExpiration: type: integer format: int32 tokenId: type: string cardNumber: type: string issueNumber: type: string userId: type: string customerCode: type: string xml: name: PaymentMethod ProductDto: type: object properties: code: type: string xml: attribute: true description: type: string xml: attribute: true chargeDate: type: string format: date-time quantity: type: number amountWithoutTax: type: number amountWithTax: type: number criteria1: type: string criteria2: type: string criteria3: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' ProductInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string applicationDate: type: string format: date-time quantity: type: number orderNumber: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: AuditableEntity ProductsDto: type: object properties: products: type: array items: $ref: '#/components/schemas/ProductDto' RatedTransactionDto: required: - amountTax - amountWithTax - amountWithoutTax - code - usageDate type: object properties: usageDate: type: string format: date-time unitAmountWithoutTax: type: number unitAmountWithTax: type: number unitAmountTax: type: number quantity: type: number amountWithoutTax: type: number amountWithTax: type: number amountTax: type: number code: type: string description: type: string unityDescription: type: string priceplanCode: type: string doNotTriggerInvoicing: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time parameter1: type: string parameter2: type: string parameter3: type: string userAccountCode: type: string taxCode: type: string taxPercent: type: number invoiceSubCategoryCode: type: string sellerCode: type: string xml: name: RatedTransaction RecordedInvoiceDto: type: object properties: id: type: integer format: int64 dueDate: type: string format: date-time type: type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: type: string accountCode: type: string accountingCode: type: string accountCodeClientSide: type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number matchingStatus: type: string enum: - O - L - P - C - I - R occCode: type: string occDescription: type: string customerAccount: type: string excludedFromDunning: type: boolean orderNumber: type: string matchingAmounts: $ref: '#/components/schemas/MatchingAmountsDto' otherCreditAndCharge: $ref: '#/components/schemas/OtherCreditAndChargeDto' recordedInvoice: $ref: '#/components/schemas/RecordedInvoiceDto' rejectedPayment: $ref: '#/components/schemas/RejectedPaymentDto' bankLot: type: string bankReference: type: string bankCollectionDate: type: string format: date-time depositDate: type: string format: date-time paymentMethod: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' paymentInfo: type: string paymentInfo1: type: string paymentInfo2: type: string paymentInfo3: type: string paymentInfo4: type: string paymentInfo5: type: string paymentInfo6: type: string billingAccountName: type: string productionDate: type: string format: date-time invoiceDate: type: string format: date-time netToPay: type: number xml: name: AccountOperation RejectedPaymentDto: type: object properties: id: type: integer format: int64 dueDate: type: string format: date-time type: type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: type: string accountCode: type: string accountingCode: type: string accountCodeClientSide: type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number matchingStatus: type: string enum: - O - L - P - C - I - R occCode: type: string occDescription: type: string customerAccount: type: string excludedFromDunning: type: boolean orderNumber: type: string matchingAmounts: $ref: '#/components/schemas/MatchingAmountsDto' otherCreditAndCharge: $ref: '#/components/schemas/OtherCreditAndChargeDto' recordedInvoice: $ref: '#/components/schemas/RecordedInvoiceDto' rejectedPayment: $ref: '#/components/schemas/RejectedPaymentDto' bankLot: type: string bankReference: type: string bankCollectionDate: type: string format: date-time depositDate: type: string format: date-time paymentMethod: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' paymentInfo: type: string paymentInfo1: type: string paymentInfo2: type: string paymentInfo3: type: string paymentInfo4: type: string paymentInfo5: type: string paymentInfo6: type: string billingAccountName: type: string rejectedType: type: string enum: - A - M rejectedDate: type: string format: date-time rejectedDescription: type: string rejectedCode: type: string xml: name: AccountOperation SellerDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string currencyCode: type: string countryCode: type: string languageCode: type: string parentSeller: type: string customers: $ref: '#/components/schemas/CustomersDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' invoiceTypeSequences: type: object additionalProperties: $ref: '#/components/schemas/SequenceDto' businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' contactInformation: $ref: '#/components/schemas/ContactInformationDto' address: $ref: '#/components/schemas/AddressDto' vatNo: type: string registrationNo: type: string legalText: type: string legalType: type: string ServiceInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time quantity: type: number terminationReason: type: string endAgreementDate: type: string format: date-time customFields: $ref: '#/components/schemas/CustomFieldsDto' orderNumber: type: string rateUntilDate: type: string format: date-time amountPS: type: number calendarPSCode: type: string paymentDayInMonthPS: type: integer format: int32 minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string autoEndOfEngagement: type: boolean subscribedTillDate: type: string format: date-time serviceRenewal: $ref: '#/components/schemas/SubscriptionRenewalDto' xml: name: AuditableEntity ServiceInstancesDto: type: object properties: serviceInstance: type: array items: $ref: '#/components/schemas/ServiceInstanceDto' SubCategoryInvoiceAgregateDto: required: - invoiceSubCategoryCode type: object properties: itemNumber: type: integer format: int32 accountingCode: type: string description: type: string taxCode: type: string taxPercent: type: number quantity: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number invoiceSubCategoryCode: type: string userAccountCode: type: string ratedTransactions: type: array xml: wrapped: true items: $ref: '#/components/schemas/RatedTransactionDto' xml: name: SubCategoryInvoiceAgregate SubscriptionDto: required: - billingCycle - offerTemplate - subscriptionDate - userAccount type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string userAccount: type: string offerTemplate: type: string subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time endAgreementDate: type: string format: date-time status: type: string enum: - CREATED - ACTIVE - CANCELED - RESILIATED - CLOSED - SUSPENDED statusDate: type: string format: date-time customFields: $ref: '#/components/schemas/CustomFieldsDto' accesses: $ref: '#/components/schemas/AccessesDto' services: $ref: '#/components/schemas/ServiceInstancesDto' products: $ref: '#/components/schemas/ProductsDto' productInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/ProductInstanceDto' terminationReason: type: string orderNumber: type: string minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string subscribedTillDate: type: string format: date-time renewed: type: boolean renewalNotifiedDate: type: string format: date-time renewalRule: $ref: '#/components/schemas/SubscriptionRenewalDto' billingCycle: type: string seller: type: string autoEndOfEngagement: type: boolean ratingGroup: type: string electronicBilling: type: boolean email: type: string mailingType: type: string emailTemplate: type: string ccedEmails: type: string discountPlansForInstantiation: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' discountPlansForTermination: type: array xml: wrapped: true items: type: string xml: name: discountPlanForTermination discountPlanInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanInstanceDto' SubscriptionRenewalDto: type: object properties: initialyActiveFor: type: integer format: int32 initialyActiveForUnit: type: string enum: - MONTH - DAY autoRenew: type: boolean daysNotifyRenewal: type: integer format: int32 endOfTermAction: type: string enum: - SUSPEND - TERMINATE terminationReasonCode: type: string renewFor: type: integer format: int32 renewForUnit: type: string enum: - MONTH - DAY extendAgreementPeriodToSubscribedTillDate: type: boolean SubscriptionsDto: type: object properties: subscription: type: array items: $ref: '#/components/schemas/SubscriptionDto' TaxInvoiceAggregateDto: type: object properties: description: type: string itemNumber: type: integer format: int32 amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number taxCode: type: string taxPercent: type: number accountingCode: type: string xml: name: CategoryInvoiceAgregate UserAccountDto: required: - billingAccount type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' jobTitle: type: string businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' loaded: type: boolean vatNo: type: string registrationNo: type: string contactInformation: $ref: '#/components/schemas/ContactInformationDto' billingAccount: type: string billingAccountDescription: type: string customerAccount: type: string customerAccountDescription: type: string customer: type: string customerDescription: type: string subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time status: type: string enum: - ACTIVE - CANCELED - TERMINATED - CLOSED statusDate: type: string format: date-time terminationReason: type: string subscriptions: $ref: '#/components/schemas/SubscriptionsDto' UserAccountsDto: type: object properties: userAccount: type: array items: $ref: '#/components/schemas/UserAccountDto' SellerCodesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' sellerCodes: type: array items: type: string xml: name: SellerCodesResponse GetSellerResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' seller: $ref: '#/components/schemas/SellerDto' xml: name: GetSellerResponse SellerResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' sellers: $ref: '#/components/schemas/SellersDto' xml: name: SellerResponse SellersDto: type: object properties: seller: type: array items: $ref: '#/components/schemas/SellerDto' GetTaxResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' tax: $ref: '#/components/schemas/TaxDto' xml: name: GetTaxResponse GetTaxesResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' taxesDto: $ref: '#/components/schemas/TaxesDto' xml: name: GetTaxesResponse GetTerminationReasonResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' terminationReason: type: array items: $ref: '#/components/schemas/TerminationReasonDto' xml: name: TerminationReasonResponse ChargeAggregateDto: type: object properties: description: type: string quantity: type: string amount: type: string xml: name: ChargeAggregate UsageChargeAggregateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' listChargeAggregate: type: array xml: wrapped: true items: $ref: '#/components/schemas/ChargeAggregateDto' xml: name: UsageChargeAggregateResponse CatUsageDto: type: object properties: code: type: string description: type: string listSubCatUsage: type: array xml: wrapped: true items: $ref: '#/components/schemas/SubCatUsageDto' xml: name: CatUsage SubCatUsageDto: type: object properties: code: type: string description: type: string listUsage: type: array xml: wrapped: true items: $ref: '#/components/schemas/UsageDto' xml: name: SubCatUsage UsageDto: type: object properties: dateEvent: type: string format: date-time code: type: string description: type: string unityDescription: type: string unitAmountWithoutTax: type: number quantity: type: number amountWithoutTax: type: number parameter1: type: string parameter2: type: string parameter3: type: string parameterExtra: type: string offerCode: type: string priceplanCode: type: string xml: name: Usage UsageResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' listCatUsage: type: array xml: wrapped: true items: $ref: '#/components/schemas/CatUsageDto' xml: name: UsageResponse UserDto: required: - email - username type: object properties: username: type: string password: type: string email: type: string firstName: type: string lastName: type: string roles: type: array xml: name: userRoles wrapped: true items: type: string xml: name: userRole externalRoles: type: array xml: wrapped: true items: $ref: '#/components/schemas/RoleDto' securedEntities: type: array xml: name: accessibleEntities wrapped: true items: $ref: '#/components/schemas/SecuredEntityDto' role: type: string userLevel: type: string createdAt: type: string format: date-time lastLoginDate: type: string format: date-time permissions: type: array xml: wrapped: true items: type: string xml: name: permission xml: name: User UsersDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' users: type: array xml: wrapped: true items: $ref: '#/components/schemas/UserDto' xml: name: Users GetUserResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' user: $ref: '#/components/schemas/UserDto' xml: name: GetUserResponse AccessesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' accesses: $ref: '#/components/schemas/AccessesDto' xml: name: AccessesResponse GetAccessResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' access: $ref: '#/components/schemas/AccessDto' xml: name: GetAccessResponse AccountHierarchyDto: required: - email type: object properties: email: type: string customerId: type: string customerCode: type: string sellerCode: type: string customerBrandCode: type: string customerCategoryCode: type: string currencyCode: type: string countryCode: type: string languageCode: type: string titleCode: type: string firstName: type: string lastName: type: string birthDate: type: string format: date-time phoneNumber: type: string billingCycleCode: type: string address1: type: string address2: type: string address3: type: string zipCode: type: string state: type: string city: type: string usePrefix: type: boolean invoicingThreshold: type: number discountPlansForInstantiation: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' discountPlansForTermination: type: array xml: wrapped: true items: type: string xml: name: discountPlanForTermination customFields: $ref: '#/components/schemas/CustomFieldsDto' limit: type: integer format: int32 sortField: type: string index: type: integer format: int32 paymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodDto' paymentMethod: type: integer format: int32 jobTitle: type: string registrationNo: type: string vatNo: type: string xml: name: AccountHierarchy CustomerHierarchyDto: type: object properties: sellers: $ref: '#/components/schemas/SellersDto' xml: name: CustomerHierarchy GetAccountHierarchyResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customers: $ref: '#/components/schemas/CustomersDto' xml: name: FindAccountHierarchyResponse FindAccountHierachyRequestDto: type: object properties: level: type: integer format: int32 name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' CRMAccountHierarchyDto: type: object properties: crmAccountType: type: string crmParentCode: type: string code: type: string description: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' contactInformation: $ref: '#/components/schemas/ContactInformationDto' jobTitle: type: string language: type: string terminationReason: type: string subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time customerCategory: type: string customerBrand: type: string registrationNo: type: string vatNo: type: string seller: type: string mandateIdentification: type: string mandateDate: type: string format: date-time currency: type: string caStatus: type: string enum: - ACTIVE - CLOSE creditCategory: type: string dateStatus: type: string format: date-time dateDunningLevel: type: string format: date-time dunningLevel: type: string enum: - R0 - R1 - R2 - R3 - R4 paymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodDto' paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' paymentTerms: type: string billingCycle: type: string country: type: string nextInvoiceDate: type: string format: date-time electronicBilling: type: boolean baStatus: type: string enum: - ACTIVE - CANCELED - TERMINATED - CLOSED email: type: string invoicingThreshold: type: number uaStatus: type: string enum: - ACTIVE - CANCELED - TERMINATED - CLOSED cfToAdd: $ref: '#/components/schemas/CustomFieldDto' cfMapToAdd: $ref: '#/components/schemas/CustomFieldDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' discountPlansForInstantiation: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' discountPlansForTermination: type: array xml: wrapped: true items: type: string xml: name: discountPlanForTermination mailingType: type: string emailTemplate: type: string ccedEmails: type: string xml: name: CRMAccountHierarchy CustomerListResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customers: $ref: '#/components/schemas/CustomersDto' xml: name: CustomerListResponse BillingAccountsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' billingAccounts: $ref: '#/components/schemas/BillingAccountsDto' xml: name: BillingAccountsResponse CounterInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string xml: name: AuditableEntity CountersInstancesDto: type: object properties: counterInstance: type: array items: $ref: '#/components/schemas/CounterInstanceDto' GetCountersInstancesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' countersInstances: $ref: '#/components/schemas/CountersInstancesDto' GetBillingAccountResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' billingAccount: $ref: '#/components/schemas/BillingAccountDto' xml: name: GetBillingAccountResponse BaseEntityDto: type: object BusinessAccountModelDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean license: type: string xml: attribute: true enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: type: string logoPictureFile: type: array items: type: string format: byte script: $ref: '#/components/schemas/ScriptInstanceDto' moduleItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/BaseEntityDto' hierarchyType: type: string enum: - S - S_C - C - S_CA - C_CA - CA - S_BA - C_BA - CA_BA - BA - S_UA - C_UA - CA_UA - BA_UA - UA codeOnly: type: boolean transient: type: boolean xml: name: BusinessAccountModel ParentEntitiesDto: type: object properties: parent: type: array items: $ref: '#/components/schemas/ParentEntityDto' ParentEntityDto: type: object properties: code: type: string xml: attribute: true description: type: string xml: attribute: true ParentListResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' parents: $ref: '#/components/schemas/ParentEntitiesDto' CRMAccountTypeSearchDto: type: object properties: searchTerm: type: string accountTypeCode: type: string limit: type: integer format: int32 offset: type: integer format: int32 order: type: string enum: - ASCENDING - DESCENDING sortField: type: string BusinessAccountModelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' businessAccountModel: $ref: '#/components/schemas/BusinessAccountModelDto' xml: name: BusinessAccountModelResponse MeveoModuleDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean license: type: string xml: attribute: true enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: type: string logoPictureFile: type: array items: type: string format: byte script: $ref: '#/components/schemas/ScriptInstanceDto' moduleItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/BaseEntityDto' codeOnly: type: boolean transient: type: boolean xml: name: Module MeveoModuleDtosResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' modules: type: array xml: wrapped: true items: $ref: '#/components/schemas/MeveoModuleDto' xml: name: MeveoModuleDtosResponse CustomerAccountsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customerAccounts: $ref: '#/components/schemas/CustomerAccountsDto' xml: name: CustomerAccountsResponse GetCustomerAccountResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customerAccount: $ref: '#/components/schemas/CustomerAccountDto' xml: name: GetCustomerAccountResponse CustomersResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' customers: $ref: '#/components/schemas/CustomersDto' xml: name: CustomersResponse GetCustomerCategoryResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customerCategory: $ref: '#/components/schemas/CustomerCategoryDto' xml: name: GetCustomerCategoryResponse GenericSequenceDto: type: object properties: prefix: pattern: ^[\p{Upper}-]{1,16}$ type: string sequenceSize: type: integer format: int64 currentSequenceNb: type: integer format: int64 GenericSequenceValueResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' sequence: $ref: '#/components/schemas/GenericSequenceDto' value: type: string seller: type: string paymentGateway: type: string xml: name: GenericSequenceValueResponse CustomerSequenceDto: required: - seller type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string genericSequence: $ref: '#/components/schemas/GenericSequenceDto' seller: type: string xml: name: AuditableEntity GetCustomerResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customer: $ref: '#/components/schemas/CustomerDto' xml: name: GetCustomerResponse ProviderContactDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string firstName: type: string lastName: type: string email: type: string phone: type: string mobile: type: string fax: type: string genericMail: type: string addressDto: $ref: '#/components/schemas/AddressDto' xml: name: ProviderContract ProviderContactResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' providerContact: $ref: '#/components/schemas/ProviderContactDto' xml: name: ProviderContactResponse ProviderContactsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' providerContacts: type: array xml: wrapped: true items: $ref: '#/components/schemas/ProviderContactDto' xml: name: ProviderContactsResponse TitleResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' titleDto: $ref: '#/components/schemas/TitleDto' xml: name: TitleResponse TitlesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' titles: $ref: '#/components/schemas/TitlesDto' xml: name: TitlesResponse UserAccountsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' userAccounts: $ref: '#/components/schemas/UserAccountsDto' xml: name: UserAccountsResponse ApplyProductRequestDto: required: - operationDate - product type: object properties: product: type: string userAccount: type: string subscription: type: string operationDate: type: string format: date-time quantity: type: number description: type: string amountWithoutTax: type: number amountWithTax: type: number criteria1: type: string criteria2: type: string criteria3: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' seller: type: string xml: name: ApplyProductRequest GetUserAccountResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' userAccount: $ref: '#/components/schemas/UserAccountDto' xml: name: GetUserAccountResponse RatedTransactionListResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' ratedTransactions: type: array xml: wrapped: true items: $ref: '#/components/schemas/RatedTransactionDto' xml: name: RatedTransactionListResponse FileUploadForm: type: object properties: data: type: array items: type: string format: byte filename: type: string FileRequestDto: required: - content - filepath type: object properties: filepath: type: string content: type: string xml: name: FileRequest FileDto: type: object properties: name: type: string lastModified: type: string format: date-time directory: type: boolean GetFilesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' files: type: array xml: wrapped: true items: $ref: '#/components/schemas/FileDto' xml: name: GetFilesResponse AccountingCodeDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean parentAccountingCode: type: string chartOfAccountTypeEnum: type: string enum: - ASSETS - LIABILITIES - EQUITY - REVENUE - EXPENSE chartOfAccountViewTypeEnum: type: string enum: - VIEW - REGULAR reportingAccount: type: string notes: type: string migrated: type: boolean xml: name: AuditableEntity AccountingCodeListResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' accountingCodes: type: array items: $ref: '#/components/schemas/AccountingCodeDto' xml: name: AccountingCodeListResponse AccountingCodeGetResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' accountingCode: $ref: '#/components/schemas/AccountingCodeDto' xml: name: AccountingCodeGetResponse CreateBillingRunDto: type: object properties: billingCycleCode: type: string xml: attribute: true billingRunTypeEnum: type: string xml: attribute: true enum: - AUTOMATIC - MANUAL startDate: type: string format: date-time endDate: type: string format: date-time invoiceDate: type: string format: date-time lastTransactionDate: type: string format: date-time referenceDate: type: string enum: - TODAY - NEXT_INVOICE_DATE - LAST_TRANSACTION_DATE - END_DATE customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: CreateBillingRunDto Access: required: - disabled - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time accessUserId: maxLength: 255 minLength: 0 type: string subscription: $ref: '#/components/schemas/Subscription' uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' active: type: boolean transient: type: boolean AccountOperation: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R matchingAmounts: type: array items: $ref: '#/components/schemas/MatchingAmount' occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD invoices: type: array items: $ref: '#/components/schemas/Invoice' code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean AccountingCode: required: - chartOfAccountTypeEnum - chartOfAccountViewTypeEnum - code - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean parentAccountingCode: $ref: '#/components/schemas/AccountingCode' chartOfAccountTypeEnum: type: string enum: - ASSETS - LIABILITIES - EQUITY - REVENUE - EXPENSE reportingAccount: type: string chartOfAccountViewTypeEnum: type: string enum: - VIEW - REGULAR notes: type: string migrated: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ActionDunning: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' creationDate: type: string format: date-time typeAction: type: string enum: - FILE - LETTER - EMAIL - CHARGE status: type: string enum: - A - T - E statusDate: type: string format: date-time customerAccount: $ref: '#/components/schemas/CustomerAccount' recordedInvoice: $ref: '#/components/schemas/RecordedInvoice' dunningLOT: $ref: '#/components/schemas/DunningLOT' fromLevel: type: string enum: - R0 - R1 - R2 - R3 - R4 toLevel: type: string enum: - R0 - R1 - R2 - R3 - R4 actionPlanItem: $ref: '#/components/schemas/WFAction' amountDue: type: number transient: type: boolean AdditionalDetails: type: object properties: id: type: integer format: int64 version: type: integer format: int32 companyName: maxLength: 200 minLength: 0 type: string position: maxLength: 200 minLength: 0 type: string instantMessengers: maxLength: 500 minLength: 0 type: string transient: type: boolean Address: type: object properties: address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string address3: maxLength: 255 minLength: 0 type: string zipCode: maxLength: 10 minLength: 0 type: string city: maxLength: 50 minLength: 0 type: string country: $ref: '#/components/schemas/Country' state: maxLength: 50 minLength: 0 type: string countryBundle: type: string AddressBook: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean contacts: uniqueItems: true type: array items: $ref: '#/components/schemas/Contact' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Auditable: type: object properties: created: type: string format: date-time updated: type: string format: date-time creator: type: string updater: type: string lastModified: type: string format: date-time lastUser: type: string AuditableFieldHistory: type: object properties: fieldName: type: string currentState: type: object auditType: type: string enum: - STATUS - RENEWAL - OTHER historable: type: boolean notfiable: type: boolean historized: type: boolean notified: type: boolean AutomatedPayment: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' dunningDocument: $ref: '#/components/schemas/DunningDocument' paymentOrder: type: string fees: type: number comment: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean AutomatedRefund: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean BankCoordinates: type: object properties: bankCode: maxLength: 5 minLength: 0 type: string branchCode: maxLength: 5 minLength: 0 type: string accountNumber: maxLength: 11 minLength: 0 type: string key: maxLength: 2 minLength: 0 type: string iban: maxLength: 80 minLength: 0 type: string bic: maxLength: 11 minLength: 0 type: string accountOwner: maxLength: 50 minLength: 0 type: string bankName: maxLength: 50 minLength: 0 type: string bankId: maxLength: 50 minLength: 0 type: string issuerNumber: maxLength: 50 minLength: 0 type: string issuerName: maxLength: 50 minLength: 0 type: string ics: maxLength: 35 minLength: 0 type: string BillingAccount: type: object properties: id: type: string href: type: string name: type: string xml: name: BillingAccount namespace: http://www.tmforum.org BillingCycle: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' billingTemplateName: maxLength: 50 minLength: 0 type: string billingTemplateNameEL: maxLength: 2000 minLength: 0 type: string calendar: $ref: '#/components/schemas/Calendar' transactionDateDelay: type: integer format: int32 invoiceDateProductionDelay: type: integer format: int32 invoiceDateDelay: type: integer format: int32 dueDateDelay: type: integer format: int32 billingAccounts: type: array items: $ref: '#/components/schemas/BillingAccount' invoicingThreshold: type: number invoiceType: $ref: '#/components/schemas/InvoiceType' dueDateDelayEL: maxLength: 2000 minLength: 0 type: string dueDateDelayELSpark: maxLength: 2000 minLength: 0 type: string invoiceTypeEl: maxLength: 2000 minLength: 0 type: string invoiceTypeElSpark: maxLength: 2000 minLength: 0 type: string type: type: string enum: - BILLINGACCOUNT - SUBSCRIPTION - ORDER scriptInstance: $ref: '#/components/schemas/ScriptInstance' referenceDate: type: string enum: - TODAY - NEXT_INVOICE_DATE - LAST_TRANSACTION_DATE - END_DATE parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean BillingRun: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' processDate: type: string format: date-time status: type: string enum: - NEW - PREINVOICED - PREVALIDATED - CANCELED - POSTINVOICED - POSTVALIDATED - VALIDATED - CANCELLING statusDate: type: string format: date-time billingCycle: $ref: '#/components/schemas/BillingCycle' billingAccountNumber: type: integer format: int32 billableBillingAcountNumber: type: integer format: int32 producibleInvoiceNumber: type: integer format: int32 producibleAmountWithoutTax: type: number producibleAmountTax: type: number producibleAmountWithTax: type: number prAmountWithoutTax: type: number prAmountWithTax: type: number prAmountTax: type: number invoices: type: array items: $ref: '#/components/schemas/Invoice' billingRunLists: uniqueItems: true type: array items: $ref: '#/components/schemas/BillingRunList' billableBillingAccounts: type: array items: $ref: '#/components/schemas/BillingAccount' ratedTransactions: uniqueItems: true type: array items: $ref: '#/components/schemas/RatedTransaction' processType: type: string enum: - AUTOMATIC - MANUAL startDate: type: string format: date-time endDate: type: string format: date-time invoiceDate: type: string format: date-time lastTransactionDate: type: string format: date-time rejectionReason: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/Currency' country: $ref: '#/components/schemas/Country' language: $ref: '#/components/schemas/Language' selectedBillingAccounts: type: string preInvoicingReports: $ref: '#/components/schemas/PreInvoicingReportsDTO' postInvoicingReports: $ref: '#/components/schemas/PostInvoicingReportsDTO' rejectedBillingAccounts: type: array items: $ref: '#/components/schemas/RejectedBillingAccount' cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' uuid: maxLength: 60 minLength: 0 type: string referenceDate: type: string enum: - TODAY - NEXT_INVOICE_DATE - LAST_TRANSACTION_DATE - END_DATE invoiceNumber: type: integer format: int32 referenceCode: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' descriptionOrCode: type: string writeOnly: true referenceDescription: type: string cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean BillingRunDto: type: object properties: processDate: type: string format: date-time status: type: string enum: - NEW - PREINVOICED - PREVALIDATED - CANCELED - POSTINVOICED - POSTVALIDATED - VALIDATED - CANCELLING statusDate: type: string format: date-time billingCycle: $ref: '#/components/schemas/BillingCycleDto' billingAccountNumber: type: integer format: int32 billableBillingAcountNumber: type: integer format: int32 producibleInvoiceNumber: type: integer format: int32 producibleAmountWithoutTax: type: number producibleAmountTax: type: number producibleAmountWithTax: type: number prAmountWithoutTax: type: number prAmountWithTax: type: number prAmountTax: type: number processType: type: string enum: - AUTOMATIC - MANUAL startDate: type: string format: date-time endDate: type: string format: date-time invoiceDate: type: string format: date-time lastTransactionDate: type: string format: date-time referenceDate: type: string enum: - TODAY - NEXT_INVOICE_DATE - LAST_TRANSACTION_DATE - END_DATE rejectionReason: type: string currencyCode: type: string countryCode: type: string languageCode: type: string selectedBillingAccounts: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' invoiceNumber: type: integer format: int32 fromEntity: $ref: '#/components/schemas/BillingRun' xml: name: BillingRun BillingRunList: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' invoice: type: boolean billingRun: $ref: '#/components/schemas/BillingRun' billingAccount: $ref: '#/components/schemas/BillingAccount' ratedAmountWithoutTax: type: number ratedAmountTax: type: number ratedAmountWithTax: type: number ratedAmount2WithoutTax: type: number transient: type: boolean BusinessAccountModel: required: - code - disabled - hierarchyType - license type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean moduleItems: type: array items: $ref: '#/components/schemas/MeveoModuleItem' license: type: string enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: maxLength: 255 minLength: 0 type: string installed: type: boolean moduleSource: type: string script: $ref: '#/components/schemas/ScriptInstance' hierarchyType: type: string enum: - S - S_C - C - S_CA - C_CA - CA - S_BA - C_BA - CA_BA - BA - S_UA - C_UA - CA_UA - BA_UA - UA downloaded: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean BusinessEntity: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean BusinessOfferModel: required: - code - disabled - license type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean moduleItems: type: array items: $ref: '#/components/schemas/MeveoModuleItem' license: type: string enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: maxLength: 255 minLength: 0 type: string installed: type: boolean moduleSource: type: string script: $ref: '#/components/schemas/ScriptInstance' offerTemplate: $ref: '#/components/schemas/OfferTemplate' downloaded: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean BusinessProductModel: required: - code - disabled - license type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean moduleItems: type: array items: $ref: '#/components/schemas/MeveoModuleItem' license: type: string enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: maxLength: 255 minLength: 0 type: string installed: type: boolean moduleSource: type: string script: $ref: '#/components/schemas/ScriptInstance' productTemplate: $ref: '#/components/schemas/ProductTemplate' downloaded: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean BusinessServiceModel: required: - code - disabled - license type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean moduleItems: type: array items: $ref: '#/components/schemas/MeveoModuleItem' license: type: string enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: maxLength: 255 minLength: 0 type: string installed: type: boolean moduleSource: type: string script: $ref: '#/components/schemas/ScriptInstance' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' duplicateService: type: boolean duplicatePricePlan: type: boolean downloaded: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Calendar: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean calendarType: maxLength: 31 minLength: 0 type: string initDate: type: string format: date-time calendarTypeWSubtypes: type: string codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Campaign: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean scheduleDate: type: string format: date-time startDate: type: string format: date-time processingThreadId: type: integer format: int32 endDate: type: string format: date-time priority: type: string enum: - SLOW - NORMAL - URGENT media: type: string enum: - POSTAL_MAIL - EMAIL - SMS - IM - FAX - VOICE - WEBSERVICE - QUEUE - FTP_FILE - CFT_FILE - DATABASE subMedia: maxLength: 255 minLength: 0 type: string useAnyMedia: type: boolean status: type: string enum: - SCHEDULED - RUNNING - PAUSED - CANCELED - TERMINATED messages: type: array items: $ref: '#/components/schemas/Message' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CategoryInvoiceAgregate: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' invoice: $ref: '#/components/schemas/Invoice' billingRun: $ref: '#/components/schemas/BillingRun' itemNumber: type: integer format: int32 description: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' prDescription: maxLength: 255 minLength: 0 type: string invoiceCategory: $ref: '#/components/schemas/InvoiceCategory' userAccount: $ref: '#/components/schemas/UserAccount' subCategoryInvoiceAgregates: uniqueItems: true type: array items: $ref: '#/components/schemas/SubCategoryInvoiceAgregate' transient: type: boolean Channel: type: object properties: id: type: string href: type: string name: type: string ChargeInstance: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time terminationDate: type: string format: date-time chargeTemplate: $ref: '#/components/schemas/ChargeTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' chargeDate: type: string format: date-time amountWithoutTax: type: number amountWithTax: type: number criteria1: maxLength: 255 minLength: 0 type: string criteria2: maxLength: 255 minLength: 0 type: string criteria3: maxLength: 255 minLength: 0 type: string walletOperations: type: array items: $ref: '#/components/schemas/WalletOperation' seller: $ref: '#/components/schemas/Seller' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' prDescription: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/TradingCurrency' country: $ref: '#/components/schemas/TradingCountry' walletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaidWalletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaid: type: boolean orderNumber: maxLength: 100 minLength: 0 type: string walletOperationsSorted: type: array items: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ChargeTemplate: required: - code - disabled - invoiceSubCategory - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CREDIT - DEBIT amountEditable: type: boolean invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRule: $ref: '#/components/schemas/RevenueRecognitionRule' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination chargeType: type: string descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CheckPaymentMethod: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean alias: type: string preferred: type: boolean customerAccount: $ref: '#/components/schemas/CustomerAccount' paymentType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD userId: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string tokenId: type: string expired: type: boolean active: type: boolean transient: type: boolean CommunicationPolicy: type: object properties: delayMinBetween2messages: type: integer format: int64 nbMaxMessagePerDay: type: integer format: int64 nbMaxMessagePerWeek: type: integer format: int64 nbMaxMessagePerMonth: type: integer format: int64 Contact: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' externalRef1: maxLength: 255 minLength: 0 type: string externalRef2: maxLength: 255 minLength: 0 type: string name: $ref: '#/components/schemas/Name' address: $ref: '#/components/schemas/Address' defaultLevel: type: boolean providerContact: maxLength: 255 minLength: 0 type: string primaryContact: $ref: '#/components/schemas/ProviderContact' accountType: maxLength: 10 minLength: 0 type: string businessAccountModel: $ref: '#/components/schemas/BusinessAccountModel' jobTitle: type: string contactInformation: $ref: '#/components/schemas/ContactInformation' vatNo: type: string registrationNo: type: string email: maxLength: 255 minLength: 0 type: string assistantName: maxLength: 50 minLength: 0 type: string assistantPhone: maxLength: 15 minLength: 0 type: string position: maxLength: 200 minLength: 0 type: string company: maxLength: 200 minLength: 0 type: string mobile: maxLength: 15 minLength: 0 type: string phone: maxLength: 15 minLength: 0 type: string websiteUrl: maxLength: 255 minLength: 0 type: string importedFrom: maxLength: 50 minLength: 0 type: string importedBy: maxLength: 50 minLength: 0 type: string socialIdentifier: maxLength: 2000 minLength: 0 type: string agreedToUA: type: boolean contactPolicy: $ref: '#/components/schemas/CommunicationPolicy' messages: type: array items: $ref: '#/components/schemas/Message' addressBook: $ref: '#/components/schemas/AddressBook' tags: uniqueItems: true type: array items: type: string xml: name: discountPlanForTermination prospect: type: boolean vip: type: boolean contactInformationNullSafe: $ref: '#/components/schemas/ContactInformation' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ContactInformation: type: object properties: email: maxLength: 100 minLength: 0 type: string phone: maxLength: 50 minLength: 0 type: string mobile: maxLength: 50 minLength: 0 type: string fax: maxLength: 50 minLength: 0 type: string CounterInstance: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean counterTemplate: $ref: '#/components/schemas/CounterTemplate' userAccount: $ref: '#/components/schemas/UserAccount' billingAccount: $ref: '#/components/schemas/BillingAccount' counterPeriods: type: array items: $ref: '#/components/schemas/CounterPeriod' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CounterPeriod: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean counterInstance: $ref: '#/components/schemas/CounterInstance' counterType: type: string enum: - USAGE - NOTIFICATION periodStartDate: type: string format: date-time periodEndDate: type: string format: date-time level: type: number value: type: number notificationLevels: maxLength: 100 minLength: 0 type: string notificationLevelsAsMap: type: object additionalProperties: type: number codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CounterTemplate: required: - code - counterLevel - counterType - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean counterType: type: string enum: - USAGE - NOTIFICATION calendar: $ref: '#/components/schemas/Calendar' ceiling: type: number unityDescription: maxLength: 20 minLength: 0 type: string counterLevel: type: string enum: - SI - SU - UA - BA ceilingExpressionEl: maxLength: 2000 minLength: 0 type: string notificationLevels: maxLength: 70 minLength: 0 type: string active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Country: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' countryCode: maxLength: 10 minLength: 0 type: string description: maxLength: 100 minLength: 0 type: string currency: $ref: '#/components/schemas/Currency' language: $ref: '#/components/schemas/Language' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination transient: type: boolean CreditCategory: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Currency: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' currencyCode: maxLength: 3 minLength: 0 type: string descriptionEn: maxLength: 255 minLength: 0 type: string systemCurrency: type: boolean description: type: string transient: type: boolean CustomFieldValue: type: object properties: from: type: string format: date-time to: type: string format: date-time valid: type: boolean empty: type: boolean priority: type: integer format: int32 valueEmptyForGui: type: boolean allEntities: type: array items: $ref: '#/components/schemas/EntityReferenceWrapper' listValue: type: array items: type: object mapValue: type: object additionalProperties: type: object excessiveInSize: type: boolean valueEmpty: type: boolean value: type: object string: type: string date: type: string format: date-time long: type: integer format: int64 double: type: number format: double boolean: type: boolean entity: $ref: '#/components/schemas/EntityReferenceWrapper' listString: type: array items: type: string xml: name: discountPlanForTermination listDate: type: array items: type: string format: date-time listLong: type: array items: type: integer format: int64 listDouble: type: array items: type: number format: double listBoolean: type: array items: type: boolean listEntity: type: array items: $ref: '#/components/schemas/EntityReferenceWrapper' mapString: type: object additionalProperties: type: string xml: name: discountPlanForTermination mapDate: type: object additionalProperties: type: string format: date-time mapLong: type: object additionalProperties: type: integer format: int64 mapDouble: type: object additionalProperties: type: number format: double mapBoolean: type: object additionalProperties: type: boolean mapEntity: type: object additionalProperties: $ref: '#/components/schemas/EntityReferenceWrapper' source: type: string CustomFieldValues: type: object properties: valuesByCode: type: object additionalProperties: type: array items: $ref: '#/components/schemas/CustomFieldValue' values: type: object additionalProperties: type: object newVersionedCFValuePeriods: type: object additionalProperties: type: array items: $ref: '#/components/schemas/DatePeriod' Customer: type: object properties: id: type: string href: type: string name: type: string CustomerAccount: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' externalRef1: maxLength: 255 minLength: 0 type: string externalRef2: maxLength: 255 minLength: 0 type: string name: $ref: '#/components/schemas/Name' address: $ref: '#/components/schemas/Address' defaultLevel: type: boolean providerContact: maxLength: 255 minLength: 0 type: string primaryContact: $ref: '#/components/schemas/ProviderContact' accountType: maxLength: 10 minLength: 0 type: string businessAccountModel: $ref: '#/components/schemas/BusinessAccountModel' jobTitle: type: string contactInformation: $ref: '#/components/schemas/ContactInformation' vatNo: type: string registrationNo: type: string addressbook: $ref: '#/components/schemas/AddressBook' tradingCurrency: $ref: '#/components/schemas/TradingCurrency' status: type: string enum: - ACTIVE - CLOSE creditCategory: $ref: '#/components/schemas/CreditCategory' billingAccounts: type: array items: $ref: '#/components/schemas/BillingAccount' accountOperations: type: array items: $ref: '#/components/schemas/AccountOperation' dunningDocuments: type: array items: $ref: '#/components/schemas/DunningDocument' actionDunnings: type: array items: $ref: '#/components/schemas/ActionDunning' dateStatus: type: string format: date-time dateDunningLevel: type: string format: date-time customer: $ref: '#/components/schemas/Customer' dunningLevel: type: string enum: - R0 - R1 - R2 - R3 - R4 password: maxLength: 10 minLength: 0 type: string dueDateDelayEL: maxLength: 2000 minLength: 0 type: string dueDateDelayELSpark: maxLength: 2000 minLength: 0 type: string tradingLanguage: $ref: '#/components/schemas/TradingLanguage' paymentMethods: type: array items: $ref: '#/components/schemas/PaymentMethod' excludedFromPayment: type: boolean preferredPaymentMethod: $ref: '#/components/schemas/PaymentMethod' preferredPaymentMethodType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD ddpaymentMethods: type: array items: $ref: '#/components/schemas/DDPaymentMethod' wirePaymentMethods: type: array items: $ref: '#/components/schemas/WirePaymentMethod' checkPaymentMethods: type: array items: $ref: '#/components/schemas/CheckPaymentMethod' noMoreValidCard: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' contactInformationNullSafe: $ref: '#/components/schemas/ContactInformation' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CustomerBrand: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CustomerCategory: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' exoneratedFromTaxes: type: boolean exonerationTaxEl: maxLength: 2000 minLength: 0 type: string exonerationTaxElSpark: maxLength: 2000 minLength: 0 type: string exonerationReason: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean CustomerSequence: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean genericSequence: $ref: '#/components/schemas/GenericSequence' seller: $ref: '#/components/schemas/Seller' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean DDPaymentMethod: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean alias: type: string preferred: type: boolean customerAccount: $ref: '#/components/schemas/CustomerAccount' paymentType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD userId: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string tokenId: type: string bankCoordinates: $ref: '#/components/schemas/BankCoordinates' mandateIdentification: maxLength: 255 minLength: 0 type: string mandateDate: type: string format: date-time expired: type: boolean active: type: boolean transient: type: boolean DDRequestBuilder: required: - code - disabled - paymentLevel - type - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CUSTOM - NATIF scriptInstance: $ref: '#/components/schemas/ScriptInstance' implementationClassName: maxLength: 255 minLength: 0 type: string nbOperationPerFile: type: integer format: int64 maxSizeFile: type: integer format: int64 paymentLevel: type: string enum: - AO - CA active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean DDRequestItem: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' amount: type: number paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string dueDate: type: string format: date-time billingAccountName: maxLength: 255 minLength: 0 type: string reference: maxLength: 255 minLength: 0 type: string ddRequestLOT: $ref: '#/components/schemas/DDRequestLOT' accountOperations: type: array items: $ref: '#/components/schemas/AccountOperation' errorMsg: maxLength: 1000 minLength: 0 type: string automatedPayment: $ref: '#/components/schemas/AutomatedPayment' automatedRefund: $ref: '#/components/schemas/AutomatedRefund' rejectedFileName: maxLength: 1000 minLength: 0 type: string transient: type: boolean DDRequestLOT: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' fileName: type: string returnFileName: maxLength: 255 minLength: 0 type: string sendDate: type: string format: date-time nbItemsOk: type: integer format: int32 paymentCreated: type: boolean totalAmount: type: number ddrequestItems: type: array items: $ref: '#/components/schemas/DDRequestItem' returnStatusCode: maxLength: 255 minLength: 0 type: string rejectedCause: maxLength: 255 minLength: 0 type: string nbItemsKo: type: integer format: int32 ddRequestBuilder: $ref: '#/components/schemas/DDRequestBuilder' paymentOrRefundEnum: type: string enum: - PAYMENT - REFUND seller: $ref: '#/components/schemas/Seller' transient: type: boolean DatePeriod: type: object properties: from: type: string format: date-time to: type: string format: date-time valid: type: boolean empty: type: boolean DigitalResource: required: - code - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean uri: type: string mimeType: maxLength: 50 minLength: 0 type: string productOfferings: type: array items: $ref: '#/components/schemas/ProductOffering' active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean DiscountPlan: required: - code - disabled - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean minDuration: type: integer format: int32 maxDuration: type: integer format: int32 discountPlanItems: type: array items: $ref: '#/components/schemas/DiscountPlanItem' startDate: type: string format: date-time endDate: type: string format: date-time defaultDuration: type: integer format: int32 durationUnit: type: string enum: - MONTH - DAY valid: type: boolean active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean DiscountPlanInstance: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 discountPlan: $ref: '#/components/schemas/DiscountPlan' billingAccount: $ref: '#/components/schemas/BillingAccount' subscription: $ref: '#/components/schemas/Subscription' startDate: type: string format: date-time endDate: type: string format: date-time uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' valid: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean DiscountPlanItem: required: - code - disabled - discountPlan - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean code: maxLength: 255 minLength: 1 type: string discountPlan: $ref: '#/components/schemas/DiscountPlan' invoiceCategory: $ref: '#/components/schemas/InvoiceCategory' invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' accountingCode: maxLength: 255 minLength: 0 type: string expressionEl: maxLength: 2000 minLength: 0 type: string expressionElSpark: maxLength: 2000 minLength: 0 type: string discountValue: type: number discountValueEL: maxLength: 2000 minLength: 0 type: string discountValueElSpark: maxLength: 2000 minLength: 0 type: string discountPlanItemType: type: string enum: - PERCENTAGE - FIXED uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' active: type: boolean transient: type: boolean DunningDocument: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean customerAccount: $ref: '#/components/schemas/CustomerAccount' subscription: $ref: '#/components/schemas/Subscription' dueInvoices: type: array items: $ref: '#/components/schemas/RecordedInvoice' payments: type: array items: $ref: '#/components/schemas/Payment' amountWithoutTax: type: number amountWithTax: type: number paidAmount: type: number codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean DunningHistory: type: object properties: id: type: integer format: int64 version: type: integer format: int32 type: maxLength: 31 minLength: 0 type: string executionDate: type: string format: date-time linesRead: type: integer format: int32 linesInserted: type: integer format: int32 linesRejected: type: integer format: int32 dunningLots: type: array items: $ref: '#/components/schemas/DunningLOT' transient: type: boolean DunningLOT: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' fileName: maxLength: 255 minLength: 0 type: string actionType: type: string enum: - FILE - LETTER - EMAIL - CHARGE dunningHistory: $ref: '#/components/schemas/DunningHistory' actions: type: array items: $ref: '#/components/schemas/ActionDunning' transient: type: boolean EDR: required: - subscription type: object properties: id: type: integer format: int64 version: type: integer format: int32 subscription: $ref: '#/components/schemas/Subscription' originBatch: maxLength: 255 minLength: 0 type: string originRecord: maxLength: 255 minLength: 0 type: string eventDate: type: string format: date-time quantity: type: number parameter1: maxLength: 255 minLength: 0 type: string parameter2: maxLength: 255 minLength: 0 type: string parameter3: maxLength: 255 minLength: 0 type: string parameter4: maxLength: 255 minLength: 0 type: string parameter5: maxLength: 255 minLength: 0 type: string parameter6: maxLength: 255 minLength: 0 type: string parameter7: maxLength: 255 minLength: 0 type: string parameter8: maxLength: 255 minLength: 0 type: string parameter9: maxLength: 255 minLength: 0 type: string dateParam1: type: string format: date-time dateParam2: type: string format: date-time dateParam3: type: string format: date-time dateParam4: type: string format: date-time dateParam5: type: string format: date-time decimalParam1: type: number decimalParam2: type: number decimalParam3: type: number decimalParam4: type: number decimalParam5: type: number status: type: string enum: - OPEN - RATED - REJECTED - MEDIATING - AGGREGATED rejectReason: maxLength: 255 minLength: 0 type: string created: type: string format: date-time lastUpdate: type: string format: date-time accessCode: maxLength: 255 minLength: 0 type: string headerEDR: $ref: '#/components/schemas/EDR' extraParameter: type: string transient: type: boolean EmailTemplate: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean media: type: string enum: - POSTAL_MAIL - EMAIL - SMS - IM - FAX - VOICE - WEBSERVICE - QUEUE - FTP_FILE - CFT_FILE - DATABASE tagStartDelimiter: maxLength: 255 minLength: 0 type: string tagEndDelimiter: maxLength: 255 minLength: 0 type: string startDate: type: string format: date-time endDate: type: string format: date-time type: type: string enum: - DUNNING - INVOICE - OTHER subject: maxLength: 255 minLength: 0 type: string htmlContent: type: string textContent: type: string codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean EntityReferenceWrapper: type: object properties: classname: type: string classnameCode: type: string code: type: string referenceCode: type: string referenceDescription: type: string empty: type: boolean GeneralLedger: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean otherTransactions: type: array items: $ref: '#/components/schemas/OtherTransaction' seller: $ref: '#/components/schemas/Seller' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean GenericSequence: type: object properties: prefix: maxLength: 255 minLength: 0 type: string sequenceSize: maximum: 20 type: integer format: int64 currentSequenceNb: maximum: 35 minimum: 0 type: integer format: int64 GetBillingRunInfoResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' billingRunDto: $ref: '#/components/schemas/BillingRunDto' xml: name: GetBillingRunInfoResponse HierarchyLevel: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean parentLevel: $ref: '#/components/schemas/HierarchyLevel' childLevels: uniqueItems: true type: array items: $ref: '#/components/schemas/HierarchyLevel' hierarchyType: maxLength: 10 minLength: 0 type: string orderLevel: type: integer format: int64 parentEntity: $ref: '#/components/schemas/BusinessEntity' codeChanged: type: boolean descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ICustomFieldEntity: type: object properties: cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' uuid: type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' Invoice: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' billingRun: $ref: '#/components/schemas/BillingRun' recordedInvoice: $ref: '#/components/schemas/RecordedInvoice' invoiceAgregates: type: array items: $ref: '#/components/schemas/InvoiceAgregate' invoiceNumber: maxLength: 50 minLength: 0 type: string temporaryInvoiceNumber: maxLength: 60 minLength: 0 type: string productDate: type: string format: date-time invoiceDate: type: string format: date-time dueDate: type: string format: date-time amount: type: number discount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number netToPay: type: number paymentMethodType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD iban: maxLength: 255 minLength: 0 type: string alias: maxLength: 255 minLength: 0 type: string tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' ratedTransactions: type: array items: $ref: '#/components/schemas/RatedTransaction' comment: maxLength: 1200 minLength: 0 type: string adjustedInvoice: $ref: '#/components/schemas/Invoice' invoiceType: $ref: '#/components/schemas/InvoiceType' uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' linkedInvoices: uniqueItems: true type: array items: $ref: '#/components/schemas/Invoice' orders: type: array items: $ref: '#/components/schemas/Order' quote: $ref: '#/components/schemas/Quote' subscription: $ref: '#/components/schemas/Subscription' order: $ref: '#/components/schemas/Order' xmlFilename: maxLength: 255 minLength: 0 type: string pdfFilename: maxLength: 255 minLength: 0 type: string paymentMethod: $ref: '#/components/schemas/PaymentMethod' dueBalance: type: number alreadySent: type: boolean dontSend: type: boolean seller: $ref: '#/components/schemas/Seller' invoiceAdjustmentCurrentSellerNb: type: integer format: int64 invoiceAdjustmentCurrentProviderNb: type: integer format: int64 previousInvoiceNumber: type: string draft: type: boolean detailedInvoice: type: boolean invoiceNumberOrTemporaryNumber: type: string discountAgregates: type: array items: $ref: '#/components/schemas/SubCategoryInvoiceAgregate' pdfFilenameOnly: type: string xmlFilenameOnly: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean InvoiceAgregate: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' invoice: $ref: '#/components/schemas/Invoice' billingRun: $ref: '#/components/schemas/BillingRun' itemNumber: type: integer format: int32 description: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' prDescription: maxLength: 255 minLength: 0 type: string transient: type: boolean InvoiceCategory: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' invoiceSubCategories: type: array items: $ref: '#/components/schemas/InvoiceSubCategory' sortIndex: type: integer format: int32 descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination occTemplate: $ref: '#/components/schemas/OCCTemplate' occTemplateNegative: $ref: '#/components/schemas/OCCTemplate' descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean InvoiceSequence: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean invoiceTypes: type: array items: $ref: '#/components/schemas/InvoiceType' invoiceTypeSellerSequences: type: array items: $ref: '#/components/schemas/InvoiceTypeSellerSequence' sequenceSize: type: integer format: int32 currentInvoiceNb: type: integer format: int64 previousInvoiceNb: type: integer format: int64 codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean InvoiceSubCategory: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' discount: type: number invoiceSubcategoryCountries: type: array items: $ref: '#/components/schemas/InvoiceSubcategoryCountry' invoiceCategory: $ref: '#/components/schemas/InvoiceCategory' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination accountingCode: $ref: '#/components/schemas/AccountingCode' taxScript: $ref: '#/components/schemas/ScriptInstance' occTemplate: $ref: '#/components/schemas/OCCTemplate' occTemplateNegative: $ref: '#/components/schemas/OCCTemplate' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean InvoiceSubcategoryCountry: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' sellingCountry: $ref: '#/components/schemas/TradingCountry' tradingCountry: $ref: '#/components/schemas/TradingCountry' tax: $ref: '#/components/schemas/Tax' filterEL: maxLength: 2000 minLength: 0 type: string taxCodeEL: maxLength: 2000 minLength: 0 type: string taxCodeELSpark: maxLength: 2000 minLength: 0 type: string startValidityDate: type: string format: date-time endValidityDate: type: string format: date-time priority: type: integer format: int32 strictMatch: type: boolean startValidityDateMatch: type: string format: date-time endValidityDateMatch: type: string format: date-time transient: type: boolean InvoiceType: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' occTemplate: $ref: '#/components/schemas/OCCTemplate' occTemplateNegative: $ref: '#/components/schemas/OCCTemplate' customInvoiceXmlScriptInstance: $ref: '#/components/schemas/ScriptInstance' appliesTo: type: array items: $ref: '#/components/schemas/InvoiceType' invoiceSequence: $ref: '#/components/schemas/InvoiceSequence' prefixEL: maxLength: 2000 minLength: 0 type: string sellerSequence: type: array items: $ref: '#/components/schemas/InvoiceTypeSellerSequence' matchingAuto: type: boolean invoiceAccountable: type: boolean billingTemplateName: maxLength: 50 minLength: 0 type: string useSelfSequence: type: boolean pdfFilenameEL: maxLength: 2000 minLength: 0 type: string xmlFilenameEL: maxLength: 2000 minLength: 0 type: string billingTemplateNameEL: maxLength: 2000 minLength: 0 type: string taxScript: $ref: '#/components/schemas/ScriptInstance' occTemplateCodeEl: maxLength: 2000 minLength: 0 type: string occTemplateNegativeCodeEl: maxLength: 2000 minLength: 0 type: string emailTemplate: $ref: '#/components/schemas/EmailTemplate' mailingType: type: string enum: - MANUAL - AUTO - BATCH parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean InvoiceTypeSellerSequence: required: - invoiceType - seller type: object properties: id: type: object invoiceType: $ref: '#/components/schemas/InvoiceType' seller: $ref: '#/components/schemas/Seller' invoiceSequence: $ref: '#/components/schemas/InvoiceSequence' prefixEL: maxLength: 2000 minLength: 0 type: string transient: type: boolean Language: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' languageCode: maxLength: 3 minLength: 0 type: string descriptionEn: maxLength: 100 minLength: 0 type: string description: type: string transient: type: boolean MatchingAmount: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' matchingCode: $ref: '#/components/schemas/MatchingCode' accountOperation: $ref: '#/components/schemas/AccountOperation' matchingAmount: type: number transient: type: boolean MatchingCode: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 0 type: string matchingType: type: string enum: - A - M - A_TIP - A_DERICT_DEBIT matchingDate: type: string format: date-time matchingAmounts: type: array items: $ref: '#/components/schemas/MatchingAmount' matchingAmountCredit: type: number matchingAmountDebit: type: number transient: type: boolean Message: type: object properties: id: type: integer format: int64 version: type: integer format: int32 templateCode: maxLength: 255 minLength: 0 type: string parameters: type: array items: $ref: '#/components/schemas/MessageVariableValue' campaign: $ref: '#/components/schemas/Campaign' contact: $ref: '#/components/schemas/Contact' media: type: string enum: - POSTAL_MAIL - EMAIL - SMS - IM - FAX - VOICE - WEBSERVICE - QUEUE - FTP_FILE - CFT_FILE - DATABASE subMedia: maxLength: 255 minLength: 0 type: string priority: type: string enum: - SLOW - NORMAL - URGENT status: type: string enum: - WAITING - PROCESSING - TREATED - REJECTED - CANCELED rejectionReason: maxLength: 255 minLength: 0 type: string transient: type: boolean MessageVariableValue: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean message: $ref: '#/components/schemas/Message' value: maxLength: 255 minLength: 0 type: string codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean MeveoInstance: required: - code - url type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean user: $ref: '#/components/schemas/User' customer: $ref: '#/components/schemas/Customer' productName: maxLength: 255 minLength: 0 type: string productVersion: maxLength: 255 minLength: 0 type: string owner: maxLength: 255 minLength: 0 type: string md5: maxLength: 255 minLength: 0 type: string status: type: string enum: - UNKNOWN - PARENT - CHILD - PARTNER creationDate: type: string format: date-time updateDate: type: string format: date-time keyEntreprise: maxLength: 255 minLength: 0 type: string macAddress: maxLength: 255 minLength: 0 type: string machineVendor: maxLength: 255 minLength: 0 type: string installationMode: maxLength: 255 minLength: 0 type: string nbCores: maxLength: 255 minLength: 0 type: string memory: maxLength: 255 minLength: 0 type: string hdSize: maxLength: 255 minLength: 0 type: string osName: maxLength: 255 minLength: 0 type: string osVersion: maxLength: 255 minLength: 0 type: string osArch: maxLength: 255 minLength: 0 type: string javaVmVersion: maxLength: 255 minLength: 0 type: string javaVmName: maxLength: 255 minLength: 0 type: string javaVendor: maxLength: 255 minLength: 0 type: string javaVersion: maxLength: 255 minLength: 0 type: string asVendor: maxLength: 255 minLength: 0 type: string asVersion: maxLength: 255 minLength: 0 type: string url: maxLength: 255 minLength: 0 type: string authUsername: maxLength: 60 minLength: 0 type: string authPassword: maxLength: 60 minLength: 0 type: string codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean MeveoModule: required: - code - disabled - license type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean license: type: string enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: maxLength: 255 minLength: 0 type: string installed: type: boolean moduleSource: type: string script: $ref: '#/components/schemas/ScriptInstance' downloaded: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean MeveoModuleItem: required: - itemClass - itemCode type: object properties: id: type: integer format: int64 version: type: integer format: int32 meveoModule: $ref: '#/components/schemas/MeveoModule' appliesTo: maxLength: 100 minLength: 0 type: string itemClass: maxLength: 100 minLength: 0 type: string itemCode: maxLength: 255 minLength: 0 type: string validity: $ref: '#/components/schemas/DatePeriod' itemEntity: $ref: '#/components/schemas/BusinessEntity' itemClassSimpleName: type: string transient: type: boolean Name: type: object properties: title: $ref: '#/components/schemas/Title' firstName: maxLength: 50 minLength: 0 type: string lastName: maxLength: 50 minLength: 0 type: string fullName: type: string OCCTemplate: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string occCategory: type: string enum: - DEBIT - CREDIT codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean OfferProductTemplate: type: object properties: id: type: object offerTemplate: $ref: '#/components/schemas/OfferTemplate' productTemplate: $ref: '#/components/schemas/ProductTemplate' mandatory: type: boolean transient: type: boolean OfferServiceTemplate: required: - offerTemplate - serviceTemplate type: object properties: id: type: integer format: int64 offerTemplate: $ref: '#/components/schemas/OfferTemplate' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' mandatory: type: boolean incompatibleServices: type: array items: $ref: '#/components/schemas/ServiceTemplate' validity: $ref: '#/components/schemas/DatePeriod' transient: type: boolean OfferTemplate: required: - code - disabled - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean name: maxLength: 100 minLength: 0 type: string offerTemplateCategories: type: array items: $ref: '#/components/schemas/OfferTemplateCategory' validity: $ref: '#/components/schemas/DatePeriod' imagePath: maxLength: 100 minLength: 0 type: string attachments: type: array items: $ref: '#/components/schemas/DigitalResource' lifeCycleStatus: type: string enum: - IN_STUDY - IN_DESIGN - IN_TEST - ACTIVE - LAUNCHED - RETIRED - OBSOLETE - REJECTED businessAccountModels: type: array items: $ref: '#/components/schemas/BusinessAccountModel' channels: type: array items: $ref: '#/components/schemas/Channel' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination longDescription: maxLength: 2000 minLength: 0 type: string longDescriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination globalRatingScriptInstance: $ref: '#/components/schemas/ScriptInstance' sellers: type: array items: $ref: '#/components/schemas/Seller' customerCategories: type: array items: $ref: '#/components/schemas/CustomerCategory' businessOfferModel: $ref: '#/components/schemas/BusinessOfferModel' offerServiceTemplates: type: array items: $ref: '#/components/schemas/OfferServiceTemplate' offerProductTemplates: type: array items: $ref: '#/components/schemas/OfferProductTemplate' minimumAmountEl: maxLength: 2000 minLength: 0 type: string minimumLabelEl: maxLength: 2000 minLength: 0 type: string minimumAmountElSpark: maxLength: 2000 minLength: 0 type: string allowedDiscountPlans: type: array items: $ref: '#/components/schemas/DiscountPlan' minimumLabelElSpark: maxLength: 2000 minLength: 0 type: string subscriptionRenewal: $ref: '#/components/schemas/SubscriptionRenewal' prefix: type: string serviceTemplatesByChargeType: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ServiceTemplate' productTemplates: type: array items: $ref: '#/components/schemas/ProductTemplate' transientCode: type: string autoEndOfEngagement: type: boolean descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination nameOrCode: type: string longDescriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean OfferTemplateCategory: required: - code - disabled - name - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean name: maxLength: 100 minLength: 0 type: string offerTemplateCategory: $ref: '#/components/schemas/OfferTemplateCategory' children: type: array items: $ref: '#/components/schemas/OfferTemplateCategory' productOffering: type: array items: $ref: '#/components/schemas/ProductOffering' orderLevel: type: integer format: int32 imagePath: maxLength: 100 minLength: 0 type: string parentCategoryCode: type: string assignedToProductOffering: type: boolean descriptionOrCode: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' active: type: boolean cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean OneShotChargeInstance: required: - code - quantity type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time terminationDate: type: string format: date-time chargeTemplate: $ref: '#/components/schemas/ChargeTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' chargeDate: type: string format: date-time amountWithoutTax: type: number amountWithTax: type: number criteria1: maxLength: 255 minLength: 0 type: string criteria2: maxLength: 255 minLength: 0 type: string criteria3: maxLength: 255 minLength: 0 type: string walletOperations: type: array items: $ref: '#/components/schemas/WalletOperation' seller: $ref: '#/components/schemas/Seller' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' prDescription: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/TradingCurrency' country: $ref: '#/components/schemas/TradingCountry' walletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaidWalletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaid: type: boolean orderNumber: maxLength: 100 minLength: 0 type: string subscriptionServiceInstance: $ref: '#/components/schemas/ServiceInstance' terminationServiceInstance: $ref: '#/components/schemas/ServiceInstance' quantity: type: number walletOperationsSorted: type: array items: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean OneShotChargeTemplate: required: - code - disabled - invoiceSubCategory - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CREDIT - DEBIT amountEditable: type: boolean invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' edrTemplates: type: array items: $ref: '#/components/schemas/TriggeredEDRTemplate' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRule: $ref: '#/components/schemas/RevenueRecognitionRule' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination oneShotChargeTemplateType: type: string enum: - oneShotChargeTemplateTypeEnum.subscription - oneShotChargeTemplateTypeEnum.termination - oneShotChargeTemplateTypeEnum.other immediateInvoicing: type: boolean filterExpression: maxLength: 2000 minLength: 0 type: string chargeType: type: string descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Order: required: - code - orderDate - status - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' externalId: maxLength: 100 minLength: 0 type: string orderNumber: maxLength: 255 minLength: 0 type: string deliveryInstructions: type: string orderDate: type: string format: date-time requestedStartDate: type: string format: date-time startDate: type: string format: date-time requestedCompletionDate: type: string format: date-time expectedCompletionDate: type: string format: date-time completionDate: type: string format: date-time priority: type: integer format: int32 category: type: string status: type: string enum: - IN_CREATION - ACKNOWLEDGED - IN_PROGRESS - CANCELLED - COMPLETED - REJECTED - PENDING - HELD - FAILED - PARTIAL statusMessage: type: string orderItems: type: array items: $ref: '#/components/schemas/OrderItem' routedToUserGroup: $ref: '#/components/schemas/UserHierarchyLevel' receivedFromApp: type: string invoices: type: array items: $ref: '#/components/schemas/Invoice' dueDateDelayEL: maxLength: 2000 minLength: 0 type: string dueDateDelayELSpark: maxLength: 2000 minLength: 0 type: string paymentMethod: $ref: '#/components/schemas/PaymentMethod' quote: $ref: '#/components/schemas/Quote' billingCycle: $ref: '#/components/schemas/BillingCycle' billingRun: $ref: '#/components/schemas/BillingRun' emailTemplate: $ref: '#/components/schemas/EmailTemplate' mailingType: type: string enum: - MANUAL - AUTO - BATCH ccedEmails: maxLength: 2000 minLength: 0 type: string email: maxLength: 255 minLength: 0 type: string electronicBilling: type: boolean minRatedTransactions: type: array items: $ref: '#/components/schemas/RatedTransaction' totalInvoicingAmountWithoutTax: type: number totalInvoicingAmountWithTax: type: number totalInvoicingAmountTax: type: number userAccounts: uniqueItems: true type: array items: $ref: '#/components/schemas/UserAccount' shippingAddress: $ref: '#/components/schemas/Address' transient: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string OrderHistory: type: object properties: id: type: integer format: int64 version: type: integer format: int32 orderItem: $ref: '#/components/schemas/OrderItem' serviceInstance: $ref: '#/components/schemas/ServiceInstance' orderNumber: maxLength: 100 minLength: 0 type: string action: type: string enum: - ADD - MODIFY - DELETE eventDate: type: string format: date-time transient: type: boolean OrderItem: required: - action - itemId - order - status - userAccount type: object properties: id: type: integer format: int64 version: type: integer format: int32 order: $ref: '#/components/schemas/Order' itemId: type: string action: type: string enum: - ADD - MODIFY - DELETE userAccount: $ref: '#/components/schemas/UserAccount' orderItemProductOfferings: type: array items: $ref: '#/components/schemas/OrderItemProductOffering' source: type: string status: type: string enum: - IN_CREATION - ACKNOWLEDGED - IN_PROGRESS - CANCELLED - COMPLETED - REJECTED - PENDING - HELD - FAILED - PARTIAL productInstances: type: array items: $ref: '#/components/schemas/ProductInstance' subscription: $ref: '#/components/schemas/Subscription' shippingAddress: $ref: '#/components/schemas/Address' orderHistories: type: array items: $ref: '#/components/schemas/OrderHistory' orderItemDto: type: object mainOffering: $ref: '#/components/schemas/ProductOffering' transient: type: boolean OrderItemProductOffering: required: - itemOrder - orderItem - productOffering type: object properties: id: type: object orderItem: $ref: '#/components/schemas/OrderItem' productOffering: $ref: '#/components/schemas/ProductOffering' itemOrder: type: integer format: int32 transient: type: boolean OtherTransaction: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT type: maxLength: 31 minLength: 0 type: string reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number generalLedger: $ref: '#/components/schemas/GeneralLedger' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: maxLength: 255 minLength: 0 type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string paymentInfo7: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' paymentVentilations: type: array items: $ref: '#/components/schemas/PaymentVentilation' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean Payment: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' dunningDocument: $ref: '#/components/schemas/DunningDocument' paymentOrder: type: string fees: type: number comment: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean PaymentGateway: required: - code - disabled - type - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CUSTOM - NATIF paymentMethodType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD scriptInstance: $ref: '#/components/schemas/ScriptInstance' implementationClassName: maxLength: 255 minLength: 0 type: string applicationEL: maxLength: 2000 minLength: 0 type: string country: $ref: '#/components/schemas/Country' tradingCurrency: $ref: '#/components/schemas/TradingCurrency' cardType: type: string enum: - VISA - MASTERCARD - AMERICAN_EXPRESS - CB nbTries: type: integer format: int32 replayCause: type: string enum: - ERROR - REJECT errorsToReplay: type: string marchandId: type: string secretKey: type: string apiKey: type: string webhooksKeyId: type: string webhooksSecretKey: type: string profile: type: string rumSequence: $ref: '#/components/schemas/PaymentGatewayRumSequence' bankCoordinates: $ref: '#/components/schemas/BankCoordinates' seller: $ref: '#/components/schemas/Seller' active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean PaymentGatewayRumSequence: required: - code - paymentGateway type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean genericSequence: $ref: '#/components/schemas/GenericSequence' paymentGateway: $ref: '#/components/schemas/PaymentGateway' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean PaymentMethod: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean alias: type: string preferred: type: boolean customerAccount: $ref: '#/components/schemas/CustomerAccount' paymentType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD userId: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string tokenId: type: string expired: type: boolean active: type: boolean transient: type: boolean PaymentScheduleInstance: required: - amount - calendar - code - disabled - endDate - paymentDayInMonth - paymentScheduleTemplate - serviceInstance - startDate - status - statusDate - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean status: type: string enum: - IN_PROGRESS - OBSOLETE - DONE - CANCELLED - TERMINATED statusDate: type: string format: date-time paymentScheduleTemplate: $ref: '#/components/schemas/PaymentScheduleTemplate' startDate: type: string format: date-time endDate: type: string format: date-time serviceInstance: $ref: '#/components/schemas/ServiceInstance' amount: type: number calendar: $ref: '#/components/schemas/Calendar' paymentDayInMonth: type: integer format: int32 paymentScheduleInstanceItems: type: array items: $ref: '#/components/schemas/PaymentScheduleInstanceItem' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' active: type: boolean cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean PaymentScheduleInstanceItem: required: - disabled - dueDate - last - paymentScheduleInstance - requestPaymentDate type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean paymentScheduleInstance: $ref: '#/components/schemas/PaymentScheduleInstance' dueDate: type: string format: date-time requestPaymentDate: type: string format: date-time recordedInvoice: $ref: '#/components/schemas/RecordedInvoice' invoice: $ref: '#/components/schemas/Invoice' last: type: boolean paid: type: boolean active: type: boolean transient: type: boolean PaymentScheduleTemplate: required: - advancePaymentInvoiceSubCategory - advancePaymentInvoiceType - amount - calendar - code - disabled - doPayment - generateAdvancePaymentInvoice - paymentDayInMonth - paymentLabel - serviceTemplate - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean paymentLabel: type: string paymentDayInMonth: type: integer format: int32 amount: type: number calendar: $ref: '#/components/schemas/Calendar' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' advancePaymentInvoiceType: $ref: '#/components/schemas/InvoiceType' generateAdvancePaymentInvoice: type: boolean advancePaymentInvoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' doPayment: type: boolean paymentScheduleInstances: type: array items: $ref: '#/components/schemas/PaymentScheduleInstance' applyAgreement: type: boolean scriptInstance: $ref: '#/components/schemas/ScriptInstance' amountEl: maxLength: 2000 minLength: 0 type: string filterEl: maxLength: 2000 minLength: 0 type: string active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean PaymentVentilation: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' originalOT: $ref: '#/components/schemas/OtherTransaction' accountOperation: $ref: '#/components/schemas/AccountOperation' newOT: $ref: '#/components/schemas/OtherTransaction' customerAccount: $ref: '#/components/schemas/CustomerAccount' ventilationAmount: type: number ventilationDate: type: string format: date-time ventilationActionStatus: type: string enum: - V - U transient: type: boolean Permission: required: - name - permission type: object properties: id: type: integer format: int64 permission: maxLength: 255 minLength: 0 type: string name: maxLength: 255 minLength: 0 type: string transient: type: boolean PostInvoicingReportsDTO: type: object properties: invoicesNumber: type: integer format: int32 positiveInvoicesNumber: type: integer format: int32 negativeInvoicesNumber: type: integer format: int32 globalAmount: type: number positiveInvoicesAmountHT: type: number positiveInvoicesTaxAmount: type: number positiveInvoicesAmount: type: number negativeInvoicesAmountHT: type: number negativeInvoicesTaxAmount: type: number negativeInvoicesAmount: type: number emptyInvoicesNumber: type: integer format: int32 electronicInvoicesNumber: type: integer format: int32 checkInvoicesNumber: type: integer format: int32 directDebitInvoicesNumber: type: integer format: int32 tipInvoicesNumber: type: integer format: int32 wiretransferInvoicesNumber: type: integer format: int32 creditDebitCardInvoicesNumber: type: integer format: int32 npmInvoicesNumber: type: integer format: int32 checkAmuontHT: type: number directDebitAmuontHT: type: number tipAmuontHT: type: number wiretransferAmuontHT: type: number creditDebitCardAmountHT: type: number npmAmountHT: type: number checkAmuont: type: number directDebitAmuont: type: number tipAmuont: type: number wiretransferAmuont: type: number creditDebitCardAmount: type: number npmAmount: type: number PreInvoicingReportsDTO: type: object properties: billingCycleCode: type: string billingAccountNumber: type: integer format: int32 billableBillingAccountNumber: type: integer format: int32 lastTransactionDate: type: string format: date-time invoiceDate: type: string format: date-time amoutWitountTax: type: number checkBANumber: type: integer format: int32 directDebitBANumber: type: integer format: int32 tipBANumber: type: integer format: int32 wiretransferBANumber: type: integer format: int32 creditDebitCardBANumber: type: integer format: int32 checkBillableBANumber: type: integer format: int32 directDebitBillableBANumber: type: integer format: int32 tipBillableBANumber: type: integer format: int32 wiretransferBillableBANumber: type: integer format: int32 creditDebitCardBillableBANumber: type: integer format: int32 checkBillableBAAmountHT: type: number directDebitBillableBAAmountHT: type: number tipBillableBAAmountHT: type: number wiretransferBillableBAAmountHT: type: number creditDebitCardBillableBAAmountHT: type: number taxesAmount: type: number subCategoriesAmountHT: type: number PricePlanMatrix: required: - code - disabled - eventCode - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean eventCode: maxLength: 255 minLength: 1 type: string offerTemplate: $ref: '#/components/schemas/OfferTemplate' startSubscriptionDate: type: string format: date-time endSubscriptionDate: type: string format: date-time startRatingDate: type: string format: date-time endRatingDate: type: string format: date-time minQuantity: type: number maxQuantity: type: number minSubscriptionAgeInMonth: type: integer format: int64 maxSubscriptionAgeInMonth: type: integer format: int64 criteria1Value: maxLength: 255 minLength: 0 type: string criteria2Value: maxLength: 255 minLength: 0 type: string criteria3Value: maxLength: 255 minLength: 0 type: string criteriaEL: maxLength: 2000 minLength: 0 type: string criteriaELSpark: maxLength: 2000 minLength: 0 type: string amountWithoutTax: type: number amountWithTax: type: number amountWithoutTaxEL: maxLength: 2000 minLength: 0 type: string amountWithoutTaxELSpark: maxLength: 2000 minLength: 0 type: string amountWithTaxEL: maxLength: 2000 minLength: 0 type: string amountWithTaxELSpark: maxLength: 2000 minLength: 0 type: string tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' priority: type: integer format: int32 seller: $ref: '#/components/schemas/Seller' validityCalendar: $ref: '#/components/schemas/Calendar' sequence: type: integer format: int64 scriptInstance: $ref: '#/components/schemas/ScriptInstance' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination woDescriptionEL: maxLength: 2000 minLength: 0 type: string woDescriptionELSpark: maxLength: 2000 minLength: 0 type: string totalAmountEL: maxLength: 2000 minLength: 0 type: string totalAmountELSpark: maxLength: 2000 minLength: 0 type: string minimumAmountEL: maxLength: 2000 minLength: 0 type: string minimumAmountELSpark: maxLength: 2000 minLength: 0 type: string invoiceSubCategoryEL: maxLength: 2000 minLength: 0 type: string descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ProductChargeInstance: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time terminationDate: type: string format: date-time chargeTemplate: $ref: '#/components/schemas/ChargeTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' chargeDate: type: string format: date-time amountWithoutTax: type: number amountWithTax: type: number criteria1: maxLength: 255 minLength: 0 type: string criteria2: maxLength: 255 minLength: 0 type: string criteria3: maxLength: 255 minLength: 0 type: string walletOperations: type: array items: $ref: '#/components/schemas/WalletOperation' seller: $ref: '#/components/schemas/Seller' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' prDescription: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/TradingCurrency' country: $ref: '#/components/schemas/TradingCountry' walletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaidWalletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaid: type: boolean orderNumber: maxLength: 100 minLength: 0 type: string productChargeTemplate: $ref: '#/components/schemas/ProductChargeTemplate' productInstance: $ref: '#/components/schemas/ProductInstance' quantity: type: number walletOperationsSorted: type: array items: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ProductChargeTemplate: required: - code - disabled - invoiceSubCategory - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CREDIT - DEBIT amountEditable: type: boolean invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRule: $ref: '#/components/schemas/RevenueRecognitionRule' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination filterExpression: maxLength: 2000 minLength: 0 type: string productTemplates: type: array items: $ref: '#/components/schemas/ProductTemplate' chargeType: type: string descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ProductInstance: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' productTemplate: $ref: '#/components/schemas/ProductTemplate' applicationDate: type: string format: date-time productChargeInstances: type: array items: $ref: '#/components/schemas/ProductChargeInstance' quantity: type: number orderNumber: maxLength: 100 minLength: 0 type: string seller: $ref: '#/components/schemas/Seller' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ProductOffering: type: object properties: id: type: string version: type: string href: type: string name: type: string description: type: string lastUpdate: type: string format: date-time lifecycleStatus: type: string enum: - In Study - In Design - In Test - Active - Launched - Retired - Obsolete - Rejected validFor: $ref: '#/components/schemas/TimeRange' isBundle: type: boolean category: type: array items: $ref: '#/components/schemas/CatalogReference' channel: type: array items: $ref: '#/components/schemas/Channel' place: type: array items: $ref: '#/components/schemas/Place' bundledProductOffering: type: array items: $ref: '#/components/schemas/BundledProductReference' serviceLevelAgreement: $ref: '#/components/schemas/ServiceLevelAgreement' productSpecification: $ref: '#/components/schemas/CatalogReference' serviceCandidate: $ref: '#/components/schemas/CatalogReference' resourceCandidate: $ref: '#/components/schemas/CatalogReference' productOfferingTerm: type: array items: $ref: '#/components/schemas/ProductOfferingTerm' productOfferingPrice: type: array items: $ref: '#/components/schemas/ProductOfferingPrice' xml: name: ProductOffering namespace: http://www.tmforum.org ProductTemplate: required: - code - disabled - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean name: maxLength: 100 minLength: 0 type: string offerTemplateCategories: type: array items: $ref: '#/components/schemas/OfferTemplateCategory' validity: $ref: '#/components/schemas/DatePeriod' imagePath: maxLength: 100 minLength: 0 type: string attachments: type: array items: $ref: '#/components/schemas/DigitalResource' lifeCycleStatus: type: string enum: - IN_STUDY - IN_DESIGN - IN_TEST - ACTIVE - LAUNCHED - RETIRED - OBSOLETE - REJECTED businessAccountModels: type: array items: $ref: '#/components/schemas/BusinessAccountModel' channels: type: array items: $ref: '#/components/schemas/Channel' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination longDescription: maxLength: 2000 minLength: 0 type: string longDescriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination globalRatingScriptInstance: $ref: '#/components/schemas/ScriptInstance' sellers: type: array items: $ref: '#/components/schemas/Seller' customerCategories: type: array items: $ref: '#/components/schemas/CustomerCategory' productChargeTemplates: type: array items: $ref: '#/components/schemas/ProductChargeTemplate' businessProductModel: $ref: '#/components/schemas/BusinessProductModel' invoicingCalendar: $ref: '#/components/schemas/Calendar' walletTemplates: type: array items: $ref: '#/components/schemas/WalletTemplate' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination nameOrCode: type: string longDescriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ProviderContact: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean firstName: maxLength: 50 minLength: 0 type: string lastName: maxLength: 50 minLength: 0 type: string email: maxLength: 100 minLength: 0 type: string phone: maxLength: 50 minLength: 0 type: string mobile: maxLength: 50 minLength: 0 type: string fax: maxLength: 50 minLength: 0 type: string genericMail: maxLength: 100 minLength: 0 type: string address: $ref: '#/components/schemas/Address' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Quote: required: - code - quoteDate - status - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' externalId: maxLength: 100 minLength: 0 type: string quoteVersion: maxLength: 10 minLength: 0 type: string notificationContact: maxLength: 100 minLength: 0 type: string quoteDate: type: string format: date-time validity: $ref: '#/components/schemas/DatePeriod' requestedCompletionDate: type: string format: date-time fulfillmentStartDate: type: string format: date-time completionDate: type: string format: date-time category: type: string status: type: string enum: - IN_PROGRESS - PENDING - CANCELLED - APPROVED - ACCEPTED - REJECTED statusMessage: type: string quoteItems: type: array items: $ref: '#/components/schemas/QuoteItem' routedToUserGroup: $ref: '#/components/schemas/UserHierarchyLevel' receivedFromApp: type: string userAccount: $ref: '#/components/schemas/UserAccount' invoices: type: array items: $ref: '#/components/schemas/Invoice' order: $ref: '#/components/schemas/Order' generatePdf: type: boolean userAccounts: uniqueItems: true type: array items: $ref: '#/components/schemas/UserAccount' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean QuoteItem: required: - itemId - quote - status - userAccount type: object properties: id: type: integer format: int64 version: type: integer format: int32 quote: $ref: '#/components/schemas/Quote' itemId: type: string quoteItemProductOfferings: type: array items: $ref: '#/components/schemas/QuoteItemProductOffering' source: type: string status: type: string enum: - IN_PROGRESS - PENDING - CANCELLED - APPROVED - ACCEPTED - REJECTED userAccount: $ref: '#/components/schemas/UserAccount' quoteItemDto: type: object mainOffering: $ref: '#/components/schemas/ProductOffering' transient: type: boolean QuoteItemProductOffering: required: - itemOrder - productOffering - quoteItem type: object properties: id: type: object quoteItem: $ref: '#/components/schemas/QuoteItem' productOffering: $ref: '#/components/schemas/ProductOffering' itemOrder: type: integer format: int32 transient: type: boolean RatedTransaction: required: - billingAccount - seller type: object properties: id: type: integer format: int64 version: type: integer format: int32 wallet: $ref: '#/components/schemas/WalletInstance' billingAccount: $ref: '#/components/schemas/BillingAccount' userAccount: $ref: '#/components/schemas/UserAccount' seller: $ref: '#/components/schemas/Seller' billingRun: $ref: '#/components/schemas/BillingRun' usageDate: type: string format: date-time invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' code: maxLength: 255 minLength: 0 type: string description: type: string unityDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitAmountWithoutTax: type: number unitAmountWithTax: type: number unitAmountTax: type: number quantity: type: number amountWithoutTax: type: number amountWithTax: type: number amountTax: type: number invoice: $ref: '#/components/schemas/Invoice' invoiceAgregateF: $ref: '#/components/schemas/SubCategoryInvoiceAgregate' invoiceAgregateR: $ref: '#/components/schemas/CategoryInvoiceAgregate' invoiceAgregateT: $ref: '#/components/schemas/TaxInvoiceAgregate' status: type: string enum: - OPEN - BILLED - REJECTED - RERATED - CANCELED doNotTriggerInvoicing: type: boolean parameter1: maxLength: 255 minLength: 0 type: string parameter2: maxLength: 255 minLength: 0 type: string parameter3: maxLength: 255 minLength: 0 type: string startDate: type: string format: date-time endDate: type: string format: date-time parameterExtra: type: string orderNumber: maxLength: 100 minLength: 0 type: string priceplan: $ref: '#/components/schemas/PricePlanMatrix' edr: $ref: '#/components/schemas/EDR' adjustedRatedTx: $ref: '#/components/schemas/RatedTransaction' subscription: $ref: '#/components/schemas/Subscription' chargeInstance: $ref: '#/components/schemas/ChargeInstance' tax: $ref: '#/components/schemas/Tax' taxPercent: type: number walletOperations: uniqueItems: true type: array items: $ref: '#/components/schemas/WalletOperation' offerTemplate: $ref: '#/components/schemas/OfferTemplate' walletOperationId: type: integer format: int64 transient: type: boolean RecordedInvoice: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' productionDate: type: string format: date-time invoiceDate: type: string format: date-time netToPay: type: number recordedInvoiceCatAgregates: type: array items: $ref: '#/components/schemas/RecordedInvoiceCatAgregate' paymentScheduleInstanceItem: $ref: '#/components/schemas/PaymentScheduleInstanceItem' dunningDocument: $ref: '#/components/schemas/DunningDocument' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean RecordedInvoiceCatAgregate: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' productionDate: type: string format: date-time invoiceDate: type: string format: date-time netToPay: type: number paymentScheduleInstanceItem: $ref: '#/components/schemas/PaymentScheduleInstanceItem' dunningDocument: $ref: '#/components/schemas/DunningDocument' recordedInvoice: $ref: '#/components/schemas/RecordedInvoice' categoryInvoiceAgregate: $ref: '#/components/schemas/CategoryInvoiceAgregate' subCategoryInvoiceAgregate: $ref: '#/components/schemas/SubCategoryInvoiceAgregate' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean RecurringChargeInstance: required: - code - quantity type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time terminationDate: type: string format: date-time chargeTemplate: $ref: '#/components/schemas/ChargeTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' chargeDate: type: string format: date-time amountWithoutTax: type: number amountWithTax: type: number criteria1: maxLength: 255 minLength: 0 type: string criteria2: maxLength: 255 minLength: 0 type: string criteria3: maxLength: 255 minLength: 0 type: string walletOperations: type: array items: $ref: '#/components/schemas/WalletOperation' seller: $ref: '#/components/schemas/Seller' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' prDescription: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/TradingCurrency' country: $ref: '#/components/schemas/TradingCountry' walletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaidWalletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaid: type: boolean orderNumber: maxLength: 100 minLength: 0 type: string recurringChargeTemplate: $ref: '#/components/schemas/RecurringChargeTemplate' serviceInstance: $ref: '#/components/schemas/ServiceInstance' subscriptionDate: type: string format: date-time nextChargeDate: type: string format: date-time counter: $ref: '#/components/schemas/CounterInstance' quantity: type: number walletOperationsSorted: type: array items: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean RecurringChargeTemplate: required: - code - disabled - invoiceSubCategory - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CREDIT - DEBIT amountEditable: type: boolean invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' edrTemplates: type: array items: $ref: '#/components/schemas/TriggeredEDRTemplate' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRule: $ref: '#/components/schemas/RevenueRecognitionRule' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination recurrenceType: type: string enum: - CALENDAR - PERIOD calendar: $ref: '#/components/schemas/Calendar' durationTermInMonth: type: integer format: int32 subscriptionProrata: type: boolean terminationProrata: type: boolean applyInAdvance: type: boolean shareLevel: type: string enum: - PROVIDER - SELLER - CUSTOMER - CUSTOMER_ACCOUNT - BILLING_ACCOUNT - USER_ACCOUNT filterExpression: maxLength: 2000 minLength: 0 type: string subscriptionProrataEl: maxLength: 2000 minLength: 0 type: string terminationProrataEl: maxLength: 2000 minLength: 0 type: string applyInAdvanceEl: maxLength: 2000 minLength: 0 type: string durationTermInMonthEl: maxLength: 2000 minLength: 0 type: string calendarCodeEl: maxLength: 2000 minLength: 0 type: string chargeType: type: string descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean RejectedBillingAccount: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' billingRun: $ref: '#/components/schemas/BillingRun' rejectCause: maxLength: 3000 minLength: 0 type: string transient: type: boolean RejectedPayment: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' dueDate: type: string format: date-time type: maxLength: 31 minLength: 0 type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT reference: maxLength: 255 minLength: 0 type: string accountingCode: $ref: '#/components/schemas/AccountingCode' accountCodeClientSide: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number taxAmount: type: number matchingAmount: type: number unMatchingAmount: type: number customerAccount: $ref: '#/components/schemas/CustomerAccount' matchingStatus: type: string enum: - O - L - P - C - I - R occCode: maxLength: 255 minLength: 0 type: string occDescription: maxLength: 255 minLength: 0 type: string orderNumber: type: string uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' bankLot: type: string bankReference: maxLength: 255 minLength: 0 type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD code: type: string description: type: string paymentInfo: maxLength: 255 minLength: 0 type: string paymentInfo1: maxLength: 255 minLength: 0 type: string paymentInfo2: maxLength: 255 minLength: 0 type: string paymentInfo3: maxLength: 255 minLength: 0 type: string paymentInfo4: maxLength: 255 minLength: 0 type: string paymentInfo5: maxLength: 255 minLength: 0 type: string paymentInfo6: maxLength: 255 minLength: 0 type: string billingAccountName: maxLength: 255 minLength: 0 type: string ddRequestItem: $ref: '#/components/schemas/DDRequestItem' rejectedPayment: $ref: '#/components/schemas/RejectedPayment' seller: $ref: '#/components/schemas/Seller' paymentVentilation: $ref: '#/components/schemas/PaymentVentilation' subscription: $ref: '#/components/schemas/Subscription' rejectedType: type: string enum: - A - M rejectedDate: type: string format: date-time rejectedDescription: maxLength: 255 minLength: 0 type: string rejectedCode: maxLength: 255 minLength: 0 type: string listAaccountOperationSupposedPaid: type: array items: $ref: '#/components/schemas/AccountOperation' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean RevenueRecognitionRule: required: - code - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean script: $ref: '#/components/schemas/ScriptInstance' startDelay: type: integer format: int32 startUnit: type: string enum: - revenueRecognitionDelayUnitEnum.MONTH - revenueRecognitionDelayUnitEnum.DAY startEvent: type: string enum: - revenueRecognitionEvent.SUBSCRIPTION_START - revenueRecognitionEvent.SUBSCRIPTION_STOP - revenueRecognitionEvent.INVOICE_DATE - revenueRecognitionEvent.INVOICE_DUE_DATE - revenueRecognitionEvent.SERVICE_PERIOD_START - revenueRecognitionEvent.SERVICE_PERIOD_STOP stopDelay: type: integer format: int32 stopUnit: type: string enum: - revenueRecognitionDelayUnitEnum.MONTH - revenueRecognitionDelayUnitEnum.DAY stopEvent: type: string enum: - revenueRecognitionEvent.SUBSCRIPTION_START - revenueRecognitionEvent.SUBSCRIPTION_STOP - revenueRecognitionEvent.INVOICE_DATE - revenueRecognitionEvent.INVOICE_DUE_DATE - revenueRecognitionEvent.SERVICE_PERIOD_START - revenueRecognitionEvent.SERVICE_PERIOD_STOP active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Role: required: - description - name type: object properties: id: type: integer format: int64 version: type: integer format: int32 name: maxLength: 255 minLength: 0 type: string description: maxLength: 255 minLength: 0 type: string permissions: uniqueItems: true type: array items: $ref: '#/components/schemas/Permission' roles: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' securedEntities: type: array items: $ref: '#/components/schemas/SecuredEntity' descriptionOrName: type: string allPermissions: uniqueItems: true type: array items: $ref: '#/components/schemas/Permission' transient: type: boolean ScriptInstance: required: - code - disabled - script type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean script: type: string sourceTypeEnum: type: string enum: - scriptSourceTypeEnum.JAVA scriptErrors: type: array items: $ref: '#/components/schemas/ScriptInstanceError' error: type: boolean reuse: type: boolean scriptInstanceCategory: $ref: '#/components/schemas/ScriptInstanceCategory' executionRoles: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' sourcingRoles: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ScriptInstanceCategory: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ScriptInstanceError: type: object properties: message: type: string lineNumber: type: integer format: int64 columnNumber: type: integer format: int64 sourceFile: type: string SecuredEntity: required: - code type: object properties: code: maxLength: 255 minLength: 1 type: string entityClass: maxLength: 255 minLength: 0 type: string Seller: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' address: $ref: '#/components/schemas/Address' contactInformation: $ref: '#/components/schemas/ContactInformation' vatNo: maxLength: 100 minLength: 0 type: string registrationNo: maxLength: 100 minLength: 0 type: string legalText: maxLength: 2000 minLength: 0 type: string legalType: maxLength: 100 minLength: 0 type: string seller: $ref: '#/components/schemas/Seller' invoiceTypeSequence: type: array items: $ref: '#/components/schemas/InvoiceTypeSellerSequence' businessAccountModel: $ref: '#/components/schemas/BusinessAccountModel' customerSequences: type: array items: $ref: '#/components/schemas/CustomerSequence' paymentGateways: type: array items: $ref: '#/components/schemas/PaymentGateway' generalLedger: $ref: '#/components/schemas/GeneralLedger' parentEntity: $ref: '#/components/schemas/BusinessEntity' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ServiceChargeTemplateRecurring: type: object properties: id: type: integer format: int64 version: type: integer format: int32 serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' chargeTemplate: $ref: '#/components/schemas/RecurringChargeTemplate' counterTemplate: $ref: '#/components/schemas/CounterTemplate' walletTemplates: type: array items: $ref: '#/components/schemas/WalletTemplate' transient: type: boolean ServiceChargeTemplateSubscription: type: object properties: id: type: integer format: int64 version: type: integer format: int32 serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' chargeTemplate: $ref: '#/components/schemas/OneShotChargeTemplate' counterTemplate: $ref: '#/components/schemas/CounterTemplate' walletTemplates: type: array items: $ref: '#/components/schemas/WalletTemplate' transient: type: boolean ServiceChargeTemplateTermination: type: object properties: id: type: integer format: int64 version: type: integer format: int32 serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' chargeTemplate: $ref: '#/components/schemas/OneShotChargeTemplate' counterTemplate: $ref: '#/components/schemas/CounterTemplate' walletTemplates: type: array items: $ref: '#/components/schemas/WalletTemplate' transient: type: boolean ServiceChargeTemplateUsage: type: object properties: id: type: integer format: int64 version: type: integer format: int32 serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' chargeTemplate: $ref: '#/components/schemas/UsageChargeTemplate' counterTemplate: $ref: '#/components/schemas/CounterTemplate' walletTemplates: type: array items: $ref: '#/components/schemas/WalletTemplate' transient: type: boolean ServiceInstance: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' subscription: $ref: '#/components/schemas/Subscription' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time endAgreementDate: type: string format: date-time autoEndOfEngagement: type: boolean recurringChargeInstances: type: array items: $ref: '#/components/schemas/RecurringChargeInstance' subscriptionChargeInstances: type: array items: $ref: '#/components/schemas/OneShotChargeInstance' terminationChargeInstances: type: array items: $ref: '#/components/schemas/OneShotChargeInstance' usageChargeInstances: type: array items: $ref: '#/components/schemas/UsageChargeInstance' subscriptionTerminationReason: $ref: '#/components/schemas/SubscriptionTerminationReason' quantity: type: number previousQuantity: type: number orderNumber: maxLength: 100 minLength: 0 type: string rateUntilDate: type: string format: date-time minimumAmountEl: maxLength: 2000 minLength: 0 type: string minimumLabelEl: maxLength: 2000 minLength: 0 type: string minimumAmountElSpark: maxLength: 2000 minLength: 0 type: string minimumLabelElSpark: maxLength: 2000 minLength: 0 type: string orderHistories: type: array items: $ref: '#/components/schemas/OrderHistory' serviceRenewal: $ref: '#/components/schemas/SubscriptionRenewal' amountPS: type: number calendarPS: $ref: '#/components/schemas/Calendar' psInstances: type: array items: $ref: '#/components/schemas/PaymentScheduleInstance' paymentDayInMonthPS: type: integer format: int32 subscribedTillDate: type: string format: date-time renewed: type: boolean notifyOfRenewalDate: type: string format: date-time renewalNotifiedDate: type: string format: date-time orderItemId: type: integer format: int64 orderItemAction: type: string enum: - ADD - MODIFY - DELETE initialServiceRenewal: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' fireRenewalNotice: type: boolean subscriptionExpired: type: boolean descriptionAndStatus: type: string quantityChanged: type: boolean cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean ServiceTemplate: required: - code - disabled - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean serviceRecurringCharges: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateRecurring' serviceSubscriptionCharges: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateSubscription' serviceTerminationCharges: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateTermination' serviceUsageCharges: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateUsage' invoicingCalendar: $ref: '#/components/schemas/Calendar' businessServiceModel: $ref: '#/components/schemas/BusinessServiceModel' longDescription: maxLength: 2000 minLength: 0 type: string imagePath: maxLength: 100 minLength: 0 type: string minimumAmountEl: maxLength: 2000 minLength: 0 type: string minimumAmountElSpark: maxLength: 2000 minLength: 0 type: string minimumLabelEl: maxLength: 2000 minLength: 0 type: string minimumLabelElSpark: maxLength: 2000 minLength: 0 type: string serviceRenewal: $ref: '#/components/schemas/SubscriptionRenewal' selected: type: boolean autoEndOfEngagement: type: boolean instantiatedFromBSM: type: boolean descriptionOverride: type: string active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean SubCategoryInvoiceAgregate: required: - discountAggregate type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' invoice: $ref: '#/components/schemas/Invoice' billingRun: $ref: '#/components/schemas/BillingRun' itemNumber: type: integer format: int32 description: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' prDescription: maxLength: 255 minLength: 0 type: string invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' categoryInvoiceAgregate: $ref: '#/components/schemas/CategoryInvoiceAgregate' userAccount: $ref: '#/components/schemas/UserAccount' wallet: $ref: '#/components/schemas/WalletInstance' accountingCode: $ref: '#/components/schemas/AccountingCode' ratedtransactions: type: array items: $ref: '#/components/schemas/RatedTransaction' discountPlanCode: maxLength: 50 minLength: 0 type: string discountPlanItemCode: maxLength: 50 minLength: 0 type: string discountPlanItem: $ref: '#/components/schemas/DiscountPlanItem' subCategoryTaxesTransient: uniqueItems: true type: array items: $ref: '#/components/schemas/Tax' discountPercent: type: number tax: $ref: '#/components/schemas/Tax' taxPercent: type: number quantity: type: number discount: type: number discountAggregate: type: boolean oldAmountWithoutTax: type: number oldAmountWithTax: type: number transient: type: boolean Subscription: required: - code - userAccount - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' offer: $ref: '#/components/schemas/OfferTemplate' status: type: string enum: - CREATED - ACTIVE - CANCELED - RESILIATED - CLOSED - SUSPENDED statusDate: type: string format: date-time subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time subscribedTillDate: type: string format: date-time serviceInstances: type: array items: $ref: '#/components/schemas/ServiceInstance' productInstances: type: array items: $ref: '#/components/schemas/ProductInstance' accessPoints: type: array items: $ref: '#/components/schemas/Access' edrs: type: array items: $ref: '#/components/schemas/EDR' userAccount: $ref: '#/components/schemas/UserAccount' accountOperations: type: array items: $ref: '#/components/schemas/AccountOperation' endAgreementDate: type: string format: date-time subscriptionTerminationReason: $ref: '#/components/schemas/SubscriptionTerminationReason' defaultLevel: type: boolean autoEndOfEngagement: type: boolean subscriptionRenewal: $ref: '#/components/schemas/SubscriptionRenewal' renewed: type: boolean notifyOfRenewalDate: type: string format: date-time renewalNotifiedDate: type: string format: date-time minimumAmountEl: maxLength: 2000 minLength: 0 type: string minimumLabelEl: maxLength: 2000 minLength: 0 type: string minimumAmountElSpark: maxLength: 2000 minLength: 0 type: string minimumLabelElSpark: maxLength: 2000 minLength: 0 type: string billingCycle: $ref: '#/components/schemas/BillingCycle' billingRun: $ref: '#/components/schemas/BillingRun' seller: $ref: '#/components/schemas/Seller' ratingGroup: type: string discountPlanInstances: type: array items: $ref: '#/components/schemas/DiscountPlanInstance' discountPlan: $ref: '#/components/schemas/DiscountPlan' emailTemplate: $ref: '#/components/schemas/EmailTemplate' mailingType: type: string enum: - MANUAL - AUTO - BATCH ccedEmails: maxLength: 2000 minLength: 0 type: string email: maxLength: 255 minLength: 0 type: string electronicBilling: type: boolean minRatedTransactions: type: array items: $ref: '#/components/schemas/RatedTransaction' totalInvoicingAmountWithoutTax: type: number totalInvoicingAmountWithTax: type: number totalInvoicingAmountTax: type: number initialSubscriptionRenewal: type: string active: type: boolean orderNumber: type: string allDiscountPlanInstances: type: array items: $ref: '#/components/schemas/DiscountPlanInstance' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' anyServiceActive: type: boolean fireRenewalNotice: type: boolean subscriptionExpired: type: boolean transient: type: boolean cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string SubscriptionRenewal: type: object properties: autoRenew: type: boolean autoRenewDate: type: string format: date-time daysNotifyRenewal: type: integer format: int32 endOfTermAction: type: string enum: - SUSPEND - TERMINATE id: type: integer format: int64 version: type: integer format: int32 historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string applyAgreement: type: boolean applyReimbursment: type: boolean applyTerminationCharges: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean initialyActiveForUnit: type: string enum: - MONTH - DAY initialyActiveFor: type: integer format: int32 extendAgreementPeriodToSubscribedTillDate: type: boolean renewForUnit: type: string enum: - MONTH - DAY renewFor: type: integer format: int32 initialTermType: type: string enum: - RECURRING - FIXED SubscriptionTerminationReason: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string applyAgreement: type: boolean applyReimbursment: type: boolean applyTerminationCharges: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean Tax: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' accountingCode: $ref: '#/components/schemas/AccountingCode' percent: type: number descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination idOrCode: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean TaxInvoiceAgregate: type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' billingAccount: $ref: '#/components/schemas/BillingAccount' invoice: $ref: '#/components/schemas/Invoice' billingRun: $ref: '#/components/schemas/BillingRun' itemNumber: type: integer format: int32 description: maxLength: 255 minLength: 0 type: string amount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number tradingCurrency: $ref: '#/components/schemas/TradingCurrency' tradingCountry: $ref: '#/components/schemas/TradingCountry' tradingLanguage: $ref: '#/components/schemas/TradingLanguage' prDescription: maxLength: 255 minLength: 0 type: string tax: $ref: '#/components/schemas/Tax' taxPercent: type: number accountingCode: $ref: '#/components/schemas/AccountingCode' transient: type: boolean Title: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean isCompany: type: boolean descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination descriptionNotNull: type: string codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean TradingCountry: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean invoiceSubcategoryCountries: type: array items: $ref: '#/components/schemas/InvoiceSubcategoryCountry' country: $ref: '#/components/schemas/Country' prDescription: maxLength: 255 minLength: 0 type: string countryCode: type: string active: type: boolean transient: type: boolean TradingCurrency: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean currency: $ref: '#/components/schemas/Currency' prDescription: maxLength: 255 minLength: 0 type: string prCurrencyToThis: type: number currencyCode: type: string active: type: boolean transient: type: boolean TradingLanguage: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean language: $ref: '#/components/schemas/Language' prDescription: maxLength: 255 minLength: 0 type: string languageCode: type: string active: type: boolean transient: type: boolean TriggeredEDRTemplate: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean subscriptionEl: maxLength: 2000 minLength: 0 type: string subscriptionElSpark: maxLength: 2000 minLength: 0 type: string meveoInstance: $ref: '#/components/schemas/MeveoInstance' conditionEl: maxLength: 2000 minLength: 0 type: string conditionElSpark: maxLength: 2000 minLength: 0 type: string quantityEl: maxLength: 2000 minLength: 0 type: string quantityElSpark: maxLength: 2000 minLength: 0 type: string param1El: maxLength: 2000 minLength: 0 type: string param1ElSpark: maxLength: 2000 minLength: 0 type: string param2El: maxLength: 2000 minLength: 0 type: string param2ElSpark: maxLength: 2000 minLength: 0 type: string param3El: maxLength: 2000 minLength: 0 type: string param3ElSpark: maxLength: 2000 minLength: 0 type: string param4El: maxLength: 2000 minLength: 0 type: string param4ElSpark: maxLength: 2000 minLength: 0 type: string opencellInstanceEL: maxLength: 2000 minLength: 0 type: string triggeredEdrScript: $ref: '#/components/schemas/ScriptInstance' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean UsageChargeInstance: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED statusDate: type: string format: date-time terminationDate: type: string format: date-time chargeTemplate: $ref: '#/components/schemas/ChargeTemplate' invoicingCalendar: $ref: '#/components/schemas/Calendar' chargeDate: type: string format: date-time amountWithoutTax: type: number amountWithTax: type: number criteria1: maxLength: 255 minLength: 0 type: string criteria2: maxLength: 255 minLength: 0 type: string criteria3: maxLength: 255 minLength: 0 type: string walletOperations: type: array items: $ref: '#/components/schemas/WalletOperation' seller: $ref: '#/components/schemas/Seller' userAccount: $ref: '#/components/schemas/UserAccount' subscription: $ref: '#/components/schemas/Subscription' prDescription: maxLength: 255 minLength: 0 type: string currency: $ref: '#/components/schemas/TradingCurrency' country: $ref: '#/components/schemas/TradingCountry' walletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaidWalletInstances: type: array items: $ref: '#/components/schemas/WalletInstance' prepaid: type: boolean orderNumber: maxLength: 100 minLength: 0 type: string serviceInstance: $ref: '#/components/schemas/ServiceInstance' counter: $ref: '#/components/schemas/CounterInstance' ratingUnitDescription: maxLength: 20 minLength: 0 type: string lastUpdate: type: string format: date-time priority: type: integer format: int32 walletOperationsSorted: type: array items: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean UsageChargeTemplate: required: - code - disabled - invoiceSubCategory - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' disabled: type: boolean type: type: string enum: - CREDIT - DEBIT amountEditable: type: boolean invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRule: $ref: '#/components/schemas/RevenueRecognitionRule' descriptionI18n: type: object additionalProperties: type: string xml: name: discountPlanForTermination filterParam1: maxLength: 255 minLength: 0 type: string filterParam2: maxLength: 255 minLength: 0 type: string filterParam3: maxLength: 255 minLength: 0 type: string filterParam4: maxLength: 255 minLength: 0 type: string filterExpression: maxLength: 2000 minLength: 0 type: string filterExpressionSpark: maxLength: 2000 minLength: 0 type: string priority: type: integer format: int32 triggerNextCharge: type: boolean triggerNextChargeEL: maxLength: 2000 minLength: 0 type: string chargeType: type: string priorityChanged: type: boolean descriptionI18nNullSafe: type: object additionalProperties: type: string xml: name: discountPlanForTermination active: type: boolean parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean User: required: - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' name: $ref: '#/components/schemas/Name' userName: maxLength: 50 minLength: 0 type: string addressbook: $ref: '#/components/schemas/AddressBook' email: maxLength: 100 minLength: 0 type: string roles: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' userLevel: $ref: '#/components/schemas/UserHierarchyLevel' securedEntities: type: array items: $ref: '#/components/schemas/SecuredEntity' uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' securedEntitiesMap: type: object additionalProperties: uniqueItems: true type: array items: $ref: '#/components/schemas/SecuredEntity' lastLoginDate: type: string format: date-time code: type: string description: type: string rolesLabel: type: string nameOrUsername: type: string referenceCode: type: string parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' referenceDescription: type: string cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' transient: type: boolean UserAccount: required: - code - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean uuid: maxLength: 60 minLength: 0 type: string cfValues: $ref: '#/components/schemas/CustomFieldValues' cfAccumulatedValues: $ref: '#/components/schemas/CustomFieldValues' externalRef1: maxLength: 255 minLength: 0 type: string externalRef2: maxLength: 255 minLength: 0 type: string name: $ref: '#/components/schemas/Name' address: $ref: '#/components/schemas/Address' defaultLevel: type: boolean providerContact: maxLength: 255 minLength: 0 type: string primaryContact: $ref: '#/components/schemas/ProviderContact' accountType: maxLength: 10 minLength: 0 type: string businessAccountModel: $ref: '#/components/schemas/BusinessAccountModel' jobTitle: type: string contactInformation: $ref: '#/components/schemas/ContactInformation' vatNo: type: string registrationNo: type: string status: type: string enum: - ACTIVE - CANCELED - TERMINATED - CLOSED statusDate: type: string format: date-time subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time billingAccount: $ref: '#/components/schemas/BillingAccount' subscriptions: type: array items: $ref: '#/components/schemas/Subscription' wallet: $ref: '#/components/schemas/WalletInstance' prepaidWallets: type: object additionalProperties: $ref: '#/components/schemas/WalletInstance' counters: type: object additionalProperties: $ref: '#/components/schemas/CounterInstance' terminationReason: $ref: '#/components/schemas/SubscriptionTerminationReason' parentEntity: $ref: '#/components/schemas/BusinessEntity' parentCFEntities: type: array items: $ref: '#/components/schemas/ICustomFieldEntity' contactInformationNullSafe: $ref: '#/components/schemas/ContactInformation' cfValuesAsValues: type: object additionalProperties: type: object cfAccumulatedValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' cfValuesNullSafe: $ref: '#/components/schemas/CustomFieldValues' codeChanged: type: boolean descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean UserHierarchyLevel: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean parentLevel: $ref: '#/components/schemas/HierarchyLevel' childLevels: uniqueItems: true type: array items: $ref: '#/components/schemas/HierarchyLevel' hierarchyType: maxLength: 10 minLength: 0 type: string orderLevel: type: integer format: int64 users: uniqueItems: true type: array items: $ref: '#/components/schemas/User' parentEntity: $ref: '#/components/schemas/BusinessEntity' codeChanged: type: boolean descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean WFAction: required: - actionEl - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 uuid: maxLength: 60 minLength: 0 type: string actionEl: maxLength: 2000 minLength: 0 type: string priority: type: integer format: int32 conditionEl: maxLength: 2000 minLength: 0 type: string wfTransition: $ref: '#/components/schemas/WFTransition' userGroupCode: type: string transient: type: boolean WFDecisionRule: required: - conditionEl - name - type - value type: object properties: id: type: integer format: int64 version: type: integer format: int32 name: maxLength: 255 minLength: 0 type: string value: maxLength: 255 minLength: 0 type: string type: type: string enum: - STRING - DATE - NUMBER - RANGE_STRING - RANGE_DATE - RANGE_NUMBER conditionEl: maxLength: 2000 minLength: 0 type: string model: type: boolean wfTransitions: uniqueItems: true type: array items: $ref: '#/components/schemas/WFTransition' transient: type: boolean WFTransition: required: - description - uuid type: object properties: id: type: integer format: int64 version: type: integer format: int32 uuid: maxLength: 60 minLength: 0 type: string fromStatus: type: string toStatus: type: string priority: type: integer format: int32 description: maxLength: 255 minLength: 0 type: string workflow: $ref: '#/components/schemas/Workflow' wfDecisionRules: uniqueItems: true type: array items: $ref: '#/components/schemas/WFDecisionRule' wfActions: type: array items: $ref: '#/components/schemas/WFAction' conditionEl: maxLength: 2000 minLength: 0 type: string combinedEl: type: string transient: type: boolean WalletInstance: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean walletTemplate: $ref: '#/components/schemas/WalletTemplate' userAccount: $ref: '#/components/schemas/UserAccount' creditExpiryDate: type: string format: date-time nextMatchingDate: type: string format: date-time lowBalanceLevel: type: number rejectLevel: type: number operations: type: array items: $ref: '#/components/schemas/WalletOperation' ratedTransactions: type: array items: $ref: '#/components/schemas/RatedTransaction' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean WalletOperation: required: - chargeInstance - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean wallet: $ref: '#/components/schemas/WalletInstance' operationDate: type: string format: date-time invoicingDate: type: string format: date-time type: type: string enum: - CREDIT - DEBIT chargeInstance: $ref: '#/components/schemas/ChargeInstance' currency: $ref: '#/components/schemas/Currency' tax: $ref: '#/components/schemas/Tax' taxPercent: type: number unitAmountWithoutTax: type: number unitAmountWithTax: type: number unitAmountTax: type: number quantity: type: number amountWithoutTax: type: number amountWithTax: type: number amountTax: type: number counter: $ref: '#/components/schemas/CounterInstance' aggregatedServiceInstance: $ref: '#/components/schemas/ServiceInstance' parameter1: maxLength: 255 minLength: 0 type: string parameter2: maxLength: 255 minLength: 0 type: string parameter3: maxLength: 255 minLength: 0 type: string parameterExtra: type: string startDate: type: string format: date-time endDate: type: string format: date-time subscriptionDate: type: string format: date-time offerCode: maxLength: 255 minLength: 1 type: string status: type: string enum: - OPEN - TREATED - CANCELED - RESERVED - TO_RERATE - RERATED - SCHEDULED seller: $ref: '#/components/schemas/Seller' priceplan: $ref: '#/components/schemas/PricePlanMatrix' reratedWalletOperation: $ref: '#/components/schemas/WalletOperation' inputUnitDescription: maxLength: 20 minLength: 0 type: string ratingUnitDescription: maxLength: 20 minLength: 0 type: string inputQuantity: type: number edr: $ref: '#/components/schemas/EDR' orderNumber: maxLength: 100 minLength: 0 type: string rawAmountWithoutTax: type: number rawAmountWithTax: type: number invoiceSubCategory: $ref: '#/components/schemas/InvoiceSubCategory' subscription: $ref: '#/components/schemas/Subscription' ratedTransaction: $ref: '#/components/schemas/RatedTransaction' serviceInstance: $ref: '#/components/schemas/ServiceInstance' billingAccount: $ref: '#/components/schemas/BillingAccount' billingRun: $ref: '#/components/schemas/BillingRun' offerTemplate: $ref: '#/components/schemas/OfferTemplate' unratedClone: $ref: '#/components/schemas/WalletOperation' codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean WalletTemplate: required: - code type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean walletType: type: string enum: - POSTPAID - PREPAID consumptionAlertSet: type: boolean fastRatingLevel: type: integer format: int32 lowBalanceLevel: type: number rejectLevel: type: number codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean WirePaymentMethod: required: - disabled type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' disabled: type: boolean alias: type: string preferred: type: boolean customerAccount: $ref: '#/components/schemas/CustomerAccount' paymentType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD userId: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string tokenId: type: string expired: type: boolean active: type: boolean transient: type: boolean Workflow: required: - code - disabled - wfType type: object properties: id: type: integer format: int64 version: type: integer format: int32 auditable: $ref: '#/components/schemas/Auditable' historized: type: boolean notified: type: boolean auditableFields: uniqueItems: true type: array items: $ref: '#/components/schemas/AuditableFieldHistory' code: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: string appendGeneratedCode: type: boolean disabled: type: boolean wfType: maxLength: 255 minLength: 0 type: string transitions: type: array items: $ref: '#/components/schemas/WFTransition' enableHistory: type: boolean active: type: boolean codeChanged: type: boolean parentEntity: $ref: '#/components/schemas/BusinessEntity' descriptionOrCode: type: string descriptionAndCode: type: string referenceCode: type: string referenceDescription: type: string transient: type: boolean GetBillingAccountListInRunResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' billingAccountsDto: $ref: '#/components/schemas/BillingAccountsDto' xml: name: GetBillingAccountListInRunResponse GetPreInvoicingReportsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' preInvoicingReportsDTO: $ref: '#/components/schemas/PreInvoicingReportsDTO' xml: name: GetPreInvoicingReportsResponse GetPostInvoicingReportsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' postInvoicingReportsDTO: $ref: '#/components/schemas/PostInvoicingReportsDTO' xml: name: GetPostInvoicingReportsResponse PrepaidReservationDto: type: object properties: reservationId: type: integer format: int64 xml: attribute: true consumedQuantity: type: number CdrListDto: type: object properties: cdr: type: array items: type: string ipAddress: type: string xml: name: CdrList CdrReservationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' availableQuantity: type: number format: double reservationId: type: integer format: int64 xml: name: CdrReservationResponse SubscriptionsListDto: type: object properties: listSize: type: integer format: int32 subscription: type: array items: $ref: '#/components/schemas/SubscriptionDto' SubscriptionsListResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' subscriptions: $ref: '#/components/schemas/SubscriptionsListDto' xml: name: SubscriptionsListResponse ChargeInstanceOverrideDto: type: object properties: chargeInstanceCode: type: string xml: attribute: true amountWithoutTax: type: number amountWithTax: type: number description: type: string ChargeInstanceOverridesDto: type: object properties: chargeInstanceOverride: type: array items: $ref: '#/components/schemas/ChargeInstanceOverrideDto' InstantiateServicesRequestDto: required: - subscription type: object properties: subscription: type: string servicesToInstantiate: $ref: '#/components/schemas/ServicesToInstantiateDto' xml: name: InstantiateServicesRequest ServiceToInstantiateDto: required: - quantity type: object properties: code: type: string xml: attribute: true overrideCode: type: string xml: attribute: true description: type: string xml: attribute: true quantity: type: number subscriptionDate: type: string format: date-time chargeInstanceOverrides: $ref: '#/components/schemas/ChargeInstanceOverridesDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' rateUntilDate: type: string format: date-time amountPS: type: number calendarPSCode: type: string xml: name: ServiceToInstantiate ServicesToInstantiateDto: required: - service type: object properties: service: type: array items: $ref: '#/components/schemas/ServiceToInstantiateDto' xml: name: ServicesToInstantiate ActivateServicesRequestDto: required: - subscription type: object properties: subscription: type: string servicesToActivateDto: $ref: '#/components/schemas/ServicesToActivateDto' xml: name: ActivateServicesRequest ServiceToActivateDto: type: object properties: code: type: string xml: attribute: true overrideCode: type: string xml: attribute: true description: type: string xml: attribute: true quantity: type: number subscriptionDate: type: string format: date-time chargeInstanceOverrides: $ref: '#/components/schemas/ChargeInstanceOverridesDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' serviceTemplate: $ref: '#/components/schemas/ServiceTemplate' rateUntilDate: type: string format: date-time amountPS: type: number calendarPSCode: type: string paymentDayInMonthPS: type: integer format: int32 xml: name: ServiceToActivate ServicesToActivateDto: required: - service type: object properties: service: type: array items: $ref: '#/components/schemas/ServiceToActivateDto' xml: name: ServicesToActivate ApplyOneShotChargeInstanceRequestDto: required: - oneShotCharge - operationDate - subscription type: object properties: oneShotCharge: type: string subscription: type: string wallet: type: string createWallet: type: boolean operationDate: type: string format: date-time quantity: type: number description: type: string amountWithoutTax: type: number amountWithTax: type: number criteria1: type: string criteria2: type: string criteria3: type: string xml: name: ApplyOneShotChargeInstanceRequest TerminateSubscriptionRequestDto: required: - subscriptionCode - terminationDate - terminationReason type: object properties: subscriptionCode: type: string terminationReason: type: string terminationDate: type: string format: date-time xml: name: TerminateSubscriptionRequest TerminateSubscriptionServicesRequestDto: required: - subscriptionCode - terminationDate - terminationReason type: object properties: services: type: array items: type: string serviceIds: type: array items: type: integer format: int64 subscriptionCode: type: string terminationReason: type: string terminationDate: type: string format: date-time action: type: string writeOnly: true enum: - ADD - MODIFY - DELETE xml: name: TerminateSubscriptionServicesRequest GetSubscriptionResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' subscription: $ref: '#/components/schemas/SubscriptionDto' xml: name: GetSubscriptionResponse GetOneShotChargesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' oneshotCharges: type: array items: $ref: '#/components/schemas/OneShotChargeTemplateDto' oneshotChargeInstances: type: array items: $ref: '#/components/schemas/OneShotChargeInstanceDto' OneShotChargeInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string operationDate: type: string format: date-time terminationDate: type: string format: date-time status: type: string enum: - ACTIVE - INACTIVE - CANCELED - TERMINATED - SUSPENDED - CLOSED quantity: type: number amountWithoutTax: type: number amountWithTax: type: number xml: name: AuditableEntity OneShotChargeTemplateDto: required: - invoiceSubCategory - oneShotChargeTemplateType type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean invoiceSubCategory: type: string amountEditable: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' inputUnitDescription: type: string ratingUnitDescription: type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingModeDtoEnum: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRuleCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' triggeredEdrs: $ref: '#/components/schemas/TriggeredEdrTemplatesDto' oneShotChargeTemplateType: type: string enum: - oneShotChargeTemplateTypeEnum.subscription - oneShotChargeTemplateTypeEnum.termination - oneShotChargeTemplateTypeEnum.other immediateInvoicing: type: boolean filterExpression: maxLength: 2000 minLength: 0 type: string xml: name: OneShotChargeTemplate TriggeredEdrTemplateDto: required: - quantityEl type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string subscriptionEl: type: string subscriptionElSpark: type: string meveoInstanceCode: type: string conditionEl: type: string conditionElSpark: type: string quantityEl: type: string quantityElSpark: type: string param1El: type: string param1ElSpark: type: string param2El: type: string param2ElSpark: type: string param3El: type: string param3ElSpark: type: string param4El: type: string param4ElSpark: type: string opencellInstanceEL: type: string triggeredEdrScript: type: string xml: name: TriggeredEdrTemplate TriggeredEdrTemplatesDto: type: object properties: triggeredEdr: type: array items: $ref: '#/components/schemas/TriggeredEdrTemplateDto' xml: name: TriggeredEdrTemplates OperationSubscriptionRequestDto: required: - subscriptionCode type: object properties: subscriptionCode: type: string actionDate: type: string format: date-time xml: name: OperationSubscriptionRequest OperationServicesRequestDto: required: - subscriptionCode type: object properties: subscriptionCode: type: string servicesToUpdate: type: array xml: name: ListServiceToUpdate wrapped: true items: $ref: '#/components/schemas/ServiceToUpdateDto' xml: name: OperationServicesRequestDto ServiceToUpdateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true overrideCode: type: string xml: attribute: true description: type: string xml: attribute: true quantity: type: number actionDate: type: string format: date-time endAgreementDate: type: string format: date-time terminationDate: type: string format: date-time terminationReason: type: string serviceRenewal: $ref: '#/components/schemas/SubscriptionRenewalDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: ServiceToUpdate UpdateServicesRequestDto: required: - subscriptionCode type: object properties: subscriptionCode: type: string servicesToUpdate: type: array xml: wrapped: true items: $ref: '#/components/schemas/ServiceToUpdateDto' xml: name: UpdateServicesRequest GetServiceInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' serviceInstance: $ref: '#/components/schemas/ServiceInstanceDto' xml: name: GetServiceInstanceResponse GetListServiceInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' serviceInstances: type: array items: $ref: '#/components/schemas/ServiceInstanceDto' xml: name: GetListServiceInstanceResponse DueDateDelayDto: type: object properties: delayOrigin: type: string enum: - ORDER - CA - BC computedDelay: type: integer format: int32 delayEL: type: string xml: name: DueDateDelay GetDueDateDelayResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' dueDateDelay: $ref: '#/components/schemas/DueDateDelayDto' RateSubscriptionResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' totalRatedCharges: type: integer format: int32 ratedChargesResult: type: object additionalProperties: type: string RateSubscriptionRequestDto: type: object properties: subscriptionCode: type: string rateUntilDate: type: string format: date-time SubscriptionForCustomerResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' subscriptionEndDate: type: string SubscriptionForCustomerRequestDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string subscriptionCode: type: string subscriptionClientId: type: string SubscriptionAndServicesToActivateRequestDto: required: - billingCycle - offerTemplate - subscriptionDate - userAccount type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string userAccount: type: string offerTemplate: type: string subscriptionDate: type: string format: date-time terminationDate: type: string format: date-time endAgreementDate: type: string format: date-time status: type: string enum: - CREATED - ACTIVE - CANCELED - RESILIATED - CLOSED - SUSPENDED statusDate: type: string format: date-time customFields: $ref: '#/components/schemas/CustomFieldsDto' accesses: $ref: '#/components/schemas/AccessesDto' services: $ref: '#/components/schemas/ServiceInstancesDto' products: $ref: '#/components/schemas/ProductsDto' productInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/ProductInstanceDto' terminationReason: type: string orderNumber: type: string minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string subscribedTillDate: type: string format: date-time renewed: type: boolean renewalNotifiedDate: type: string format: date-time renewalRule: $ref: '#/components/schemas/SubscriptionRenewalDto' billingCycle: type: string seller: type: string autoEndOfEngagement: type: boolean ratingGroup: type: string electronicBilling: type: boolean email: type: string mailingType: type: string emailTemplate: type: string ccedEmails: type: string discountPlansForInstantiation: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' discountPlansForTermination: type: array xml: wrapped: true items: type: string xml: name: discountPlanForTermination discountPlanInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanInstanceDto' servicesToActivateDto: $ref: '#/components/schemas/ServicesToActivateDto' WalletTemplateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string walletType: type: string enum: - POSTPAID - PREPAID consumptionAlertSet: type: boolean fastRatingLevel: type: integer format: int32 lowBalanceLevel: type: number rejectLevel: type: number GetWalletTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' walletTemplate: $ref: '#/components/schemas/WalletTemplateDto' xml: name: GetWalletTemplateResponse AmountsDto: type: object properties: amountWithTax: type: number amountWithoutTax: type: number WalletBalanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' amounts: $ref: '#/components/schemas/AmountsDto' xml: name: WalletBalanceResponse WalletBalanceDto: type: object properties: sellerCode: type: string customerCode: type: string customerAccountCode: type: string billingAccountCode: type: string userAccountCode: type: string startDate: type: string format: date-time endDate: type: string format: date-time walletCode: type: string amountWithTax: type: boolean xml: name: WalletBalance WalletReservationDto: type: object properties: reservationId: type: integer format: int64 providerCode: type: string sellerCode: type: string offerCode: type: string userAccountCode: type: string subscriptionDate: type: string format: date-time expirationDate: type: string format: date-time terminationDate: type: string format: date-time creditLimit: type: number param1: type: string param2: type: string param3: type: string amountWithTax: type: boolean xml: name: WalletReservation WalletOperationDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string userAccount: type: string subscription: type: string walletTemplate: type: string seller: type: string chargeInstance: type: string chargeInstanceId: type: integer format: int64 currency: type: string type: type: string enum: - CREDIT - DEBIT status: type: string enum: - OPEN - TREATED - CANCELED - RESERVED - TO_RERATE - RERATED - SCHEDULED ratingUnitDescription: type: string taxCode: type: string taxPercent: type: number unitAmountWithoutTax: type: number unitAmountWithTax: type: number unitAmountTax: type: number quantity: type: number amountWithoutTax: type: number amountWithTax: type: number amountTax: type: number parameter1: type: string parameter2: type: string parameter3: type: string parameterExtra: type: string orderNumber: type: string startDate: type: string format: date-time endDate: type: string format: date-time operationDate: type: string format: date-time subscriptionDate: type: string format: date-time offerCode: type: string rawAmountWithoutTax: type: number rawAmountWithTax: type: number ratedTransaction: $ref: '#/components/schemas/WoRatedTransactionDto' xml: name: WalletOperation WoRatedTransactionDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string status: type: string enum: - OPEN - BILLED - REJECTED - RERATED - CANCELED xml: name: ratedTransaction FindWalletOperationsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' walletOperations: type: array items: $ref: '#/components/schemas/WalletOperationDto' xml: name: FindWalletOperationsResponse FindWalletOperationsDto: required: - userAccount type: object properties: status: type: string enum: - OPEN - TREATED - CANCELED - RESERVED - TO_RERATE - RERATED - SCHEDULED walletTemplate: type: string userAccount: type: string fromDate: type: string format: date-time toDate: type: string format: date-time chargeTemplateCode: type: string parameter1: type: string parameter2: type: string parameter3: type: string offerTemplateCode: type: string subscriptionCode: type: string orderNumber: type: string BusinessOfferModelDto: required: - offerTemplate type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean license: type: string xml: attribute: true enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: type: string logoPictureFile: type: array items: type: string format: byte script: $ref: '#/components/schemas/ScriptInstanceDto' moduleItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/BaseEntityDto' offerTemplate: $ref: '#/components/schemas/OfferTemplateDto' codeOnly: type: boolean transient: type: boolean xml: name: BusinessOfferModel BusinessProductModelDto: required: - productTemplate type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean license: type: string xml: attribute: true enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: type: string logoPictureFile: type: array items: type: string format: byte script: $ref: '#/components/schemas/ScriptInstanceDto' moduleItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/BaseEntityDto' productTemplate: $ref: '#/components/schemas/ProductTemplateDto' codeOnly: type: boolean transient: type: boolean xml: name: BusinessProductModel ChannelDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean xml: name: Channel DigitalResourceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean uri: type: string mimeType: type: string xml: name: DigitalResource OfferProductTemplateDto: type: object properties: productTemplate: $ref: '#/components/schemas/ProductTemplateDto' mandatory: type: boolean xml: name: OfferProductTemplate OfferServiceTemplateDto: type: object properties: serviceTemplate: $ref: '#/components/schemas/ServiceTemplateDto' mandatory: type: boolean incompatibleServices: type: array xml: wrapped: true items: $ref: '#/components/schemas/ServiceTemplateDto' xml: name: OfferServiceTemplate OfferTemplateCategoryDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean name: type: string offerTemplateCategoryCode: type: string href: type: string version: type: integer format: int32 lastModified: type: string format: date-time active: type: boolean parentId: type: integer format: int64 imagePath: type: string imageBase64: type: string xml: name: OfferCategory OfferTemplateDto: required: - lifeCycleStatus - name type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean validFrom: type: string format: date-time xml: attribute: true validTo: type: string format: date-time xml: attribute: true name: type: string offerTemplateCategories: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferTemplateCategoryDto' channels: type: array xml: wrapped: true items: $ref: '#/components/schemas/ChannelDto' attachments: type: array xml: name: digitalResources wrapped: true items: $ref: '#/components/schemas/DigitalResourceDto' modelCode: type: string lifeCycleStatus: type: string enum: - IN_STUDY - IN_DESIGN - IN_TEST - ACTIVE - LAUNCHED - RETIRED - OBSOLETE - REJECTED customFields: $ref: '#/components/schemas/CustomFieldsDto' imagePath: type: string imageBase64: type: string languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' longDescription: type: string longDescriptionsTranslated: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' globalRatingScriptInstance: type: string sellers: type: array xml: wrapped: true items: type: string xml: name: seller customerCategories: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomerCategoryDto' bomCode: type: string offerTemplateCategoryCode: type: string offerServiceTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferServiceTemplateDto' offerProductTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferProductTemplateDto' allowedDiscountPlans: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanDto' renewalRule: $ref: '#/components/schemas/SubscriptionRenewalDto' minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string autoEndOfEngagement: type: boolean codeOnly: type: boolean xml: name: OfferTemplate ProductChargeTemplateDto: required: - invoiceSubCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean invoiceSubCategory: type: string amountEditable: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' inputUnitDescription: type: string ratingUnitDescription: type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingModeDtoEnum: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRuleCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' triggeredEdrs: $ref: '#/components/schemas/TriggeredEdrTemplatesDto' filterExpression: maxLength: 255 minLength: 0 type: string xml: name: ProductChargeTemplate ProductTemplateDto: required: - lifeCycleStatus - name - productChargeTemplates type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean validFrom: type: string format: date-time xml: attribute: true validTo: type: string format: date-time xml: attribute: true name: type: string offerTemplateCategories: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferTemplateCategoryDto' channels: type: array xml: wrapped: true items: $ref: '#/components/schemas/ChannelDto' attachments: type: array xml: name: digitalResources wrapped: true items: $ref: '#/components/schemas/DigitalResourceDto' modelCode: type: string lifeCycleStatus: type: string enum: - IN_STUDY - IN_DESIGN - IN_TEST - ACTIVE - LAUNCHED - RETIRED - OBSOLETE - REJECTED customFields: $ref: '#/components/schemas/CustomFieldsDto' imagePath: type: string imageBase64: type: string languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' longDescription: type: string longDescriptionsTranslated: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' globalRatingScriptInstance: type: string sellers: type: array xml: wrapped: true items: type: string xml: name: seller customerCategories: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomerCategoryDto' productChargeTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/ProductChargeTemplateDto' businessProductModel: $ref: '#/components/schemas/BusinessProductModelDto' walletTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/WalletTemplateDto' codeOnly: type: boolean xml: name: ProductTemplate ServiceChargeTemplateRecurringDto: type: object properties: code: type: string wallets: $ref: '#/components/schemas/WalletsDto' counterTemplate: type: string ServiceChargeTemplateRecurringsDto: type: object properties: serviceChargeTemplateRecurring: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateRecurringDto' ServiceChargeTemplateSubscriptionDto: type: object properties: code: type: string wallets: $ref: '#/components/schemas/WalletsDto' counterTemplate: type: string ServiceChargeTemplateSubscriptionsDto: type: object properties: serviceChargeTemplateSubscription: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateSubscriptionDto' ServiceChargeTemplateTerminationDto: type: object properties: code: type: string wallets: $ref: '#/components/schemas/WalletsDto' counterTemplate: type: string ServiceChargeTemplateTerminationsDto: type: object properties: serviceChargeTemplateTermination: type: array items: $ref: '#/components/schemas/ServiceChargeTemplateTerminationDto' ServiceChargeTemplateUsagesDto: type: object properties: serviceChargeTemplateUsage: type: array items: $ref: '#/components/schemas/ServiceUsageChargeTemplateDto' ServiceTemplateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean longDescription: type: string invoicingCalendar: type: string serviceChargeTemplateRecurrings: $ref: '#/components/schemas/ServiceChargeTemplateRecurringsDto' serviceChargeTemplateSubscriptions: $ref: '#/components/schemas/ServiceChargeTemplateSubscriptionsDto' serviceChargeTemplateTerminations: $ref: '#/components/schemas/ServiceChargeTemplateTerminationsDto' serviceChargeTemplateUsages: $ref: '#/components/schemas/ServiceChargeTemplateUsagesDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' mandatory: type: boolean somCode: type: string imagePath: type: string imageBase64: type: string minimumAmountEl: type: string minimumAmountElSpark: type: string minimumLabelEl: type: string minimumLabelElSpark: type: string autoEndOfEngagement: type: boolean renewalRule: $ref: '#/components/schemas/SubscriptionRenewalDto' codeOnly: type: boolean xml: name: ServiceTemplate ServiceUsageChargeTemplateDto: type: object properties: code: type: string wallets: $ref: '#/components/schemas/WalletsDto' counterTemplate: type: string xml: name: ServiceUsageChargeTemplate WalletsDto: type: object properties: wallet: type: array items: type: string GetBusinessOfferModelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' businessOfferModel: $ref: '#/components/schemas/BusinessOfferModelDto' xml: name: GetBusinessOfferModelResponse GetBusinessProductModelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' businessProductModel: $ref: '#/components/schemas/BusinessProductModelDto' xml: name: GetBusinessProductModelResponse BusinessServiceModelDto: required: - serviceTemplate type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean license: type: string xml: attribute: true enum: - APACHE - BSD3_N - BSD3_R - BSD2_S - FREE_BSD - GPL - AGPL - LGPL - MIT - MOZ - CDDL - EPL - OPEN - COM logoPicture: type: string logoPictureFile: type: array items: type: string format: byte script: $ref: '#/components/schemas/ScriptInstanceDto' moduleItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/BaseEntityDto' serviceTemplate: $ref: '#/components/schemas/ServiceTemplateDto' duplicateService: type: boolean duplicatePricePlan: type: boolean codeOnly: type: boolean transient: type: boolean xml: name: BusinessServiceModel GetBusinessServiceModelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' businessServiceModel: $ref: '#/components/schemas/BusinessServiceModelDto' xml: name: GetBusinessServiceModelResponse GetChannelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' channel: $ref: '#/components/schemas/ChannelDto' xml: name: GetChannelResponse GetListChannelsAndSegmentsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' channels: type: array items: $ref: '#/components/schemas/ChannelDto' segments: type: array items: $ref: '#/components/schemas/OfferTemplateCategoryDto' xml: name: GetChannelResponse ChargeTemplateDto: required: - invoiceSubCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean invoiceSubCategory: type: string amountEditable: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' inputUnitDescription: type: string ratingUnitDescription: type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingModeDtoEnum: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRuleCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' triggeredEdrs: $ref: '#/components/schemas/TriggeredEdrTemplatesDto' xml: name: ChargeTemplate GetChargeTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' chargeTemplate: $ref: '#/components/schemas/ChargeTemplateDto' xml: name: GetChargeTemplateResponse CounterTemplateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean calendar: type: string xml: attribute: true unity: type: string type: type: string enum: - USAGE - NOTIFICATION ceiling: type: number counterLevel: type: string enum: - SI - SU - UA - BA ceilingExpressionEl: type: string notificationLevels: type: string xml: name: CounterTemplate GetCounterTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' counterTemplate: $ref: '#/components/schemas/CounterTemplateDto' xml: name: GetCounterTemplateResponse DiscountPlanItemResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' discountPlanItem: $ref: '#/components/schemas/DiscountPlanItemDto' xml: name: DiscountPlanItemResponse DiscountPlanItemsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' discountPlanItems: type: array xml: wrapped: true items: $ref: '#/components/schemas/DiscountPlanItemDto' xml: name: DiscountPlanItemsResponse GetDiscountPlanResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' discountPlanDto: $ref: '#/components/schemas/DiscountPlanDto' xml: name: GetDiscountPlanResponse DiscountPlansDto: type: object properties: discountPlan: type: array items: $ref: '#/components/schemas/DiscountPlanDto' GetDiscountPlansResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' discountPlan: $ref: '#/components/schemas/DiscountPlansDto' xml: name: GetDiscountPlansResponse GetOfferTemplateCategoryResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' offerTemplateCategory: $ref: '#/components/schemas/OfferTemplateCategoryDto' xml: name: GetOfferTemplateResponse GetListOfferTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' offerTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferTemplateDto' xml: name: GetListOfferTemplateResponse GetOfferTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' offerTemplate: $ref: '#/components/schemas/OfferTemplateDto' xml: name: GetOfferTemplateResponse OneShotChargeTemplateWithPriceDto: type: object properties: chargeCode: type: string description: type: string unitPriceWithoutTax: type: number format: double taxPercent: type: number format: double taxCode: type: string taxDescription: type: string xml: name: OneShotChargeTemplate OneShotChargeTemplateWithPriceListDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' oneShotChargeTemplateDtos: type: array items: $ref: '#/components/schemas/OneShotChargeTemplateWithPriceDto' xml: name: OneShotChargeTemplateList GetOneShotChargeTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' oneShotChargeTemplate: $ref: '#/components/schemas/OneShotChargeTemplateDto' xml: name: GetOneShotChargeTemplateResponse PricePlanMatrixDto: required: - eventCode type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean eventCode: type: string seller: type: string country: type: string currency: type: string minQuantity: type: number maxQuantity: type: number offerTemplate: type: string offerTemplateVersion: $ref: '#/components/schemas/OfferTemplateDto' startSubscriptionDate: type: string format: date-time endSubscriptionDate: type: string format: date-time startRatingDate: type: string format: date-time endRatingDate: type: string format: date-time minSubscriptionAgeInMonth: type: integer format: int64 maxSubscriptionAgeInMonth: type: integer format: int64 amountWithoutTax: type: number amountWithTax: type: number amountWithoutTaxEL: type: string amountWithoutTaxELSpark: type: string amountWithTaxEL: type: string amountWithTaxELSpark: type: string minimumAmountWithoutTaxEl: type: string minimumAmountWithoutTaxELSpark: type: string minimumAmountWithTaxEl: type: string minimumAmountWithTaxELSpark: type: string priority: type: integer format: int32 criteria1: type: string criteria2: type: string criteria3: type: string criteriaEL: type: string criteriaELSpark: type: string validityCalendarCode: type: string scriptInstance: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' woDescriptionEL: type: string woDescriptionELSpark: type: string ratingWithTaxEL: maxLength: 2000 minLength: 0 type: string ratingWithTaxELSpark: maxLength: 2000 minLength: 0 type: string ratingWithoutTaxEL: maxLength: 2000 minLength: 0 type: string ratingWithoutTaxELSpark: maxLength: 2000 minLength: 0 type: string invoiceSubCategoryEL: type: string totalAmountEL: type: string totalAmountELSpark: type: string minimumAmountEL: type: string minimumAmountELSpark: type: string xml: name: PricePlan PricePlanMatrixesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' pricePlanMatrixes: $ref: '#/components/schemas/PricePlansDto' xml: name: PricePlanMatrixesResponse PricePlansDto: type: object properties: pricePlanMatrix: type: array items: $ref: '#/components/schemas/PricePlanMatrixDto' GetPricePlanResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' pricePlan: $ref: '#/components/schemas/PricePlanMatrixDto' xml: name: GetPricePlanResponse RecurringChargeTemplateDto: required: - calendar - invoiceSubCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean invoiceSubCategory: type: string amountEditable: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' inputUnitDescription: type: string ratingUnitDescription: type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingModeDtoEnum: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRuleCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' triggeredEdrs: $ref: '#/components/schemas/TriggeredEdrTemplatesDto' calendar: type: string durationTermInMonth: type: integer format: int32 subscriptionProrata: type: boolean terminationProrata: type: boolean applyInAdvance: type: boolean shareLevel: type: integer format: int32 filterExpression: maxLength: 2000 minLength: 0 type: string calendarCodeEl: maxLength: 2000 minLength: 0 type: string durationTermInMonthEl: maxLength: 2000 minLength: 0 type: string subscriptionProrataEl: maxLength: 2000 minLength: 0 type: string terminationProrataEl: maxLength: 2000 minLength: 0 type: string applyInAdvanceEl: maxLength: 2000 minLength: 0 type: string xml: name: RecurringChargeTemplate GetRecurringChargeTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' recurringChargeTemplate: $ref: '#/components/schemas/RecurringChargeTemplateDto' xml: name: GetRecurringChargeTemplateResponse GetServiceTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' serviceTemplate: $ref: '#/components/schemas/ServiceTemplateDto' xml: name: GetServiceTemplateResponse GetListServiceTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' listServiceTemplate: type: array items: $ref: '#/components/schemas/ServiceTemplateDto' xml: name: GetListServiceTemplateResponse GetTriggeredEdrResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' triggeredEdrTemplate: $ref: '#/components/schemas/TriggeredEdrTemplateDto' xml: name: GetTriggeredEdrResponse UsageChargeTemplateDto: required: - invoiceSubCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean invoiceSubCategory: type: string amountEditable: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' inputUnitDescription: type: string ratingUnitDescription: type: string unitMultiplicator: type: number unitNbDecimal: type: integer format: int32 roundingModeDtoEnum: type: string enum: - NEAREST - DOWN - UP revenueRecognitionRuleCode: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' triggeredEdrs: $ref: '#/components/schemas/TriggeredEdrTemplatesDto' filterParam1: maxLength: 255 minLength: 0 type: string filterParam2: maxLength: 255 minLength: 0 type: string filterParam3: maxLength: 255 minLength: 0 type: string filterParam4: maxLength: 255 minLength: 0 type: string filterExpression: maxLength: 2000 minLength: 0 type: string filterExpressionSpark: maxLength: 2000 minLength: 0 type: string priority: type: integer format: int32 triggerNextCharge: type: boolean triggerNextChargeEL: type: string xml: name: UsageChargeTemplate GetUsageChargeTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' usageChargeTemplate: $ref: '#/components/schemas/UsageChargeTemplateDto' xml: name: GetUsageChargeTemplateResponse CommunicationRequestDto: required: - macAddress - meveoInstanceCode - subject type: object properties: meveoInstanceCode: type: string macAddress: type: string subject: type: string body: type: string additionnalInfo1: type: string additionnalInfo2: type: string additionnalInfo3: type: string additionnalInfo4: type: string vaild: type: boolean xml: name: CommunicationRequest EmailTemplateDto: required: - subject type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string media: type: string enum: - POSTAL_MAIL - EMAIL - SMS - IM - FAX - VOICE - WEBSERVICE - QUEUE - FTP_FILE - CFT_FILE - DATABASE tagStartDelimiter: type: string tagEndDelimiter: type: string startDate: type: string format: date-time endDate: type: string format: date-time type: type: string enum: - DUNNING - INVOICE - OTHER subject: type: string htmlContent: type: string textContent: type: string xml: name: EmailTemplate EmailTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' emailTemplate: $ref: '#/components/schemas/EmailTemplateDto' xml: name: EmailTemplateResponse EmailTemplatesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' emailTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/EmailTemplateDto' xml: name: EmailTemplatesResponse MeveoInstanceDto: required: - url type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string productName: type: string productVersion: type: string owner: type: string md5: type: string status: type: string enum: - UNKNOWN - PARENT - CHILD - PARTNER creationDate: type: string format: date-time updateDate: type: string format: date-time keyEntreprise: type: string macAddress: type: string machineVendor: type: string installationMode: type: string nbCores: type: string memory: type: string hdSize: type: string osName: type: string osVersion: type: string osArch: type: string javaVmVersion: type: string javaVmName: type: string javaVendor: type: string javaVersion: type: string asVendor: type: string asVersion: type: string url: type: string authUsername: type: string authPassword: type: string user: type: string customer: type: string xml: name: MeveoInstance MeveoInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' meveoInstance: $ref: '#/components/schemas/MeveoInstanceDto' xml: name: MeveoInstanceResponse MeveoInstancesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' meveoInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/MeveoInstanceDto' xml: name: MeveoInstancesResponse AddressBookDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string contact: type: array items: $ref: '#/components/schemas/ContactDto' xml: name: AuditableEntity ContactDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string externalRef1: type: string externalRef2: type: string name: $ref: '#/components/schemas/NameDto' address: $ref: '#/components/schemas/AddressDto' jobTitle: type: string businessAccountModel: $ref: '#/components/schemas/BusinessEntityDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' loaded: type: boolean vatNo: type: string registrationNo: type: string contactInformation: $ref: '#/components/schemas/ContactInformationDto' email: type: string assistantName: type: string assistantPhone: type: string position: type: string company: type: string mobile: type: string phone: type: string websiteUrl: type: string importedFrom: type: string importedBy: type: string socialIdentifier: type: string agreedToUA: type: boolean contactPolicy: $ref: '#/components/schemas/CommunicationPolicy' tags: uniqueItems: true type: array items: type: string prospect: type: boolean vip: type: boolean xml: name: Account GetAddressBookResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' addressBook: $ref: '#/components/schemas/AddressBookDto' ContactsDto: type: object properties: contact: type: array items: $ref: '#/components/schemas/ContactDto' totalNumberOfRecords: type: integer format: int64 ContactsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' contacts: $ref: '#/components/schemas/ContactsDto' GetContactResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' contact: $ref: '#/components/schemas/ContactDto' CustomEntityInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean cetCode: type: string xml: attribute: true customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: CustomEntityInstance CustomEntityInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customEntityInstance: $ref: '#/components/schemas/CustomEntityInstanceDto' xml: name: GetCustomEntityInstanceResponse CustomEntityInstancesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customEntityInstances: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomEntityInstanceDto' xml: name: GetCustomEntityInstancesResponse CustomFieldMatrixColumnDto: type: object properties: columnUse: type: string xml: attribute: true enum: - USE_KEY - USE_VALUE position: type: integer format: int32 xml: attribute: true code: maxLength: 20 minLength: 0 type: string xml: attribute: true label: maxLength: 50 minLength: 0 type: string xml: attribute: true keyType: type: string xml: attribute: true enum: - STRING - LONG - DOUBLE - RON xml: name: CustomFieldMatrixColumn CustomFieldTemplateDto: required: - fieldType - storageType type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean languageDescriptions: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' fieldType: type: string enum: - STRING - DATE - LONG - DOUBLE - LIST - ENTITY - TEXT_AREA - CHILD_ENTITY - MULTI_VALUE - BOOLEAN accountLevel: type: string appliesTo: type: string defaultValue: type: string useInheritedAsDefaultValue: type: boolean storageType: type: string enum: - SINGLE - LIST - MAP - MATRIX valueRequired: type: boolean versionable: type: boolean triggerEndPeriodEvent: type: boolean calendar: type: string cacheValueTimeperiod: type: integer format: int32 entityClazz: type: string listValues: type: object additionalProperties: type: string allowEdit: type: boolean hideOnNew: type: boolean maxValue: type: integer format: int64 minValue: type: integer format: int64 regExp: type: string cacheValue: type: boolean nbDecimal: type: integer format: int32 roundingMode: type: string enum: - NEAREST - DOWN - UP guiPosition: type: string mapKeyType: type: string enum: - STRING - LONG - DOUBLE - RON applicableOnEl: type: string matrixColumns: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomFieldMatrixColumnDto' childEntityFieldsForSummary: type: array xml: wrapped: true items: type: string xml: name: fieldCode indexType: type: string enum: - STORE_ONLY - INDEX - INDEX_NOT_ANALYZE tags: type: string displayFormat: type: string xml: name: CustomFieldTemplate GetCustomFieldTemplateReponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customFieldTemplate: $ref: '#/components/schemas/CustomFieldTemplateDto' xml: name: GetCustomFieldTemplateReponse CustomTableDataDto: type: object properties: customTableCode: type: string xml: attribute: true overrwrite: type: boolean xml: attribute: true values: type: array xml: name: records wrapped: true items: $ref: '#/components/schemas/CustomTableRecordDto' valuesFromListofMap: type: array writeOnly: true items: type: object additionalProperties: type: object xml: name: CustomTableData CustomTableRecordDto: type: object properties: id: type: integer format: int64 values: type: object additionalProperties: type: object xml: name: CustomTableRecord CustomTableDataResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' customTableData: $ref: '#/components/schemas/CustomTableDataDto' xml: name: CustomTableDataResponse CustomEntityTemplateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean name: type: string xml: attribute: true storeAsTable: type: boolean xml: attribute: true fields: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomFieldTemplateDto' actions: type: array xml: wrapped: true items: $ref: '#/components/schemas/EntityCustomActionDto' xml: name: CustomEntityTemplate CustomEntityTemplatesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customEntityTemplates: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomEntityTemplateDto' xml: name: CustomEntityTemplatesResponseDto EntityCustomActionDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean appliesTo: type: string xml: attribute: true applicableOnEl: type: string label: type: string labelsTranslated: type: array items: $ref: '#/components/schemas/LanguageDescriptionDto' script: $ref: '#/components/schemas/ScriptInstanceDto' guiPosition: type: string xml: name: EntityCustomAction CustomEntityTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customEntityTemplate: $ref: '#/components/schemas/CustomEntityTemplateDto' xml: name: CustomEntityTemplateResponseDto EntityCustomizationDto: type: object properties: classname: type: string xml: attribute: true fields: type: array xml: wrapped: true items: $ref: '#/components/schemas/CustomFieldTemplateDto' actions: type: array xml: wrapped: true items: $ref: '#/components/schemas/EntityCustomActionDto' xml: name: EntityCustomization EntityCustomizationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' entityCustomization: $ref: '#/components/schemas/EntityCustomizationDto' xml: name: EntityCustomizationResponseDto EntityCustomActionResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' entityAction: $ref: '#/components/schemas/EntityCustomActionDto' xml: name: EntityCustomActionResponse BusinessEntityResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' businessEntities: type: array items: $ref: '#/components/schemas/BusinessEntityDto' xml: name: BusinessEntityResponse SignFileResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' id: type: string name: type: string description: type: string content: type: array items: type: string format: byte SignMemberDto: type: object properties: id: type: string firstname: type: string lastname: type: string email: type: string phone: type: string user: type: string internal: type: boolean SignProcedureResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' id: type: string name: type: string description: type: string status: type: string members: type: array items: $ref: '#/components/schemas/SignMemberDto' files: type: array items: $ref: '#/components/schemas/SignFileResponseDto' CreateProcedureRequestDto: type: object properties: absolutePaths: type: boolean withInternalMember: type: boolean filesToSign: type: array items: $ref: '#/components/schemas/SignFileRequestDto' procedure: $ref: '#/components/schemas/SignProcedureDto' SignEventEmailDto: type: object properties: subject: type: string message: type: string to: type: array items: type: string SignEventWebhookDto: type: object properties: url: type: string method: type: string headers: type: object additionalProperties: type: string SignFileObjectRequestDto: type: object properties: position: type: string page: type: integer format: int32 file: type: string SignFileRequestDto: type: object properties: id: type: string name: type: string filePath: type: string position: type: integer format: int32 internalPosition: type: string externalPosition: type: string internalPage: type: integer format: int32 externalPage: type: integer format: int32 content: type: array items: type: string format: byte listExternalPositions: type: array items: $ref: '#/components/schemas/SignFileObjectRequestDto' SignMemberRequestDto: type: object properties: id: type: string firstname: type: string lastname: type: string email: type: string phone: type: string user: type: string internal: type: boolean fileObjects: type: array items: $ref: '#/components/schemas/SignFileObjectRequestDto' SignProcedureConfigDto: type: object properties: email: type: object additionalProperties: type: array items: $ref: '#/components/schemas/SignEventEmailDto' webhook: type: object additionalProperties: type: array items: $ref: '#/components/schemas/SignEventWebhookDto' SignProcedureDto: type: object properties: id: type: string name: type: string description: type: string start: type: boolean members: type: array items: $ref: '#/components/schemas/SignMemberRequestDto' config: $ref: '#/components/schemas/SignProcedureConfigDto' RawResponseDto: required: - response type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' response: type: object RawResponseDtoString: required: - response type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' response: type: string PDFDocumentResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' listPdfFilePaths: type: array items: type: string pdfFilePath: type: string pdfFile: type: array items: type: string format: byte pdfFiles: type: array items: type: array items: type: string format: byte PDFDocumentRequestDto: type: object properties: listTemplates: type: array items: $ref: '#/components/schemas/PDFTemplateDto' documentDestinationDir: type: string documentNamePrefix: type: string returnPdf: type: boolean combineFiles: type: boolean absolutePaths: type: boolean PDFTemplateDto: type: object properties: templateFields: type: object additionalProperties: type: string templateName: type: string templatePath: type: string barCodeFields: type: array items: type: string ChartDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean measurableQuantity: $ref: '#/components/schemas/MeasurableQuantityDto' width: type: string height: type: string style: type: string styleClass: type: string extender: type: string visible: type: boolean xml: name: Chart MeasurableQuantityDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean theme: type: string dimension1: type: string dimension2: type: string dimension3: type: string dimension4: type: string editable: type: boolean additive: type: boolean sqlQuery: type: string measurementPeriod: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY lastMeasureDate: type: string format: date-time codeOnly: type: boolean xml: name: MeasurableQuantity BarChartDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean measurableQuantity: $ref: '#/components/schemas/MeasurableQuantityDto' width: type: string height: type: string style: type: string styleClass: type: string extender: type: string visible: type: boolean legendPosition: type: string enum: - n - s - e - w barPadding: type: integer format: int32 barMargin: type: integer format: int32 orientation: type: string enum: - vertical - horizontal stacked: type: boolean min: type: number format: double max: type: number format: double breakOnNull: type: boolean xaxisLabel: type: string yaxisLabel: type: string xaxisAngle: type: integer format: int32 yaxisAngle: type: integer format: int32 legendCols: type: integer format: int32 legendRows: type: integer format: int32 zoom: type: boolean animate: type: boolean showDataTip: type: boolean datatipFormat: type: string xml: name: BarChart PieChartDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean measurableQuantity: $ref: '#/components/schemas/MeasurableQuantityDto' width: type: string height: type: string style: type: string styleClass: type: string extender: type: string visible: type: boolean filled: type: boolean legendPosition: type: string enum: - n - s - e - w seriesColors: type: string diameter: type: integer format: int32 sliceMargin: type: integer format: int32 shadow: type: boolean showDataLabels: type: boolean legendCols: type: integer format: int32 legendRows: type: integer format: int32 xml: name: PieChart LineChartDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean measurableQuantity: $ref: '#/components/schemas/MeasurableQuantityDto' width: type: string height: type: string style: type: string styleClass: type: string extender: type: string visible: type: boolean filled: type: boolean legendPosition: type: string enum: - n - s - e - w seriesColors: type: string shadow: type: boolean minX: type: integer format: int32 maxX: type: integer format: int32 minY: type: integer format: int32 maxY: type: integer format: int32 breakOnNull: type: boolean xaxisLabel: type: string yaxisLabel: type: string xaxisAngle: type: integer format: int32 yaxisAngle: type: integer format: int32 stacked: type: boolean zoom: type: boolean animate: type: boolean showDataTip: type: boolean datatipFormat: type: string legendCols: type: integer format: int32 legendRows: type: integer format: int32 xml: name: LineChart GetChartResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' chartDto: $ref: '#/components/schemas/ChartDto' xml: name: GetChartResponse GetMeasurableQuantityResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' measurableQuantityDto: $ref: '#/components/schemas/MeasurableQuantityDto' xml: name: GetMeasurableQuantityResponse GetListMeasurableQuantityResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' listMeasurableQuantityDto: type: array xml: name: listMeasurableQuantity wrapped: true items: $ref: '#/components/schemas/MeasurableQuantityDto' xml: name: GetListMeasurableQuantityResponse ReportExtractDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean scriptType: type: string enum: - JAVA - SQL filenameFormat: type: string category: type: string outputDir: type: string scriptInstanceCode: type: string sqlQuery: type: string params: type: object additionalProperties: type: string startDate: type: string format: date-time endDate: type: string format: date-time reportExtractResultType: type: string enum: - CSV - HTML xml: name: AuditableEntity ReportExtractExecutionResultDto: type: object properties: reportExtractCode: type: string startDate: type: string format: date-time endDate: type: string format: date-time filePath: type: string lineCount: type: integer format: int32 origin: type: string enum: - API - JOB - GUI errorMessage: type: string status: type: boolean ReportExtractExecutionResultsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' reportExtractExecutionResults: type: array items: $ref: '#/components/schemas/ReportExtractExecutionResultDto' ReportExtractExecutionResultResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' reportExtractExecutionResult: $ref: '#/components/schemas/ReportExtractExecutionResultDto' ReportExtractsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' reportExtracts: type: array xml: wrapped: true items: $ref: '#/components/schemas/ReportExtractDto' xml: name: ReportExtractsResponse RunReportExtractDto: required: - code type: object properties: code: type: string params: type: object additionalProperties: type: string ReportExtractResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' reportExtract: $ref: '#/components/schemas/ReportExtractDto' xml: name: ReportExtractResponse GWFTransitionDto: required: - conditionEl - description - fromStatus - toStatus type: object properties: uuid: type: string fromStatus: type: string toStatus: type: string conditionEl: type: string priority: type: integer format: int32 description: type: string actionScriptCode: type: string GenericWorkflowDto: required: - initStatus - targetEntityClass type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean targetEntityClass: type: string targetCetCode: type: string initStatus: type: string statuses: type: array xml: wrapped: true items: $ref: '#/components/schemas/WFStatusDto' transitions: type: array xml: wrapped: true items: $ref: '#/components/schemas/GWFTransitionDto' enableHistory: type: boolean WFStatusDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string uuid: type: string xml: name: AuditableEntity GenericWorkflowsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' workflows: type: array xml: wrapped: true items: $ref: '#/components/schemas/GenericWorkflowDto' xml: name: GenericWorkflowsResponse WorkflowInsHistoryResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' workflowInsHistories: type: array xml: wrapped: true items: $ref: '#/components/schemas/WorkflowInstanceHistoryDto' xml: name: WorkflowInsHistoryResponse WorkflowInstanceHistoryDto: type: object properties: actionDate: type: string format: date-time workflowInstanceCode: type: string fromStatus: type: string toStatus: type: string transitionName: type: string GenericWorkflowResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' genericWorkflow: $ref: '#/components/schemas/GenericWorkflowDto' xml: name: GenericWorkflowResponse UserHierarchyLevelDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string parentLevel: type: string childLevels: type: array xml: wrapped: true items: $ref: '#/components/schemas/UserHierarchyLevelDto' orderLevel: type: integer format: int64 xml: name: UserHierarchyLevel UserHierarchyLevelsDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' userHierarchyLevels: type: array xml: wrapped: true items: $ref: '#/components/schemas/UserHierarchyLevelDto' xml: name: UserHierarchyLevels UserHierarchyLevelResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' userHierarchyLevel: $ref: '#/components/schemas/UserHierarchyLevelDto' xml: name: UserHierarchyLevelResponseDto FieldsNotImportedStringCollectionDto: type: object properties: fieldsNotImported: type: array items: type: string xml: name: FieldsNotImportedStringCollection ImportExportResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' executionId: type: string summary: type: object additionalProperties: type: integer format: int32 fieldsNotImported: type: object additionalProperties: $ref: '#/components/schemas/FieldsNotImportedStringCollectionDto' exceptionMessage: type: string done: type: boolean failureMessageKey: type: string failed: type: boolean failureMessage: type: string xml: name: ImportExportResponse InputPart: type: object properties: headers: type: object properties: empty: type: boolean additionalProperties: type: array items: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: type: object additionalProperties: type: string wildcardType: type: boolean wildcardSubtype: type: boolean contentTypeFromMessage: type: boolean bodyAsString: type: string MultipartFormDataInput: type: object properties: formDataMap: type: object additionalProperties: type: array items: $ref: '#/components/schemas/InputPart' formData: type: object additionalProperties: $ref: '#/components/schemas/InputPart' parts: type: array items: $ref: '#/components/schemas/InputPart' preamble: type: string InvoicesDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' invoices: type: array items: $ref: '#/components/schemas/InvoiceDto' xml: name: Invoices GetInvoiceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoice: $ref: '#/components/schemas/InvoiceDto' xml: name: GetInvoiceResponse GenerateInvoiceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' generateInvoiceResultDto: type: array items: $ref: '#/components/schemas/GenerateInvoiceResultDto' xml: name: GenerateInvoiceResponse GenerateInvoiceResultDto: required: - billingAccountCode - categoryInvoiceAgregates - dueDate - invoiceDate - invoiceMode - invoiceType - taxAggregates type: object properties: invoiceId: type: integer format: int64 invoiceType: type: string billingAccountCode: type: string sellerCode: type: string subscriptionCode: type: string orderNumber: type: string dueDate: type: string format: date-time invoiceDate: type: string format: date-time categoryInvoiceAgregates: type: array xml: wrapped: true items: $ref: '#/components/schemas/CategoryInvoiceAgregateDto' taxAggregates: type: array xml: wrapped: true items: $ref: '#/components/schemas/TaxInvoiceAggregateDto' listInvoiceIdToLink: type: array xml: wrapped: true items: type: integer format: int64 xml: name: invoiceIdToLink invoiceNumber: type: string discount: type: number amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD xmlFilename: type: string xml: type: string pdfFilename: type: string pdf: type: array items: type: string format: byte autoValidation: type: boolean returnXml: type: boolean returnPdf: type: boolean includeBalance: type: boolean recordedInvoiceDto: $ref: '#/components/schemas/RecordedInvoiceDto' netToPay: type: number invoiceMode: type: string enum: - AGGREGATED - DETAILLED customFields: $ref: '#/components/schemas/CustomFieldsDto' dueBalance: type: number checkAlreadySent: type: boolean overrideEmail: type: string sentByEmail: type: boolean temporaryInvoiceNumber: type: string invoiceTypeCode: type: string amount: type: number accountOperationId: type: integer format: int64 draft: type: boolean xml: name: GenerateInvoiceResult GenerateInvoiceRequestDto: required: - invoicingDate type: object properties: targetType: type: string targetCode: type: string billingAccountCode: type: string invoicingDate: type: string format: date-time firstTransactionDate: type: string format: date-time lastTransactionDate: type: string format: date-time filter: $ref: '#/components/schemas/FilterDto' orderNumber: type: string generateXML: type: boolean generatePDF: type: boolean generateAO: type: boolean customFields: $ref: '#/components/schemas/CustomFieldsDto' includeRatedTransactions: type: boolean xml: name: GenerateInvoiceRequest GetXmlInvoiceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' xmlContent: type: string xml: name: GetXmlInvoiceResponse GetXmlInvoiceRequestDto: type: object properties: invoiceNumber: type: string invoiceType: type: string xml: name: GetXmlInvoiceRequest GetPdfInvoiceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' pdfContent: type: array items: type: string format: byte xml: name: GetPdfInvoiceResponse GetPdfInvoiceRequestDto: type: object properties: invoiceNumber: type: string invoiceType: type: string generatePdf: type: boolean xml: name: GetPdfInvoiceRequest CustomerInvoicesResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' customerInvoiceDtoList: type: array items: $ref: '#/components/schemas/InvoiceDto' xml: name: CustomerInvoicesResponse CreateInvoiceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' invoiceId: type: integer format: int64 invoiceNumber: type: string invoiceDate: type: string format: date-time dueDate: type: string format: date-time amountWithoutTax: type: number amountTax: type: number amountWithTax: type: number netToPay: type: number xmlFilename: type: string xmlInvoice: type: string pdfFilename: type: string pdfInvoice: type: array items: type: string format: byte sentByEmail: type: boolean xml: name: CreateInvoiceResponse JobInstanceDto: required: - jobCategory type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean jobCategory: type: string enum: - jobCategoryEnum.rating - jobCategoryEnum.invoicing - jobCategoryEnum.importHierarchy - jobCategoryEnum.dwh - jobCategoryEnum.accountReceivables - jobCategoryEnum.wallet - jobCategoryEnum.utils - jobCategoryEnum.mediation jobTemplate: type: string xml: attribute: true followingJob: type: string parameter: type: string active: type: boolean customFields: $ref: '#/components/schemas/CustomFieldsDto' timerCode: type: string xml: attribute: true runOnNodes: type: string limitToSingleNode: type: boolean verboseReport: type: boolean xml: name: JobInstance JobInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' jobInstanceDto: $ref: '#/components/schemas/JobInstanceDto' xml: name: JobInstanceResponse TimerEntityDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean hour: type: string xml: attribute: true minute: type: string xml: attribute: true second: type: string xml: attribute: true year: type: string xml: attribute: true month: type: string xml: attribute: true dayOfMonth: type: string xml: attribute: true dayOfWeek: type: string xml: attribute: true xml: name: TimerEntity TimerEntityResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' timerEntity: $ref: '#/components/schemas/TimerEntityDto' xml: name: TimerEntityResponse JobExecutionResultDto: required: - done - nbItemsCorrectlyProcessed - nbItemsProcessedWithError - nbItemsProcessedWithWarning type: object properties: id: type: integer format: int64 xml: attribute: true jobInstanceId: type: integer format: int64 runningOnNodes: type: string startDate: type: string format: date-time endDate: type: string format: date-time nbItemsToProcess: type: integer format: int64 nbItemsCorrectlyProcessed: type: integer format: int64 nbItemsProcessedWithWarning: type: integer format: int64 nbItemsProcessedWithError: type: integer format: int64 done: type: boolean report: type: string jobInstanceCode: type: string xml: name: JobExecutionResult JobExecutionResultResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' jobExecutionResultDto: $ref: '#/components/schemas/JobExecutionResultDto' xml: name: JobExecutionResultResponse JobCategoriesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' jobCategories: type: array items: type: string enum: - jobCategoryEnum.rating - jobCategoryEnum.invoicing - jobCategoryEnum.importHierarchy - jobCategoryEnum.dwh - jobCategoryEnum.accountReceivables - jobCategoryEnum.wallet - jobCategoryEnum.utils - jobCategoryEnum.mediation xml: name: JobCategoriesResponse JobInstanceInfoDto: type: object properties: timerName: type: string code: type: string xml: attribute: true lastTransactionDate: type: string format: date-time invoiceDate: type: string format: date-time billingCycle: type: string forceExecution: type: boolean runOnNodes: type: string parameters: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: JobInstanceInfo JobInstanceListDto: type: object properties: listSize: type: integer format: int32 jobInstances: type: array items: $ref: '#/components/schemas/JobInstanceDto' xml: name: JobInstanceListDto JobInstanceListResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' jobInstances: $ref: '#/components/schemas/JobInstanceListDto' xml: name: JobInstanceListResponseDto GetTimerEntityResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' timerEntity: $ref: '#/components/schemas/TimerEntityDto' xml: name: TimerEntityResponse MeveoModuleDtoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' module: $ref: '#/components/schemas/MeveoModuleDto' xml: name: MeveoModuleDtoResponse EmailNotificationDto: required: - classNameFilter - emailFrom - eventTypeFilter - subject type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean classNameFilter: type: string eventTypeFilter: type: string enum: - CREATED - UPDATED - REMOVED - TERMINATED - DISABLED - PROCESSED - REJECTED - REJECTED_CDR - LOGGED_IN - INBOUND_REQ - ENABLED - LOW_BALANCE - FILE_UPLOAD - FILE_DOWNLOAD - FILE_RENAME - FILE_DELETE - COUNTER_DEDUCED - END_OF_TERM - STATUS_UPDATED - RENEWAL_UPDATED elFilter: type: string scriptInstanceCode: type: string scriptParams: type: object additionalProperties: type: string counterTemplate: type: string priority: type: integer format: int32 active: type: boolean runAsync: type: boolean emailFrom: type: string emailToEl: type: string subject: type: string body: type: string htmlBody: type: string sendToMail: type: array items: type: string xml: name: sendToMail xml: name: EmailNotification GetEmailNotificationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' emailNotificationDto: $ref: '#/components/schemas/EmailNotificationDto' xml: name: GetEmailNotificationResponse JobTriggerDto: required: - classNameFilter - eventTypeFilter - jobInstance type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean classNameFilter: type: string eventTypeFilter: type: string enum: - CREATED - UPDATED - REMOVED - TERMINATED - DISABLED - PROCESSED - REJECTED - REJECTED_CDR - LOGGED_IN - INBOUND_REQ - ENABLED - LOW_BALANCE - FILE_UPLOAD - FILE_DOWNLOAD - FILE_RENAME - FILE_DELETE - COUNTER_DEDUCED - END_OF_TERM - STATUS_UPDATED - RENEWAL_UPDATED elFilter: type: string scriptInstanceCode: type: string scriptParams: type: object additionalProperties: type: string counterTemplate: type: string priority: type: integer format: int32 active: type: boolean runAsync: type: boolean jobParams: type: object additionalProperties: type: string jobInstance: type: string xml: name: JobTrigger GetJobTriggerResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' jobTriggerDto: $ref: '#/components/schemas/JobTriggerDto' xml: name: GetJobTriggerResponse ScriptNotificationDto: required: - classNameFilter - eventTypeFilter type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean classNameFilter: type: string eventTypeFilter: type: string enum: - CREATED - UPDATED - REMOVED - TERMINATED - DISABLED - PROCESSED - REJECTED - REJECTED_CDR - LOGGED_IN - INBOUND_REQ - ENABLED - LOW_BALANCE - FILE_UPLOAD - FILE_DOWNLOAD - FILE_RENAME - FILE_DELETE - COUNTER_DEDUCED - END_OF_TERM - STATUS_UPDATED - RENEWAL_UPDATED elFilter: type: string scriptInstanceCode: type: string scriptParams: type: object additionalProperties: type: string counterTemplate: type: string priority: type: integer format: int32 active: type: boolean runAsync: type: boolean xml: name: ScriptNotification NotificationHistoriesDto: type: object properties: notificationHistory: type: array items: $ref: '#/components/schemas/NotificationHistoryDto' xml: name: NotificationHistories NotificationHistoriesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' notificationHistories: $ref: '#/components/schemas/NotificationHistoriesDto' xml: name: NotificationHistoriesResponse NotificationHistoryDto: type: object properties: notification: type: string entityClassName: type: string entityCode: type: string serializedEntity: type: string nbRetry: type: integer format: int32 result: type: string date: type: string format: date-time status: type: string enum: - SENT - TO_RETRY - FAILED - CANCELED xml: name: NotificationHistory InboundRequestDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string contentLength: type: integer format: int32 contentType: type: string protocol: type: string scheme: type: string remoteAddr: type: string remotePort: type: integer format: int32 method: type: string authType: type: string pathInfo: type: string requestURI: type: string responseContentType: type: string responseEncoding: type: string xml: name: InboundRequest InboundRequestsDto: type: object properties: inboundRequest: type: array items: $ref: '#/components/schemas/InboundRequestDto' xml: name: InboutRequests InboundRequestsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' inboundRequests: $ref: '#/components/schemas/InboundRequestsDto' xml: name: InboundRequestsResponse GetScriptNotificationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' notificationDto: $ref: '#/components/schemas/ScriptNotificationDto' xml: name: GetNotificationResponse WebHookDto: required: - classNameFilter - eventTypeFilter - host - httpMethod - page - port type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean classNameFilter: type: string eventTypeFilter: type: string enum: - CREATED - UPDATED - REMOVED - TERMINATED - DISABLED - PROCESSED - REJECTED - REJECTED_CDR - LOGGED_IN - INBOUND_REQ - ENABLED - LOW_BALANCE - FILE_UPLOAD - FILE_DOWNLOAD - FILE_RENAME - FILE_DELETE - COUNTER_DEDUCED - END_OF_TERM - STATUS_UPDATED - RENEWAL_UPDATED elFilter: type: string scriptInstanceCode: type: string scriptParams: type: object additionalProperties: type: string counterTemplate: type: string priority: type: integer format: int32 active: type: boolean runAsync: type: boolean httpProtocol: type: string enum: - HTTPS - HTTP host: type: string port: type: integer format: int32 page: type: string httpMethod: type: string enum: - HTTP_GET - HTTP_POST - HTTP_PUT - HTTP_DELETE username: type: string password: type: string headers: type: object additionalProperties: type: string params: type: object additionalProperties: type: string xml: name: WebhookNotification GetWebHookNotificationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' webhookDto: $ref: '#/components/schemas/WebHookDto' xml: name: GetWebHookNotificationResponse AccountOperationsDto: type: object properties: accountOperation: type: array items: $ref: '#/components/schemas/AccountOperationDto' xml: name: AccountOperationsDto AccountOperationsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' accountOperations: $ref: '#/components/schemas/AccountOperationsDto' xml: name: AccountOperationsResponse MatchOperationRequestDto: type: object properties: customerAccountCode: type: string accountOperations: $ref: '#/components/schemas/AccountOperationsDto' xml: name: MatchOperationRequest UnMatchingOperationRequestDto: type: object properties: customerAccountCode: type: string accountOperationId: type: integer format: int64 xml: name: UnMatchingOperationRequest LitigationRequestDto: type: object properties: customerAccountCode: type: string accountOperationId: type: integer format: int64 xml: name: LitigationRequest MatchedOperationDto: type: object properties: matchingId: type: integer format: int64 matchingType: type: string enum: - A - M - A_TIP - A_DERICT_DEBIT matchingDate: type: string format: date-time matchingAmount: type: number accountOperationId: type: integer format: int64 occCode: type: string occDescription: type: string transactionDate: type: string format: date-time transactionCategory: type: string enum: - DEBIT - CREDIT dueDate: type: string format: date-time transactionAmount: type: number matchedTransactionAmount: type: number matchingStatus: type: string enum: - O - L - P - C - I - R xml: name: MatchedOperation MatchedOperationsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' matchedOperations: type: array xml: wrapped: true items: $ref: '#/components/schemas/MatchedOperationDto' xml: name: MatchedOperationsResponse AccountOperationResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' accountOperation: $ref: '#/components/schemas/AccountOperationDto' CreditCategoryResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' creditCategory: $ref: '#/components/schemas/CreditCategoryDto' CreditCategoriesResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' creditCategories: type: array items: $ref: '#/components/schemas/CreditCategoryDto' DDRequestLotOpDto: required: - fromDueDate - toDueDate type: object properties: fromDueDate: type: string format: date-time toDueDate: type: string format: date-time filterCode: type: string ddrequestOp: type: string enum: - CREATE - PAYMENT - FILE status: type: string enum: - WAIT - PROCESSED - ERROR errorCause: type: string ddRequestBuilderCode: type: string dueDateRageScriptCode: type: string recurrent: type: boolean paymentOrRefundEnum: type: string enum: - PAYMENT - REFUND sellerCode: type: string xml: name: DDRequestLotOp DDRequestLotOpsResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' ddrequestLotOps: type: array xml: wrapped: true items: $ref: '#/components/schemas/DDRequestLotOpDto' xml: name: DDRequestLotOpsResponse DDRequestBuilderDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean type: type: string enum: - CUSTOM - NATIF scriptInstanceCode: type: string implementationClassName: type: string nbOperationPerFile: type: integer format: int64 maxSizeFile: type: integer format: int64 paymentLevel: type: string enum: - AO - CA customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: DDRequestBuilderDto DDRequestBuilderResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' ddRequestBuilders: type: array xml: wrapped: true items: $ref: '#/components/schemas/DDRequestBuilderDto' xml: name: DDRequestBuilderResponse PaymentHostedCheckoutResponseDto: required: - message - status type: object properties: status: type: string enum: - SUCCESS - FAIL errorCode: type: string enum: - ENTITY_DOES_NOT_EXISTS_EXCEPTION - ENTITY_NOT_ALLOWED_EXCEPTION - ENTITY_ALREADY_EXISTS_EXCEPTION - DELETE_REFERENCED_ENTITY_EXCEPTION - MISSING_PARAMETER - INVALID_PARAMETER - INVALID_ENUM_VALUE - DUPLICATE_ACCESS - INSUFFICIENT_BALANCE - GENERIC_API_EXCEPTION - BUSINESS_API_EXCEPTION - AUTHENTICATION_AUTHORIZATION_EXCEPTION - ACTION_FORBIDDEN - INVALID_IMAGE_DATA message: type: string entityId: type: integer format: int64 entityCode: type: string result: $ref: '#/components/schemas/Result' getjson: type: string xml: name: PaymentHostedCheckoutResponseDto Result: type: object properties: hostedCheckoutUrl: type: string ca: type: string returnUrl: type: string PaymentScheduleTemplateDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string startDate: type: string format: date-time amount: type: number calendarCode: type: string paymentLabel: type: string paymentDayInMonth: type: integer format: int32 serviceTemplateCode: type: string advancePaymentInvoiceTypeCode: type: string generateAdvancePaymentInvoice: type: boolean doPayment: type: boolean advancePaymentInvoiceSubCategoryCode: type: string applyAgreement: type: boolean amountEl: type: string filterEl: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: PaymentScheduleTemplateDto PaymentScheduleTemplateResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paymentScheduleTemplateDto: $ref: '#/components/schemas/PaymentScheduleTemplateDto' xml: name: PaymentScheduleTemplateResponseDto PaymentScheduleTemplatesDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' templates: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentScheduleTemplateDto' xml: name: PaymentScheduleTemplatesDto PaymentScheduleInstanceBalanceDto: type: object properties: nbSchedulePaid: type: integer format: int32 nbScheduleIncoming: type: integer format: int32 sumAmountPaid: type: number sumAmountIncoming: type: number xml: name: PaymentScheduleInstanceBalanceDto PaymentScheduleInstanceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string endDate: type: string format: date-time startDate: type: string format: date-time amount: type: number calendarCode: type: string status: type: string enum: - IN_PROGRESS - OBSOLETE - DONE - CANCELLED - TERMINATED statusDate: type: string format: date-time paymentScheduleTemplateCode: type: string paymentDayInMonth: type: integer format: int32 serviceInstanceTemplateCode: type: string serviceInstanceId: type: integer format: int64 subscriptionCode: type: string paymentScheduleInstanceBalanceDto: $ref: '#/components/schemas/PaymentScheduleInstanceBalanceDto' items: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentScheduleInstanceItemDto' customFields: $ref: '#/components/schemas/CustomFieldsDto' xml: name: PaymentScheduleInstanceDto PaymentScheduleInstanceItemDto: type: object properties: id: type: integer format: int64 dueDate: type: string format: date-time requestPaymentDate: type: string format: date-time recordedInvoice: $ref: '#/components/schemas/RecordedInvoiceDto' last: type: boolean paid: type: boolean xml: name: PaymentScheduleInstanceItemDto PaymentScheduleInstanceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paymentScheduleInstanceDto: $ref: '#/components/schemas/PaymentScheduleInstanceDto' xml: name: PaymentScheduleInstanceResponseDto PaymentScheduleInstancesDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' instances: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentScheduleInstanceDto' xml: name: PaymentScheduleInstancesDto CardPaymentMethodDto: required: - paymentMethodType type: object properties: paymentMethodType: type: string xml: attribute: true enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD id: type: integer format: int64 disabled: type: boolean alias: type: string preferred: type: boolean customerAccountCode: type: string info1: type: string info2: type: string info3: type: string info4: type: string info5: type: string bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' mandateIdentification: type: string mandateDate: type: string format: date-time cardType: type: string enum: - VISA - MASTERCARD - AMERICAN_EXPRESS - CB owner: type: string monthExpiration: type: integer format: int32 yearExpiration: type: integer format: int32 tokenId: type: string cardNumber: type: string issueNumber: type: string userId: type: string customerCode: type: string xml: name: CardPaymentMethod CardPaymentMethodTokenDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' cardPaymentMethod: $ref: '#/components/schemas/CardPaymentMethodDto' xml: name: CardPaymentMethodToken PaymentMethodTokenDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paymentMethod: $ref: '#/components/schemas/PaymentMethodDto' xml: name: PaymentMethodToken PaymentMethodTokensDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' paymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodDto' xml: name: PaymentMethodTokens PaymentGatewayDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean type: type: string enum: - CUSTOM - NATIF paymentMethodType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD scriptInstanceCode: type: string implementationClassName: type: string applicationEL: type: string countryCode: type: string tradingCurrencyCode: type: string cardType: type: string enum: - VISA - MASTERCARD - AMERICAN_EXPRESS - CB marchandId: type: string secretKey: type: string apiKey: type: string webhooksSecretKey: type: string webhooksKeyId: type: string profile: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' rumSequence: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' sellerCode: type: string bankCoordinates: $ref: '#/components/schemas/BankCoordinatesDto' xml: name: PaymentGateway PaymentGatewayResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' paymentGateways: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentGatewayDto' xml: name: PaymentGatewayResponse PaymentGatewayRumSequenceDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string genericSequence: $ref: '#/components/schemas/GenericSequenceDto' paymentGateway: type: string xml: name: AuditableEntity CardPaymentMethodTokensDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' cardPaymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/CardPaymentMethodDto' xml: name: CardPaymentMethods PaymentGatewayRumSequenceResponseDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paymentGatewayRumSequence: $ref: '#/components/schemas/PaymentGatewayRumSequenceDto' PaymentHistoriesDto: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' paymentHistories: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentHistoryDto' PaymentHistoryDto: type: object properties: customerAccountCode: type: string sellerCode: type: string customerCode: type: string customerAccountName: type: string operationDate: type: string format: date-time updatedStatusDate: type: string format: date-time lastUpdateDate: type: string format: date-time amountCts: type: integer format: int64 syncStatus: type: string enum: - ACCEPTED - PENDING - REJECTED - ERROR - NOT_PROCESSED asyncStatus: type: string enum: - ACCEPTED - PENDING - REJECTED - ERROR - NOT_PROCESSED status: type: string enum: - ACCEPTED - PENDING - REJECTED - ERROR - NOT_PROCESSED externalPaymentId: type: string errorCode: type: string errorMessage: type: string errorType: type: string enum: - ERROR - REJECT paymentGatewayCode: type: string paymentMethodType: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD paymentMethodName: type: string operationCategory: type: string enum: - DEBIT - CREDIT payment: $ref: '#/components/schemas/AccountOperationDto' refund: $ref: '#/components/schemas/AccountOperationDto' listAoPaid: $ref: '#/components/schemas/AccountOperationsDto' PaymentActionStatus: required: - message - status type: object properties: status: type: string enum: - SUCCESS - FAIL errorCode: type: string enum: - ENTITY_DOES_NOT_EXISTS_EXCEPTION - ENTITY_NOT_ALLOWED_EXCEPTION - ENTITY_ALREADY_EXISTS_EXCEPTION - DELETE_REFERENCED_ENTITY_EXCEPTION - MISSING_PARAMETER - INVALID_PARAMETER - INVALID_ENUM_VALUE - DUPLICATE_ACCESS - INSUFFICIENT_BALANCE - GENERIC_API_EXCEPTION - BUSINESS_API_EXCEPTION - AUTHENTICATION_AUTHORIZATION_EXCEPTION - ACTION_FORBIDDEN - INVALID_IMAGE_DATA message: type: string entityId: type: integer format: int64 entityCode: type: string paymentId: type: integer format: int64 getjson: type: string PaymentDto: type: object properties: type: type: string description: type: string paymentMethod: type: string enum: - CHECK - DIRECTDEBIT - WIRETRANSFER - CARD occTemplateCode: type: string amount: type: number customerAccountCode: type: string reference: type: string bankLot: type: string depositDate: type: string format: date-time bankCollectionDate: type: string format: date-time dueDate: type: string format: date-time transactionDate: type: string format: date-time listOCCReferenceforMatching: type: array items: type: string paymentOrder: type: string fees: type: number comment: type: string customFields: $ref: '#/components/schemas/CustomFieldsDto' toMatching: type: boolean xml: name: Payment CustomerPaymentsResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' paging: $ref: '#/components/schemas/PagingAndFiltering' customerPaymentDtoList: type: array items: $ref: '#/components/schemas/PaymentDto' balance: type: number format: double xml: name: CustomerPaymentsResponse RevenueRecognitionRuleDto: type: object properties: id: type: integer format: int64 xml: attribute: true code: type: string xml: attribute: true description: type: string xml: attribute: true updatedCode: type: string disabled: type: boolean startDelay: type: integer format: int32 startUnit: type: string enum: - revenueRecognitionDelayUnitEnum.MONTH - revenueRecognitionDelayUnitEnum.DAY startEvent: type: string enum: - revenueRecognitionEvent.SUBSCRIPTION_START - revenueRecognitionEvent.SUBSCRIPTION_STOP - revenueRecognitionEvent.INVOICE_DATE - revenueRecognitionEvent.INVOICE_DUE_DATE - revenueRecognitionEvent.SERVICE_PERIOD_START - revenueRecognitionEvent.SERVICE_PERIOD_STOP stopDelay: type: integer format: int32 stopUnit: type: string enum: - revenueRecognitionDelayUnitEnum.MONTH - revenueRecognitionDelayUnitEnum.DAY stopEvent: type: string enum: - revenueRecognitionEvent.SUBSCRIPTION_START - revenueRecognitionEvent.SUBSCRIPTION_STOP - revenueRecognitionEvent.INVOICE_DATE - revenueRecognitionEvent.INVOICE_DUE_DATE - revenueRecognitionEvent.SERVICE_PERIOD_START - revenueRecognitionEvent.SERVICE_PERIOD_STOP script: $ref: '#/components/schemas/ScriptInstanceDto' xml: name: RevenueRecognitionRule RevenueRecognitionRuleDtoResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' revenueRecognitionRuleDto: $ref: '#/components/schemas/RevenueRecognitionRuleDto' xml: name: RevenueRecognitionRuleResponse RevenueRecognitionRuleDtosResponse: type: object properties: actionStatus: $ref: '#/components/schemas/ActionStatus' revenueRecognitionRules: type: array xml: wrapped: true items: $ref: '#/components/schemas/RevenueRecognitionRuleDto' xml: name: AccountOperationsResponse BSMConfigurationDto: type: object properties: code: type: string xml: attribute: true serviceConfiguration: $ref: '#/components/schemas/ServiceConfigurationDto' xml: name: BSMConfiguration BomOfferDto: required: - bomCode - code - name type: object properties: bomCode: type: string xml: attribute: true code: type: string xml: attribute: true name: type: string xml: attribute: true description: type: string xml: attribute: true customFields: type: array xml: name: parameters wrapped: true items: $ref: '#/components/schemas/CustomFieldDto' prefix: type: string servicesToActivate: type: array xml: wrapped: true items: $ref: '#/components/schemas/ServiceConfigurationDto' productsToActivate: type: array xml: wrapped: true items: $ref: '#/components/schemas/ServiceConfigurationDto' businessServiceModels: type: array xml: wrapped: true items: $ref: '#/components/schemas/BSMConfigurationDto' lifeCycleStatusEnum: type: string enum: - IN_STUDY - IN_DESIGN - IN_TEST - ACTIVE - LAUNCHED - RETIRED - OBSOLETE - REJECTED offerTemplateCategories: type: array xml: wrapped: true items: $ref: '#/components/schemas/OfferTemplateCategoryDto' imageBase64: type: string imagePath: type: string xml: name: BomOffer ServiceConfigurationDto: required: - code type: object properties: code: type: string xml: attribute: true description: type: string xml: attribute: true customFields: type: array xml: name: parameters wrapped: true items: $ref: '#/components/schemas/CustomFieldDto' mandatory: type: boolean instantiatedFromBSM: type: boolean match: type: boolean imageBase64: type: string imagePath: type: string xml: name: ServiceConfiguration BsmServiceDto: required: - bsmCode - prefix type: object properties: bsmCode: type: string xml: attribute: true prefix: type: string xml: attribute: true customFields: type: array xml: name: parameters wrapped: true items: $ref: '#/components/schemas/CustomFieldDto' imageBase64: type: string imagePath: type: string xml: name: BsmService BpmProductDto: required: - bpmCode - prefix type: object properties: bpmCode: type: string xml: attribute: true prefix: type: string customFields: type: array xml: name: parameters wrapped: true items: $ref: '#/components/schemas/CustomFieldDto' xml: name: BpmProduct AbstractEntity: type: object properties: id: type: string version: type: string href: type: string name: type: string description: type: string lastUpdate: type: string format: date-time lifecycleStatus: type: string enum: - In Study - In Design - In Test - Active - Launched - Retired - Obsolete - Rejected validFor: $ref: '#/components/schemas/TimeRange' AlterationPrice: type: object properties: percentage: type: string BundledProductReference: type: object properties: id: type: string version: type: string href: type: string name: type: string description: type: string lastUpdate: type: string format: date-time lifecycleStatus: type: string enum: - In Study - In Design - In Test - Active - Launched - Retired - Obsolete - Rejected validFor: $ref: '#/components/schemas/TimeRange' xml: name: BundledProductReference namespace: http://www.tmforum.org CatalogReference: type: object properties: id: type: string version: type: string href: type: string name: type: string description: type: string lastUpdate: type: string format: date-time lifecycleStatus: type: string enum: - In Study - In Design - In Test - Active - Launched - Retired - Obsolete - Rejected validFor: $ref: '#/components/schemas/TimeRange' Note: type: object properties: text: type: string date: type: string format: date-time author: type: string xml: name: Note namespace: http://www.tmforum.org Place: type: object properties: id: type: string href: type: string name: type: string address: $ref: '#/components/schemas/AddressDto' Price: type: object properties: taxIncludedAmount: type: string dutyFreeAmount: type: string taxRate: type: string currencyCode: type: string percentage: type: number Product: type: object properties: id: type: string href: type: string place: $ref: '#/components/schemas/Place' productCharacteristic: type: array items: $ref: '#/components/schemas/ProductCharacteristic' relatedParty: type: array items: $ref: '#/components/schemas/RelatedParty' productRelationship: type: array items: $ref: '#/components/schemas/ProductRelationship' xml: name: Product namespace: http://www.tmforum.org ProductCharacteristic: type: object properties: name: type: string value: type: string xml: name: ProductCharacteristic namespace: http://www.tmforum.org ProductOfferPriceAlteration: type: object properties: name: type: string description: type: string validFor: $ref: '#/components/schemas/TimeRange' priceType: type: string enum: - recurring - one time - usage unitOfMeasure: type: string price: $ref: '#/components/schemas/AlterationPrice' recurringChargePeriod: type: string priceCondition: type: string xml: name: ProductOfferPriceAlteration namespace: http://www.tmforum.org ProductOfferingPrice: type: object properties: priceType: type: string enum: - recurring - one time - usage unitOfMeasure: type: string price: $ref: '#/components/schemas/Price' recurringChargePeriod: type: string productOfferPriceAlteration: $ref: '#/components/schemas/ProductOfferPriceAlteration' name: type: string description: type: string validFor: $ref: '#/components/schemas/TimeRange' ProductOfferingTerm: type: object properties: name: type: string description: type: string duration: type: string validFor: $ref: '#/components/schemas/TimeRange' xml: name: ProductOfferingTerm namespace: http://www.tmforum.org ProductOrder: type: object properties: id: type: string href: type: string externalId: type: string priority: type: string description: type: string category: type: string state: type: string orderDate: type: string format: date-time completionDate: type: string format: date-time requestedStartDate: type: string format: date-time requestedCompletionDate: type: string format: date-time expectedCompletionDate: type: string format: date-time notificationContact: type: string note: type: array items: $ref: '#/components/schemas/Note' relatedParty: type: array items: $ref: '#/components/schemas/RelatedParty' orderItem: type: array items: $ref: '#/components/schemas/ProductOrderItem' customFields: $ref: '#/components/schemas/CustomFieldsDto' paymentMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodDto' dueDateDelayEL: type: string dueDateDelayELSpark: type: string billingCycle: type: string electronicBilling: type: boolean email: type: string mailingType: type: string emailTemplate: type: string ccedEmails: type: string xml: name: ProductOrder namespace: http://www.tmforum.org ProductOrderItem: type: object properties: id: type: string action: type: string state: type: string appointment: type: string billingAccount: type: array items: $ref: '#/components/schemas/BillingAccount' productOffering: $ref: '#/components/schemas/ProductOffering' product: $ref: '#/components/schemas/Product' xml: name: OrderItem namespace: http://www.tmforum.org ProductRelationship: type: object properties: type: type: string product: $ref: '#/components/schemas/Product' xml: name: ProductRelationship namespace: http://www.tmforum.org RelatedParty: type: object properties: id: type: string href: type: string name: type: string validFor: $ref: '#/components/schemas/TimeRange' role: type: string ServiceLevelAgreement: type: object properties: id: type: string href: type: string name: type: string TimeRange: type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time ApplicableDueDateDelayDto: type: object properties: level: type: string enum: - ORDER - CA - BC custom: type: boolean referenceDate: type: string enum: - INVOICE_DATE - INVOICE_GENERATION_DATE - END_OF_MONTH_INVOICE_DATE - NEXT_MONTH_INVOICE_DATE - END_OF_MONTH_INVOICE_GENERATION_DATE - NEXT_MONTH_INVOICE_GENERATION_DATE numberOfDays: type: integer format: int32 dueDateDelayEL: type: string Attachment: type: object properties: id: type: string href: type: string description: type: string type: type: string url: type: string xml: name: Attachment namespace: http://www.tmforum.org Characteristic: type: object properties: name: type: string value: type: string ProductQuote: type: object properties: billingAccount: type: array items: $ref: '#/components/schemas/BillingAccount' state: type: string id: type: string href: type: string externalId: type: string description: type: string category: type: string version: type: string quoteDate: type: string format: date-time effectiveQuoteCompletionDate: type: string format: date-time quoteCompletionDate: type: string format: date-time fulfillmentStartDate: type: string format: date-time notificationContact: type: string validFor: $ref: '#/components/schemas/TimeRange' note: type: array items: $ref: '#/components/schemas/Note' characteristic: type: array items: $ref: '#/components/schemas/Characteristic' customer: $ref: '#/components/schemas/Customer' relatedParty: type: array items: $ref: '#/components/schemas/RelatedParty' agreement: type: array items: $ref: '#/components/schemas/ServiceLevelAgreement' quoteProductOfferingPrice: type: array items: $ref: '#/components/schemas/QuoteProductOfferingPrice' quoteItem: type: array items: $ref: '#/components/schemas/ProductQuoteItem' generatePdf: type: boolean customFields: $ref: '#/components/schemas/CustomFieldsDto' invoices: type: array items: $ref: '#/components/schemas/GenerateInvoiceResultDto' xml: name: Quote namespace: http://www.tmforum.org ProductQuoteItem: type: object properties: id: type: string state: type: string action: type: string appointment: type: string attachment: $ref: '#/components/schemas/Attachment' relatedParty: type: array items: $ref: '#/components/schemas/RelatedParty' note: type: array items: $ref: '#/components/schemas/Note' productOffering: $ref: '#/components/schemas/ProductOffering' product: $ref: '#/components/schemas/Product' itemQuoteProductOfferingPrice: type: array items: $ref: '#/components/schemas/QuoteProductOfferingPrice' billingAccount: type: array items: $ref: '#/components/schemas/BillingAccount' subscriptionPeriod: $ref: '#/components/schemas/TimeRange' consumptionCdr: type: array items: type: string xml: name: QuoteItem namespace: http://www.tmforum.org QuotePriceAlteration: type: object properties: name: type: string description: type: string validFor: $ref: '#/components/schemas/TimeRange' QuoteProductOfferingPrice: type: object properties: priceType: type: string recurringChargePeriod: type: string priceCondition: type: string quotePriceAlteration: $ref: '#/components/schemas/QuotePriceAlteration' price: $ref: '#/components/schemas/Price' securitySchemes: auth: type: http name: auth scheme: basic