Equivalent of BusinessEntity in DTO
| name | data type | constraints | description |
|---|---|---|---|
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| externalRef1 | string | The external ref 1. | |
| description | string | The description | |
| externalRef2 | string | The external ref 2. | |
| updatedCode | string | The updated code. | |
| name | NameDto | The name. | |
| address | AddressDto | The address. | |
| jobTitle | string | The job title. | |
| customFields | CustomFieldsDto | The custom fields. | |
| vatNo | string | The vat no. | |
| registrationNo | string | The registration no. | |
| contactInformation | ContactInformationDto | The contact information. | |
| isCompany | boolean | ||
| legalEntityType | TitleDto | ||
| assistantName | string | ||
| assistantPhone | string | ||
| position | string | ||
| company | string | ||
| websiteUrl | string | ||
| importedFrom | string | ||
| importedBy | string | ||
| string | |||
| reference | string | ||
| comment | string | ||
| AddressBookContacts | array of AddressBookContactDto | ||
| isVip | boolean | ||
| isProspect | boolean | ||
| agreedToUA | boolean | ||
| contactPolicy | CommunicationPolicy | ||
| array of string | |||
| contactCategoryCodes | array of string |
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" : "..."
} ],
"code" : "...",
"externalRef1" : "...",
"description" : "...",
"externalRef2" : "...",
"updatedCode" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"jobTitle" : "...",
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "BOOLEAN",
"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" : "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" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "BOOLEAN",
"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",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"vatNo" : "...",
"registrationNo" : "...",
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
}
},
"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" : "..."
},
"assistantName" : "...",
"assistantPhone" : "...",
"position" : "...",
"company" : "...",
"websiteUrl" : "...",
"importedFrom" : "...",
"importedBy" : "...",
"socialIdentifier" : "...",
"reference" : "...",
"comment" : "...",
"AddressBookContacts" : [ {
"addressBook" : {
"property1" : 12345,
"property2" : 12345
},
"position" : "...",
"mainContact" : true,
"id" : 12345,
"customer" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"externalRef1" : "...",
"code" : "...",
"externalRef2" : "...",
"description" : "...",
"customerCategory" : "...",
"name" : { },
"address" : { },
"updatedCode" : "...",
"customerBrand" : "...",
"jobTitle" : "...",
"seller" : "...",
"businessAccountModel" : { },
"mandateIdentification" : "...",
"customFields" : { },
"mandateDate" : 12345,
"customerAccounts" : { },
"vatNo" : "...",
"additionalDetails" : { },
"registrationNo" : "...",
"contactInformation" : { },
"invoicingThreshold" : 12345.0,
"minimumAmountEl" : "...",
"checkThreshold" : "AFTER_DISCOUNT",
"minimumLabelEl" : "...",
"thresholdPerEntity" : true,
"minimumTargetAccount" : "...",
"anonymizationDate" : 12345,
"infoGdpr" : [ { }, { } ],
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"legalEntityType" : { }
}
}, {
"addressBook" : {
"property1" : 12345,
"property2" : 12345
},
"position" : "...",
"mainContact" : true,
"id" : 12345,
"customer" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"externalRef1" : "...",
"code" : "...",
"externalRef2" : "...",
"description" : "...",
"customerCategory" : "...",
"name" : { },
"address" : { },
"updatedCode" : "...",
"customerBrand" : "...",
"jobTitle" : "...",
"seller" : "...",
"businessAccountModel" : { },
"mandateIdentification" : "...",
"customFields" : { },
"mandateDate" : 12345,
"customerAccounts" : { },
"vatNo" : "...",
"additionalDetails" : { },
"registrationNo" : "...",
"contactInformation" : { },
"invoicingThreshold" : 12345.0,
"minimumAmountEl" : "...",
"checkThreshold" : "AFTER_DISCOUNT",
"minimumLabelEl" : "...",
"thresholdPerEntity" : true,
"minimumTargetAccount" : "...",
"anonymizationDate" : 12345,
"infoGdpr" : [ { }, { } ],
"minimumAmountElSpark" : "...",
"minimumLabelElSpark" : "...",
"minimumChargeTemplate" : "...",
"isCompany" : true,
"legalEntityType" : { }
}
} ],
"isVip" : true,
"isProspect" : true,
"agreedToUA" : true,
"contactPolicy" : {
"nbMaxMessagePerWeek" : 12345,
"nbMaxMessagePerMonth" : 12345,
"nbMaxMessagePerDay" : 12345,
"delayMinBetween2messages" : 12345
},
"tags" : [ "...", "..." ],
"contactCategoryCodes" : [ "...", "..." ]
}