The Class CRMAccountHierarchyDto.
| name | data type | description |
|---|---|---|
| crmAccountType | string | The crm account type. |
| crmParentCode | string | The crm parent code. |
| code | string | The code. |
| description | string | The description. |
| externalRef1 | string | The external ref 1. |
| externalRef2 | string | The external ref 2. |
| name | NameDto | The name. |
| address | AddressDto | The address. |
| contactInformation | ContactInformationDto | The contact information. |
| jobTitle | string | The job title. |
| language | string | The language. |
| terminationReason | string | The termination reason. |
| subscriptionDate | number | The subscription date. |
| terminationDate | number | The termination date. |
| customerCategory | string | The customer category. |
| customerBrand | string | The customer brand. |
| registrationNo | string | The registration no. |
| vatNo | string | The vat no. |
| |
|
|
| mandateIdentification | string | The mandate identification. |
| mandateDate | number | The mandate date. |
| currency | string | The currency. |
| caStatus | CustomerAccountStatusEnum | The ca status. |
| creditCategory | string | The credit category. |
| dateStatus | number | The date status. |
| dateDunningLevel | number | The date dunning level. |
| dunningLevel | DunningLevelEnum | The dunning level. |
| methodOfPayment | array of PaymentMethodDto | The payment methods. |
| isCompany | boolean | |
| |
|
|
| |
|
|
| |
|
|
| billingCycle | string | The billing cycle. |
| country | string | The country. |
| nextInvoiceDate | number | The next invoice date. |
| electronicBilling | boolean | The electronic billing. |
| baStatus | AccountStatusEnum | The ba status. |
| string | The email. | |
| invoicingThreshold | number | The invoicing threshold. |
| uaStatus | AccountStatusEnum | The ua status. |
| cfToAdd | CustomFieldDto | The cf to add. |
| cfMapToAdd | CustomFieldDto | The cf map to add. |
| customFields | CustomFieldsDto | The custom fields. |
| 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 |
| mailingType | string | Mailing type. |
| emailTemplate | string | Email Template code. |
| ccedEmails | string | a list of emails separated by comma. |
| 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. |
| checkThreshold | ThresholdOptionsEnum | The option on how to check the threshold for billingAccount. |
| 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. |
| taxCategoryCode | string | |
| legalEntityType | TitleDto | |
| 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. |
Example
{
"crmAccountType" : "...",
"crmParentCode" : "...",
"code" : "...",
"description" : "...",
"externalRef1" : "...",
"externalRef2" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
}
},
"jobTitle" : "...",
"language" : "...",
"terminationReason" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"customerCategory" : "...",
"customerBrand" : "...",
"registrationNo" : "...",
"vatNo" : "...",
"mandateIdentification" : "...",
"mandateDate" : 12345,
"currency" : "...",
"caStatus" : "ACTIVE",
"creditCategory" : "...",
"dateStatus" : 12345,
"dateDunningLevel" : 12345,
"dunningLevel" : "R2",
"methodOfPayment" : [ {
"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" : "CB",
"owner" : "...",
"monthExpiration" : 12345,
"yearExpiration" : 12345,
"tokenId" : "...",
"cardNumber" : "...",
"issueNumber" : "...",
"userId" : "...",
"email" : "...",
"referenceDocumentCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"paymentMethodType" : "WIRETRANSFER",
"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" : [ { }, { } ]
}
} ],
"isCompany" : true,
"billingCycle" : "...",
"country" : "...",
"nextInvoiceDate" : 12345,
"electronicBilling" : true,
"baStatus" : "CLOSED",
"email" : "...",
"invoicingThreshold" : 12345.0,
"uaStatus" : "CLOSED",
"cfToAdd" : {
"code" : "...",
"description" : "...",
"fieldType" : "DATE",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ {
"value" : {
"booleanValue" : true
}
}, {
"value" : {
"booleanValue" : true
}
} ],
"mapValue" : {
"property1" : {
"value" : {
"booleanValue" : true
}
},
"property2" : {
"value" : {
"booleanValue" : true
}
}
},
"entityReferenceValue" : {
"classname" : "...",
"classnameCode" : "...",
"code" : "..."
},
"indexType" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : {
"singleValue" : "...",
"listValue" : [ "...", "..." ],
"mapValue" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"urlReferenceValue" : {
"url" : "...",
"regexp" : "...",
"label" : "...",
"length" : 12345
},
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
},
"cfMapToAdd" : {
"code" : "...",
"description" : "...",
"fieldType" : "BOOLEAN",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ {
"value" : {
"booleanValue" : true
}
}, {
"value" : {
"booleanValue" : true
}
} ],
"mapValue" : {
"property1" : {
"value" : {
"booleanValue" : true
}
},
"property2" : {
"value" : {
"booleanValue" : true
}
}
},
"entityReferenceValue" : {
"classname" : "...",
"classnameCode" : "...",
"code" : "..."
},
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : {
"singleValue" : "...",
"listValue" : [ "...", "..." ],
"mapValue" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"urlReferenceValue" : {
"url" : "...",
"regexp" : "...",
"label" : "...",
"length" : 12345
},
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
},
"customFields" : {
"customField" : [ {
"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" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "CHECKBOX_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" : "..."
} ],
"inheritedCustomField" : [ {
"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" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "MULTI_VALUE",
"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" : "..."
} ]
},
"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" : "PERCENTAGE",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
} ],
"expressionEl" : "...",
"discountPlanType" : "INVOICE_LINE",
"status" : "EXPIRED",
"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" : "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" : "PERCENTAGE",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
} ],
"expressionEl" : "...",
"discountPlanType" : "PRODUCT",
"status" : "INACTIVE",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ {
"code" : "...",
"entityClass" : "..."
}, {
"code" : "...",
"entityClass" : "..."
} ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
} ],
"discountPlanForTermination" : [ "...", "..." ],
"mailingType" : "...",
"emailTemplate" : "...",
"ccedEmails" : "...",
"minimumAmountEl" : {
"customerMinimumAmountEl" : "...",
"customerMinimumLabelEl" : "...",
"customerMinimumTargetAccount" : "...",
"customerAccountMinimumAmountEl" : "...",
"customerAccountMinimumLabelEl" : "...",
"customerAccountMinimumTargetAccount" : "...",
"billingAccountMinimumAmountEl" : "...",
"billingAccountMinimumLabelEl" : "...",
"userAccountMinimumAmountEl" : "...",
"userAccountMinimumLabelEl" : "...",
"customerMinimumChargeTemplate" : "...",
"customerAccountMinimumChargeTemplate" : "...",
"billingAccountMinimumChargeTemplate" : "...",
"userAccountMinimumChargeTemplate" : "..."
},
"customerInvoicingThreshold" : 12345.0,
"customerAccountInvoicingThreshold" : 12345.0,
"checkThreshold" : "AFTER_DISCOUNT",
"customerAccountCheckThreshold" : "AFTER_DISCOUNT",
"customerCheckThreshold" : "POSITIVE_RT",
"taxCategoryCode" : "...",
"legalEntityType" : {
"id" : 12345,
"isCompany" : true,
"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" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"description" : "...",
"updatedCode" : "..."
},
"thresholdPerEntity" : true,
"customerAccountThresholdPerEntity" : true,
"customerThresholdPerEntity" : true
}