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, DunningDocument, OCCTemplate, Order, Campaign, Attribute, ProductOffering, CustomerBrand, CpqQuote, MeveoModule, AccountingArticle, ProductInstance, Calendar, TagType, QueryScheduler, ScriptInstance, FileType, OfferTemplateCategory, BusinessServiceModel, CustomerAccount, Channel, Quote, AutomatedPayment, CustomerCategory, MeveoInstance, 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
transient boolean  
parentEntity BusinessEntity  
version number  
descriptionOrCode string  
auditable Auditable  
parentEntityType object  
descriptionAndCode string  
code string required, max size: 255, min size: 1
codeChanged boolean  
id number  
notified boolean  
description string max size: 255, min size: 0
referenceCode string  
auditableFields array of AuditableFieldHistory  
historized boolean  
referenceDescription string  
appendGeneratedCode boolean  

Example

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