1. REST API for Oracle CX Sales and B2B ServiceREST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Industry Solutions
  3. Financial Services
  4. Transaction

Transaction

The Transaction resource is used to store the credit and debit transactions related to a financial account.

Resource Plural Label Transactions

Resource Name

__ORAFS__Transaction_c

On this page:

Get All Transactions

Request: GET

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c

Request Path Parameters

There are no required path parameters for this task.

Request Query Parameters

Use the following finder parameters to query the resource:

Finder Name Description

Id

Finds Transaction records by ID.

Finder Variables:
  • PrimaryKey
    • Type: Integer
    • Description: The unique identifier of the Transaction record.

Request Body

There are no elements in the request body for this task.

Response Body

Returns an array of Transaction resources.

The following table summarizes the supported response body content types:

Media Type

application/json

Media Type

application/vnd.oracle.adf.resourcecollection+json

Example

Gets all Transaction records.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c

Example Response Body

{
"Id" : 300000000888515,
"RowType" : "__ORAFS__Transaction_c",
"RecordName" : "1305201502",
"CreatedBy" : "aic_1",
"CreationDate" : "2015-05-26T11.12.1.0:14:07+00:00",
"LastUpdatedBy" : "aic_1",
"LastUpdateDate" : "2015-05-26T11.12.1.0:14:13+00:00",
"LastUpdateLogin" : null,
"CpdrfVerSor" : null,
"UserLastUpdateDate" : null,
"CpdrfLastUpd" : null,
"CpdrfVerPillar" : null,
"JobDefinitionPackage" : null,
"RequestId" : null,
"JobDefinitionName" : null,
"CurrencyCode" : "USD",
"CurcyConvRateType" : "Corporate",
"CorpCurrencyCode" : "USD",
"SourceType" : "__ORAFS__TRANSACTION_C",
"AttachmentEntityName" : "__ORAFS__Transaction_c",
"PKProxy" : "300000000888515",
"IsOwner" : "false",
"__ORAFS__FinancialAccount_Id_c" : 300000000888331,"__ORAFS__FinancialAccount_c" : "2605201512",
"__ORAFS__TransactionDate_c" : null,
"__ORAFS__Description_c" : null,
"__ORAFS__Type_c" : null,
"__ORAFS__Status_c" : null,
"__ORAFS__Balance_c" : null,
"__ORAFS__Channel_c" : null,
"__ORAFS__Contact_Id_c" : 300000000839369,
"__ORAFS__Contact_c" : "Mark Smith",
"__ORAFS__Quantity_c" : null,
"__ORAFS__Price_c" : null,
"__ORAFS__Owner_Id_c" : null,
"__ORAFS__Owner_c" : null,
"__ORAFS__OwnerManager_c" : "",
"__ORAFS__OwnerOrganization_c" : "",
"__ORAFS__Amount_c" : 0.00,
"__ORAFS__FinancialAdviser_Id_c" : null,
"__ORAFS__FinancialAdviser_c" : null,
"__ORAFS__Commission_c" : null,
"__ORAFS__AccountId_c" : "300000000888331",
"__ORAFS__OwnerIDIMP_c" : null,
"__ORAFS__LastImported_c" : null,
"__ORAFS__Extn__ORAFS__Transaction_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__Transaction_c/__ORAFS__Transaction_cFuseCreate/__ORAFS__Transaction_cFuseCreate_Layout2.jsff",
"__ORAFS__Extn__ORAFS__Transaction_cFuseCreateLayoutDrivers" : "null",
"__ORAFS__Extn__ORAFS__Transaction_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__Transaction_c/__ORAFS__Transaction_cFuseDetail/__ORAFS__Transaction_cFuseDetail_Layout2.jsff",
"__ORAFS__Extn__ORAFS__Transaction_cFuseDetailLayoutDrivers" : "null",
"Extn__ORAFS__Transaction_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__Transaction_c/__ORAFS__Transaction_cFuseCreate/__ORAFS__Transaction_cFuseCreate_Layout2.jsff",
"Extn__ORAFS__Transaction_cFuseCreateLayoutDrivers" : null,
"Extn__ORAFS__Transaction_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__Transaction_c/__ORAFS__Transaction_cFuseDetail/__ORAFS__Transaction_cFuseDetail_Layout2.jsff",
"Extn__ORAFS__Transaction_cFuseDetailLayoutDrivers" : null,
"links" : [ {
...
}]
}

Create a Transaction

Request: POST

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c

Request Path Parameters

There are no required path parameters for this task.

Request Body

The following table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourceitem+json

Response Body

Returns a Transaction resource item.

The following table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Example

Creates a new Transaction record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c

Get a Transaction

Request: GET

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/< Replace with system generated unique ID>

Request Path Parameters

The following are the required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Transaction record.

Request Body

There are no elements in the request body for this task.

Response Body

Returns a Transaction resource item.

The following table summarizes the supported response body content types:

Media Type

application/json

Media Type

application/vnd.oracle.adf.resourceitem+json

Example

Gets a Transaction record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/30000000089311.12.1.02

Update a Transaction

Request: PATCH

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/< Replace with system generated unique ID>

Request Path Parameters

The following are the required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Transaction record.

Request Body

The following table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourceitem+json

Response Body

Returns a Transaction resource item.

The following table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourceitem+json

Example

Updates an existing Transaction record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/30000000089311.12.1.02

Delete a Transaction

