opencell REST and WS API: AccountDto

The Class AccountDto.

Abstract Type
Subtypes: BillingAccountDto, CustomerDto, UserAccountDto, GetBillingAccountResponseDto, CustomerAccountDto
Implemented Interfaces: Serializable

Properties
name	data type	constraints	description
id	number		The id.
auditableField	array of AuditableFieldDto
externalRef1	string		The external ref 1.
code	string	required	The code
externalRef2	string		The external ref 2.
description	string		The description
name	NameDto		The name.
address	AddressDto		The address.
updatedCode	string		The updated code.
jobTitle	string		The job title.
businessAccountModel	BusinessEntityDto		The business account model.
customFields	CustomFieldsDto		The custom fields.
vatNo	string		The vat no.
registrationNo	string		The registration no.
contactInformation	ContactInformationDto		The contact information.
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

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.

{
  "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" : "..."
  } ],
  "externalRef1" : "...",
  "code" : "...",
  "externalRef2" : "...",
  "description" : "...",
  "name" : {
    "title" : "...",
    "firstName" : "...",
    "lastName" : "..."
  },
  "address" : {
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "address4" : "...",
    "address5" : "...",
    "zipCode" : "...",
    "city" : "...",
    "country" : "...",
    "state" : "..."
  },
  "updatedCode" : "...",
  "jobTitle" : "...",
  "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" : "..."
  },
  "customFields" : {
    "customField" : [ {
      "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_NOT_ANALYZE",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "STRING",
      "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" : "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" : "INDEX",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ]
  },
  "vatNo" : "...",
  "registrationNo" : "...",
  "contactInformation" : {
    "email" : "...",
    "phone" : "...",
    "mobile" : "...",
    "fax" : "...",
    "address" : {
      "address1" : "...",
      "address2" : "...",
      "address3" : "...",
      "address4" : "...",
      "address5" : "...",
      "zipCode" : "...",
      "city" : "...",
      "country" : "...",
      "state" : "..."
    }
  },
  "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" : "..."
  }
}

AccountDto Data Type