BillingRule Data Type

Implemented Interfaces
Serializable
Properties
name data type description
id number
transient boolean
priority number
version number
contract Contract
active boolean
invoicedBACodeEL string
historized boolean
disabled boolean
auditableFields array of AuditableFieldHistory
criteriaEL string
notified boolean
auditable Auditable

Example

{
  "id" : 12345,
  "transient" : true,
  "priority" : 12345,
  "version" : 12345,
  "contract" : {
    "customer" : {
      "minimumLabelEl" : "...",
      "addressbook" : { },
      "parentEntityType" : { },
      "appendGeneratedCode" : true,
      "minimumAmountEl" : "...",
      "checkThreshold" : "POSITIVE_RT",
      "primaryContact" : { },
      "customerCategory" : { },
      "codeChanged" : true,
      "isCompany" : true,
      "jobTitle" : "...",
      "auditable" : { },
      "minimumArticle" : { },
      "contactInformation" : { },
      "legalEntityType" : { },
      "invoicingThreshold" : 12345.0,
      "contactInformationNullSafe" : { },
      "thresholdPerEntity" : true,
      "customerBrand" : { },
      "descriptionOrCode" : "...",
      "registrationNo" : "...",
      "providerContact" : "...",
      "seller" : { },
      "minimumChargeTemplate" : { },
      "code" : "...",
      "accountType" : "...",
      "notified" : true,
      "referenceDescription" : "...",
      "descriptionAndCode" : "...",
      "parentEntity" : { },
      "vatNo" : "...",
      "anonymized" : true,
      "id" : 12345,
      "transient" : true,
      "cfAccumulatedValues" : { },
      "version" : 12345,
      "defaultLevel" : true,
      "externalRef2" : "...",
      "cfValues" : { },
      "uuid" : "...",
      "referenceCode" : "...",
      "additionalDetails" : { },
      "auditableFields" : [ { }, { } ],
      "name" : { },
      "historized" : true,
      "address" : { },
      "minimumTargetAccount" : { },
      "businessAccountModel" : { },
      "customerAccounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "externalRef1" : "...",
      "contracts" : [ { }, { } ],
      "anonymizationDate" : 12345,
      "counters" : {
        "property1" : { },
        "property2" : { }
      },
      "description" : "..."
    },
    "parentEntityType" : { },
    "historized" : true,
    "descriptionAndCode" : "...",
    "contractDuration" : 12345,
    "contractDate" : 12345,
    "referenceCode" : "...",
    "cfAccumulatedValues" : {
      "valuesByCode" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "values" : {
        "property1" : { },
        "property2" : { }
      },
      "newVersionedCFValuePeriods" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "encrypted" : true
    },
    "status" : "CLOSED",
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "active" : true,
    "seller" : {
      "businessAccountModel" : { },
      "parentEntity" : { },
      "uuid" : "...",
      "vatNo" : "...",
      "contactInformationNullSafe" : { },
      "customerSequences" : [ { }, { } ],
      "registrationNo" : "...",
      "historized" : true,
      "name" : { },
      "minimumChargeTemplate" : { },
      "appendGeneratedCode" : true,
      "description" : "...",
      "auditable" : { },
      "tradingCountry" : { },
      "parentCFEntities" : [ { }, { } ],
      "invoiceTypeSequence" : [ { }, { } ],
      "minimumAmountEl" : "...",
      "providerContact" : "...",
      "tradingLanguage" : { },
      "accountType" : "...",
      "auditableFields" : [ { }, { } ],
      "referenceCode" : "...",
      "defaultLevel" : true,
      "descriptionAndCode" : "...",
      "isCompany" : true,
      "tradingCurrency" : { },
      "primaryContact" : { },
      "minimumLabelEl" : "...",
      "transient" : true,
      "externalRef1" : "...",
      "seller" : { },
      "codeChanged" : true,
      "referenceDescription" : "...",
      "code" : "...",
      "legalEntityType" : { },
      "jobTitle" : "...",
      "contactInformation" : { },
      "parentEntityType" : { },
      "minimumArticle" : { },
      "descriptionOrCode" : "...",
      "generalLedger" : { },
      "externalRef2" : "...",
      "cfAccumulatedValues" : { },
      "legalType" : "...",
      "version" : 12345,
      "contracts" : [ { }, { } ],
      "paymentGateways" : [ { }, { } ],
      "legalText" : "...",
      "cfValues" : { },
      "address" : { },
      "id" : 12345,
      "notified" : true
    },
    "endDate" : 12345,
    "description" : "...",
    "transient" : true,
    "beginDate" : 12345,
    "renewal" : true,
    "contractItems" : [ {
      "referenceCode" : "...",
      "serviceTemplate" : { },
      "offerTemplate" : { },
      "product" : { },
      "descriptionAndCode" : "...",
      "active" : true,
      "disabled" : true,
      "pricePlan" : { },
      "notified" : true,
      "historized" : true,
      "code" : "...",
      "uuid" : "...",
      "contract" : { },
      "auditableFields" : [ { }, { } ],
      "auditable" : { },
      "parentCFEntities" : [ { }, { } ],
      "parentEntity" : { },
      "cfAccumulatedValues" : { },
      "version" : 12345,
      "cfValues" : { },
      "chargeTemplate" : { },
      "amountWithoutTax" : 12345.0,
      "referenceDescription" : "...",
      "transient" : true,
      "parentEntityType" : { },
      "description" : "...",
      "rate" : 12345.0,
      "codeChanged" : true,
      "descriptionOrCode" : "...",
      "contractRateType" : "FIXED",
      "id" : 12345,
      "appendGeneratedCode" : true
    }, {
      "referenceCode" : "...",
      "serviceTemplate" : { },
      "offerTemplate" : { },
      "product" : { },
      "descriptionAndCode" : "...",
      "active" : true,
      "disabled" : true,
      "pricePlan" : { },
      "notified" : true,
      "historized" : true,
      "code" : "...",
      "uuid" : "...",
      "contract" : { },
      "auditableFields" : [ { }, { } ],
      "auditable" : { },
      "parentCFEntities" : [ { }, { } ],
      "parentEntity" : { },
      "cfAccumulatedValues" : { },
      "version" : 12345,
      "cfValues" : { },
      "chargeTemplate" : { },
      "amountWithoutTax" : 12345.0,
      "referenceDescription" : "...",
      "transient" : true,
      "parentEntityType" : { },
      "description" : "...",
      "rate" : 12345.0,
      "codeChanged" : true,
      "descriptionOrCode" : "...",
      "contractRateType" : "PERCENTAGE",
      "id" : 12345,
      "appendGeneratedCode" : true
    } ],
    "parentCFEntities" : [ {
      "cfAccumulatedValuesNullSafe" : { },
      "cfValuesAsValues" : {
        "property1" : { },
        "property2" : { }
      },
      "cfAccumulatedValues" : { },
      "CFValuesCopy" : { },
      "cfValuesNullSafe" : { },
      "cfValues" : { },
      "dirtyCF" : true,
      "uuid" : "...",
      "parentCFEntities" : [ { }, { } ]
    }, {
      "cfAccumulatedValuesNullSafe" : { },
      "cfValuesAsValues" : {
        "property1" : { },
        "property2" : { }
      },
      "cfAccumulatedValues" : { },
      "CFValuesCopy" : { },
      "cfValuesNullSafe" : { },
      "cfValues" : { },
      "dirtyCF" : true,
      "uuid" : "...",
      "parentCFEntities" : [ { }, { } ]
    } ],
    "referenceDescription" : "...",
    "disabled" : true,
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "RENEWAL",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "RENEWAL",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "version" : 12345,
    "cfValues" : {
      "valuesByCode" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "values" : {
        "property1" : { },
        "property2" : { }
      },
      "newVersionedCFValuePeriods" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "encrypted" : true
    },
    "id" : 12345,
    "billingAccount" : {
      "accountType" : "...",
      "billingRun" : { },
      "statusDate" : 12345,
      "address" : { },
      "name" : { },
      "exoneratedFromtaxes" : true,
      "invoicingThreshold" : 12345.0,
      "usersAccounts" : [ { }, { } ],
      "emailTemplate" : { },
      "cfValues" : { },
      "ccedEmails" : "...",
      "minimumLabelEl" : "...",
      "descriptionOrCode" : "...",
      "historized" : true,
      "brAmountWithoutTax" : 12345.0,
      "cfAccumulatedValues" : { },
      "discountPlan" : { },
      "counters" : {
        "property1" : { },
        "property2" : { }
      },
      "minRatedTransactions" : [ { }, { } ],
      "mailingType" : "AUTO",
      "jobTitle" : "...",
      "checkThreshold" : "POSITIVE_RT",
      "taxCategoryResolved" : { },
      "notified" : true,
      "registrationNo" : "...",
      "contactInformation" : { },
      "defaultLevel" : true,
      "brAmountWithTax" : 12345.0,
      "electronicBilling" : true,
      "contracts" : [ { }, { } ],
      "contactInformationNullSafe" : { },
      "discountRate" : 12345.0,
      "code" : "...",
      "tradingLanguage" : { },
      "uuid" : "...",
      "tradingCurrency" : { },
      "parentCFEntities" : [ { }, { } ],
      "externalRef2" : "...",
      "vatNo" : "...",
      "description" : "...",
      "tradingCountry" : { },
      "status" : "CLOSED",
      "businessAccountModel" : { },
      "thresholdPerEntity" : true,
      "minimumInvoiceSubCategory" : { },
      "externalRef1" : "...",
      "invoices" : [ { }, { } ],
      "parentUserAccounts" : [ { }, { } ],
      "minimumAmountEl" : "...",
      "id" : 12345,
      "totalInvoicingAmountWithTax" : 12345.0,
      "terminationDate" : 12345,
      "primaryContact" : { },
      "subscriptionDate" : 12345,
      "auditableFields" : [ { }, { } ],
      "totalInvoicingAmountWithoutTax" : 12345.0,
      "totalInvoicingAmountTax" : 12345.0,
      "discountPlanInstances" : [ { }, { } ],
      "isCompany" : true,
      "parentEntity" : { },
      "nextInvoiceDate" : 12345,
      "seller" : { },
      "minimumArticle" : { },
      "version" : 12345,
      "minInvoiceLines" : [ { }, { } ],
      "transient" : true,
      "paymentMethod" : { },
      "billingCycle" : { },
      "parentEntityType" : { },
      "codeChanged" : true,
      "tags" : [ { }, { } ],
      "terminationReason" : { },
      "legalEntityType" : { },
      "referenceDescription" : "...",
      "providerContact" : "...",
      "invoicePrefix" : "...",
      "auditable" : { },
      "customerAccount" : { },
      "taxCategory" : { },
      "appendGeneratedCode" : true,
      "minimumChargeTemplate" : { },
      "descriptionAndCode" : "...",
      "allDiscountPlanInstances" : [ { }, { } ],
      "referenceCode" : "..."
    },
    "billingRules" : [ {
      "id" : 12345,
      "transient" : true,
      "priority" : 12345,
      "version" : 12345,
      "contract" : { },
      "active" : true,
      "invoicedBACodeEL" : "...",
      "historized" : true,
      "disabled" : true,
      "auditableFields" : [ { }, { } ],
      "criteriaEL" : "...",
      "notified" : true,
      "auditable" : { }
    }, {
      "id" : 12345,
      "transient" : true,
      "priority" : 12345,
      "version" : 12345,
      "contract" : { },
      "active" : true,
      "invoicedBACodeEL" : "...",
      "historized" : true,
      "disabled" : true,
      "auditableFields" : [ { }, { } ],
      "criteriaEL" : "...",
      "notified" : true,
      "auditable" : { }
    } ],
    "codeChanged" : true,
    "notified" : true,
    "statusDate" : 12345,
    "parentEntity" : {
      "codeChanged" : true,
      "notified" : true,
      "descriptionOrCode" : "...",
      "description" : "...",
      "version" : 12345,
      "historized" : true,
      "transient" : true,
      "id" : 12345,
      "parentEntityType" : { },
      "parentEntity" : { },
      "referenceCode" : "...",
      "code" : "...",
      "auditableFields" : [ { }, { } ],
      "auditable" : { },
      "descriptionAndCode" : "...",
      "appendGeneratedCode" : true,
      "referenceDescription" : "..."
    },
    "descriptionOrCode" : "...",
    "customerAccount" : {
      "dueBalance" : "...",
      "providerContact" : "...",
      "preferredPaymentMethodType" : "PAYPAL",
      "id" : 12345,
      "dateStatus" : 12345,
      "appendGeneratedCode" : true,
      "legalEntityType" : { },
      "billingAccounts" : [ { }, { } ],
      "password" : "...",
      "counters" : {
        "property1" : { },
        "property2" : { }
      },
      "contactInformationNullSafe" : { },
      "minimumLabelEl" : "...",
      "externalRef2" : "...",
      "status" : "ACTIVE",
      "actionDunnings" : [ { }, { } ],
      "contracts" : [ { }, { } ],
      "stripePaymentMethods" : [ { }, { } ],
      "dunningDocuments" : [ { }, { } ],
      "excludedFromPayment" : true,
      "auditableFields" : [ { }, { } ],
      "checkThreshold" : "AFTER_DISCOUNT",
      "jobTitle" : "...",
      "description" : "...",
      "contactInformation" : { },
      "tradingCurrency" : { },
      "generalClientAccount" : { },
      "paymentMethods" : [ { }, { } ],
      "primaryContact" : { },
      "parentEntityType" : { },
      "registrationNo" : "...",
      "noMoreValidCard" : true,
      "auditable" : { },
      "referenceCode" : "...",
      "minimumChargeTemplate" : { },
      "customer" : { },
      "transient" : true,
      "seller" : { },
      "dateDunningLevel" : 12345,
      "thresholdPerEntity" : true,
      "vatNo" : "...",
      "creditCategory" : { },
      "preferredPaymentMethod" : { },
      "accountType" : "...",
      "minimumAmountEl" : "...",
      "invoicingThreshold" : 12345.0,
      "isCompany" : true,
      "defaultLevel" : true,
      "descriptionOrCode" : "...",
      "descriptionAndCode" : "...",
      "checkPaymentMethods" : [ { }, { } ],
      "uuid" : "...",
      "businessAccountModel" : { },
      "paypalPaymentMethods" : [ { }, { } ],
      "dunningLevel" : "R4",
      "parentCFEntities" : [ { }, { } ],
      "historized" : true,
      "cfValues" : { },
      "codeChanged" : true,
      "notified" : true,
      "version" : 12345,
      "tradingLanguage" : { },
      "dueDateDelayEL" : "...",
      "code" : "...",
      "parentEntity" : { },
      "minimumTargetAccount" : { },
      "auditedMethodPayments" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "addressbook" : { },
      "DDPaymentMethods" : [ { }, { } ],
      "externalRef1" : "...",
      "paymentPlans" : [ { }, { } ],
      "name" : { },
      "accountOperations" : [ { }, { } ],
      "referenceDescription" : "...",
      "wirePaymentMethods" : [ { }, { } ],
      "cfAccumulatedValues" : { },
      "minimumArticle" : { },
      "address" : { }
    },
    "code" : "...",
    "uuid" : "...",
    "appendGeneratedCode" : true
  },
  "active" : true,
  "invoicedBACodeEL" : "...",
  "historized" : true,
  "disabled" : true,
  "auditableFields" : [ {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "STATUS",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  }, {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "STATUS",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  } ],
  "criteriaEL" : "...",
  "notified" : true,
  "auditable" : {
    "creator" : "...",
    "updater" : "...",
    "updated" : 12345,
    "lastModified" : 12345,
    "lastUser" : "...",
    "created" : 12345
  }
}