/customerManagement/customerAccount/{ID}
Supporetd Methods
GET, PATCH, PUT
Description
The customerAccount service is primarily mapped to the Salesforce Account objects. The service can either be used to retrieved a collection or a specific record (using {ID} at the end of the service). This service is partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped).
| 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.TMF_Contact_Type__c | YES | |
| validFor | NO | ||
| contactName | Account.Contact.Name | YES | |
| partyRoleType | Account__r.Contact.AccountContactRole.Role | NO | |
| contactMedium[] | NO | ||
| 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.] | NO | |
| validFor | NO | ||
| medium | Account.Contact.[emai,phone,etc.] | NO | |
| 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 | ||
| } |