/billingAccount
[POST]
This usecase is used to create billing account in Liberate.
URL
https://nonprod.cwp.esb.cloud.lla.com/test/sfdc-ux-cwp/sfdc-ux/v1/{businessId}/billingAccount
url Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Expected values: PA | Y |
| name | type | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request syntax: correlationId: uuid:cwc--, example: correlationId: f058ebd6-02f7-4d3f-942e-904344e8cde5 | Y |
#Body Definations
| Name | Type | Description | Required |
|---|
| name | string | Billing Account Name | Y |
| relatedParty[].id | string | AccountId | Y |
| relatedParty[].name | string | Related Party Name | Y |
| relatedParty[].@type | string | Default: Organization | Y |
| relatedParty[].id | string | Salesforce Record Id | Y |
| relatedParty[].name | string | Default: recordId | Y |
| relatedParty[].@type | string | Default: Salesforce | Y |
| contact[].contactMedium[].preferred | boolean | Preferred Contact Indicator | Y |
| contact[].contactMedium[].characteristic.city | string | City | Y |
| contact[].contactMedium[].characteristic.country | string | Country | Y |
| contact[].contactMedium[].characteristic.street1 | string | Address Line 1 | Y |
| contact[].contactMedium[].characteristic.street2 | string | Address Line 2 | Y |
| contact[].contactMedium[].characteristic.postCode | string | Postal Code | Y |
| contact[].contactMedium[].characteristic.stateOrProvince | string | State or Province | Y |
| contact[].contactMedium[].preferred | boolean | Preferred Contact Indicator | Y |
| contact[].contactMedium[].mediumType | string | Default: Address | Y |
| contact[].contactMedium[].characteristic.emailAddress | string | Email Address | Y |
| contact[].contactMedium[].mediumType | string | Default: Email | Y |
| contact[].contactMedium[].preferred | boolean | Preferred Contact Indicator | Y |
| contact[].contactMedium[].characteristic.phoneNumber | string | Phone Number | Y |
| contact[].contactMedium[].characteristic.contactType | string | Contact Type (e.g., home) | Y |
| contact[].contactMedium[].mediumType | string | Default: Telephone | Y |
| @type | string | Default: BillingAccount | Y |
| accountType | string | Account Type | Y |
| characteristic[].name | string | Characteristic Name | Y |
| characteristic[].value | string | Characteristic Value | Y |
| characteristic[].valueType | string | Characteristic Value Type | Y |
| characteristic[].name | string | Default: billStatusArea | Y |
| characteristic[].value | string | Bill Status Area | Y |
| characteristic[].valueType | string | Default: String | Y |
| characteristic[].name | string | Default: regionCode | Y |
| characteristic[].value | string | Region Code | Y |
| characteristic[].valueType | string | Default: String | Y |
cURL request
{
"name": "222 Calle Jerónimo de la Ossa ",
"relatedParty": [
{
"id": "35330705",
"name": "11 Calle Merlin SubOrder48 Bil"
},
{
"id": "0010100000RhiN9AAJ",
"@type": "Salesforce",
"name": "recordId"
}
],
"contact": [
{
"contactMedium": [
{
"preferred": false,
"characteristic": {
"city": "Jamaika",
"country": "Jamaika",
"street1": "222 Calle ",
"street2": "Jerónimo de la Ossa",
"postCode": "1234",
"stateOrProvince": "Jamaika"
},
"mediumType": "Address"
},
{
"preferred": false,
"characteristic": {
"emailAddress": "rajinireddy08@x.com"
},
"mediumType": "Email"
},
{
"preferred": false,
"characteristic": {
"phoneNumber": "456789",
"contactType": "home"
},
"mediumType": "Telephone"
}
]
}
],
"@type": "BillingAccount",
"accountType": "COM",
"characteristic": [
{
"name": "billStatusArea",
"value": "GSM",
"valueType": "String"
},
{
"name": "regionCode",
"value": "PNO",
"valueType": "String"
}
]
}'
Response
{
"id": "326000460400",
"name": "Home Account",
"relatedParty": [
{
"id": "32600046",
"name": "Richard Cole"
},
{
"id": "0010100000RhiN9AAJ",
"@type": "Salesforce",
"name": "recordId"
}
]
}