AddressBookDto Data Type

Equivalent of BusinessEntity in DTO

Implemented Interfaces
Serializable
Properties
name data type constraints description
contact array of ContactDto  
id number   The id.
auditableField array of AuditableFieldDto  
code string required The code
description string   The description
updatedCode string   The updated code.

Example

{
  "contact" : [ {
    "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" : "...",
    "externalRef1" : "...",
    "description" : "...",
    "externalRef2" : "...",
    "updatedCode" : "...",
    "name" : {
      "title" : "...",
      "firstName" : "...",
      "lastName" : "..."
    },
    "address" : {
      "address1" : "...",
      "address2" : "...",
      "address3" : "...",
      "address4" : "...",
      "address5" : "...",
      "zipCode" : "...",
      "city" : "...",
      "country" : "...",
      "state" : "..."
    },
    "jobTitle" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "vatNo" : "...",
    "registrationNo" : "...",
    "contactInformation" : {
      "email" : "...",
      "phone" : "...",
      "mobile" : "...",
      "fax" : "...",
      "address" : { }
    },
    "isCompany" : true,
    "legalEntityType" : {
      "id" : 12345,
      "isCompany" : true,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "languageDescriptions" : [ { }, { } ],
      "description" : "...",
      "updatedCode" : "..."
    },
    "assistantName" : "...",
    "assistantPhone" : "...",
    "position" : "...",
    "company" : "...",
    "websiteUrl" : "...",
    "importedFrom" : "...",
    "importedBy" : "...",
    "socialIdentifier" : "...",
    "reference" : "...",
    "comment" : "...",
    "AddressBookContacts" : [ {
      "addressBook" : {
        "property1" : 12345,
        "property2" : 12345
      },
      "position" : "...",
      "mainContact" : true,
      "id" : 12345,
      "customer" : { }
    }, {
      "addressBook" : {
        "property1" : 12345,
        "property2" : 12345
      },
      "position" : "...",
      "mainContact" : true,
      "id" : 12345,
      "customer" : { }
    } ],
    "isVip" : true,
    "isProspect" : true,
    "agreedToUA" : true,
    "contactPolicy" : {
      "nbMaxMessagePerWeek" : 12345,
      "nbMaxMessagePerDay" : 12345,
      "delayMinBetween2messages" : 12345,
      "nbMaxMessagePerMonth" : 12345
    },
    "tags" : [ "...", "..." ],
    "contactCategoryCodes" : [ "...", "..." ]
  }, {
    "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" : "...",
    "externalRef1" : "...",
    "description" : "...",
    "externalRef2" : "...",
    "updatedCode" : "...",
    "name" : {
      "title" : "...",
      "firstName" : "...",
      "lastName" : "..."
    },
    "address" : {
      "address1" : "...",
      "address2" : "...",
      "address3" : "...",
      "address4" : "...",
      "address5" : "...",
      "zipCode" : "...",
      "city" : "...",
      "country" : "...",
      "state" : "..."
    },
    "jobTitle" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "vatNo" : "...",
    "registrationNo" : "...",
    "contactInformation" : {
      "email" : "...",
      "phone" : "...",
      "mobile" : "...",
      "fax" : "...",
      "address" : { }
    },
    "isCompany" : true,
    "legalEntityType" : {
      "id" : 12345,
      "isCompany" : true,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "languageDescriptions" : [ { }, { } ],
      "description" : "...",
      "updatedCode" : "..."
    },
    "assistantName" : "...",
    "assistantPhone" : "...",
    "position" : "...",
    "company" : "...",
    "websiteUrl" : "...",
    "importedFrom" : "...",
    "importedBy" : "...",
    "socialIdentifier" : "...",
    "reference" : "...",
    "comment" : "...",
    "AddressBookContacts" : [ {
      "addressBook" : {
        "property1" : 12345,
        "property2" : 12345
      },
      "position" : "...",
      "mainContact" : true,
      "id" : 12345,
      "customer" : { }
    }, {
      "addressBook" : {
        "property1" : 12345,
        "property2" : 12345
      },
      "position" : "...",
      "mainContact" : true,
      "id" : 12345,
      "customer" : { }
    } ],
    "isVip" : true,
    "isProspect" : true,
    "agreedToUA" : true,
    "contactPolicy" : {
      "nbMaxMessagePerWeek" : 12345,
      "nbMaxMessagePerDay" : 12345,
      "delayMinBetween2messages" : 12345,
      "nbMaxMessagePerMonth" : 12345
    },
    "tags" : [ "...", "..." ],
    "contactCategoryCodes" : [ "...", "..." ]
  } ],
  "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" : "..."
}