1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. External Cash Transactions

Get an external transaction

get

/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : cashExternalTransactions-item-response
Type: object
Show Source
  • Title: Account Servicer Reference
    Read Only: true
    Maximum Length: 50
    The reference number assigned by the account servicing institution for the underlying payment, receipt, external transaction, or payroll payment.
  • Maximum Length: 1
    Default Value: true
    The option that indicates whether the accounting event is raised when the external transaction is reconciled.
  • Title: Additional Entry Information
    Read Only: true
    Maximum Length: 1000
    Additional information about the entry details.
  • The transaction amount of the external transaction.
  • The cash general ledger account code combination of the external transaction.
  • Attachments
    Title: Attachments
    The attachments resource manages documents that are attached by the user to the external transaction.
  • Maximum Length: 360
    The name of the bank account associated to the external transaction.
  • The accounting conversion rate used to convert the external transaction amount from the bank account currency to the ledger currency.
  • Maximum Length: 30
    The accounting conversion rate type used to convert the external transaction amount from the bank account currency to the ledger currency.
  • Read Only: true
    Maximum Length: 20
    Unique identifier of the bank transaction on the statement line.
  • The name of the business unit associated to the external transaction.
  • Descriptive Flexfields
    Title: Descriptive Flexfields
    The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.
  • Title: Check Number
    Read Only: true
    Maximum Length: 40
    The check number of the underlying transaction.
  • The date when the external transaction is cleared.
  • Title: Clearing System Reference
    Read Only: true
    Maximum Length: 50
    The unique identifier assigned by the clearing system to a payment instruction.
  • Read Only: true
    Maximum Length: 64
    The user who created the external transaction.
  • Read Only: true
    The date and time when the external transaction was created.
  • Maximum Length: 15
    The currency code of the external transaction.
  • Title: Customer Reference
    Read Only: true
    Maximum Length: 30
    The customer reference used by BAI format.
  • Maximum Length: 360
    The description of the external transaction.
  • Title: End to End ID
    Read Only: true
    Maximum Length: 100
    The unique identification assigned by the initiating party to the transaction. It's passed on unchanged throughout the entire end to end chain.
  • The unique identifier of the external transaction.
  • Title: Instruction ID
    Read Only: true
    Maximum Length: 100
    The unique identification which is a point to point reference used between the instructing party and the instructed party to refer to an individual instruction. It's assigned by the instructing party to the instructed party and can be included in several messages related to the instruction.
  • Read Only: true
    The date and time when the external transaction was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the external transaction.
  • Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the external transaction.
  • The name of the legal entity associated to the external transaction.
  • Links
  • The offset general ledger account code combination of the external transaction.
  • Title: Reconciliation Reference
    Read Only: true
    Maximum Length: 50
    The reference to the underlying transaction information.
  • Maximum Length: 50
    The reconciliation reference of the external transaction.
  • Maximum Length: 30
    Default Value: MANUAL
    The source of the external transaction. The default value is Imported.
  • Maximum Length: 30
    Default Value: UNR
    The status of the external transaction. The default value is UNR for Unreconciled. Unreconciled external transactions can be rendered as void by updating this attribute to VOID.
  • Read Only: true
    Maximum Length: 256
    The structured payment reference or receipt reference on the bank statement line.
  • The date when the external transaction is created.
  • The sequence number transaction identifier of the external transaction.
  • Maximum Length: 30
    The transaction type of the external transaction. Examples include Bank adjustment, Fee, Check, Electronic funds transfer, Interest, Zero balancing, Lockbox, Miscellaneous, and Automated clearing house. A list of accepted values is defined in the lookup type CE_TRX_TYPE.
  • The unique identifier of the bank account transfer or the ad hoc payment that created the external transaction.
  • The actual value date of the external transaction.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource manages documents that are attached by the user to the external transaction.
Show Source
Nested Schema : Descriptive Flexfields
Type: array
Title: Descriptive Flexfields
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.
Show Source
Nested Schema : cashExternalTransactions-attachments-item-response
Type: object
Show Source
Nested Schema : cashExternalTransactions-cashExternalTransactionDFF-item-response
Type: object
Show Source
Links
attachments
Parameters:
  • ExternalTransactionId: $request.path.ExternalTransactionId
The attachments resource manages documents that are attached by the user to the external transaction.
cashExternalTransactionDFF
Parameters:
  • ExternalTransactionId: $request.path.ExternalTransactionId
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.
Back to Top

Examples

The following example shows how to retrieve an external transaction by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340

Example Response Body

The following example shows the contents of the response body in JSON format:

{
 "AccountingFlag" : false,
 "Amount" : 130,
 "ClearedDate" : null,
 "CreatedBy" : "CASH_MANAGER",
 ...
 "links" : [ 
 {
 "rel" : "self",
 "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340",
 "name" : "cashExternalTransactions",
 "kind" : "item",
 "properties" : {
                   "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                }
 }, 
 {
 "rel" : "child",
 "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments",
 "name" : "attachments",
 "kind" : "collection"
 },
 ... 
 ]
}
Back to Top