Route Pre-Settlement Reports
Subcategories: Attachments, Notes
The route pre-setttlement reports resource is used to view, create, and update route pre-settlement reports.
|
Resource Plural Label |
Route Pre-Settlement Reports |
|
Resource Name |
__ORACO__RoutePresettlement_c |
Get all Route Pre-Settlement Reports
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_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 route settlement 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 Route Pre-Settlement Report
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_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 |
Get a Route Pre-Settlement Report
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route settlement. |
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 Route Pre-Settlement Report
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route settlement. |
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 |
Replace a Route Pre-Settlement Report
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route settlement. |
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 Route Pre-Settlement Report
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RoutePresettlement_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
Enter request path parameters table
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__Resource_c |
ResourceProfileId |
__ORACO__Resource_Id_c |
|
LOVVA_For___ORACO__Resource_c |
PartyName |
__ORACO__Resource_c |
|
FK_LOVVA_For___ORACO__Route_c |
Id |
__ORACO__Route_Id_c |
|
LOVVA_For___ORACO__Route_c |
RecordName |
__ORACO__Route_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route presettlement record. UI Label: Record ID |
|
RowType |
string |
This is the type field for categorization of records. Value will be __ORACO__RoutePresettlement_c always. Properties: The maximum length is 80. |
|
RecordName |
string |
The number of the settlement report. Properties: The maximum length is 80. UI Label: Presettlement Report Number |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the record was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the record was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last update from mobile. |
|
CurrencyCode |
string |
The currency code. 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 This attribute is used by CRM Extensibility framework. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of source object. A system-generated read-only attribute used by the application framework. Properties: The maximum length is 0. |
|
__ORACO__SalesRepId_c |
string |
The identifier of the sales representative who is submitting the settlement report. Properties: The maximum length is 80. UI Label: Sales Representative Id |
|
__ORACO__Resource_Id_c |
integer |
UI Label: Sales Representative Name |
|
__ORACO__Resource_c |
string |
The name of the sales representative who is submitting the settlement report. Properties: The maximum length is 1500. UI Label: Sales Representative Name |
|
__ORACO__ReportTime_c |
datetime |
The reported time for the settlement report. UI Label: Report Time |
|
__ORACO__UnitsSold_c |
integer |
The number of units sold during the visits on the routes. UI Label: Units Sold |
|
__ORACO__Currency_c |
string |
The currency of the route. Properties: The maximum length is 80. UI Label: Currency |
|
__ORACO__Balance_c |
number |
The balance funds pending receipt by the cashier. UI Label: Balance |
|
__ORACO__Sales_c |
number |
The amount obtained from sales on the route. UI Label: Sales |
|
__ORACO__Discounts_c |
number |
The sum of the total discounts offered on the route. UI Label: Discounts |
|
__ORACO__NetSales_c |
number |
The total sum of all the delivered invoices on the route. UI Label: Net Sales |
|
__ORACO__CreditsCollected_c |
number |
The credits collected from the route. UI Label: Credits Collected |
|
__ORACO__TotalSales_c |
number |
The sum of net sales and credits collected. UI Label: Total |
|
__ORACO__Bills_c |
number |
The total amount collected as bills. UI Label: Bills |
|
__ORACO__Coins_c |
number |
The total amount collected as coins. UI Label: Coins |
|
__ORACO__TotalCash_c |
number |
The total amount collected as bills and coins. UI Label: Total |
|
__ORACO__TotalBankDeposits_c |
number |
The sum of all bank deposits. UI Label: Total |
|
__ORACO__TotalCoupons_c |
number |
The sum of all coupon payment amounts. UI Label: Total |
|
__ORACO__TotalChecks_c |
number |
The sum of all check payment amounts. UI Label: Total |
|
__ORACO__TotalCreditUsage_c |
number |
The sum of all credit usage amounts. UI Label: Total |
|
__ORACO__TotalProofofPurchase_c |
number |
The sum of all proof of purchase payment amounts. UI Label: Total |
|
__ORACO__TotalETransfer_c |
number |
The sum of all electronic transfer payment amounts. UI Label: Total |
|
__ORACO__TotalCreditCard_c |
number |
The sum of all credit card payment amounts. UI Label: Total |
|
__ORACO__TotalInvShortage_c |
number |
The total amount corresponding to Lost Inventory. UI Label: Total |
|
__ORACO__TotalExpenses_c |
number |
The sum of all expense lines. UI Label: Total Expenses |
|
__ORACO__Shortage_c |
number |
The missing cash. UI Label: Shortage |
|
__ORACO__Overage_c |
number |
The extra cash. UI Label: Overage |
|
__ORACO__Route_Id_c |
integer |
The identifier of the route for which this audit is done. UI Label: Route |
|
__ORACO__Route_c |
string |
The name of the route for which this audit is done. Properties: The maximum length is 1500. UI Label: Route |
|
__ORACO__Note_c |
string |
The notes regarding the inventory audit. Properties: The maximum length is 80. UI Label: Note |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |