Data Model
All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data.
This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.
Namespace "ns0"
Namespace URI: | (default namespace) |
XSD: | ns0.xsd |
Data Elements
- AccessesResponse
- Account
- AccountHierarchy
- AccountOperation
- AccountOperationsDto
- AccountOperationsResponse
- ActionStatus
- ActivateServicesRequest
- Address
- ApplyOneShotChargeInstanceRequest
- BillingAccountsResponse
- BillingCycle
- BillingCycles
- Calendar
- CalendarDateInterval
- Calendars
- CdrList
- CdrReservationResponse
- ChargeTemplate
- CounterTemplate
- Countries
- Country
- Currencies
- Currency
- CustomerAccountsResponse
- CustomerBrand
- CustomerBrands
- CustomerCategories
- CustomerCategory
- CustomerHierarchy
- CustomerInvoicesResponse
- CustomerListResponse
- CustomerPaymentsResponse
- CustomersResponse
- CustomField
- CustomFields
- DayInYear
- dunningInclusionExclusion
- EmailNotification
- FindWalletOperationsResponse
- GetAccessResponse
- GetBillingAccountResponse
- GetBillingCycleResponse
- GetCalendarResponse
- GetChargeTemplateResponse
- GetCounterTemplateResponse
- GetCountryResponse
- GetCurrencyResponse
- GetCustomerAccountResponse
- GetCustomerConfigurationResponse
- GetCustomerResponse
- GetEmailNotificationResponse
- GetInvoiceCategoryResponse
- GetInvoiceSubCategoryCountryResponse
- GetInvoiceSubCategoryResponse
- GetInvoicingConfigurationResponse
- GetLanguageResponse
- GetNotificationResponse
- GetOccTemplateResponse
- GetOfferTemplateResponse
- GetOneShotChargeTemplateResponse
- GetPricePlanResponse
- GetProviderResponse
- GetRecurringChargeTemplateResponse
- GetSellerResponse
- GetServiceTemplateResponse
- GetSubscriptionResponse
- GetTaxResponse
- GetTradingConfigurationResponse
- GetTriggeredEdrResponse
- GetUsageChargeTemplateResponse
- GetUserAccountResponse
- GetUserResponse
- GetWebHookNotificationResponse
- HourInDay
- InboundRequest
- InboundRequestsResponse
- InboutRequests
- InstantiateServicesRequest
- Invoice
- InvoiceCategories
- InvoiceCategory
- InvoiceSubCategories
- InvoiceSubCategory
- InvoiceSubCategoryCountry
- Language
- LanguageDescription
- Languages
- MatchingAmount
- MatchingAmounts
- MatchingCode
- MatchingCodes
- Name
- Notification
- NotificationHistories
- NotificationHistoriesResponse
- NotificationHistory
- OCCTemplate
- OfferTemplate
- OneShotChargeTemplate
- OneShotChargeTemplate
- OneShotChargeTemplateList
- Payment
- PdfInvoiceResponse
- PdfInvoiceResponse
- PricePlan
- Provider
- RatedTransaction
- RecurringChargeTemplate
- SellerCodesResponse
- SellerResponse
- ServicesToActivate
- ServicesToInstantiate
- ServiceTemplate
- ServiceTemplates
- ServiceToActivate
- ServiceToInstantiate
- ServiceUsageChargeTemplate
- SubCategoryInvoiceAgregate
- SubscriptionsResponse
- Tax
- Taxes
- TerminateSubscriptionRequest
- TerminateSubscriptionServicesRequest
- TerminationReasonDto
- TerminationReasonDto
- TimerInfo
- Title
- Titles
- TriggeredEdrTemplate
- TriggeredEdrTemplates
- UsageChargeTemplate
- User
- UserAccountsResponse
- WalletBalance
- WalletOperation
- WalletReservation
- WebhookNotification
Data Types
- Access
- Accesses
- accessesResponseDto
- accountDto
- accountHierarchyDto
- accountOperationDto
- accountOperationsDto
- accountOperationsResponseDto
- actionStatus
- actionStatusEnum
- activateServicesRequestDto
- addressDto
- applyOneShotChargeInstanceRequestDto
- BankCoordinates
- baseDto
- baseResponse
- baseServiceChargeTemplateDto
- BillingAccount
- BillingAccounts
- billingAccountsResponseDto
- billingCycleDto
- billingCyclesDto
- calendarDateIntervalDto
- calendarDto
- calendarsDto
- cdrListDto
- cdrReservationResponseDto
- ChargeInstanceOverride
- ChargeInstanceOverrides
- chargeTemplateDto
- ContactInformation
- counterTemplateDto
- countriesDto
- countryDto
- currenciesDto
- currencyDto
- Customer
- CustomerAccount
- CustomerAccounts
- customerAccountsResponseDto
- customerBrandDto
- customerBrandsDto
- customerCategoriesDto
- customerCategoryDto
- customerHierarchyDto
- customerInvoicesResponse
- customerListResponse
- customerPaymentsResponse
- Customers
- customersResponseDto
- customFieldDto
- customFieldsDto
- dayInYearDto
- dunningInclusionExclusionDto
- emailNotificationDto
- findWalletOperationsResponseDto
- getAccessResponseDto
- getBillingAccountResponseDto
- getBillingCycleResponse
- getCalendarResponse
- getChargeTemplateResponseDto
- getCounterTemplateResponseDto
- getCountryResponse
- getCurrencyResponse
- getCustomerAccountResponseDto
- getCustomerConfigurationResponseDto
- getCustomerResponseDto
- getEmailNotificationResponseDto
- getInvoiceCategoryResponse
- getInvoiceSubCategoryCountryResponse
- getInvoiceSubCategoryResponse
- getInvoicingConfigurationResponseDto
- getLanguageResponse
- getNotificationResponseDto
- getOccTemplateResponseDto
- getOfferTemplateResponseDto
- getOneShotChargeTemplateResponseDto
- getPricePlanResponseDto
- getProviderResponse
- getRecurringChargeTemplateResponseDto
- getSellerResponse
- getServiceTemplateResponseDto
- getSubscriptionResponseDto
- getTaxResponse
- getTradingConfigurationResponseDto
- getTriggeredEdrResponseDto
- getUsageChargeTemplateResponseDto
- getUserAccountResponseDto
- getUserResponse
- getWebHookNotificationResponseDto
- hourInDayDto
- inboundRequestDto
- inboundRequestsDto
- inboundRequestsResponseDto
- instantiateServicesRequestDto
- invoiceCategoriesDto
- invoiceCategoryDto
- invoiceCreationResponse
- invoiceDto
- invoiceSubCategoriesDto
- invoiceSubCategoryCountryDto
- invoiceSubCategoryDto
- languageDescriptionDto
- languageDto
- languagesDto
- matchingAmountDto
- matchingAmountsDto
- matchingCodeDto
- matchingCodesDto
- nameDto
- notificationDto
- notificationHistoriesDto
- notificationHistoriesResponseDto
- notificationHistoryDto
- notificationHistoryStatusEnum
- occTemplateDto
- offerTemplateDto
- oneShotChargeTemplateDto
- oneShotChargeTemplateWithPriceDto
- oneShotChargeTemplateWithPriceListDto
- OtherCreditAndCharge
- paymentDto
- pdfInvoiceResponse
- pricePlanDto
- providerDto
- ratedTransactionDto
- RecordedInvoice
- recurringChargeTemplateDto
- RejectedPayment
- Seller
- sellerCodesResponseDto
- sellerResponseDto
- Sellers
- ServiceChargeTemplateRecurring
- ServiceChargeTemplateRecurrings
- ServiceChargeTemplateSubscription
- ServiceChargeTemplateSubscriptions
- ServiceChargeTemplateTermination
- ServiceChargeTemplateTerminations
- ServiceChargeTemplateUsages
- ServiceInstance
- ServiceInstances
- servicesToActivateDto
- servicesToInstantiateDto
- serviceTemplateDto
- serviceTemplatesDto
- serviceToActivateDto
- serviceToInstantiateDto
- serviceUsageChargeTemplateDto
- subCategoryInvoiceAgregateDto
- Subscription
- Subscriptions
- subscriptionsResponseDto
- taxDto
- taxesDto
- terminateSubscriptionRequestDto
- terminateSubscriptionServicesRequestDto
- terminationReasonDto
- terminationReasonsDto
- timerInfoDto
- titleDto
- titlesDto
- triggeredEdrTemplateDto
- triggeredEdrTemplatesDto
- usageChargeTemplateDto
- UserAccount
- UserAccounts
- userAccountsResponseDto
- userDto
- walletBalanceDto
- walletOperationDto
- walletReservationDto
- Wallets
- webhookNotificationDto