Financials
The following services are included in this functional area:
Budgets
The following services are included in this functional area:
Half Data Budget Upload Service
Update Half Data Budget
Business Overview
The primary role of this service is to modify half data budgets and send them to Merchandising.
Modify Half Data Budget
Business Overview
This service modifies half data budget by calling the SVCPROV_HDB
package to load input data to the staging
tables and then calling the core half data budget package to validate and insert data to the Merchandising tables.
Input Parameters
SvcprovHdbdescRecRDO
Parameter Name | Data Type |
---|---|
dept |
BigDecimal |
halfNo |
BigDecimal |
locType |
String |
location |
BigDecimal |
setOfBooksId |
BigDecimal |
cumMarkonPct |
BigDecimal |
shrinkagePct |
BigDecimal |
markdownPct |
BigDecimal |
JSON Structure
[
{
"dept": null,
"halfNo": null,
"locType": null,
"location": null,
"setOfBooksId": null,
"cumMarkonPct": null,
"shrinkagePct": null,
"markdownPct": null
}
]
Output
SvcprovHdbStatusRecRDO
Parameter Name | Data Type |
---|---|
statusMsg |
String |
hdbErrTbl |
List< SvcprovFailHdbRecRDO> |
SvcprovFailHdbRecRDO
Parameter Name | Data Type |
---|---|
dept |
BigDecimal |
halfNo |
BigDecimal |
locType |
String |
location |
BigDecimal |
setOfBooksId |
BigDecimal |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure
{
"statusMsg": null,
" hdbErrTbl ": [
{
"dept": null,
"halfNo": null,
"locType": null,
"location": null,
"setOfBooksId": null,
"errorMsg": null,
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}
],
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}
Currency
The following services are included in this functional area:
Currency Download Service
Get Currency Definitions
Output
Table 5-48 MblCurrenciesRDO
Parameter Name | Data Type |
---|---|
currencyCode |
String |
currencyDescription |
String |
currencyCostFormat |
String |
currencyRetailFormat |
String |
currencyCostDecimal |
BigDecimal |
currencyRetailDecimal |
BigDecimal |
JSON Structure:
[
{
"links": [],
"currencyCode": "AED",
"currencyDescription": "U.A.E. Dirham",
"currencyCostFormat": "FM9G999G999G999G990D9099PR",
"currencyRetailFormat": "FM9G999G999G999G990D90PR",
"currencyCostDecimal": 4,
"currencyRetailDecimal": 2,
"hyperMediaContent": {
"linkRDO": []
}
},
{
"links": [],
"currencyCode": "ALL",
"currencyDescription": "UNKNOWN",
"currencyCostFormat": "FMD0",
"currencyRetailFormat": "FMD90",
"currencyCostDecimal": 2,
"currencyRetailDecimal": 2,
"hyperMediaContent": {
"linkRDO": []
}
},
........
Currency Exchange Rate Download Service
Get Currency Exchange Rates
This section describes the Currency Rate service.
Business Overview
This service is used to retrieve all currencies and currency conversion rates. The conversion rate is the value used to convert to the primary currency.
Output
RestCurrencyRatesRecRDO
Parameter Name | Data Type |
---|---|
exchangeRate |
BigDecimal |
effectiveDate |
Timestamp |
currencyCode |
String |
exchangeType |
String |
JSON Structure
[
{
"exchangeRate": null,
"effectiveDate": null,
"currencyCode": null,
"exchangeType": null,
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}
]
Currency Exchange Rate Upload Service
Manage Currency Exchange Rates
Business Overview
Currency exchange rates constitute financial information that is subscribed to by Merchandising. A currency exchange rate is the price of one country's currency expressed in another country's currency. This webservice assumes that currency codes are already present in Merchandising. This service supports creating new rates by date and updating existing rates for the same conversion date.
Availability During Nightly Batch Cycle
This service will not be available when batches affecting either inventory or cost are in-progress.
Input Payload Details
Table 5-49 Manage - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
collectionSize |
Yes |
Number (4) |
Number of items in the collection. |
items |
Yes |
Collection of Object |
References a collection of currency exchange rate details. |
Table 5-50 Items - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
fromCurrency |
Yes |
String (3) |
Contains the currency code that the rate exchange is from. |
toCurrency |
Yes |
String (3) |
Contains the currency code that the rate exchange is to. |
conversionDate |
Yes |
date |
Contains the date on which the currency rate became or will become active. |
conversionRate |
Yes |
Number (20,10) |
The exchange rate between the two currency codes for the type and effective date. |
conversionType |
Yes |
String (30) |
This field identifies the type of exchange rate the history exists for. Valid values are valid exchange types in fif_currency_xref table. |
Sample Input Message
{
"collectionSize": 1,
"items": [
{
"fromCurrency": "USD",
"toCurrency": "AUD",
"conversionDate": "2001-12-31",
"conversionRate": 3,
"conversionType": "C"
}
]
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
General Ledger
The following services are included in this functional area:
General Ledger Chart of Accounts Upload Service
Manage General Ledger Chart of Accounts
Business Overview
This service is used when Retail Financial Integration (RFI) is not being used and integration with a financial system is a custom or to a non-Oracle financials system. When using RFI with an Oracle Financial system, the chart of accounts (COA) information in Merchandising and Sales Audit is created through a mapping and COA validation process. It is used to create new chart of account entries, as well as update existing entries.
Before Merchandising can publish stock ledger data to an external financial application, it must receive the General Ledger chart of accounts (GLCOA) structure. The chart of accounts is the financial application's debit and credit account segments (for example, company, cost center, account, and so on). These are mapped to the transactions, locations, and product hierarchy in Merchandising when stock ledger data and Sales Audit totals are sent to the General Ledger. In some financial applications, these are known as code combination chart fields. There is also a primary account, in some systems know as a CCID that uniquely identifies the combination of segment or chart field values. Upon receipt of GLCOA message data, Merchandising populates the data to the FIF_GL_ACCT table.
Input Payload Details
Table 5-51 Manage - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
collectionSize |
Yes |
Number (4) |
Number of items in the collection. |
items |
Yes |
Collection of Object |
References a collection of GL chart of accounts. |
Table 5-52 Items - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
primaryAccount |
Yes |
String (25) |
This denotes the primary account for a chart of accounts. |
attribute1 |
No |
String (25) |
Secondary Account information. A value is required if description1 is supplied. |
attribute2 |
No |
String (25) |
Secondary Account information. A value is required if description2 is supplied. |
attribute3 |
No |
String (25) |
Secondary Account information. A value is required if description3 is supplied. |
attribute4 |
No |
String (25) |
Secondary Account information. A value is required if description4 is supplied. |
attribute5 |
No |
String (25) |
Secondary Account information. A value is required if description5 is supplied. |
attribute6 |
No |
String (25) |
Secondary Account information. A value is required if description6 is supplied. |
attribute7 |
No |
String (25) |
Secondary Account information. A value is required if description7 is supplied. |
attribute8 |
No |
String (25) |
Secondary Account information. A value is required if description8 is supplied. |
attribute9 |
No |
String (25) |
Secondary Account information. A value is required if description9 is supplied. |
attribute10 |
No |
String (25) |
Secondary Account information. A value is required if description10 is supplied. |
attribute11 |
No |
String (25) |
Secondary Account information. A value is required if description11 is supplied. |
attribute12 |
No |
String (25) |
Secondary Account information. A value is required if description12 is supplied. |
attribute13 |
No |
String (25) |
Secondary Account information. A value is required if description13 is supplied. |
attribute14 |
No |
String (25) |
Secondary Account information. A value is required if description14 is supplied. |
attribute15 |
No |
String (25) |
Secondary Account information. A value is required if description15 is supplied. |
description1 |
No |
String (50) |
Description of the attribute1 field. Required if attribute1 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description2 |
No |
String (50) |
Description of the attribute2 field. Required if attribute2 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description3 |
No |
String (50) |
Description of the attribute3 field. Required if attribute3 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description4 |
No |
String (50) |
Description of the attribute4 field. Required if attribute4 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description5 |
No |
String (50) |
Description of the attribute5 field. Required if attribute5 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description6 |
No |
String (50) |
Description of the attribute6 field. Required if attribute6 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description7 |
No |
String (50) |
Description of the attribute7 field. Required if attribute7 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description8 |
No |
String (50) |
Description of the attribute8 field. Required if attribute8 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description9 |
No |
String (50) |
Description of the attribute9 field. Required if attribute9 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description10 |
No |
String (50) |
Description of the attribute10 field. Required if attribute10 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description11 |
No |
String (50) |
Description of the attribute11 field. Required if attribute11 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description12 |
No |
String (50) |
Description of the attribute12 field. Required if attribute12 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description13 |
No |
String (50) |
Description of the attribute13 field. Required if attribute13 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
description14 |
No |
String (50) |
Description of the attribute14 field. Required if attribute14 is supplied and you are not using Oracle Financials 11.5.10 or greater |
description15 |
No |
String (50) |
Description of the attribute15 field. Required if attribute15 is supplied and you are not using Oracle Financials 11.5.10 or greater. |
setOfBooksId |
No |
Number (15) |
The Set of books Identifier. |
attribute16 |
No |
String (25) |
Secondary Account information. A value is required if description16 is supplied. |
attribute17 |
No |
String (25) |
Secondary Account information. A value is required if description17 is supplied. |
attribute18 |
No |
String (25) |
Secondary Account information. A value is required if description18 is supplied. |
attribute19 |
No |
String (25) |
Secondary Account information. A value is required if description19 is supplied. |
attribute20 |
No |
String (25) |
Secondary Account information. A value is required if description20 is supplied. |
description16 |
No |
String (50) |
Description of the attribute16 field. Required if attribute16 supplied and you are not using Oracle Financials 11. 5. 10 or greater. |
description17 |
No |
String (50) |
Description of the attribute17 field. Required if attribute17 supplied and you are not using Oracle Financials 11. 5. 10 or greater. |
description18 |
No |
String (50) |
Description of the attribute18 field. Required if attribute18 supplied and you are not using Oracle Financials 11. 5. 10 or greater. |
description19 |
No |
String (50) |
Description of the attribute19 field. Required if attribute19 supplied and you are not using Oracle Financials 11. 5. 10 or greater. |
description20 |
No |
String (50) |
Description of the attribute20 field. Required if attribute20 supplied and you are not using Oracle Financials 11. 5. 10 or greater. |
Sample Input Message
{
"collectionSize": 1,
"items": [
{
"primaryAccount": "99338",
"attribute1": "1001",
"attribute2": "1002",
"attribute3": "1003",
"attribute4": "1004",
"attribute5": "1005",
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"description1": "Attribute 1001",
"description2": "Attribute 1002",
"description3": "Attribute 1003",
"description4": "Attribute 1004",
"description5": "Attribute 1005",
"description6": null,
"description7": null,
"description8": null,
"description9": null,
"description10": null,
"description11": null,
"description12": null,
"description13": null,
"description14": null,
"description15": null,
"setOfBooksId": 111111111111111,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"description16": null,
"description17": null,
"description18": null,
"description19": null,
"description20": null
}
]
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Terms
The following services are included in this functional area:
Freight Term Upload Service
Manage Freight Term
Business Overview
This service is exposed to allow an external financial system to manage freight terms in Merchandising. Freight Terms are financial arrangement information related to shipping that can be subscribed to by Merchandising from a financial system. Freight terms are the terms for shipping - for example, the freight terms could be a certain percentage of the total cost; a flat fee per order, etc. After confirming the validity of the records enclosed within the message, Merchandising is updated with the information.
Both new records and updates to already existing ones are sent through this single service. Freight Terms and external reference ID are optional fields. If both are empty or the external reference ID does not map to an existing record, a new ID will be generated to create the freight term. If both are passed, Freight Terms will be used to create or update the record. If only the external reference ID is provided and more than one matching record is found, service will raise an error.
When a new freight term is created, this service will validate that all required fields such as description, enabled flag, start and end dates are present in the message. After this field validation is completed successfully, the freight term record in the message will be inserted if the term does not exist. If the freight term exists, then the external reference ID, dates and enabled flag will be updated.
Input Payload Details
Table 5-53 Manage - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
freightTerms |
No |
String (30) |
Contains a number that uniquely identifies the freight terms. |
externalReferenceId |
No |
String (50) |
Contains the ID for the freight terms used in the external financial system. |
description |
Yes |
String (240) |
Contains a description of the freight terms used in the system. |
enabledFlag |
Yes |
String (1) |
Indicates whether the freight terms are valid or invalid within the respective application. Valid values are 'Y'es or 'N'o. If interface is from Oracle Financials, the Check_Enabled logic will be bypassed which means field would not be required. |
startActiveDate |
No |
date |
Indicates the date for assigning an active date to the Freight Terms. |
endActiveDate |
No |
date |
Indicates the date for assigning an inactive date to the Freight Terms. |
Sample Input Message
{
"freightTerms": "FTTERM01",
"externalReferenceId": "FTTERM55",
"description": "Freight Term 01",
"enabledFlag": "Y",
"startActiveDate": "2001-12-31",
"endActiveDate": "2001-12-31"
}
Response Code: 200 (Success)
Table 5-54 ManageResponse - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
status |
Yes |
String (10) |
Status code for a successful service call. |
freightTerms |
Yes |
String (30) |
Contains a number that uniquely identifies the freight terms. |
externalReferenceId |
No |
String (50) |
Contains the ID for the freight terms used in the external financial system. |
Sample Response Message
{
"status": "SUCCESS",
"freightTerms": "FTTERM01",
"externalReferenceId": "FTTERM55"
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Payment Term Upload Service
Create Payment Term
Business Overview
This service is used by Oracle Retail Financial Integration (RFI) for integration of payment terms with PeopleSoft Financials, and can also be used by an external financial system to send new payment terms information to Merchandising. Terms and external reference Id are optional fields. If Terms id is empty, a new Id will be generated to create the payment term.
Input Payload Details
Table 5-55 Create - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
terms |
No |
String (15) |
Unique id for this payment term. |
externalReferenceId |
No |
String (50) |
ID for the supplier terms used in the external financial system. |
termsCode |
Yes |
String (50) |
The alpha value which acts as the Term code in Oracle Financials. |
description |
Yes |
String (240) |
Description of the payment terms. |
rank |
No |
Number (10) |
Unique rank to rate invoice payment terms against PO terms |
details |
No |
Collection of Object |
Child node. |
Table 5-56 Details - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
termsSequence |
Yes |
Number (10) |
Sequence for the discount percent and part of unique identifier for the detail line. |
dueDays |
Yes |
Number (3) |
The number of days until payment is due. |
dueMaximumAmount |
Yes |
Number (12,4) |
Maximum payment amount due by a certain date. |
dueDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate due date. |
discountDays |
Yes |
Number (3) |
Number of days in which payment must be made to get the discount. |
percent |
Yes |
Number (12,4) |
Percentage used to calculate discount available. |
discountDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate discount date. |
discountMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate discount date. |
fixedDate |
No |
date |
Fixed due date. |
enabledFlag |
Yes |
String (1) |
Indicates whether the Payment terms are valid or invalid within the respective application. The values would be either (Y)es or (N)o. |
startActiveDate |
No |
date |
Start date terms are in effect. |
endActiveDate |
No |
date |
End date terms are in effect. |
dueMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate due date. |
cutoffDay |
Yes |
Number (2) |
Day of month after which the following month will be used for calculations. |
Sample Input Message
{
"terms": "55",
"externalReferenceId": "55",
"termsCode": "55",
"description": "55 termsDesc",
"rank": 12,
"details": [
{
"termsSequence": 1,
"dueDays": 100,
"dueMaximumAmount": 12.95,
"dueDayOfMonth": 10,
"discountDays": 100,
"percent": 3,
"discountDayOfMonth": 10,
"discountMonthForward": 100,
"fixedDate": "2001-12-31",
"enabledFlag": "N",
"startActiveDate": "2001-12-31",
"endActiveDate": "2001-12-31",
"dueMonthForward": 100,
"cutoffDay": 10
}
]
}
Response Code: 200 (Success)
Table 5-57 CreateResponse - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
status |
Yes |
String (10) |
Status code for a successful service call. |
terms |
Yes |
String (15) |
Unique id for this payment term. |
externalReferenceId |
No |
String (50) |
ID for the supplier terms used in the external financial system. |
Sample Response Message
{
"status": "SUCCESS",
"terms": "55",
"externalReferenceId": "55"
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Create Payment Term Detail
Business Overview
This service can be used by an external financial system to send additional details for existing payment terms to Merchandising. Terms and external reference ID are optional fields, but at least one must be provided when adding details to an existing payment term. If both are passed, Terms will be used to identify the record. If only the external reference ID is provided, it will be used to find a matching payment term. If more than one record is found, service will raise an error.
Input Payload Details
Table 5-58 Create - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
terms |
No |
String (15) |
Unique id for this payment term. |
externalReferenceId |
No |
String (50) |
ID for the supplier terms used in the external financial system. |
termsCode |
Yes |
String (50) |
The alpha value which acts as the Term code in Oracle Financials. |
description |
Yes |
String (240) |
Description of the payment terms. |
rank |
No |
Number (10) |
Unique rank to rate invoice payment terms against PO terms |
details |
No |
Collection of Object |
Child node. |
Table 5-59 Details - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
termsSequence |
Yes |
Number (10) |
Sequence for the discount percent and part of unique identifier for the detail line. |
dueDays |
Yes |
Number (3) |
The number of days until payment is due. |
dueMaximumAmount |
Yes |
Number (12,4) |
Maximum payment amount due by a certain date. |
dueDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate due date. |
discountDays |
Yes |
Number (3) |
Number of days in which payment must be made to get the discount. |
percent |
Yes |
Number (12,4) |
Percentage used to calculate discount available. |
discountDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate discount date. |
discountMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate discount date. |
fixedDate |
No |
date |
Fixed due date. |
enabledFlag |
Yes |
String (1) |
Indicates whether the Payment terms are valid or invalid within the respective application. The values would be either (Y)es or (N)o. |
startActiveDate |
No |
date |
Start date terms are in effect. |
endActiveDate |
No |
date |
End date terms are in effect. |
dueMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate due date. |
cutoffDay |
Yes |
Number (2) |
Day of month after which the following month will be used for calculations. |
Sample Input Message
{
"terms": "55",
"externalReferenceId": "55",
"termsCode": "55DTLADD",
"description": "55DESCDTLADD",
"rank": 14,
"details": [
{
"termsSequence": 2,
"dueDays": 100,
"dueMaximumAmount": 12.95,
"dueDayOfMonth": 10,
"discountDays": 100,
"percent": 4,
"discountDayOfMonth": 10,
"discountMonthForward": 100,
"fixedDate": "2001-12-31",
"enabledFlag": "N",
"startActiveDate": "2001-12-31",
"endActiveDate": "2001-12-31",
"dueMonthForward": 100,
"cutoffDay": 12
}
]
}
Response Code: 200 (Success)
Table 5-60 CreateResponse - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
status |
Yes |
String (10) |
Status code for a successful service call |
Sample Response Message
{
"status": "SUCCESS"
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Update Payment Term
Business Overview
This service can be used by an external financial system to send updated payment terms information to Merchandising. Terms and external reference ID are optional fields, but at least one must be provided when updating a payment term. If both are passed, Terms will be used to identify the record. If only the external reference ID is provided, it will be used to find a matching payment term. If more than one record is found, the service will raise an error.
For more details on Payment Terms, see the Create Payment Term service description.
Input Payload Details
Table 5-61 Update - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
terms |
No |
String (15) |
Unique id for this payment term. |
externalReferenceId |
No |
String (50) |
ID for the supplier terms used in the external financial system. |
termsCode |
Yes |
String (50) |
The alpha value which acts as the Term code in Oracle Financials. |
description |
Yes |
String (240) |
Description of the payment terms. |
rank |
No |
Number (10) |
Unique rank to rate invoice payment terms against PO terms |
Sample Input Message
{
"terms": "55",
"externalReferenceId": "55",
"termsCode": "55HDRUPD",
"description": "55 TERMS Description HDR UPD",
"rank": 13
}
Response Code: 200 (Success)
Table 5-62 UpdateResponse - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
status |
Yes |
String (10) |
Status code for a successful service call |
Sample Response Message
{
"status": "SUCCESS"
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Update Payment Term Detail
Business Overview
This service can be used by an external financial systems to send detail level updates to the payment terms that already exist within Merchandising. Terms and external reference ID are optional fields, but at least one must be provided when updating details of an existing payment term. If both are passed, Terms will be used to identify the record. If only the external reference ID is provided, it will be used to find a matching payment term. If more than one record is found, service will raise an error.
Input Payload Details
Table 5-63 Update - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
terms |
No |
String (15) |
Unique id for this payment term. |
externalReferenceId |
No |
String (50) |
ID for the supplier terms used in the external financial system. |
termsCode |
Yes |
String (50) |
The alpha value which acts as the Term code in Oracle Financials. |
description |
Yes |
String (240) |
Description of the payment terms. |
rank |
No |
Number (10) |
Unique rank to rate invoice payment terms against PO terms |
details |
No |
Collection of Object |
Child node. |
Table 5-64 Details - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
termsSequence |
Yes |
Number (10) |
Sequence for the discount percent and part of unique identifier for the detail line. |
dueDays |
Yes |
Number (3) |
The number of days until payment is due. |
dueMaximumAmount |
Yes |
Number (12,4) |
Maximum payment amount due by a certain date. |
dueDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate due date. |
discountDays |
Yes |
Number (3) |
Number of days in which payment must be made to get the discount. |
percent |
Yes |
Number (12,4) |
Percentage used to calculate discount available. |
discountDayOfMonth |
Yes |
Number (2) |
Day of month used to calculate discount date. |
discountMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate discount date. |
fixedDate |
No |
date |
Fixed due date. |
enabledFlag |
Yes |
String (1) |
Indicates whether the Payment terms are valid or invalid within the respective application. The values would be either (Y)es or (N)o. |
startActiveDate |
No |
date |
Start date terms are in effect. |
endActiveDate |
No |
date |
End date terms are in effect. |
dueMonthForward |
Yes |
Number (3) |
Number of months ahead to calculate due date. |
cutoffDay |
Yes |
Number (2) |
Day of month after which the following month will be used for calculations. |
Sample Input Message
{
"terms": "55",
"externalReferenceId": "55",
"termsCode": "55DTLUPD",
"description": "55DESCDTLUPD",
"rank": 14,
"details": [
{
"termsSequence": 2,
"dueDays": 55,
"dueMaximumAmount": 12.95,
"dueDayOfMonth": 10,
"discountDays": 55,
"percent": 4,
"discountDayOfMonth": 10,
"discountMonthForward": 100,
"fixedDate": "2001-12-31",
"enabledFlag": "N",
"startActiveDate": "2001-12-31",
"endActiveDate": "2001-12-31",
"dueMonthForward": 55,
"cutoffDay": 12
}
]
}
Response Code: 200 (Success)
Table 5-65 UpdateResponse - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
status |
Yes |
String (10) |
Status code for a successful service call |
Sample Response Message
{
"status": "SUCCESS"
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
will be present when input payload or input parameters do not match the schema definition for this service.
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
]
}
Transaction Data
The following services are included in this functional area:
Transaction Data Upload Service
Manage Transaction Data
Business Overview
The primary role of this service is to create transaction data records in the stock ledger, such as to adjust previously posted transactions. If the transaction is marked for WAC recalculation, it will recalculate the WAC for the item/location at the same time. The transactions written by this service will not impact unit inventory in Merchandising.
Input Parameters
Parameter Name | Required | Data Type | Description |
---|---|---|---|
Item |
No |
String |
Item Identification |
Dept |
Yes |
Number |
Department Id |
Class |
Yes |
Number |
Class Id |
Subclass |
Yes |
Number |
Subclass Id |
LocType |
Yes |
String |
Location Type, Valid values are |
Location |
Yes |
Number |
Location ID |
TranDate |
No |
Date |
Date of Transaction. (Format: |
TranCode |
Yes |
Number |
Transaction Type Identification. |
AdjCode |
No |
String |
Type of Adjustment. Valid values are |
Units |
Yes |
BigDecimal |
Number of units involved in transaction. |
TotalCost |
No |
BigDecimal |
Total Cost associated with transaction. |
TotalRetail |
No |
BigDecimal |
Total Retail value associated with transaction. |
RefNo1 |
No |
String |
Reference number associated with transaction. |
RefNo2 |
No |
String |
Reference number associated with transaction. |
GLRefNo |
No |
String |
Reference number associated with transactions, and is used for defining the General Ledger account relationship, along with dept, class, subclass, location and tran_code. |
OldUnitRetail |
No |
BigDecimal |
Old Unit Retail |
NewUnitRetail |
No |
BigDecimal |
New Unit Retail |
SalesType |
No |
String |
Type of Sale.Valid Values are ‘C’learance,’P’romotion and ‘R’egular. |
VatRate |
No |
BigDecimal |
VAT Rate |
Avg Cost |
No |
BigDecimal |
Average cost for the SKU |
RefPackNo |
No |
String |
Pack Number for the transaction item. |
TotalCostExclusiveELC |
No |
BigDecimal |
Cost Exclusive for ELC |
WACRecalcIndicator |
No |
String |
WAC should be recalculated.Valid values are |
Example JSON input
[
{
"item": "string",
"dept": 0,
"classId": 0,
"subClass": 0,
"locType": "string",
"location": 0,
"tranDate": "string",
"tranCode": 0,
"adjCode": "string",
"units": 0,
"totalCost": 0,
"totalRetail": 0,
"refNo1": "string",
"refNo2": "string",
"glRefNo": "string",
"oldUnitRetail": 0,
"newUnitRetail": 0,
"salesType": "string",
"vatRate": 0,
"avCost": 0,
"refPackNo": "string",
"totalCostExclElc": 0,
"wacRecalcInd": "string"
"hyperMediaContent": {}
}
]
Output
Table 5-66 RestTranDataStatusRec
Parameter Name | Data Type |
---|---|
Status Message |
String |
TranDataErrorTBL |
List< RestTranDataFailTbl> |
Table 5-67 TranDataErrorTBL
Parameter Name | Data Type |
---|---|
Item |
String |
Dept |
Number |
Class |
Number |
Subclass |
Number |
Location Type |
String |
Location |
Number |
Tran Code |
Number |
Units |
BigDecimal |
Total Cost |
BigDecimal |
Total Retail |
BigDecimal |
RefNo1 |
String |
RefNo2 |
String |
GLRefNo |
String |
WACRecalcIndicator |
String |
ErrorMessage |
String |
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
TRAN_DATA |
No |
Yes |
No |
No |
ITEM_MASTER |
Yes |
No |
No |
No |
DEPS |
Yes |
No |
No |
No |
SUBCLASS |
Yes |
No |
No |
No |
STORE |
Yes |
No |
No |
No |
WH |
Yes |
No |
No |
No |
PARTNER |
Yes |
No |
No |
No |
TRAN_DATA_CODES |
Yes |
No |
No |
No |
ITEM_LOC |
Yes |
No |
No |
No |
ITEM_LOC_SOH |
Yes |
No |
Yes |
No |
VAT_RATE |
Yes |
No |
No |
No |
VAT_REGION |
Yes |
No |
No |
No |
PACKITEM |
Yes |
No |
No |
No |
SYSTEM_OPTIONS |
Yes |
No |
No |
No |
PERIOD |
Yes |
No |
No |
No |