AccountHierarchyDto Data Type

The Class AccountHierarchyDto.

Implemented Interfaces
Serializable
Properties
name data type description
email string The email.
customerId string Replaced by customerCode. If customerId parameter is present then its value is use.
customerCode string Customer Code.
sellerCode string Seller Code.
customerBrandCode string SelCustomer Brand Code.
customerCategoryCode string Custmork Code.
currencyCode string Currency Code.
countryCode string SeCountry Cideller Code.
languageCode string Language Code.
titleCode string Title Code.
firstName string First Code.
lastName string Last Name.
birthDate number Birth Date.
phoneNumber string Phone Number.
billingCycleCode string Billing Cycle Code.
address1 string Address 1.
address2 string Address 2.
address3 string Address 3.
zipCode string Zip Code.
state string State.
city string City.
usePrefix boolean True if use prefix.
invoicingThreshold number Invoicing Threshold.
taxCategoryCode string Account tax category code - overrides the value from a customer category
discountPlanForInstantiation array of DiscountPlanDto List of discount plans. Use in instantiating DiscountPlanInstance.
discountPlanForTermination array of string List of discount plans to be disassociated in a BillingAccount
customFields CustomFieldsDto Custom Fiends.
methodOfPayment array of PaymentMethodDto The payment methods.
paymentMethod number Field was deprecated in 4.6 version. Use 'paymentMethods' field instead
jobTitle string Job title. Account Entity
registrationNo string Registration number. CUST.
checkThreshold ThresholdOptionsEnum The option on how to check the threshold.
customerAccountCheckThreshold ThresholdOptionsEnum The option on how to check the threshold for customer Account.
customerCheckThreshold ThresholdOptionsEnum The option on how to check the threshold for customer.
vatNo string VAT. CUST.
mailingType string The mailing Type.
emailTemplate string Email template.
ccedEmails string CC Emails.
minimumAmountEl MinimumAmountElDto An object to store minimumAmount data for each account.
customerInvoicingThreshold number The invoicing threshold for the customer .
customerAccountInvoicingThreshold number The invoicing threshold for the customer account.
thresholdPerEntity boolean check the threshold per entity/invoice for BA.
customerAccountThresholdPerEntity boolean check the threshold per entity/invoice for customerAccount.
customerThresholdPerEntity boolean check the threshold per entity/invoice for customer.
generalClientAccountCode string General client account code

Example

