/adjustCustomerBill
[POST]
This usecase is used to raise adjustment in Liberate.
URL
http:// nonprod.lc.esb.cloud.lla.com/test/sfdc-ux-lc/sfdc-ux/v1/{businessId}/adjustCustomerBill
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: JM, AI, BS, BB, VG, KY, DM, GD, MS, KN, LC, VC, TT, TC | 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 |
|---|
| id | string | Query Id | Y |
| billingAccount.ids | string | Account Number | Y |
| billingAccount.@refferedTypes | string | Default: BillingAccount | Y |
| relatedParty[0].id | string | Department Name | Y |
| relatedParty[0].role | string | Default: Department | Y |
| relatedParty[0].@referredType | string | Default: Organization | Y |
| relatedParty[1].id | string | User Employee | Y |
| relatedParty[1].role | strings | Default: employee | Y |
| relatedParty[1].@referredType | sstring | Default: Individual | Y |
| characteristics[0].name | string | Default: totalAdjutments | Y |
| characteristics[0].value | string | How many adjustments sending to liberate | Y |
| characteristics[1].name | string | Default: Adjutments | Y |
| characteristics[1].value[].adjCode | string | Adjustment Code | Y |
| characteristics[1].value[].adjBillDescription | strings | Adjustment Description | Y |
| characteristics[1].value[].adjustmentAmount | string | Adjustment Amount | Y |
| characteristics[1].value[].queryNotesText | string | Notes | Y |
| characteristics[1].value[].QueryStatus | string | Query status | Y |
| characteristics[1].value[].employeeAuthorisedBy | string | AuthoriserId | Y |
| characteristics[1].value[].effectiveDate | string | Effective Date | Y |
| characteristics[2].name | string | Default: InputAdjustmentGroup | Y |
| characteristics[2].value[].adjCode | string | Adjustment Code | Y |
| characteristics[2].value[].adjBillDescription | strings | Adjustment Description | Y |
| characteristics[2].value[].adjustmentAmount | string | Adjustment Amount | Y |
| characteristics[2].value[].adjContraAcctNo | string | Contract account number | Y |
| @type | string | Default: AdjustCustomerBill | Y |
cURL request
'{
"id": "I00045L",
"relatedParty": [
{
"id": "99999",
"role": "employee",
"@referredType": "Individual"
},
{
"id": "KNI",
"role": "Department",
"@referredType": "Organization"
}
],
"characteristics": [
{
"name": "totalAdjustments",
"value": "4",
"valueType": "string"
},
{
"name": "Adjustments",
"valueType": "array",
"value": [
{
"adjCode": "1000",
"adjBillDescription": "Bill debt issue",
"adjustmentAmount": "1900",
"employeeAuthorisedBy": "1234",
"queryNotesText":"Raise Adjustment",
"effectiveDate": ""
}
]
},
{
"name": "InputAdjustmentGroup",
"valueType": "array",
"value": [
{
"adjCode": "1001",
"adjBillDescription": "Bill debt issue",
"adjustmentAmount": "1500",
"adjContraAcctNo": "353307050000"
},
{
"adjCode": "1002",
"adjBillDescription": "Bill date issue",
"adjustmentAmount": "1600",
"adjContraAcctNo": "353307050000"
},
{
"adjCode": "1003",
"adjBillDescription": "Bill issue",
"adjustmentAmount": "1700",
"adjContraAcctNo": "353307050000"
}
]
}
],
"@type": "AdjustCustomerBill"
}'
Response
{
"id": "I00045L"
}