Ingest Customer, Contact, and Concern: Case Creation and Update Guidelines

Ingest Customer

Field Sent as Empty	Create Case	Update Case
customerType	The value is determined by verifying the type of customer based on the trading name or a combination of trading name and identifier value.	The value present in the database is retained.
customerGroupType	Set to null.	Made null.
customerExternalSystemIdentifier	Cannot be null (as per Swagger validation). A default SCV customerExternalSystemIdentifier is created.	The values present in the database are retained. For instance, if the database contains three external identifiers—A, B, and C—and the update request includes updates for A and B, along with a new identifier D, then C remains untouched, while A and B are updated, and D is created.
customerStatus	Set to Active by default.	The value present in the database is retained.
url	Set to null.	Set to null.
communicationNumber	Set as empty.	Set as empty (if any value exists in the database, it will be deleted).
invoiceISOLanguageCodePreference	The default language for the country is fetched and set.	The value present in the database is retained.
customerAddress	Cannot be empty.	If any subfield within the customer address is empty, that value will be deleted from the database.
customerIdentifiers	No action taken.	The values present in the database are retained. For example, if the database has three identifiers—A, B, and C—and the update request includes updates for A and B, along with a new identifier D, then C remains untouched, while A and B are updated, and D is created.
customerWebBillLadings	WebBills are created for default brands.	The value present in the database is retained.
customerBrands	No action taken.	The value present in the database is retained.
isSoleProprietor	if not passed, considered as false by default.	If not passed in payload, then it will be considered as false value.

INGEST CONTACT

Field Sent as Null	Create Case	Update Case
isTeamContact	Defaults to false.	The value in the database is retained.
isMasterContact	Changes to true if the customer does not already have a master contact (a primary email is mandatory for all contacts).	The value in the database is retained.
role	Set to CUST_CONT.	The value in the database is retained.
statusCode	Set to A.	The value in the database is retained.
isoLanguageCodePreference	Remains null (support for the default language based on the country is needed).	Deleted (needs to be updated).
communicationNumbers	Remains null.	Existing numbers are deleted if not provided in the payload.
contactBrands	Remains null.	The value in the database is retained unless the isDeletedFlag is set to true.
contactTypes	Remains null.	The value in the database is retained unless the isDeletedFlag is set to true.
documentPreferences	Not applicable for the create scenario.	The value in the database is retained unless the isDeletedFlag is set to true.

Ingest Concern

Here’s a refined table template that enhances clarity and organization:

Ingest Customer

Field	Create Case	Update Case
customerType	The value is determined by verifying the type of customer based on the trading name or a combination of trading name and identifier value.	The value present in the database is retained.
customerGroupType	Set to null.	Made null.
customerExternalSystemIdentifier	Cannot be null (as per Swagger validation). A default SCV customerExternalSystemIdentifier is created.	The values present in the database are retained. For instance, if the database contains three external identifiers—A, B, and C—and the update request includes updates for A and B, along with a new identifier D, then C remains untouched, while A and B are updated, and D is created.
customerStatus	Set to Active by default.	The value present in the database is retained.
url	Set to null.	Set to null.
communicationNumber	Set as empty.	Set as empty (if any value exists in the database, it will be deleted).
invoiceISOLanguageCodePreference	The default language for the country is fetched and set.	The value present in the database is retained.
customerAddress	Cannot be empty.	If any subfield within the customer address is empty, that value will be deleted from the database.
customerIdentifiers	No action taken.	The values present in the database are retained. For example, if the database has three identifiers—A, B, and C—and the update request includes updates for A and B, along with a new identifier D, then C remains untouched, while A and B are updated, and D is created.
customerWebBillLadings	WebBills are created for default brands.	The value present in the database is retained.
customerBrands	No action taken.	The value present in the database is retained.

Ingest Contact

Field	Create Case	Update Case
isTeamContact	Defaults to false.	The value in the database is retained.
isMasterContact	Changes to true if the customer does not already have a master contact (a primary email is mandatory for all contacts).	The value in the database is retained.
role	Set to CUST_CONT.	The value in the database is retained.
statusCode	Set to A.	The value in the database is retained.
isoLanguageCodePreference	Remains null (support for the default language based on the country is needed).	Deleted (needs to be updated).
communicationNumbers	Remains null.	Existing numbers are deleted if not provided in the payload.
contactBrands	Remains null.	The value in the database is retained unless the isDeletedFlag is set to true.
contactTypes	Remains null.	The value in the database is retained unless the isDeletedFlag is set to true.
documentPreferences	Not applicable for the create scenario.	The value in the database is retained unless the isDeletedFlag is set to true.

Ingest Concern

Field	Create Scenario	Update Scenario
ConcernName	Cannot be null or empty; an error is thrown.	Cannot be null or empty; an error is thrown.
isoLanguageCodePreference	Remains null.	The value in the database will be retained.
isConcernActive	Cannot be null or empty; an error is thrown.	Cannot be null or empty; an error is thrown.
customerRelationships	The IS_CONCRN relationship is mandatory; hence, it cannot be null or empty; an error is thrown.	Remains null. No updates are made to relationships.
concernAuditData	Cannot be null or empty; an error is thrown.	Cannot be null or empty; an error is thrown.