Review and Complete Transactions Using a REST API

Review and complete transactions using the Receivables Invoices and Receivables Credit Memos REST APIs. Leveraging these REST endpoints allows customers to implement custom validations and automate transaction completion for Pending Approval transactions. 

This 26A feature offers additional functionality for feature Receivables Transaction Review and Control delivered in release 24D.

Use the enhanced Receivables Invoices REST API to:

  • Approve Receivables invoices using the Approve custom operation of receivablesInvoices REST API. 
  • Rework receivables invoices using the Rework custom operation of receivablesInvoices REST API.

Use the enhanced Receivables Credit Memos REST API to:

  • Approve Receivables credit memos using the Approve custom operation of receivablesCreditMemos REST API.
  • Rework Receivables credit memos using the Rework custom operation of receivablesCreditMemos REST API.

All the custom actions accept approval and rework comments as payload attributes. The comments passed with the action will be captured in the approval audit history of the Receivables transaction. 

Transactions must be in Pending Approval status for the end users to approve or rework the transactions using the REST APIS. 

If the transaction is approved, it will move to Completed status. If the transaction is requested for rework, it will move to Incomplete status. 

These are the business benefits:

  • Using these REST endpoints, customers can implement custom validation logic and streamline the completion of transactions without the need for manual intervention.
  • The APIs enable easy integration with external systems to facilitate faster and more efficient receivables transaction processing.
  • Automating the approval of pending approval transactions with REST APIs minimizes the need for manual review, thereby accelerating the process of marking the Receivables transaction as complete.

Steps to Enable and Configure

You don't need to do anything to enable this feature.

Tips And Considerations

  • Only users with required privileges can approve or rework transactions using the REST APIs.
  • Transactions must be in Pending Approval status to be approved via the API.
  • The REST API prevents users from approving transactions they have created themselves.

Key Resources

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > Financials > APIs & Schema). If you are new to Oracle's REST services, you may want to begin with the Quick Start section.

Access Requirements

  • To approve Receivables transactions for user-based approval, end users calling the REST APIs do not need any explicit privilege grant if they are assigned as approvers in the Simplified Rules Configuration (SRC) spreadsheet
  • To approve Receivables transactions for role-based approval, end users calling the REST APIs need the following privilege:
    • Approve Receivables Transaction (AR_APPROVE_RECEIVABLES_TRANSACTION_PRIV). 
  • To force approve Receivables transaction, end users calling the REST APIs need the following privilege:
    • Force Approve Receivables Transaction (AR_FORCE_APPROVE_RECEIVABLES_TRANSACTION_PRIV) 

        You must create custom roles with the above privileges to approve or force approve Receivable transactions.