Request: DELETE

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/< Replace with system generated unique ID>

Request Path Parameters

The following are the required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Transaction record.

Request Body

There are no elements in the request body for this task.

Response Body

There are no elements in the response body for this task.

Example

Deletes an existing Transaction record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Transaction_c/30000000089311.12.1.02

List of Values

This resource defines the following list of values (LOV):

LOV Name Source Attribute in LOV Target Attribute in Resource

ViewAccessor_CurrencyCode

CurrencyCode

Currency Code

FK_LOVVA_For___ORAFS__FinancialAccount_c

__ORAFS__FinancialAccount_Id_c

Financial Account

LOVVA_For___ORAFS__FinancialAccount_c

__ORAFS__FinancialAccount_c

Financial Account

LOVVA_For___ORAFS__Type_c

__ORAFS__Type_c

Type

LOVVA_For___ORAFS__Status_c

__ORAFS__Status_c

Status

FK_LOVVA_For___ORAFS__Contact_c

__ORAFS__Contact_Id_c

Contact

LOVVA_For___ORAFS__Contact_c

__ORAFS__Contact_c

Contact

FK_LOVVA_For___ORAFS__Owner_c

__ORAFS__Owner_Id_c

Owner

LOVVA_For___ORAFS__Owner_c

__ORAFS__Owner_c

Owner

FK_LOVVA_For___ORAFS__FinancialAdviser_c

__ORAFS__FinancialAdviser_Id_c

Financial Adviser

LOVVA_For___ORAFS__FinancialAdviser_c

__ORAFS__FinancialAdviser_c

Financial Adviser

Resource Attributes

This resource has the following attributes:

Attribute Name Attribute Type Description

Id

integer

The unique identifier of the Transaction record.

UI Label

Record ID

RowType

string

The name of the Transaction object. In this case __ORAFS__Transaction_c.

Properties

The maximum length is 80.

RecordName

string

An autogenerated unique identifier for the Transaction record.

Properties

The maximum length is 80.

UI Label

Transaction Number

CreatedBy

string

The user who created the Transaction record.

Properties

The maximum length is 32.

UI Label

Created By

CreationDate

string

The date and time when the Transaction record was created.

UI Label

Creation Date

LastUpdatedBy

string

The user who last updated the Transaction record.

Properties

The maximum length is 32.

UI Label

Last Updated By

LastUpdateDate

string

The date and time when the Transaction record was last updated.

UI Label

Last Update Date

CurrencyCode

string

The currency code associated with the Transaction record.

Properties

The maximum length is 15.

UI Label

Currency Code

SourceType

string

The name of the Transaction object. In this case __ORAFS__Transaction_c.

__ORAFS__FinancialAccount_Id_c

integer

The unique identifier of the financial account associated with the Transaction.

UI Label

Financial Account

__ORAFS__FinancialAccount_c

string

The financial account associated with the Transaction.

Properties

The maximum length is 1500.

UI Label

Financial Account

__ORAFS__TransactionDate_c

string

The date when the Transaction was done.

UI Label

Transaction Date

__ORAFS__Description_c

string

A description of the Transaction.

Properties

The maximum length is 200.

UI Label

Description

__ORAFS__Type_c

string

The type of Transaction.

Properties

The maximum length is 1500.

UI Label

Type

__ORAFS__Status_c

string

The status of the Transaction record.

Properties

The maximum length is 1500.

UI Label

Status

__ORAFS__Balance_c

number

The balance of the financial account after the Transaction.

UI Label

Balance

__ORAFS__Channel_c

string

The channel of the Transaction record.

Properties

The maximum length is 80.

UI Label

Channel

__ORAFS__Contact_Id_c

integer

The unique identifier of the contact associated with the Transaction.

UI Label

Contact

__ORAFS__Contact_c

string

The name of the contact associated with the Transaction.

Properties

The maximum length is 1500.

UI Label

Contact

__ORAFS__Quantity_c

integer

The quantity of the Transaction record.

UI Label

Quantity

__ORAFS__Price_c

number

The price of each Transaction quantity.

UI Label

Price

__ORAFS__Owner_Id_c

integer

The unique identifier of the Transaction owner.

UI Label

Owner

__ORAFS__Owner_c

string

The name of the Transaction owner.

Properties

The maximum length is 1500.

UI Label

Owner

__ORAFS__OwnerManager_c

string

The name of the owner's manager. The value is calculated using the Owner field value.

UI Label

Owner Manager

__ORAFS__OwnerOrganization_c

string

The name of the owner's organization. The value is calculated using the Owner field value.

UI Label

Owner Organization

__ORAFS__Amount_c

integer

The transaction amount. This is calculated from price and quantity.

UI Label

Amount

__ORAFS__FinancialAdviser_Id_c

integer

The unique identifier of the financial adviser for the Transaction.

UI Label

Financial Adviser

__ORAFS__FinancialAdviser_c

string

The name of the financial adviser of the Transaction.

Properties

The maximum length is 1500.

UI Label

Financial Adviser

__ORAFS__Commission_c

number

The unique identifier of the Transaction commission.

UI Label

Commission

__ORAFS__AccountId_c

string

The unique identifier of the financial account associated with the Transaction.

UI Label

Account Id

__ORAFS__OwnerIDIMP_c

string

The unique identifier of the Transaction owner.

UI Label

Owner ID IMP

__ORAFS__LastImported_c

string

The date when the last file import was done on the Transaction record.

UI Label

Last Imported