Receivables Debit Memo 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 debit that is assigned to a customer to collect additional charges, such as unearned discounts taken, additional freight charges, taxes, or finance charges. For example, debit memo number DM2354 dated 04/29/2007 against invoice number B42315 for increased freight cost due to revised federal taxes.

Life Cycle Status: Deprecated

QName: {http://xmlns.oracle.com/apps/financials/receivables/transactions/invoices/debitMemoAPIService/}DebitMemoAPIService

Service WSDL URL: https://servername/fscmService/DebitMemoAPIService?WSDL

createDeditMemo

Creates a debit memo.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
header_trx_header_id	long	Debit memo identifier.
header_Customer_trx_type_Sequence_id	long	Transaction type identifier for the debit memo.
header_trx_number	string	Transaction number of the debit memo.
header_trx_date	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Transaction date of the debit memo.
header_bill_to_customer_id	long	Bill-to customer identifier of the debit memo.
header_trx_currency	string	Debit memo currency.
header_ORG_id	long	Business unit identifier for the debit memo.
line_trx_header_id	long	Identifier of a debit memo provided by the user to link the debit memo to a transaction line.
line_trx_line_id	long	Debit memo line identifier.
line_line_number	long	Debit memo line number.
line_UOM_CODE	string	Unit of measure code on the debit memo line.
line_description	string	Debit memo transaction line description.
line_quantity_invoiced	long	Invoiced quantity at the debit memo line level.
line_unit_selling_price	long	Debit memo line level unit price.
line_line_type	string	Debit memo line type.
batch_source_Sequence_id	long	Transaction source identifier of the debit memo.
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_global_attribute_category	string	Global descriptive flexfield context
p_global_attribute1	string	Global descriptive flexfield attribute 1
p_global_attribute2	string	Global descriptive flexfield attribute 2
p_global_attribute3	string	Global descriptive flexfield attribute 3
p_global_attribute4	string	Global descriptive flexfield attribute 4
p_global_attribute5	string	Global descriptive flexfield attribute 5
p_global_attribute6	string	Global descriptive flexfield attribute 6
p_global_attribute7	string	Global descriptive flexfield attribute 7
p_global_attribute8	string	Global descriptive flexfield attribute 8
p_global_attribute9	string	Global descriptive flexfield attribute 9
p_global_attribute10	string	Global descriptive flexfield attribute 10
p_global_attribute11	string	Global descriptive flexfield attribute 11
p_global_attribute12	string	Global descriptive flexfield attribute 12
p_global_attribute13	string	Global descriptive flexfield attribute 13
p_global_attribute14	string	Global descriptive flexfield attribute 14
p_global_attribute15	string	Global descriptive flexfield attribute 15
p_global_attribute16	string	Global descriptive flexfield attribute 16
p_global_attribute17	string	Global descriptive flexfield attribute 17
p_global_attribute18	string	Global descriptive flexfield attribute 18
p_global_attribute19	string	Global descriptive flexfield attribute 19
p_global_attribute20	string	Global descriptive flexfield attribute 20
header_reference_number	string	Debit memo reference number.
header_trx_class	string	Debit memo transaction class.
header_gl_date	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Debit memo accounting date.
header_bill_to_account_number	string	Bill-to customer account number on the debit memo.
header_bill_to_customer_name	string	Bill-to customer name on the debit memo.
header_bill_to_contact_id	long	Bill-to contract identifier on the debit memo.
header_bill_to_address_id	long	Customer bill-to address on the debit memo.
header_bill_to_site_use_id	long	Bill-to site use identifier on the debit memo.
header_ship_to_customer_id	long	Ship-to customer identifier on the debit memo.
header_ship_to_account_number	string	Ship-to customer account number on the debit memo.
header_ship_to_customer_name	string	Ship-to customer on the debit memo.
header_ship_to_contact_id	long	Ship-to contact identifier on the debit memo.
header_ship_to_address_id	long	Ship-to address identifier on the debit memo.
header_ship_to_site_use_id	long	Ship-to site use identifier on the debit memo.
header_sold_to_customer_id	long	Sold-to customer identifier on the debit memo.
header_Termination_id	long	Payment terms identifier on the debit memo.
h_primary_resource_salesrep_id	long	Primary salesperson identifier on the debit memo.
header_primary_salesrep_name	string	Primary salesperson name on the debit memo.
header_exchange_rate_type	string	Conversion rate type on the debit memo.
header_exchange_date	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Conversion date on the debit memo.
header_exchange_rate	long	Conversion rate on the debit memo.
header_territory_id	long	Territory identifier on the debit memo.
header_remit_to_address_Sequence_id	long	Remit-to address identifier on the debit memo.
header_invoicing_rule_id	long	Transaction invoicing rule on the debit memo.
header_printing_option	string	Printing option on the debit memo.
header_purchase_order	string	Purchase order on the debit memo.
header_purchase_order_revision	string	Purchase order revision on the debit memo.
header_purchase_order_date	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Purchase order date on the debit memo.
header_comments	string	User comments on the debit memo.
header_internal_notes	string	Internal notes on the debit memo.
header_finance_charges	string	Finance charges on the debit memo.
header_receipt_method_id	long	Receipt method identifier on the debit memo.
header_related_customer_trx_id	long	Transaction identifier on the debit memo.
header_agreement_id	long	Agreement identifier on the debit memo.
header_ship_via	string	Ship via on the debit memo.
header_ship_date_actual	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Shipment date on the debit memo.
header_waybill_number	string	Waybill number on the debit memo.
header_FOB_point	string	FOB on the debit memo.
default_USSGL_transaction_COD	string	Default USSGL transaction code on the debit memo.
header_status_trx	string	Transaction status of the debit memo.
header_paying_customer_id	long	Paying customer identifier on the debit memo.
header_paying_site_use_id	long	Paying customer site use identifier on the debit memo.
header_default_tax_exempt_flag	string	Default tax exemption option on the debit memo.
header_Document_sequence_value	long	Document sequence number on the debit memo.
header_legal_entity_id	long	Legal entity identifier on the debit memo.
h_payment_trxn_extension_id	long	Payment transaction extension identifier on the debit memo.
header_billing_date	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Billing date on the debit memo.
header_interest_header_id	long	Identifier for the debit memo for late charge interest.
header_late_charges_assessed	string	Assessed late charges indicator on the debit memo.
p_global_attribute21	string	Global descriptive flexfield attribute 21
p_global_attribute22	string	Global descriptive flexfield attribute 22
p_global_attribute23	string	Global descriptive flexfield attribute 23
p_global_attribute24	string	Global descriptive flexfield attribute 24
p_global_attribute25	string	Global descriptive flexfield attribute 25
p_global_attribute26	string	Global descriptive flexfield attribute 26
p_global_attribute27	string	Global descriptive flexfield attribute 27
p_global_attribute28	string	Global descriptive flexfield attribute 28
p_global_attribute29	string	Global descriptive flexfield attribute 29
p_global_attribute30	string	Global descriptive flexfield attribute 30
h_interface_header_context	string	Descriptive flexfield context for interface table.
h_interface_header_attribute1	string	Descriptive flexfield attribute 1 for line Interface Table
h_interface_header_attribute2	string	Descriptive flexfield attribute 2 for line Interface Table
h_interface_header_attribute3	string	Descriptive flexfield attribute 3 for line Interface Table
h_interface_header_attribute4	string	Descriptive flexfield attribute 4 for line Interface Table
h_interface_header_attribute5	string	Descriptive flexfield attribute 5 for line Interface Table
h_interface_header_attribute6	string	Descriptive flexfield attribute 6 for line Interface Table
h_interface_header_attribute7	string	Descriptive flexfield attribute 7 for line Interface Table
h_interface_header_attribute8	string	Descriptive flexfield attribute 8 for line Interface Table
h_interface_header_attribute9	string	Descriptive flexfield attribute 9 for line interface table
h_interface_header_attribute10	string	Descriptive flexfield attribute 10 for line Interface Table
h_interface_header_attribute11	string	Descriptive flexfield attribute 11 for line Interface Table
h_interface_header_attribute12	string	Descriptive flexfield attribute 12 for line Interface Table
h_interface_header_attribute13	string	Descriptive flexfield attribute 13 for line Interface Table
h_interface_header_attribute14	string	Descriptive flexfield attribute 14 for line Interface Table
h_interface_header_attribute15	string	Descriptive flexfield attribute 15 for line Interface Table
link_to_trx_line_id	long	Link to transaction line identifier on the debit memo.
REASON_CODE	string	Debit memo reason code.
INVENTORY_ITEM_ID	long	Inventory item identifier on the debit memo.
QUANTITY_ORDERED	long	Ordered quantity on the debit memo.
UNIT_STANDARD_PRICE	long	List price per unit on the debit memo.
SALES_ORDER	string	Sales order on the debit memo.
SALES_ORDER_LINE	string	Sales order line on the debit memo.
SALES_ORDER_DATE	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Sales order date on the debit memo.
ACCOUNTING_RULE_ID	long	Revenue scheduling rule identifier on the debit memo.
ATTRIBUTE_CATEGORY	string	Descriptive flexfield context
ATTRIBUTE1	string	Descriptive flexfield attribute 1
ATTRIBUTE2	string	Descriptive flexfield attribute 2
ATTRIBUTE3	string	Descriptive flexfield attribute 3
ATTRIBUTE4	string	Descriptive flexfield attribute 4
ATTRIBUTE5	string	Descriptive flexfield attribute 5
ATTRIBUTE6	string	Descriptive flexfield attribute 6
ATTRIBUTE7	string	Descriptive flexfield attribute 7
ATTRIBUTE8	string	Descriptive flexfield attribute 8
ATTRIBUTE9	string	Descriptive flexfield attribute 9
ATTRIBUTE10	string	Descriptive flexfield attribute 10
ATTRIBUTE11	string	Descriptive flexfield attribute 11
ATTRIBUTE12	string	Descriptive flexfield attribute 12
ATTRIBUTE13	string	Descriptive flexfield attribute 13
ATTRIBUTE14	string	Descriptive flexfield attribute 14
ATTRIBUTE15	string	Descriptive flexfield attribute 15
RULE_START_DATE	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Revenue scheduling rule start date on the debit memo.
INTERFACE_LINE_CONTEXT	string	Descriptive flexfield context for line interface table
INTERFACE_LINE_ATTRIBUTE1	string	Descriptive flexfield attribute 1 for line interface table
INTERFACE_LINE_ATTRIBUTE2	string	Descriptive flexfield attribute 2 for line interface table
INTERFACE_LINE_ATTRIBUTE3	string	Descriptive flexfield attribute 3 for line interface table
INTERFACE_LINE_ATTRIBUTE4	string	Descriptive flexfield attribute 4 for line interface table
INTERFACE_LINE_ATTRIBUTE5	string	Descriptive flexfield attribute 5 for line interface table
INTERFACE_LINE_ATTRIBUTE6	string	Descriptive flexfield attribute 6 for line interface table
INTERFACE_LINE_ATTRIBUTE7	string	Descriptive flexfield attribute 7 for line interface table
INTERFACE_LINE_ATTRIBUTE8	string	Descriptive flexfield attribute 8 for line interface table
INTERFACE_LINE_ATTRIBUTE9	string	Descriptive flexfield attribute 9 for line interface table
INTERFACE_LINE_ATTRIBUTE10	string	Descriptive flexfield attribute 10 for line interface table
INTERFACE_LINE_ATTRIBUTE11	string	Descriptive flexfield attribute 11 for line interface table
INTERFACE_LINE_ATTRIBUTE12	string	Descriptive flexfield attribute 12 for line interface table
INTERFACE_LINE_ATTRIBUTE13	string	Descriptive flexfield attribute 13 for line interface table
INTERFACE_LINE_ATTRIBUTE14	string	Descriptive flexfield attribute 14 for line interface table
INTERFACE_LINE_ATTRIBUTE15	string	Descriptive flexfield attribute 15 for line interface table
SALES_ORDER_SOURCE	string	Sales order source on the debit memo.
AMOUNT	long	Debit memo amount.
TAX_PRECEDENCE	long	Tax precedence on the debit memo.
TAX_RATE	long	Tax rate on the debit memo.
TAX_EXEMPTION_ID	long	Tax exemption identifier on the debit memo.
MEMO_LINE_Sequence_ID	long	Memo line identifier on the debit memo.
DEFAULT_USSGL_TRANSACTION_CODE	string	Default USSGL transaction code on the debit memo.
DEFAULT_USSGL_TRX_CODE_CONTEXT	string	Default USSGL transaction code context on the debit memo.
VAT_TAX_ID	long	VAT tax identifier on the debit memo.
TAX_EXEMPT_FLAG	string	Allow tax exemption option on the debit memo.
TAX_EXEMPT_NUMBER	string	Tax exempt number on the debit memo.
TAX_EXEMPT_REASON_CODE	string	Tax exemption reason code on the debit memo.
TAX_VENDOR_RETURN_CODE	string	Tax vendor return code for internal use only.
MOVEMENT_ID	long	Identifier on the debit memo to pass movement statistics that are tied to the shipment information and passed through AutoInvoice.
GLOBAL_ATTRIBUTE1	string	Global descriptive flexfield attribute 1
GLOBAL_ATTRIBUTE2	string	Global descriptive flexfield attribute 2
GLOBAL_ATTRIBUTE3	string	Global descriptive flexfield attribute 3
GLOBAL_ATTRIBUTE4	string	Global descriptive flexfield attribute 4
GLOBAL_ATTRIBUTE5	string	Global descriptive flexfield attribute 5
GLOBAL_ATTRIBUTE6	string	Global descriptive flexfield attribute 6
GLOBAL_ATTRIBUTE7	string	Global descriptive flexfield attribute 7
GLOBAL_ATTRIBUTE8	string	Global descriptive flexfield attribute 8
GLOBAL_ATTRIBUTE9	string	Global descriptive flexfield attribute 9
GLOBAL_ATTRIBUTE10	string	Global descriptive flexfield attribute 10
GLOBAL_ATTRIBUTE11	string	Global descriptive flexfield attribute 11
GLOBAL_ATTRIBUTE12	string	Global descriptive flexfield attribute 12
GLOBAL_ATTRIBUTE13	string	Global descriptive flexfield attribute 13
GLOBAL_ATTRIBUTE14	string	Global descriptive flexfield attribute 14
GLOBAL_ATTRIBUTE15	string	Global descriptive flexfield attribute 15
GLOBAL_ATTRIBUTE16	string	Global descriptive flexfield attribute 16
GLOBAL_ATTRIBUTE17	string	Global descriptive flexfield attribute 17
GLOBAL_ATTRIBUTE18	string	Global descriptive flexfield attribute 18
GLOBAL_ATTRIBUTE19	string	Global descriptive flexfield attribute 19
GLOBAL_ATTRIBUTE20	string	Global descriptive flexfield attribute 20
GLOBAL_ATTRIBUTE_CATEGORY	string	Global descriptive flexfield context
AMOUNT_INCLUDES_TAX_FLAG	string	Tax inclusive option on the debit memo.
WAREHOUSE_ID	long	Warehouse identifier on the debit memo.
CONTRACT_LINE_ID	long	Contract line identifier on the debit memo.
SOURCE_DATA_KEY1	string	Source System data keys used in AutoInvoice interface table.
SOURCE_DATA_KEY2	string	Source System data keys used in AutoInvoice interface table.
SOURCE_DATA_KEY3	string	Source System data keys used in AutoInvoice interface table.
SOURCE_DATA_KEY4	string	Source System data keys used in AutoInvoice interface table.
SOURCE_DATA_KEY5	string	Source System data keys used in AutoInvoice interface table.
INVOICED_LINE_ACCTG_LEVEL	string	Identifier of accounting level for invoiceable lines in original system.
SHIP_DATE_ACTUAL	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Shipment date on the debit memo.
OVERRIDE_AUTO_ACCOUNTING_FLAG	string	Allow Override of AutoAccounting option on the debit memo.
DEFERRAL_EXCLUSION_FLAG	string	Option on the debit memo to exclude a transaction line from automated revenue deferral.
RULE_END_DATE	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Revenue scheduling rule end date on the debit memo.
SOURCE_APPLICATION_ID	long	Source application identifier on the debit memo.
SOURCE_EVENT_CLASS_CODE	string	Source event class code on the debit memo.
SOURCE_ENTITY_CODE	string	Source system entity code on the debit memo used in AutoInvoice interface table.
SOURCE_TRX_ID	long	Source transaction identifier on the debit memo.
SOURCE_TRX_LINE_ID	long	Source transaction line identifier on the debit memo.
SOURCE_TRX_LINE_TYPE	string	Source transaction line type on the debit memo.
SOURCE_TRX_DETAIL_TAX_LINE_ID	long	Source transaction tax line identifier on the debit memo.
HISTORICAL_FLAG	string	Option on the debit memo that indicates whether the transaction line existed prior to implementation of Fusion Tax.
TAXABLE_FLAG	string	Option on the debit memo that indicates whether the transaction is taxable.
TAX_REGIME_CODE	string	Tax regime code on the debit memo.
TAX	string	Tax on the debit memo.
TAX_STATUS_CODE	string	Tax status code on the debit memo.
TAX_RATE_CODE	string	Tax rate code on the debit memo.
TAX_JURISDICTION_CODE	string	Tax jurisdiction code on the debit memo.
TAX_CLASSIFICATION_CODE	string	Tax classification code on the debit memo.
interest_line_id	long	Interest line identifier on the debit memo.
ACCOUNTING_RULE_DURATION	long	Revenue scheduling rule duration on the debit memo.

Response Payload

Element Name	Type	Description
result	string	Debit memo creation status.

getDfltObjAttrHints

An operation to retrieve 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.