Benefit Transactions
Subcategories: Attachments, Notes
The benefits transactions resource is used to view, create, update, replace, and delete the benefit transactions.
|
Resource Plural Label |
Benefit Transactions |
|
Resource Name |
__ORACO__AccruedBenefitTxn_c |
Get All Accrued Benefit Transactions
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a term with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create an Accrued Benefit Transaction
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace an Accrued Benefit Transaction
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Table | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the accrued benefit transaction. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get an Accrued Benefit Transaction
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Table | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the accrued benefit transaction. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update an Accrued Benefit Transaction
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Table | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the accrued benefit transaction. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete an Accrued Benefit Transaction
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AccruedBenefitTxn_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Table | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the accrued benefit transaction. |
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.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__Benefit_c |
Id |
__ORACO__Benefit_Id_c |
|
LOVVA_For___ORACO__Benefit_c |
RecordName |
__ORACO__Benefit_c |
|
FK_LOVVA_For___ORACO__Settlement_c |
Id |
__ORACO__Settlement_Id_c |
|
LOVVA_For___ORACO__Settlement_c |
RecordName |
__ORACO__Settlement_c |
|
LOVVA_For___ORACO__Type_c |
LookupCode |
__ORACO__Type_c |
|
FK_LOVVA_For___ORACO__Resolution_c |
Id |
__ORACO__Resolution_Id_c |
|
LOVVA_For___ORACO__Resolution_c |
RecordName |
__ORACO__Resolution_c |
|
FK_LOVVA_For___ORACO__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the benefit transaction. UI Label: ID |
|
RecordName |
string |
The name of the benefit transaction. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the benefit transaction. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the benefit transaction was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the benefit transaction. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the benefit transaction was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the benefit transaction. This attribute is used for internal logics. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login details of the user who last updated the benefit transaction. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code associated with the benefit transaction. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the benefit transaction. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code of the benefit transaction. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
__ORACO__Benefit_Id_c |
number |
The unique identifier of the benefit associated with a transaction. UI Label: Benefit |
|
__ORACO__Benefit_c |
string |
The name of the benefit associated with a transaction. Properties: The maximum length is 1500. UI Label: Benefit |
|
__ORACO__Settlement_Id_c |
number |
deprecated field UI Label: Settlement(Obsolete) |
|
__ORACO__Settlement_c |
string |
deprecated field Properties: The maximum length is 1500. UI Label: Settlement(Obsolete) |
|
__ORACO__AccruedDate_c |
date |
The date when the benefit transaction was accrued. UI Label: Accrued Date |
|
__ORACO__Amount_c |
number |
The amount accrued in the benefit transaction. UI Label: Amount |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
__ORACO__Type_c |
string |
The type of the benefit transaction. Properties: The maximum length is 1500. UI Label: Type |
|
__ORACO__Resolution_Id_c |
number |
Unique id of Settlement associated to Benefit transaction UI Label: Resolution |
|
__ORACO__Resolution_c |
string |
Name of Settlement associated to Benefit transaction Properties: The maximum length is 1500. UI Label: Resolution |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the owner of the record. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the owner of the record. Properties: The maximum length is 1500. UI Label: Owner |