Receivables Chargeback (Deprecated)
WARNING: This service has been deprecated. There is no new public replacement service in the current release but one is planned for the upcoming release. Used when applying payments to an invoice and the customer shortpays or takes an unauthorized deduction. The process closes the original invoice and creates a new chargeback invoice for the difference. For example, chargeback number CB54 for shortpaying invoice B42315.
Life Cycle Status: Deprecated
QName: {http://xmlns.oracle.com/apps/financials/receivables/receipts/shared/chargeBackAPIService/}ChargeBackAPIService
Service WSDL URL: https://servername/fscmService/ChargeBackAPIService?WSDL
Operations
CreateChargeBack
Creates a chargeback.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
P_RECEIVABLE_APPLICATION_ID |
long |
Receivables application identifier on a chargeback. |
|
P_APP_CUSTOMER_TRX_ID |
long |
Transaction identifier on a chargeback. |
|
P_APP_TERMS_SEQUENCE_NUMBER |
long |
Installment number on a chargeback. |
|
P_CASH_RECEIPT_ID |
long |
Receipt identifier on a chargeback. |
|
P_Customer_TRX_TYPE_Sequence_ID |
long |
Chargeback transaction type identifier. |
|
P_REASON_CODE |
string |
Chargeback reason. |
|
P_COMMENTS |
string |
User comments on a chargeback. |
|
P_DUE_DATE |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Due date of the chargeback. |
|
P_REC_CCID |
long |
Chargeback distribution. |
|
P_AMOUNT |
long |
Chargeback amount. |
|
P_ATTRIBUTE_CATEGORY |
string |
Descriptive flexfield context |
|
P_ATTRIBUTE1 |
string |
Descriptive flexfield attribute 1 |
|
P_ATTRIBUTE2 |
string |
Descriptive flexfield attribute 2 |
|
P_ATTRIBUTE3 |
string |
Descriptive flexfield attribute 3 |
|
P_ATTRIBUTE4 |
string |
Descriptive flexfield attribute 4 |
|
P_ATTRIBUTE5 |
string |
Descriptive flexfield attribute 5 |
|
P_ATTRIBUTE6 |
string |
Descriptive flexfield attribute 6 |
|
P_ATTRIBUTE7 |
string |
Descriptive flexfield attribute 7 |
|
P_ATTRIBUTE8 |
string |
Descriptive flexfield attribute 8 |
|
P_ATTRIBUTE9 |
string |
Descriptive flexfield attribute 9 |
|
P_ATTRIBUTE10 |
string |
Descriptive flexfield attribute 10 |
|
P_ATTRIBUTE11 |
string |
Descriptive flexfield attribute 11 |
|
P_ATTRIBUTE12 |
string |
Descriptive flexfield attribute 12 |
|
P_ATTRIBUTE13 |
string |
Descriptive flexfield attribute 13 |
|
P_ATTRIBUTE14 |
string |
Descriptive flexfield attribute 14 |
|
P_ATTRIBUTE15 |
string |
Descriptive flexfield attribute 15 |
|
P_Document_SEQUENCE_VALUE |
long |
Document sequence value on a chargeback. |
|
P_Document_SEQUENCE_ID |
long |
Document sequence identifier on a chargeback. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Creation status of a chargeback. |
getDfltObjAttrHints
Retrieves user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
An operation that returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
An operation to get the list of service data objects defined on this service
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
All Operations |
AR_MANAGE_RECEIVABLES_RECEIPT_PRIV |
Manage Receivables Receipt |
Manage a Receivables receipt, including update, deletion, application, unapplication, standard reversal, debit memo reversal, transaction adjustment, creation of chargeback, and creation of credit card chargebacks. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
AR_MANAGE_RECEIVABLES_RECEIPT_PRIV |
ORA_AR_PAYMENT_MANAGEMENT_DUTY |
Payment Management |
Processes customer payment activities, including cash adjustments, deductions, receipt reversals, receipt write-offs, receipt conversion rate adjustments, receipt applications, and the creation of miscellaneous receipts. |
|
AR_MANAGE_RECEIVABLES_RECEIPT_PRIV |
ORA_AR_PAYMENT_MANAGEMENT_SEGREGATED_DUTY |
Payment Management Segregated |
Manages accounts receivables activities except the creation and management of receipts. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_AR_PAYMENT_MANAGEMENT_SEGREGATED_DUTY |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
|
ORA_AR_PAYMENT_MANAGEMENT_DUTY |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |