GET /customerManagement/customer/{ID}

Partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped)

Retrieving the Customer is a supported service (with partial field alignment). Only GET by ID will be supported.

RESOURCE	ELEMENT	SALESFORCE FIELD	OTB MAPPING
CustomerAccount {
	id	Account.ID	YES
	href	Resource Locator	GENERATED
	name	Account.Name	YES
	description	Account.Description	YES
	status		NO
	accountType	Account.Type	YES
	creditLimit		NO
	pin		NO
	receivableBalance		NO
	customerAccountTaxExemption[]		NO
	customerAccountRelationship[]		NO
	contact[]	Account__r.Contact	YES
	customer		NO
	customerAccountBalance[]		NO
	paymentPlan[]		NO
	lastModified	Account.lastModifiedDate	YES
}
CustomerAccountTaxExemption{			NO
	issuingJurisdiction		NO
	certificateNumber		NO
	reason		NO
	validFor		NO
}
CustomerAccountRelationship{			NO
	relationshipType		NO
	validFor		NO
	customerAccount[]		NO
}
Contact{
	contactType	Account__r.Contact.RecordTypeId.DeveloperName	YES
	validFor		NO
	contactName	Account__r.Contact.Name	YES
	partyRoleType	Account__r.Contact.AccountContactRole.Role	YES
	contactMedium[]		YES
	relatedParty		NO
}
CustomerRef{
	id		NO
	href		NO
	name		NO
	description		NO
}			NO
CustomerAccountBalance{			NO
	type		NO
	amount		NO
	validFor		NO
	status		NO
}
PaymentPlan{			NO
	status		NO
	type		NO
	priority		NO
	amount		NO
	paymentFrequency		NO
	numberOfPayments		NO
	validFor		NO
	paymentMean		NO
}
ValidFor{			NO
	startDateTime		NO
	endDateTime		NO
}
CustomerAccountRef{			NO
	id		NO
	href		NO
	name		NO
	description		NO
	status		NO
}
ContactMedium{
	type	Account.Contact.[emai,phone,etc.]	YES
	validFor		NO
	medium	Account.Contact.[emai,phone,etc.]	YES
	preferred		NO
}
Reference{			NO
	id		NO
	href		NO
	role		NO
	name		NO
}
PaymentMeanRef{			NO
	id		NO
	href		NO
	name		NO
}
Medium {			NO
	city		NO
	country		NO
	emailAddress		NO
	type		NO
	number		NO
	postcode		NO
	stateOrProvince		NO
	streetOne		NO
	streetTwo		NO
}

PUT /customerManagement/customer/{ID}

Partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped)

The PUT operation will only support updating fields (will not support blank fields for example) - similar to PATCH operation

RESOURCE	ELEMENT	SALESFORCE FIELD	OTB MAPPING
CustomerAccount {
	id	Account.ID	NO
	href	Resource Locator	GENERATED
	name	Account.Name	YES
	description	Account.Description	YES
	status		NEW
	accountType	Account.Type	YES
	creditLimit		NEW
	pin		NEW
	receivableBalance		NO
	customerAccountTaxExemption[]		NO
	customerAccountRelationship[]		NO
	contact[]	Account__r.Contact	YES
	customer		NO
	customerAccountBalance[]		NO
	paymentPlan[]		NO
	lastModified	Account.lastModifiedDate	YES
}
CustomerAccountTaxExemption{
	issuingJurisdiction		NO
	certificateNumber		NO
	reason		NO
	validFor		NO
}
CustomerAccountRelationship{
	relationshipType		NO
	validFor		NO
	customerAccount[]		NO
}
Contact{
	contactType	Account__r.Contact.RecordTypeId.DeveloperName	YES
	validFor		NO
	contactName	Account__r.Contact.Name	YES
	partyRoleType	Account__r.Contact.AccountContactRole.Role	YES
	contactMedium[]		YES
	relatedParty		NO
}
CustomerRef{
	id		NO
	href		NO
	name		NO
	description		NO
}
CustomerAccountBalance{
	type		NO
	amount		NO
	validFor		NO
	status		NO
}
PaymentPlan{
	status		NO
	type		NO
	priority		NO
	amount		NO
	paymentFrequency		NO
	numberOfPayments		NO
	validFor		NO
	paymentMean		NO
}
ValidFor{
	startDateTime		NO
	endDateTime		NO
}
CustomerAccountRef{
	id
	href
	name
	description
	status
}
ContactMedium{
	type	Account.Contact.[emai,phone,etc.]	YES
	validFor		NO
	medium	Account.Contact.[emai,phone,etc.]	YES
	preferred		NO
}
Reference{			NO
	id		NO
	href		NO
	role		NO
	name		NO
}
PaymentMeanRef{
	id		NO
	href		NO
	name		NO
}
Medium {
	city		NO
	country		NO
	emailAddress		NO
	type		NO
	number		NO
	postcode		NO
	stateOrProvince		NO
	streetOne		NO
	streetTwo		NO
}

Partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped)

This service is a partial update (similar to the way Salesforce works)

RESOURCE	ELEMENT	SALESFORCE FIELD	OTB MAPPING
CustomerAccount {
	id	Account.ID	NO
	href	Resource Locator	GENERATED
	name	Account.Name	YES
	description	Account.Description	YES
	status		NEW
	accountType	Account.Type	YES
	creditLimit		NEW
	pin		NEW
	receivableBalance		NO
	customerAccountTaxExemption[]		NO
	customerAccountRelationship[]		NO
	contact[]	Account__r.Contact	YES
	customer		NO
	customerAccountBalance[]		NO
	paymentPlan[]		NO
	lastModified	Account.lastModifiedDate	YES
}
CustomerAccountTaxExemption{
	issuingJurisdiction		NO
	certificateNumber		NO
	reason		NO
	validFor		NO
}
CustomerAccountRelationship{
	relationshipType		NO
	validFor		NO
	customerAccount[]		NO
}
Contact{
	contactType	Account__r.Contact.RecordTypeId.DeveloperName	YES
	validFor		NO
	contactName	Account__r.Contact.Name	YES
	partyRoleType	Account__r.Contact.AccountContactRole.Role	YES
	contactMedium[]		YES
	relatedParty		NO
}
CustomerRef{
	id		NO
	href		NO
	name		NO
	description		NO
}
CustomerAccountBalance{
	type		NO
	amount		NO
	validFor		NO
	status		NO
}
PaymentPlan{
	status		NO
	type		NO
	priority		NO
	amount		NO
	paymentFrequency		NO
	numberOfPayments		NO
	validFor		NO
	paymentMean		NO
}
ValidFor{
	startDateTime		NO
	endDateTime		NO
}
CustomerAccountRef{
	id
	href
	name
	description
	status
}
ContactMedium{
	type	Account.Contact.[emai,phone,etc.]	YES
	validFor		NO
	medium	Account.Contact.[emai,phone,etc.]	YES
	preferred		NO
}
Reference{			NO
	id		NO
	href		NO
	role		NO
	name		NO
}
PaymentMeanRef{
	id		NO
	href		NO
	name		NO
}
Medium {
	city		NO
	country		NO
	emailAddress		NO
	type		NO
	number		NO
	postcode		NO
	stateOrProvince		NO
	streetOne		NO
	streetTwo		NO
}

Partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped)

POST requests are supported to create accounts (This is an atomic creation request - i.e. can only create a single account at a time)

RESOURCE	ELEMENT	SALESFORCE FIELD	OTB MAPPING
CustomerAccount {
	id	Account.ID	NO
	href	Resource Locator	GENERATED
	name	Account.Name	YES
	description	Account.Description	YES
	status		NEW
	accountType	Account.Type	YES
	creditLimit		NEW
	pin		NEW
	receivableBalance		NO
	customerAccountTaxExemption[]		NO
	customerAccountRelationship[]		NO
	contact[]	Account__r.Contact	YES
	customer		NO
	customerAccountBalance[]		NO
	paymentPlan[]		NO
	lastModified	Account.lastModifiedDate	YES
}
CustomerAccountTaxExemption{
	issuingJurisdiction		NO
	certificateNumber		NO
	reason		NO
	validFor		NO
}
CustomerAccountRelationship{
	relationshipType		NO
	validFor		NO
	customerAccount[]		NO
}
Contact{
	contactType	Account__r.Contact.RecordTypeId.DeveloperName	YES
	validFor		NO
	contactName	Account__r.Contact.Name	YES
	partyRoleType	Account__r.Contact.AccountContactRole.Role	YES
	contactMedium[]		YES
	relatedParty		NO
}
CustomerRef{
	id		NO
	href		NO
	name		NO
	description		NO
}
CustomerAccountBalance{
	type		NO
	amount		NO
	validFor		NO
	status		NO
}
PaymentPlan{
	status		NO
	type		NO
	priority		NO
	amount		NO
	paymentFrequency		NO
	numberOfPayments		NO
	validFor		NO
	paymentMean		NO
}
ValidFor{
	startDateTime		NO
	endDateTime		NO
}
CustomerAccountRef{			NO
	id		NO
	href		NO
	name		NO
	description		NO
	status		NO
}
ContactMedium{
	type	Account.Contact.[emai,phone,etc.]	YES
	validFor		NO
	medium	Account.Contact.[emai,phone,etc.]	YES
	preferred		NO
}
Reference{			NO
	id		NO
	href		NO
	role		NO
	name		NO
}
PaymentMeanRef{
	id		NO
	href		NO
	name		NO
}
Medium {
	city		NO
	country		NO
	emailAddress		NO
	type		NO
	number		NO
	postcode		NO
	stateOrProvince		NO
	streetOne		NO
	streetTwo		NO
}