Receivables Adjustment API (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. The increase or decrease in the amount due of an invoice, debit memo, or chargeback using adjustments. Receivables can create manual or automatic adjustments. For example, write-off invoice B42315 because the package was damaged during delivery.
Life Cycle Status: Deprecated
QName: {http://xmlns.oracle.com/apps/financials/receivables/transactions/adjustments/adjustmentAPIService/}AdustmentAPIService
Service WSDL URL: https://servername/fscmService/AdustmentAPIService?WSDL
Operations
createAdjustment
Creates an adjustment.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
p_form_name |
string |
Form name of an adjustment. |
|
p_form_version |
long |
Form version of an adjustment. |
|
p_acctd_amount |
long |
Accounted amount of an adjustment. |
|
p_adjustment_id |
long |
Adjustment identifier of an adjustment. |
|
p_adjustment_number |
string |
Adjustment number of an adjustment. |
|
p_adjustment_type |
string |
Adjustment type of an adjustment. |
|
p_amount |
long |
Adjustment amount of an adjustment. |
|
p_apply_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date the application was applied to an adjustment. |
|
p_approved_by |
string |
Person who approved the adjustment. |
|
p_associated_application_id |
long |
Associated application identifier of an adjustment. |
|
p_associated_cash_receipt_id |
long |
Associated cash receipt identifier of an adjustment. |
|
p_attribute1 |
string |
Descriptive flexfield attribute 1 |
|
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_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_attribute_category |
string |
Descriptive flexfield context. |
|
p_automatically_generated |
string |
Automatically generated marker for an adjustment. |
|
p_batch_id |
long |
Batch identifier of an adjustment. |
|
p_chargeback_customer_trx_id |
long |
Chargeback transaction identifier of an adjustment. |
|
p_code_combination_id |
long |
Code combination identifier of an adjustment. |
|
p_comments |
string |
User comments on an adjustment. |
|
p_created_by |
string |
Person who created the adjustment. |
|
p_created_from |
string |
Person who created the adjustment record. |
|
p_creation_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date the adjustment was created. |
|
p_customer_trx_id |
long |
Identifies the affected invoices of an adjustment. |
|
p_customer_trx_line_id |
long |
Identifies the affected invoice lines of an adjustment. |
|
p_distribution_set_id |
long |
Distribution set identifier of an adjustment. |
|
p_Document_sequence_id |
long |
Document sequence identifier of an adjustment. |
|
p_Document_sequence_value |
long |
Document sequence value of an adjustment. |
|
p_freight_adjusted |
long |
Adjusted freight on an adjustment. |
|
p_gl_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Accounting date of an adjustment. |
|
p_gl_posted_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date that the adjustment amount is posted to general ledger. |
|
p_last_updated_by |
string |
Person who last updated the adjustment record. |
|
p_last_update_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date the adjustment was last updated. |
|
p_last_update_login |
long |
Person who last logged in and made updates to the adjustment record. |
|
p_line_adjusted |
long |
Identifies the adjusted transaction lines. |
|
p_ORG_id |
long |
Organization identifier of the adjustment. |
|
p_payment_schedule_id |
long |
Payment schedule identifier of the adjustment. |
|
p_postable |
string |
Indicates whether the adjustment is postable. |
|
p_posting_control_id |
long |
Posting control identifier of the adjustment. |
|
p_program_application_id |
long |
Program application identifier of the adjustment. |
|
p_program_id |
long |
Program identifier which creates an adjustment. |
|
p_program_update_date |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date the adjustment program was updated. |
|
p_reason_code |
string |
Code that identifies the reason for the adjustment. |
|
p_receivables_charges_adjusted |
long |
Identifies the adjusted charges. |
|
p_receivables_trx_id |
long |
Identifier of the receivables activity on the adjustment. |
|
p_request_id |
long |
Program request identifier of the adjustment. |
|
p_set_of_books_id |
long |
Set of books identifier of the adjustment. |
|
p_status |
string |
Adjustment status. |
|
p_subsequent_trx_id |
long |
Subsequent transaction identifier of the adjustment. |
|
p_tax_adjusted |
long |
Adjusted tax amount on the adjustment. |
|
p_type |
string |
Adjustment type of an adjustment. |
|
p_USSGL_transaction_code |
string |
Code defined by public sector accounting for an adjustment. |
|
p_USSGL_transaction_code_conte |
string |
Code defined by public sector accounting for an adjustment. |
|
p_override_flag |
string |
Override option on the adjustment. |
|
p_APP_level |
string |
Adjustment application level. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Indicates the adjustment creation status. |
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_INVOICE_PRIV |
Manage Receivables Invoice |
Manage a Receivables invoice, debit memo, or chargeback transaction, including its update and deletion. |
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_INVOICE_PRIV |
ORA_AR_BILLING_MANAGEMENT_DUTY |
Billing Management |
Manages the creation and processing of customer billing, billing adjustments, receipt write-offs, revenue recognition, revenue accounting, credit checking, and credit management. |
|
AR_MANAGE_RECEIVABLES_INVOICE_PRIV |
ORA_ZX_TAX_MANAGER_JOB |
Tax Manager |
Defines the tax policies and most efficient tax configuration. Sets up relatively stable entities that seldom require updates, such as tax regimes and taxes. |
|
AR_MANAGE_RECEIVABLES_INVOICE_PRIV |
ORA_AR_TAX_BILLING_DUTY |
Tax Billing |
Provide access to billing information for tax users. |
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_ZX_TAX_MANAGER_JOB |
ORA_FUN_CUSTOMER_ACCOUNT_INQUIRY_DUTY |
Customer Account Inquiry |
View customer account details. |
|
ORA_AR_BILLING_MANAGEMENT_DUTY |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_GBL_INTRASTAT_PROCESSING_DUTY |
Intrastat Processing |
Manages intrastat transactions including collecting, validating, exporting, printing, and purging intrastat transactions. Defines intrastat country characteristics, parameters, and rules. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_EGP_ITEM_INQUIRY_DUTY |
Item Inquiry |
Queries and views items in the enterprise. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_XLE_LEGAL_ENTITIES_ADMIN_DUTY |
Legal Entities Administration |
Manages legal entities, legal reporting units and registrations. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_ZX_REGISTRATION_PII_DUTY |
Party Taxpayer Identifier PII |
View personally identifiable information for tax registration number of type taxpayer ID. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_AP_PAYABLES_INVOICE_INQUIRY_DUTY |
Payables Invoice Inquiry |
Views Oracle Fusion Payables invoices. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_AP_PAYABLES_INVOICE_PROCESSING_DUTY |
Payables Invoice Processing |
Views invoices and related documents and takes action, such as approving and resolving holds. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_ZX_TAX_ADMINISTRATION_DUTY |
Tax Administration |
Sets up transaction tax content including regime to rate configuration, rules, tax determinants, configuration options and party tax profiles. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_AR_TAX_BILLING_DUTY |
Tax Billing |
Provide access to billing information for tax users. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_ZX_TAX_EXTERNAL_TRANSACTION_DUTY |
Tax External Taxable Transaction Processing |
Duty Role to manage import of transactions from external sources. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_ZX_TAX_REPORTING_DUTY |
Tax Reporting |
Sets up tax reporting types and creates tax reports. |
|
ORA_ZX_TAX_MANAGER_JOB |
ORA_ZX_WHT_ADMINISTRATION_DUTY |
Withholding Tax Administration |
Sets up withholding tax content including regime to rate configuration, rules, tax determinants, configuration options and party tax profiles. |