The Class UserAccountDto.
| name | data type | constraints | description |
|---|---|---|---|
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| parentUserAccountCode | string | Parent user account. | |
| externalRef1 | string | The external ref 1. | |
| code | string | required | The code |
| userAccountCodes | array of string | Sub user accounts. | |
| externalRef2 | string | The external ref 2. | |
| billingAccount | string | The billing account. | |
| description | string | The description | |
| name | NameDto | The name. | |
| billingAccountDescription | string | The billing account description. | |
| address | AddressDto | The address. | |
| updatedCode | string | The updated code. | |
| customerAccount | string | The customer account. | |
| customerAccountDescription | string | The customer account description. | |
| jobTitle | string | The job title. | |
| customer | string | The customer. | |
| businessAccountModel | BusinessEntityDto | The business account model. | |
| customerDescription | string | The customer description. | |
| subscriptionDate | number | The subscription date. | |
| terminationDate | number | The termination date. | |
| customFields | CustomFieldsDto | The custom fields. | |
| status | AccountStatusEnum | The status. | |
| statusDate | number | The status date. | |
| terminationReason | string | The termination reason. | |
| vatNo | string | The vat no. | |
| isConsumer | boolean | Indicate if this is a consumer | |
| registrationNo | string | The registration no. | |
| infoGdpr | array of GDPRInfoDto | List of GDPR information | |
| subscriptions | SubscriptionsDto | Use for GET / LIST only. | |
| contactInformation | ContactInformationDto | The contact information. | |
| parentUserAccount | UserAccountDto | ||
| userAccounts | array of UserAccountDto | ||
| minimumAmountEl | string | Expression to determine minimum amount value | |
| minimumLabelEl | string | Expression to determine rated transaction description to reach minimum amount value | |
| minimumTargetAccount | string | The billing account code to be used when calculating the min amount billable for Customer and CA. | |
| minimumAmountElSpark | string | Expression to determine minimum amount value - for Spark. | |
| minimumLabelElSpark | string | Expression to determine rated transaction description to reach minimum amount value - for Spark. | |
| minimumChargeTemplate | string | Corresponding to minimum one shot charge template code. | |
| isCompany | boolean | ||
| legalEntityType | TitleDto |
Example
{
"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" : "..."
} ],
"parentUserAccountCode" : "...",
"externalRef1" : "...",
"code" : "...",
"userAccountCodes" : [ "...", "..." ],
"externalRef2" : "...",
"billingAccount" : "...",
"description" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"billingAccountDescription" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"updatedCode" : "...",
"customerAccount" : "...",
"customerAccountDescription" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : {
"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" : "...",
"updatedCode" : "..."
},
"customerDescription" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "CHILD_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" : "..."
}, {
"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",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"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" : "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" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"status" : "CLOSED",
"statusDate" : 12345,
"terminationReason" : "...",
"vatNo" : "...",
"isConsumer" : true,
"registrationNo" : "...",
"infoGdpr" : [ {
"key" : "...",
"value" : { }
}, {
"key" : "...",
"value" : { }
} ],
"subscriptions" : {
"subscription" : [ {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"versionNumber" : 12345,
"updatedCode" : "...",
"nextVersion" : 12345,
"previousVersion" : 12345,
"userAccount" : "...",
"offerTemplate" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"endAgreementDate" : 12345,
"status" : "SUSPENDED",
"statusDate" : 12345,
"validityDate" : 12345,
"customFields" : { },
"accesses" : { },
"services" : { },
"products" : { },
"productInstances" : [ { }, { } ],
"productsToInstantiate" : [ { }, { } ],
"terminationReason" : "...",
"orderNumber" : "...",
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumChargeTemplate" : "...",
"subscribedTillDate" : 12345,
"renewed" : true,
"renewalNotifiedDate" : 12345,
"renewalRule" : { },
"billingCycle" : "...",
"seller" : "...",
"autoEndOfEngagement" : true,
"ratingGroup" : "...",
"electronicBilling" : true,
"email" : "...",
"mailingType" : "...",
"emailTemplate" : "...",
"ccedEmails" : "...",
"discountPlanForInstantiation" : [ { }, { } ],
"discountPlanForTermination" : [ "...", "..." ],
"discountPlanInstance" : [ { }, { } ],
"paymentMethod" : { },
"customerService" : "...",
"salesPersonName" : "..."
}, {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"versionNumber" : 12345,
"updatedCode" : "...",
"nextVersion" : 12345,
"previousVersion" : 12345,
"userAccount" : "...",
"offerTemplate" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"endAgreementDate" : 12345,
"status" : "ACTIVE",
"statusDate" : 12345,
"validityDate" : 12345,
"customFields" : { },
"accesses" : { },
"services" : { },
"products" : { },
"productInstances" : [ { }, { } ],
"productsToInstantiate" : [ { }, { } ],
"terminationReason" : "...",
"orderNumber" : "...",
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumChargeTemplate" : "...",
"subscribedTillDate" : 12345,
"renewed" : true,
"renewalNotifiedDate" : 12345,
"renewalRule" : { },
"billingCycle" : "...",
"seller" : "...",
"autoEndOfEngagement" : true,
"ratingGroup" : "...",
"electronicBilling" : true,
"email" : "...",
"mailingType" : "...",
"emailTemplate" : "...",
"ccedEmails" : "...",
"discountPlanForInstantiation" : [ { }, { } ],
"discountPlanForTermination" : [ "...", "..." ],
"discountPlanInstance" : [ { }, { } ],
"paymentMethod" : { },
"customerService" : "...",
"salesPersonName" : "..."
} ]
},
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
}
},
"parentUserAccount" : {
"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" : "..."
} ],
"parentUserAccountCode" : "...",
"externalRef1" : "...",
"code" : "...",
"userAccountCodes" : [ "...", "..." ],
"externalRef2" : "...",
"billingAccount" : "...",
"description" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"billingAccountDescription" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"updatedCode" : "...",
"customerAccount" : "...",
"customerAccountDescription" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"customerDescription" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"status" : "ACTIVE",
"statusDate" : 12345,
"terminationReason" : "...",
"vatNo" : "...",
"isConsumer" : true,
"registrationNo" : "...",
"infoGdpr" : [ {
"key" : "...",
"value" : { }
}, {
"key" : "...",
"value" : { }
} ],
"subscriptions" : {
"subscription" : [ { }, { } ]
},
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : { }
},
"parentUserAccount" : { },
"userAccounts" : [ { }, { } ],
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumTargetAccount" : "...",
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"legalEntityType" : {
"id" : 12345,
"isCompany" : true,
"auditableField" : [ { }, { } ],
"code" : "...",
"languageDescriptions" : [ { }, { } ],
"description" : "...",
"updatedCode" : "..."
}
},
"userAccounts" : [ {
"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" : "..."
} ],
"parentUserAccountCode" : "...",
"externalRef1" : "...",
"code" : "...",
"userAccountCodes" : [ "...", "..." ],
"externalRef2" : "...",
"billingAccount" : "...",
"description" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"billingAccountDescription" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"updatedCode" : "...",
"customerAccount" : "...",
"customerAccountDescription" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"customerDescription" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"status" : "ACTIVE",
"statusDate" : 12345,
"terminationReason" : "...",
"vatNo" : "...",
"isConsumer" : true,
"registrationNo" : "...",
"infoGdpr" : [ {
"key" : "...",
"value" : { }
}, {
"key" : "...",
"value" : { }
} ],
"subscriptions" : {
"subscription" : [ { }, { } ]
},
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : { }
},
"parentUserAccount" : { },
"userAccounts" : [ { }, { } ],
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumTargetAccount" : "...",
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"legalEntityType" : {
"id" : 12345,
"isCompany" : true,
"auditableField" : [ { }, { } ],
"code" : "...",
"languageDescriptions" : [ { }, { } ],
"description" : "...",
"updatedCode" : "..."
}
}, {
"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" : "..."
} ],
"parentUserAccountCode" : "...",
"externalRef1" : "...",
"code" : "...",
"userAccountCodes" : [ "...", "..." ],
"externalRef2" : "...",
"billingAccount" : "...",
"description" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"billingAccountDescription" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"updatedCode" : "...",
"customerAccount" : "...",
"customerAccountDescription" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"customerDescription" : "...",
"subscriptionDate" : 12345,
"terminationDate" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"status" : "CANCELED",
"statusDate" : 12345,
"terminationReason" : "...",
"vatNo" : "...",
"isConsumer" : true,
"registrationNo" : "...",
"infoGdpr" : [ {
"key" : "...",
"value" : { }
}, {
"key" : "...",
"value" : { }
} ],
"subscriptions" : {
"subscription" : [ { }, { } ]
},
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : { }
},
"parentUserAccount" : { },
"userAccounts" : [ { }, { } ],
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumTargetAccount" : "...",
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"legalEntityType" : {
"id" : 12345,
"isCompany" : true,
"auditableField" : [ { }, { } ],
"code" : "...",
"languageDescriptions" : [ { }, { } ],
"description" : "...",
"updatedCode" : "..."
}
} ],
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumTargetAccount" : "...",
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"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" : "..."
}
}