BusinessEntity Data Type

Abstract Type
Subtypes
Subscription, RevenueRecognitionRule, OrderArticleLine, OneShotChargeTemplate, OrderItem, EmailTemplate, CustomerSequence, ProductLine, AutomatedRefund, OrderOffer, AccountEntity, ProductTemplate, CreditCategory, PaymentScheduleInstance, PaymentScheduleTemplate, FileFormat, PaymentGateway, TradingCountry, UsageChargeInstance, ReportQuery, SubscriptionChargeInstance, RecurringChargeTemplate, Customer, Tax, DocumentCategory, TaxCategory, DunningActionInstance, ChargeTemplate, UnitOfMeasure, OrderPrice, InvoiceValidationRule, DunningDocument, OCCTemplate, Order, Campaign, Attribute, ProductOffering, CustomerBrand, CpqQuote, MeveoModule, AccountingArticle, ProductInstance, Calendar, TagType, QueryScheduler, ScriptInstance, FileType, OfferTemplateCategory, BusinessServiceModel, CustomerAccount, Channel, Quote, AutomatedPayment, CustomerCategory, MeveoInstance, ContactCategory, PricePlanMatrixColumn, ArticleMapping, InvoicingPlanItem, ChargeInstance, CounterPeriod, Media, Workflow, TimerEntity, RecurringChargeInstance, OrderLot, CommercialRuleHeader, DunningLevel, InvoiceSequence, BillingAccount, BillingCycle, Title, OrderType, JobInstance, Payment, Contract, Sequence, ServiceTemplate, AccountingScheme, AccountOperation, ProductChargeInstance, BusinessAccountModel, PaymentGatewayRumSequence, InvoicingPlan, ProductChargeTemplate, GroupedAttributes, UserAccount, Journal, Seller, QuoteLot, SubscriptionTerminationReason, Product, OfferTemplate, Contact, BusinessProductModel, BusinessOfferModel, TaxClass, DunningAction, RecordedInvoiceCatAgregate, CounterTemplate, ServiceInstance, TerminationChargeInstance, WalletInstance, ScriptInstanceCategory, Document, InvoiceCategory, AccountingCode, InvoiceType, ArticleFamily, RejectedPayment, PaymentPlan, DigitalResource, MessageVariableValue, WalletTemplate, DunningSettings, ServiceCharge, InvoiceSubCategory, QuoteOffer, CounterInstance, Refund, ProviderContact, TriggeredEDRTemplate, Tag, PricePlanMatrix, RecordedInvoice, DiscountPlan, CommercialOrder, ArticleMappingLine, CustomFieldTemplate, GeneralLedger, AddressBook, ContractItem, DDRequestBuilder
Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
description string max size: 255, min size: 0
code string required, max size: 255, min size: 1
version number  
parentEntity BusinessEntity  
id number  
transient boolean  
historized boolean  
descriptionOrCode string  
auditable Auditable  
referenceDescription string  
referenceCode string  
codeChanged boolean  
parentEntityType object  
notified boolean  
appendGeneratedCode boolean  
descriptionAndCode string  
auditableFields array of AuditableFieldHistory  

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "description" : "...",
  "code" : "...",
  "version" : 12345,
  "parentEntity" : {
    "description" : "...",
    "code" : "...",
    "version" : 12345,
    "parentEntity" : { },
    "id" : 12345,
    "transient" : true,
    "historized" : true,
    "descriptionOrCode" : "...",
    "auditable" : {
      "created" : 12345,
      "updater" : "...",
      "lastModified" : 12345,
      "updated" : 12345,
      "lastUser" : "...",
      "creator" : "..."
    },
    "referenceDescription" : "...",
    "referenceCode" : "...",
    "codeChanged" : true,
    "parentEntityType" : { },
    "notified" : true,
    "appendGeneratedCode" : true,
    "descriptionAndCode" : "...",
    "auditableFields" : [ {
      "notified" : true,
      "historized" : true,
      "notfiable" : true,
      "historable" : true,
      "auditType" : "RENEWAL",
      "fieldName" : "...",
      "currentState" : { },
      "previousState" : { }
    }, {
      "notified" : true,
      "historized" : true,
      "notfiable" : true,
      "historable" : true,
      "auditType" : "STATUS",
      "fieldName" : "...",
      "currentState" : { },
      "previousState" : { }
    } ]
  },
  "id" : 12345,
  "transient" : true,
  "historized" : true,
  "descriptionOrCode" : "...",
  "auditable" : {
    "created" : 12345,
    "updater" : "...",
    "lastModified" : 12345,
    "updated" : 12345,
    "lastUser" : "...",
    "creator" : "..."
  },
  "referenceDescription" : "...",
  "referenceCode" : "...",
  "codeChanged" : true,
  "parentEntityType" : { },
  "notified" : true,
  "appendGeneratedCode" : true,
  "descriptionAndCode" : "...",
  "auditableFields" : [ {
    "notified" : true,
    "historized" : true,
    "notfiable" : true,
    "historable" : true,
    "auditType" : "RENEWAL",
    "fieldName" : "...",
    "currentState" : { },
    "previousState" : { }
  }, {
    "notified" : true,
    "historized" : true,
    "notfiable" : true,
    "historable" : true,
    "auditType" : "RENEWAL",
    "fieldName" : "...",
    "currentState" : { },
    "previousState" : { }
  } ]
}