{
  "email" : "...",
  "customerCode" : "...",
  "sellerCode" : "...",
  "customerBrandCode" : "...",
  "customerCategoryCode" : "...",
  "currencyCode" : "...",
  "countryCode" : "...",
  "languageCode" : "...",
  "titleCode" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "birthDate" : 12345,
  "phoneNumber" : "...",
  "billingCycleCode" : "...",
  "address1" : "...",
  "address2" : "...",
  "address3" : "...",
  "zipCode" : "...",
  "state" : "...",
  "city" : "...",
  "usePrefix" : true,
  "invoicingThreshold" : 12345.0,
  "taxCategoryCode" : "...",
  "discountPlanForInstantiation" : [ {
    "disabled" : true,
    "id" : 12345,
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "code" : "...",
    "description" : "...",
    "startDate" : 12345,
    "updatedCode" : "...",
    "endDate" : 12345,
    "defaultDuration" : 12345,
    "durationUnit" : "DAY",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "discountPlanItem" : [ {
      "code" : "...",
      "discountPlanCode" : "...",
      "invoiceCategoryCode" : "...",
      "invoiceSubCategoryCode" : "...",
      "expressionEl" : "...",
      "disabled" : true,
      "discountPlanItemType" : "FIXED",
      "discountValue" : 12345.0,
      "discountValueEL" : "...",
      "targetAccountingArticleCodes" : [ "...", "..." ],
      "pricePlanMatrixCode" : "...",
      "customFields" : { },
      "allowToNegate" : true,
      "description" : "...",
      "priority" : 12345,
      "accountingArticleCode" : "...",
      "applyByArticle" : true,
      "sequence" : 12345,
      "lastDiscount" : true
    }, {
      "code" : "...",
      "discountPlanCode" : "...",
      "invoiceCategoryCode" : "...",
      "invoiceSubCategoryCode" : "...",
      "expressionEl" : "...",
      "disabled" : true,
      "discountPlanItemType" : "FIXED",
      "discountValue" : 12345.0,
      "discountValueEL" : "...",
      "targetAccountingArticleCodes" : [ "...", "..." ],
      "pricePlanMatrixCode" : "...",
      "customFields" : { },
      "allowToNegate" : true,
      "description" : "...",
      "priority" : 12345,
      "accountingArticleCode" : "...",
      "applyByArticle" : true,
      "sequence" : 12345,
      "lastDiscount" : true
    } ],
    "expressionEl" : "...",
    "discountPlanType" : "QUOTE",
    "status" : "IN_USE",
    "statusDate" : 12345,
    "initialQuantity" : 12345,
    "usedQuantity" : 12345,
    "applicationLimit" : 12345,
    "applicationFilterEL" : "...",
    "incompatibleDiscountPlans" : [ { }, { } ],
    "applicableEntities" : [ {
      "code" : "...",
      "entityClass" : "..."
    }, {
      "code" : "...",
      "entityClass" : "..."
    } ],
    "applicableOnOverriddenPrice" : true,
    "sequence" : 12345,
    "applicableOnDiscountedPrice" : true
  }, {
    "disabled" : true,
    "id" : 12345,
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "code" : "...",
    "description" : "...",
    "startDate" : 12345,
    "updatedCode" : "...",
    "endDate" : 12345,
    "defaultDuration" : 12345,
    "durationUnit" : "DAY",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "discountPlanItem" : [ {
      "code" : "...",
      "discountPlanCode" : "...",
      "invoiceCategoryCode" : "...",
      "invoiceSubCategoryCode" : "...",
      "expressionEl" : "...",
      "disabled" : true,
      "discountPlanItemType" : "PERCENTAGE",
      "discountValue" : 12345.0,
      "discountValueEL" : "...",
      "targetAccountingArticleCodes" : [ "...", "..." ],
      "pricePlanMatrixCode" : "...",
      "customFields" : { },
      "allowToNegate" : true,
      "description" : "...",
      "priority" : 12345,
      "accountingArticleCode" : "...",
      "applyByArticle" : true,
      "sequence" : 12345,
      "lastDiscount" : true
    }, {
      "code" : "...",
      "discountPlanCode" : "...",
      "invoiceCategoryCode" : "...",
      "invoiceSubCategoryCode" : "...",
      "expressionEl" : "...",
      "disabled" : true,
      "discountPlanItemType" : "PERCENTAGE",
      "discountValue" : 12345.0,
      "discountValueEL" : "...",
      "targetAccountingArticleCodes" : [ "...", "..." ],
      "pricePlanMatrixCode" : "...",
      "customFields" : { },
      "allowToNegate" : true,
      "description" : "...",
      "priority" : 12345,
      "accountingArticleCode" : "...",
      "applyByArticle" : true,
      "sequence" : 12345,
      "lastDiscount" : true
    } ],
    "expressionEl" : "...",
    "discountPlanType" : "OFFER",
    "status" : "IN_USE",
    "statusDate" : 12345,
    "initialQuantity" : 12345,
    "usedQuantity" : 12345,
    "applicationLimit" : 12345,
    "applicationFilterEL" : "...",
    "incompatibleDiscountPlans" : [ { }, { } ],
    "applicableEntities" : [ {
      "code" : "...",
      "entityClass" : "..."
    }, {
      "code" : "...",
      "entityClass" : "..."
    } ],
    "applicableOnOverriddenPrice" : true,
    "sequence" : 12345,
    "applicableOnDiscountedPrice" : true
  } ],
  "discountPlanForTermination" : [ "...", "..." ],
  "customFields" : {
    "customField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "TEXT_AREA",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "ENTITY",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX_NOT_ANALYZE",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ],
    "inheritedCustomField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "DOUBLE",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "LIST",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX_NOT_ANALYZE",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ]
  },
  "methodOfPayment" : [ {
    "paymentMethodType" : "STRIPE",
    "id" : 12345,
    "disabled" : true,
    "alias" : "...",
    "preferred" : true,
    "customerAccountCode" : "...",
    "info1" : "...",
    "info2" : "...",
    "info3" : "...",
    "info4" : "...",
    "info5" : "...",
    "bankCoordinates" : {
      "bankCode" : "...",
      "branchCode" : "...",
      "accountNumber" : "...",
      "key" : "...",
      "iban" : "...",
      "bic" : "...",
      "accountOwner" : "...",
      "bankName" : "...",
      "bankId" : "...",
      "issuerNumber" : "...",
      "issuerName" : "...",
      "ics" : "..."
    },
    "mandateIdentification" : "...",
    "mandateDate" : 12345,
    "cardType" : "MASTERCARD",
    "owner" : "...",
    "monthExpiration" : 12345,
    "yearExpiration" : 12345,
    "tokenId" : "...",
    "cardNumber" : "...",
    "issueNumber" : "...",
    "userId" : "...",
    "email" : "...",
    "referenceDocumentCode" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    }
  }, {
    "paymentMethodType" : "DIRECTDEBIT",
    "id" : 12345,
    "disabled" : true,
    "alias" : "...",
    "preferred" : true,
    "customerAccountCode" : "...",
    "info1" : "...",
    "info2" : "...",
    "info3" : "...",
    "info4" : "...",
    "info5" : "...",
    "bankCoordinates" : {
      "bankCode" : "...",
      "branchCode" : "...",
      "accountNumber" : "...",
      "key" : "...",
      "iban" : "...",
      "bic" : "...",
      "accountOwner" : "...",
      "bankName" : "...",
      "bankId" : "...",
      "issuerNumber" : "...",
      "issuerName" : "...",
      "ics" : "..."
    },
    "mandateIdentification" : "...",
    "mandateDate" : 12345,
    "cardType" : "AMERICAN_EXPRESS",
    "owner" : "...",
    "monthExpiration" : 12345,
    "yearExpiration" : 12345,
    "tokenId" : "...",
    "cardNumber" : "...",
    "issueNumber" : "...",
    "userId" : "...",
    "email" : "...",
    "referenceDocumentCode" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    }
  } ],
  "jobTitle" : "...",
  "registrationNo" : "...",
  "checkThreshold" : "AFTER_DISCOUNT",
  "customerAccountCheckThreshold" : "BEFORE_DISCOUNT",
  "customerCheckThreshold" : "POSITIVE_RT",
  "vatNo" : "...",
  "mailingType" : "...",
  "emailTemplate" : "...",
  "ccedEmails" : "...",
  "minimumAmountEl" : {
    "customerMinimumAmountEl" : "...",
    "customerMinimumLabelEl" : "...",
    "customerMinimumTargetAccount" : "...",
    "customerAccountMinimumAmountEl" : "...",
    "customerAccountMinimumLabelEl" : "...",
    "customerAccountMinimumTargetAccount" : "...",
    "billingAccountMinimumAmountEl" : "...",
    "billingAccountMinimumLabelEl" : "...",
    "userAccountMinimumAmountEl" : "...",
    "userAccountMinimumLabelEl" : "...",
    "customerMinimumChargeTemplate" : "...",
    "customerAccountMinimumChargeTemplate" : "...",
    "billingAccountMinimumChargeTemplate" : "...",
    "userAccountMinimumChargeTemplate" : "..."
  },
  "customerInvoicingThreshold" : 12345.0,
  "customerAccountInvoicingThreshold" : 12345.0,
  "thresholdPerEntity" : true,
  "customerAccountThresholdPerEntity" : true,
  "customerThresholdPerEntity" : true,
  "generalClientAccountCode" : "..."
}