Benefit Balance Transactions
Subcategories: Attachments, Notes
The benefit balance transactions resource is used to view, create, update, replace, or delete book keeping record. A benefit balance transaction is a statement about the accrual or settlement transactions for a benefit record.
|
Resource Plural Label |
Benefit Balance Transactions |
|
Resource Name |
__ORACO__BenefitBalanceTxn_c |
Get All Benefit Balance Transactions
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_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 a Benefit Balance Transaction
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_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 a Benefit Balance Transaction
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit balance 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 a Benefit Balance Transaction
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit balance 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 a Benefit Balance Transaction
Request: PATCH
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit balance 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 a Benefit Balance Transaction
Request: DELETE
URI: crmRestApi/resources/11.13.18.05/__ORACO__BenefitBalanceTxn_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit balance 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__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 balance transaction. UI Label: ID |
|
RecordName |
string |
The name of the benefit balance transaction. This is an auto generated attribute. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the benefit balance transaction. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the benefit balance transaction was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the benefit balance transaction. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the benefit balance transaction was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the benefit balance transaction. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the benefit balance 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 balance. 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. 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 associated with the benefit balance. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
__ORACO__Benefit_Id_c |
number |
The unique identifier of the benefit. UI Label: Benefit |
|
__ORACO__Benefit_c |
string |
The name of the benefit. Properties: The maximum length is 1500. UI Label: Benefit |
|
__ORACO__CumulativeValue_c |
number |
The cumulative value of the benefit balance transaction. UI Label: Cumulative Value |
|
__ORACO__PaidValue_c |
number |
The settled value of the benefit balance transaction. UI Label: Settled Value |
|
__ORACO__AvailableValue_c |
number |
The available value of the benefit balance transaction. UI Label: Available Value |
|
__ORACO__EvaluationDate_c |
date |
The date when the benefit balance was evaluated. UI Label: Evaluation Date |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the resource. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the resource. Properties: The maximum length is 1500. UI Label: Owner |