The Class CustomerDto.
| 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 | |
| customerCategory | string | The customer category. | |
| name | NameDto | The name. | |
| address | AddressDto | The address. | |
| updatedCode | string | The updated code. | |
| customerBrand | string | The customer brand. | |
| jobTitle | string | The job title. | |
| seller | string | The seller. | |
| businessAccountModel | BusinessEntityDto | The business account model. | |
| mandateIdentification | string | The mandate identification. | |
| customFields | CustomFieldsDto | The custom fields. | |
| mandateDate | number | The mandate date. | |
| customerAccounts | CustomerAccountsDto | Use for GET / LIST only. | |
| vatNo | string | The vat no. | |
| additionalDetails | AdditionalDetailsDto | ||
| registrationNo | string | The registration no. | |
| contactInformation | ContactInformationDto | The contact information. | |
| invoicingThreshold | number | Invoicing threshold - do not invoice for a lesser amount. | |
| minimumAmountEl | string | Expression to determine minimum amount value | |
| checkThreshold | ThresholdOptionsEnum | The option on how to check the threshold. | |
| minimumLabelEl | string | Expression to determine rated transaction description to reach minimum amount value | |
| thresholdPerEntity | boolean | check the threshold per entity/invoice. | |
| minimumTargetAccount | string | The billing account code to be used when calculating the min amount billable for Customer and CA. | |
| anonymizationDate | number | The termination date. | |
| infoGdpr | array of GDPRInfoDto | information GDPR | |
| 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" : "..."
} ],
"externalRef1" : "...",
"code" : "...",
"externalRef2" : "...",
"description" : "...",
"customerCategory" : "...",
"name" : {
"title" : "...",
"firstName" : "...",
"lastName" : "..."
},
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
},
"updatedCode" : "...",
"customerBrand" : "...",
"jobTitle" : "...",
"seller" : "...",
"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" : "..."
},
"mandateIdentification" : "...",
"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" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"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" : "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" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"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" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"mandateDate" : 12345,
"customerAccounts" : {
"customerAccount" : [ {
"id" : 12345,
"auditableField" : [ { }, { } ],
"externalRef1" : "...",
"code" : "...",
"externalRef2" : "...",
"description" : "...",
"name" : { },
"address" : { },
"updatedCode" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : { },
"currency" : "...",
"language" : "...",
"customFields" : { },
"status" : "ACTIVE",
"creditCategory" : "...",
"dateStatus" : 12345,
"vatNo" : "...",
"dateDunningLevel" : 12345,
"registrationNo" : "...",
"contactInformation" : { },
"minimumAmountEl" : "...",
"balance" : 12345.0,
"minimumLabelEl" : "...",
"totalBalance" : 12345.0,
"totalBalanceExigible" : 12345.0,
"minimumTargetAccount" : "...",
"totalInvoiceBalance" : 12345.0,
"accountBalance" : 12345.0,
"minimumAmountElSpark" : "...",
"creditBalance" : 12345.0,
"minimumLabelElSpark" : "...",
"terminationDate" : 12345,
"dueDateDelayEL" : "...",
"methodOfPayment" : [ { }, { } ],
"minimumChargeTemplate" : "...",
"excludedFromPayment" : true,
"isCompany" : true,
"legalEntityType" : { },
"billingAccounts" : { },
"accountOperations" : [ { }, { } ],
"invoicingThreshold" : 12345.0,
"checkThreshold" : "BEFORE_DISCOUNT",
"thresholdPerEntity" : true,
"infoGdpr" : [ { }, { } ],
"generalClientAccountCode" : "..."
}, {
"id" : 12345,
"auditableField" : [ { }, { } ],
"externalRef1" : "...",
"code" : "...",
"externalRef2" : "...",
"description" : "...",
"name" : { },
"address" : { },
"updatedCode" : "...",
"jobTitle" : "...",
"customer" : "...",
"businessAccountModel" : { },
"currency" : "...",
"language" : "...",
"customFields" : { },
"status" : "ACTIVE",
"creditCategory" : "...",
"dateStatus" : 12345,
"vatNo" : "...",
"dateDunningLevel" : 12345,
"registrationNo" : "...",
"contactInformation" : { },
"minimumAmountEl" : "...",
"balance" : 12345.0,
"minimumLabelEl" : "...",
"totalBalance" : 12345.0,
"totalBalanceExigible" : 12345.0,
"minimumTargetAccount" : "...",
"totalInvoiceBalance" : 12345.0,
"accountBalance" : 12345.0,
"minimumAmountElSpark" : "...",
"creditBalance" : 12345.0,
"minimumLabelElSpark" : "...",
"terminationDate" : 12345,
"dueDateDelayEL" : "...",
"methodOfPayment" : [ { }, { } ],
"minimumChargeTemplate" : "...",
"excludedFromPayment" : true,
"isCompany" : true,
"legalEntityType" : { },
"billingAccounts" : { },
"accountOperations" : [ { }, { } ],
"invoicingThreshold" : 12345.0,
"checkThreshold" : "BEFORE_DISCOUNT",
"thresholdPerEntity" : true,
"infoGdpr" : [ { }, { } ],
"generalClientAccountCode" : "..."
} ]
},
"vatNo" : "...",
"additionalDetails" : {
"companyName" : "...",
"position" : "...",
"instantMessengers" : "..."
},
"registrationNo" : "...",
"contactInformation" : {
"email" : "...",
"phone" : "...",
"mobile" : "...",
"fax" : "...",
"address" : {
"address1" : "...",
"address2" : "...",
"address3" : "...",
"address4" : "...",
"address5" : "...",
"zipCode" : "...",
"city" : "...",
"country" : "...",
"state" : "..."
}
},
"invoicingThreshold" : 12345.0,
"minimumAmountEl" : "...",
"checkThreshold" : "BEFORE_DISCOUNT",
"minimumLabelEl" : "...",
"thresholdPerEntity" : true,
"minimumTargetAccount" : "...",
"anonymizationDate" : 12345,
"infoGdpr" : [ {
"key" : "...",
"value" : { }
}, {
"key" : "...",
"value" : { }
} ],
"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" : "..."
}
}