Financial Account
The financial account resource is used to manage all financial accounts that belong to a household.
| Resource Plural Label | Financial Accounts |
|---|---|
|
Resource Name |
__ORAFS__FinancialAccount_c |
Get all Financial Accounts
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 Financial Account records by ID. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
Returns an array of Financial Account 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 Financial Account records.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_c
Create a Financial Account
Request: POST
URI crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 Financial Account resource item.
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Example
Creates a new Financial Account record.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_c
Example Response Body
{
"Id" : 300000000940109,
"RowType" : "__ORAFS__FinancialAccount_c",
"RecordName" : "87348-10",
"CreatedBy" : "FAAdmin",
"CreationDate" : "2015-07-10T10:03:23+00:00",
"LastUpdatedBy" : "FAAdmin",
"LastUpdateDate" : "2015-07-10T10:07:03+00:00",
"LastUpdateLogin" : null,
"CpdrfVerSor" : null,
"UserLastUpdateDate" : null,
"CpdrfLastUpd" : null,"CpdrfVerPillar" : null,
"JobDefinitionPackage" : null,
"RequestId" : null,
"JobDefinitionName" : null,
"CurrencyCode" : null,
"CurcyConvRateType" : null,
"CorpCurrencyCode" : null,
"SourceType" : "__ORAFS__FINANCIALACCOUNT_C",
"AttachmentEntityName" : "__ORAFS__FinancialAccount_c",
"PKProxy" : "300000000940109",
"IsOwner" : "true",
"__ORAFS__Description_c" : null,
"__ORAFS__Type_c" : "ORA_AFS_PORTFOLIO",
"__ORAFS__Joint_c" : false,
"__ORAFS__Balance_c" : null,
"__ORAFS__BalanceAsOfDate_c" : "2015-05-15",
"__ORAFS__DateOpened_c" : null,
"__ORAFS__HomeBranch_c" : null,
"__ORAFS__Status_c" : "ORA_AFS_NORMAL",
"__ORAFS__Asset_c" : true,
"__ORAFS__ProductName_Id_c" : 300000000838139,
"__ORAFS__ProductName_c" : "FP-0000000001",
"__ORAFS__Product_c" : "15 Year Home Loan",
"__ORAFS__Household_Id_c" : 300000000932391,
"__ORAFS__Household_c" : "Mahesh Family",
"__ORAFS__Owner_Id_c" : null,
"__ORAFS__Owner_c" : null,
"__ORAFS__OwnerManager_c" : "",
"__ORAFS__OwnerOrganization_c" : "",
"__ORAFS__CustomerID_c" : "300000000940109",
"__ORAFS__ExternalSystemId_c" : null,
"__ORAFS__LastImported_c" : null,
"__ORAFS__FinancialSummary_Id_c" : null,
"__ORAFS__FinancialSummary_c" : null,
"__ORAFS__Extn__ORAFS__FinancialAccount_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__FinancialAccount_c/__ORAFS__FinancialAccount_cFuseDetail/__ORAFS__FinancialAccount_cFuseDetail_Layout2.jsff",
"__ORAFS__Extn__ORAFS__FinancialAccount_cFuseDetailLayoutDrivers" : "null",
"__ORAFS__Extn__ORAFS__FinancialAccount_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__FinancialAccount_c/__ORAFS__FinancialAccount_cFuseCreate/__ORAFS__FinancialAccount_cFuseCreate_Layout2.jsff",
"__ORAFS__Extn__ORAFS__FinancialAccount_cFuseCreateLayoutDrivers" : "null"
"__ORAFS__HeldAwayInstitution_c" : null,
"Extn__ORAFS__FinancialAccount_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__FinancialAccount_c/__ORAFS__FinancialAccount_cFuseCreate/__ORAFS__FinancialAccount_cFuseCreate_Layout2.jsff",
"Extn__ORAFS__FinancialAccount_cFuseCreateLayoutDrivers" : null,
"Extn__ORAFS__FinancialAccount_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__FinancialAccount_c/__ORAFS__FinancialAccount_cFuseDetail/__ORAFS__FinancialAccount_cFuseDetail_Layout2.jsff",
"Extn__ORAFS__FinancialAccount_cFuseDetailLayoutDrivers" : null,
"links" : [ {
...
}]
} Get a Financial Account
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 Financial Account record. |
Request Body
There are no elements in the request body for this task.
Response Body
Returns a Financial Account 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 Financial Account record.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_c/30000000089311.12.1.02
Update a Financial Account
Request: PATCH
URI: crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 Financial Account 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 Financial Account resource item.
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Example
Updates an existing Financial Account record.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_c/30000000089311.12.1.02
Delete a Financial Account
Request: DELETE
URI: crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 Financial Account 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 Financial Account record.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__FinancialAccount_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 |
|
LOVVA_For___ORAFS__Type_c |
__ORAFS__Type_c |
Type |
|
LOVVA_For___ORAFS__Joint_c |
__ORAFS__Joint_c |
Joint |
|
LOVVA_For___ORAFS__Status_c |
__ORAFS__Status_c |
Status |
|
LOVVA_For___ORAFS__Asset_c |
__ORAFS__Asset_c |
Asset |
|
FK_LOVVA_For___ORAFS__ProductName_c |
__ORAFS__ProductName_Id_c |
Product Name |
|
LOVVA_For___ORAFS__ProductName_c |
__ORAFS__ProductName_c |
Product |
|
FK_LOVVA_For___ORAFS__Household_c |
__ORAFS__Household_Id_c |
Household |
|
LOVVA_For___ORAFS__Household_c |
__ORAFS__Household_c |
Household |
|
FK_LOVVA_For___ORAFS__Owner_c |
__ORAFS__Owner_Id_c |
Owner |
|
LOVVA_For___ORAFS__Owner_c |
__ORAFS__Owner_c |
Owner |
Resource Attributes
This resource has the following attributes:
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Financial Account record. UI Label Record ID |
|
RowType |
string |
The name of the Financial Account object. In this case __ORAFS__Financial Account_c. Properties The maximum length is 80. |
|
RecordName |
string |
An autogenerated unique identifier for the Financial Account record. Properties The maximum length is 80. UI Label Financial Account |
|
CreatedBy |
string |
The user who created the Financial Account record. Properties The maximum length is 32. UI Label Created By |
|
CreationDate |
string |
The date and time when the Financial Account record was created. UI Label Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the Financial Account record. Properties The maximum length is 32. UI Label Last Updated By |
|
LastUpdateDate |
string |
The date and time when the Financial Account record was last updated. UI Label Last Update Date |
|
CurrencyCode |
string |
The currency code associated with the Financial Account record. Properties The maximum length is 15. UI Label Currency Code |
|
SourceType |
string |
The name of the Financial Account object. In this case __ORAFS__Financial Account_c. |
|
__ORAFS__Description_c |
string |
The description of the Financial Account record. Properties The maximum length is 200. UI Label Description |
|
__ORAFS__Type_c |
string |
The financial account type for the associated Financial Account. Properties The maximum length is 1500. UI Label Type |
|
__ORAFS__Joint_c |
boolean |
Indicates whether the Financial Account is joint or not. Properties The maximum length is 10. UI Label Joint |
|
__ORAFS__Balance_c |
number |
The balance of the associated Financial Account. UI Label Balance |
|
__ORAFS__BalanceAsOfDate_c |
string |
The balance as of date of the associated Financial Account. UI Label Balance as of Date |
|
__ORAFS__DateOpened_c |
string |
The date when the associated Financial Account opened. UI Label Date Opened |
|
__ORAFS__HomeBranch_c |
string |
The home branch of the Financial Account. Properties The maximum length is 200. UI Label Home Branch |
|
__ORAFS__Status_c |
string |
The status of the Financial Account. Properties The maximum length is 1500. UI Label Status |
|
__ORAFS__Asset_c |
boolean |
Indicates whether the Financial Account is a Cash Account or a Credit Account. Properties The maximum length is 10. UI Label Asset |
|
__ORAFS__ProductName_Id_c |
integer |
The unique identifier of the financial product of the associated product. UI Label Product Name |
|
__ORAFS__ProductName_c |
string |
The name of the financial product of the associated product. Properties The maximum length is 1500. UI Label Product Name |
|
__ORAFS__Product_c |
string |
This calculates the SCM Item Name from the Financial Product associated. This is the Product Name displayed in the Application. UI Label Product |
|
__ORAFS__Household_Id_c |
integer |
The unique identifier of the household associated with the Financial Account record. UI Label Household |
|
__ORAFS__Household_c |
string |
The name of the household associated with the Financial Account record. Properties The maximum length is 1500. UI Label Household |
|
__ORAFS__Owner_Id_c |
integer |
The unique identifier of the owner of the Financial Account record. UI Label Owner |
|
__ORAFS__Owner_c |
string |
The name of the owner of the Financial Account record. 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__CustomerID_c |
string |
The unique identifier of the customer for this Financial Account record. This is calculated from the ID field. UI Label Customer ID |
|
__ORAFS__ExternalSystemId_c |
string |
The external IDs from where Financial Accounts are migrated. Properties The maximum length is 80. UI Label External System Id |
|
__ORAFS__LastImported_c |
string |
The date when the file import was done last for the Financial Account record. UI Label Last Imported |
|
__ORAFS__HeldAwayInstitution_c |
string |
The name of the held away institution of the Financial Account when the Account status is Held Away. This is a mandatory field when status is Held Away. Properties The maximum length is 80. UI Label Held Away Institution |