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, PricePlanMatrix, Tag, RecordedInvoice, DiscountPlan, CommercialOrder, ArticleMappingLine, CustomFieldTemplate, GeneralLedger, AddressBook, ContractItem, DDRequestBuilder
Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
code string required, max size: 255, min size: 1
appendGeneratedCode boolean  
auditableFields array of AuditableFieldHistory  
notified boolean  
parentEntity BusinessEntity  
referenceDescription string  
id number  
auditable Auditable  
codeChanged boolean  
transient boolean  
referenceCode string  
descriptionOrCode string  
historized boolean  
version number  
parentEntityType object  
description string max size: 255, min size: 0
descriptionAndCode string  

Example

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