Account Management Biz Api
PATCH-billingAccount-for-eBill
PATCH billingAccount
Key Points
To update account level status when requested for eBill ON or OFF.
- In the request payload.billStructure.presentationMedia.name need to be pass as "EMAIL" when we requested for ON and in the request payload.billStructure.presentationMedia.name need to be pass as "MAIL" when we requested for OFFCASE 2 Unitary TestEnable Ebill
URL
https://[localhost]:[port]/sfdc-sys/v1/{businessId}/billingAccount/{id}Param
| name | type | description | required |
|---|---|---|---|
| id | string | Billing Account Id | Y |
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| channelId | string | This is to identify the source (Project).Digital | Conditionally Mandatory |
| lob | string | The Line of Business Identifier ["POSTPAID"] | Conditionally Mandatory |
| targetSystem | string | Use this data type to indicate target system name/id in your request. ["sfdc"] | Conditionally Mandatory |
| 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 | Y |
Request
{
"relatedParty": [
{
"id": "1",
"@type": "msisdn"
},
{
"@type": "channel",
"name": "Digital"
}
],
"billStructure": {
"presentationMedia": [
{
"@type": "eBill/non-eBill"
}
]
}
}Response
{
"status": "200",
"description": "Request to update the Ebill Flag received"
}