3 Integration

Retail Fiscal Management Integration Overview

Retail Fiscal Management Cloud Service integration flows comprise a set of REST services that support the configuration of fiscal attributes and the fiscal classification of items and entities, as well as the services that support the receiving and generation of fiscal documents.

In addition to these services, the Merchandising Foundation data subscription APIs also have extensions that allow the creation of foundation data already associated with fiscal attributes. The Merchandising APIs with this extension are:

Item Subscription API: This API subscribes to items from external systems to create, update or delete items in Merchandising. It also supports the insertion of data into the Item Induction staging tables.

Item Location Subscription API: This API subscribes to item/location data from external systems to create or modify item location combinations in Merchandising. Item/location relationships are created for an item and a single location, or by using one of the levels of the organizational hierarchy.

Store Subscription API: The Store Subscription API provides the ability to keep store data in Merchandising in sync with an external system if Merchandising is not being used as the system of record for organizational hierarchy information. The store data handled by the API includes basic store data, in addition to addresses, store hours, location traits, up-charges, and walk-through stores.

Vendor Subscription API (Suppliers and Partners): Merchandising subscribes to vendor information that is published from an external financial application; however, this API is not used by Oracle Retail Financial Integration (RFI). “Vendor” can refer to either a partner or a supplier.

Contract Conventions

Required indicates a required input or a conditional business requirement explained in the field description. Optional fields may still be required by a selected workflow, scenario or template. XML elements must use the namespace and child structure of the applicable scenario. XML examples containing descriptive payload text illustrate the integration envelope; replace that text with the complete scenario payload before calling the service.

The body of the three FDM creation services is a JSON array. It is not a JSON string and is not wrapped in an attributes property. Query parameters belong in the URL. Output examples illustrate the returned structure; identifiers, dates and statuses depend on the request and processing state. Table Impact matrices identify the principal tables listed for each service; downstream workflow activity can affect additional tables.

Service Inventory

Table 3-1 REST Service Inventory

Method	Resource
POST	/services/private/fdm/fiscalAttributes/create
POST	/services/private/fdm/fiscalAttributesLists/create
POST	/services/private/fdm/reclass/create
GET	/services/private/fdm/fiscalAttributes/get
GET	/services/private/fdm/fiscalAttributesLists/get
POST	/services/private/flx/integration/create
GET	/services/private/flx/integration/get
POST	/services/private/flx/fdr/nfeManifest
GET	/services/private/integration/list
PUT	/services/private/integration/manage
GET	/services/private/documents
GET	/services/private/documents/status
PUT	/services/private/documents/ledger/manage
GET	/services/private/documents/ledger
POST	/services/private/flx/documents/upload
GET	/services/private/fdg/documentDetail
POST	/services/private/fdg/processDoc
POST	/services/private/fdg/processPreDoc
POST	/services/private/fdg/processDocStatus
POST	/services/private/fdg/processDocCancel
GET	/services/private/fdg/documentStatusDetail
GET	/services/private/fdg/nextDocumentDetail

ReSTful Web Services

Create or Update Fiscal Attributes Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Creates, updates or deletes fiscal attribute definitions and their parameters. NEW creates a definition, MOD modifies an existing definition and DEL requests deletion. Deletion is subject to dependency checks for child records.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdm/fiscalAttributes/create?action=NEW

Content-Type: application/json or application/xml. Response media type: application/json or application/xml.

Input

Table 3-2 Input

Parameter Name	Required	Data Type	Description
action	Yes	String	URL query parameter. Valid values: NEW, MOD, DEL.
body	Yes	Array of RestRfmFdmSetFa	Collection of fiscal attribute definitions.

Table 3-3 RestRfmFdmSetFa

Parameter Name	Required	Data Type	Description
code	Yes	String	Attribute code in snake case, for example TAX_PAYER_TYPE.
camelCase	Yes	String	Attribute code used in XML and JSON structures, for example taxPayerType.
label	Yes	String	Attribute label displayed on Fiscal Data Management screens.
description	Yes	String	Description of the attribute and its purpose.
template	Yes	String	Merchandising entity associated with the attribute. ITEM_MASTER, ITEM_LOC, ITEM_SUPPLIER, LOCATION, SUPS, PARTNER.
country	Yes	String	Country code from Merchandising COUNTRY.
effectiveFromDate	No	Date	Start of attribute availability.
effectiveToDate	No	Date	End of attribute availability.
systemBehavior	No	String	Y/N. Indicates use in system behavior rules.
fiscalDocumentUse	No	String	Y/N. Indicates use as additional information in fiscal documents.
taxCalculation	No	String	Y/N. Indicates inclusion in tax calculation integration data.
fiscalReporting	No	String	Y/N. Indicates inclusion in fiscal reporting data.
userDefinedInd	No	String	Y/N. Indicates a user-defined attribute.
groupCode	Yes	String	Screen grouping code: 1 Fiscal Codes, 2 System Behavior, 3 Tax Inscriptions, 4 User defined.
screenSeq	Yes	Number	Display sequence within the group. Review existing attributes before selecting a new sequence.
mandatory	Yes	String	Y/N. Whether the attribute must be associated with an item or entity for fiscal classification to be complete.
dataType	Yes	String	VARCHAR, NUMBER or DATE.
dataLength	Yes	String	Attribute data length.
attributeType	No	String	DATALIST for a list of valid codes; FIXVALUE for a value entered directly.
listSource	No	String	For DATALIST: INTERNAL, EXTERNAL or MFCS.
listCode	No	String	List name for an INTERNAL or EXTERNAL DATALIST. Maintain values with Fiscal Attribute Lists Create.
listTableName	No	String	For MFCS lists, Merchandising source table.
listCodeColumn	No	String	For MFCS lists, column containing the code.
listDescColumn	No	String	For MFCS lists, column containing the description.
parentAttribCode	No	String	Parent attribute code used for hierarchical attribute selection.
functionValidation	No	String	Predefined fiscal validation function applied during classification. See the validation function catalog.
levelValidation	No	String	Simple conditional validation rule, for example ATTRIBUTE1 = 'Y', evaluated for the entity being classified.
uniqueInd	Yes	String	Y/N. Y allows only one value of this attribute for a given item or entity.

blockedForEdit is a computed response field of the fiscal attribute query. The creation and modification service does not persist this field. Use mandatory for the mandatory flag; availabilityStatus and required are not fields in this input contract.

JSON Input Structure

[
  {
    "code": "ABRANGENCIA",
    "camelCase": "abrangencia",
    "label": "Abrangencia",
    "description": "Item scope: N national, E state, M municipal.",
    "template": "ITEM_MASTER",
    "country": "BR",
    "effectiveFromDate": "2023-05-16T00:00:00.000Z",
    "effectiveToDate": null,
    "systemBehavior": null,
    "fiscalDocumentUse": null,
    "taxCalculation": null,
    "fiscalReporting": null,
    "userDefinedInd": "Y",
    "groupCode": "4",
    "screenSeq": 14,
    "mandatory": "Y",
    "dataType": "VARCHAR",
    "dataLength": "1",
    "attributeType": "DATALIST",
    "listSource": "INTERNAL",
    "listCode": "itemAbrangenciaList",
    "listTableName": null,
    "listCodeColumn": null,
    "listDescColumn": null,
    "parentAttribCode": null,
    "functionValidation": null,
    "levelValidation": null,
    "uniqueInd": "Y"
  }
]

Output

Table 3-4 Operation Status

Parameter Name	Data Type	Description
status	String	S: successful operation; E: operation error.
errors	Array	Error records; null when no errors are returned.

Table 3-5 Fiscal Attribute Error

Parameter Name	Data Type	Description
errorCode	String	Error code.
errorDesc	String	Error description.

JSON Output Structure

{
  "status": "S",
  "errors": null
}

Table Impact

Table 3-6 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FDM_SET_FA	Yes	Yes	Yes	Yes
COUNTRY	Yes	No	No	No
RFM_FDM_LIST	Yes	No	No	Yes

Validation Function Catalog

The functions below belong to rfm_fdm_val_fiscal_content_sql. Supply the package name followed by the function name in functionValidation.

Table 3-7 Fiscal Validation Functions

Function Name	Country	Description
validate_cnpj_digit	BR	Corporate taxpayer identifier check digit validation.
validate_cpf_digit	BR	Individual taxpayer identifier check digit validation.
validate_ie	BR	State inscription validation based on the fiscal address.
validate_ie_ac	BR	State inscription validation for Acre.
validate_ie_al	BR	State inscription validation for Alagoas.
validate_ie_am	BR	State inscription validation for Amazonas.
validate_ie_ap	BR	State inscription validation for Amapa.
validate_ie_ba	BR	State inscription validation for Bahia.
validate_ie_ce	BR	State inscription validation for Ceara.
validate_ie_df	BR	State inscription validation for Federal District.
validate_ie_es	BR	State inscription validation for Espirito Santo.
validate_ie_go	BR	State inscription validation for Goias.
validate_ie_ma	BR	State inscription validation for Maranhao.
validate_ie_mg	BR	State inscription validation for Minas Gerais.
validate_ie_ms	BR	State inscription validation for Mato Grosso do Sul.
validate_ie_mt	BR	State inscription validation for Mato Grosso.
validate_ie_pa	BR	State inscription validation for Para.
validate_ie_pb	BR	State inscription validation for Paraiba.
validate_ie_pe	BR	State inscription validation for Pernambuco.
validate_ie_pi	BR	State inscription validation for Piaui.
validate_ie_pr	BR	State inscription validation for Parana.
validate_ie_rj	BR	State inscription validation for Rio de Janeiro.
validate_ie_rn	BR	State inscription validation for Rio Grande do Norte.
validate_ie_ro	BR	State inscription validation for Rondonia.
validate_ie_rr	BR	State inscription validation for Roraima.
validate_ie_rs	BR	State inscription validation for Rio Grande do Sul.
validate_ie_sc	BR	State inscription validation for Santa Catarina.
validate_ie_se	BR	State inscription validation for Sergipe.
validate_ie_sp	BR	State inscription validation for Sao Paulo.
validate_ie_to	BR	State inscription validation for Tocantins.

Create or Update Fiscal Attribute Lists Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Creates, modifies or deletes values of a fiscal attribute list. The list is referenced by the listCode of an existing attribute definition.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdm/fiscalAttributesLists/create?action=NEW

Content-Type: application/json or application/xml. Response media type: application/json or application/xml.

Input

Table 3-8 Input

Parameter Name	Required	Data Type	Description
action	Yes	String	URL query parameter. NEW, MOD or DEL.
body	Yes	Array of RestRfmListRecord	List values to maintain.

Table 3-9 RestRfmListRecord

Parameter Name	Required	Data Type	Description
codeType	Yes	String	List code matching listCode in the attribute definition.
code	Yes	String	Code of a value in the list.
codeDesc	Yes	String	Description of the list value.
codeSeq	Yes	Number	Display sequence of the list value.
parentCodeType	No	String	Parent list code for hierarchical selection.
parentCode	No	String	Parent list value code.
userDefinedInd	Yes	String	Y/N. Identifies a user-defined list value.
effectiveFromDate	No	Date	Start of list value availability.
effectiveToDate	No	Date	End of list value availability.

JSON Input Structure

[
  {
    "codeType": "itemAbrangenciaList",
    "code": "N",
    "codeDesc": "National",
    "codeSeq": 1,
    "parentCodeType": null,
    "parentCode": null,
    "userDefinedInd": "Y",
    "effectiveFromDate": "2023-05-16T00:00:00.000Z",
    "effectiveToDate": null
  }
]

Output

Table 3-10 Operation Status

Parameter Name	Data Type	Description
status	String	S: successful operation; E: operation error.
errors	Array	Error records; null when no errors are returned.

Table 3-11 Fiscal Attribute Error

Parameter Name	Data Type	Description
errorCode	String	Error code.
errorDesc	String	Error description.

JSON Output Structure

{
  "status": "S",
  "errors": null
}

Table Impact

Table 3-12 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FDM_LIST	Yes	Yes	Yes	Yes

Fiscal Reclassification Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Associates fiscal attributes with items or entities, or modifies and deletes existing fiscal classification records. Internal entity keys or the supported external vendor identification determine the classified entity.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdm/reclass/create?requestSource=Webservice

Content-Type: application/json or application/xml. Response media type: application/json or application/xml.

Input

Table 3-13 Input

Parameter Name	Required	Data Type	Description
requestSource	No	String	URL query parameter. MFCS, UI or Webservice. Default: Webservice.
body	Yes	Array of RestRfmFdmFiscalReclass	Classification or reclassification records.

Table 3-14 RestRfmFdmFiscalReclass

Parameter Name	Required	Data Type	Description
reclassId	Conditional	Number	Existing reclassification identifier for MOD or DEL; not needed for NEW.
seqNo	Conditional	Number	Existing detail sequence for MOD or DEL; not needed for NEW.
reclassAction	Yes	String	NEW creates an association, MOD updates it and DEL deletes an unprocessed association.
reclassStatus	No	String	Reclassification processing status; the NEW example uses N.
reclassTemplate	Yes	String	Association template. ITEM_MASTER, ITEM_LOC, ITEM_SUPPLIER, LOCATION, SUPS, PARTNER.
country	Yes	String	Country code in Merchandising.
item	Conditional	String	Required for ITEM_MASTER, ITEM_LOC and ITEM_SUPPLIER.
loc	Conditional	Number	Required location for ITEM_LOC and LOCATION.
locType	Conditional	String	Location type S or W for ITEM_LOC and LOCATION.
sups	Conditional	Number	Supplier site for SUPS and ITEM_SUPPLIER.
partner	Conditional	String	Partner code for PARTNER.
partnerType	Conditional	String	Partner type for PARTNER.
attribute	Yes	String	Existing active fiscal attribute code.
attribValue	Yes	String	Value to associate; must satisfy attribute validation and list rules.
startDate	Yes	String	Start of association validity, YYYY-MM-DD.
endDate	No	String	End of association validity, YYYY-MM-DD; null when open ended.
vendorTypeCode	Conditional	String	Alternative external vendor identification: code in VENDOR_TYPE_CODE_MAPPING that resolves a supplier or partner and partner type.
externalRefId	Conditional	String	Used with vendorTypeCode to resolve SUPS.EXTERNAL_REF_ID or PARTNER.EXTERNAL_REF_ID to an internal identifier.

Use the keys applicable to the selected template. vendorTypeCode and externalRefId are an alternative vendor identity pair; they are not required for a request that already supplies the applicable internal supplier or partner identity.

JSON Input Structure

[
  {
    "reclassAction": "NEW",
    "reclassStatus": "N",
    "country": "BR",
    "reclassTemplate": "SUPS",
    "sups": 790011,
    "attribute": "PESSOA_JURIDICA",
    "attribValue": "S",
    "startDate": "2023-05-16",
    "endDate": null
  }
]

Output

Table 3-15 Fiscal Reclassification Output

Parameter Name	Data Type	Description
status	String	S or E.
reclassId	String	Reclassification identifier returned by processing.
statusDesc	String	Description of the reclassification processing status.
reclassDtl	Array	Reclassification details using the fiscal reclassification record fields. In output details, reclassId and seqNo are strings from the SQL record.
errors	Array	Processing errors.

Table 3-16 Reclassification Error

Parameter Name	Data Type	Description
errorCode	String	Error code.
errorDesc	String	Error description.
seqNo	Number	Error sequence number.

JSON Output Structure

{
  "status": "S",
  "reclassId": "12345",
  "statusDesc": null,
  "reclassDtl": [],
  "errors": null
}

Table Impact

Table 3-17 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SVC_RFM_FDM_FISCAL_RECLASS	Yes	Yes	Yes	Yes
RFM_WFLW_ERR	Yes	No	No	No

Fiscal Attributes Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves fiscal attribute definitions and screen configuration. It does not return the values assigned to a specific item, location, supplier or partner.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/fdm/fiscalAttributes/get?entity=SUPS&country=BR

Response media type: application/json or application/xml.

Input Parameters

Table 3-18 Query Parameters

Parameter Name	Required	Data Type	Description
entity	No	String	Template to query. ITEM_MASTER, ITEM_LOC, ITEM_SUPPLIER, LOCATION, SUPS, PARTNER.
country	No	String	Country code filter.
groupCode	No	String	Fiscal attribute group code filter.

entity is optional in the REST signature, but the database query compares the template to the supplied value. Omission does not request all templates; supply entity to retrieve the intended definitions.

Output

Table 3-19 Fiscal Attribute Definition

Parameter Name	Data Type	Description
code	String	Attribute code in snake case, for example TAX_PAYER_TYPE.
camelCase	String	Attribute code used in XML and JSON structures, for example taxPayerType.
label	String	Attribute label displayed on Fiscal Data Management screens.
description	String	Description of the attribute and its purpose.
template	String	Merchandising entity associated with the attribute. ITEM_MASTER, ITEM_LOC, ITEM_SUPPLIER, LOCATION, SUPS, PARTNER.
country	String	Country code from Merchandising COUNTRY.
effectiveFromDate	Date	Start of attribute availability.
effectiveToDate	Date	End of attribute availability.
systemBehavior	String	Y/N. Indicates use in system behavior rules.
fiscalDocumentUse	String	Y/N. Indicates use as additional information in fiscal documents.
taxCalculation	String	Y/N. Indicates inclusion in tax calculation integration data.
fiscalReporting	String	Y/N. Indicates inclusion in fiscal reporting data.
userDefinedInd	String	Y/N. Indicates a user-defined attribute.
groupCode	String	Screen grouping code: 1 Fiscal Codes, 2 System Behavior, 3 Tax Inscriptions, 4 User defined.
screenSeq	Number	Display sequence within the group. Review existing attributes before selecting a new sequence.
mandatory	String	Y/N. Whether the attribute must be associated with an item or entity for fiscal classification to be complete.
dataType	String	VARCHAR, NUMBER or DATE.
dataLength	String	Attribute data length.
attributeType	String	DATALIST for a list of valid codes; FIXVALUE for a value entered directly.
listSource	String	For DATALIST: INTERNAL, EXTERNAL or MFCS.
listCode	String	List name for an INTERNAL or EXTERNAL DATALIST. Maintain values with Fiscal Attribute Lists Create.
listTableName	String	For MFCS lists, Merchandising source table.
listCodeColumn	String	For MFCS lists, column containing the code.
listDescColumn	String	For MFCS lists, column containing the description.
parentAttribCode	String	Parent attribute code used for hierarchical attribute selection.
functionValidation	String	Predefined fiscal validation function applied during classification. See the validation function catalog.
levelValidation	String	Simple conditional validation rule, for example ATTRIBUTE1 = 'Y', evaluated for the entity being classified.
uniqueInd	String	Y/N. Y allows only one value of this attribute for a given item or entity.
blockedForEdit	String	Y/N. Indicates that editing of this attribute is blocked. Computed by the query.

The response is a JSON array. Date values can be accompanied by display fields produced by the record serializer.

JSON Output Structure

[
  {
    "code": "ABRANGENCIA",
    "camelCase": "abrangencia",
    "label": "Abrangencia",
    "description": "Item scope: N national, E state, M municipal.",
    "template": "ITEM_MASTER",
    "country": "BR",
    "effectiveFromDate": 1684195200000,
    "effectiveToDate": null,
    "systemBehavior": null,
    "fiscalDocumentUse": null,
    "taxCalculation": null,
    "fiscalReporting": null,
    "userDefinedInd": "Y",
    "groupCode": "4",
    "screenSeq": 14,
    "mandatory": "Y",
    "dataType": "VARCHAR",
    "dataLength": "1",
    "attributeType": "DATALIST",
    "listSource": "INTERNAL",
    "listCode": "itemAbrangenciaList",
    "listTableName": null,
    "listCodeColumn": null,
    "listDescColumn": null,
    "parentAttribCode": null,
    "functionValidation": null,
    "levelValidation": null,
    "uniqueInd": "Y",
    "blockedForEdit": "N"
  }
]

Table Impact

Table 3-20 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FDM_SET_FA	Yes	No	No	No
RFM_FDM_SET_FA_TL	Yes	No	No	No

Fiscal Attributes Lists Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves values for the selected fiscal attribute list in a paginated response.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/fdm/fiscalAttributesLists/get?template=ITEM_MASTER&attribCode=ABRANGENCIA&pageSize=50&pageNumber=1

Response media type: application/json or application/xml.

Input Parameters

Table 3-21 Query Parameters

Parameter Name	Required	Data Type	Description
template	Yes	String	Fiscal attribute association template. ITEM_MASTER, ITEM_LOC, ITEM_SUPPLIER, LOCATION, SUPS, PARTNER.
attribCode	Yes	String	Fiscal attribute code.
attribList	No	String	Attribute list code filter.
attribListValue	No	String	Attribute list value code filter.
pageSize	No	Number	Maximum records per page. Default: 50.
pageNumber	No	Number	Page to retrieve. Default: 1.

Output

Table 3-22 PageResultsItems

Parameter Name	Data Type	Description
items	Array	Records returned on this page.
hasMore	Boolean	Whether more records are available.
limit	Number	Maximum records on the page.
count	Number	Records returned on the page.
totalRecordCount	Number	Total records matching the filters.
links	Array	Pagination links supplied by the service. Each link identifies a relation and target URI.

Table 3-23 List Value

Parameter Name	Data Type	Description
codeType	String	List code matching listCode in the attribute definition.
code	String	Code of a value in the list.
codeDesc	String	Description of the list value.
codeSeq	Number	Display sequence of the list value.
parentCodeType	String	Parent list code for hierarchical selection.
parentCode	String	Parent list value code.
userDefinedInd	String	Y/N. Identifies a user-defined list value.
effectiveFromDate	Date	Start of list value availability.
effectiveToDate	Date	End of list value availability.

JSON Output Structure

{
  "items": [
    {
      "codeType": "itemAbrangenciaList",
      "code": "N",
      "codeDesc": "National",
      "codeSeq": 1,
      "parentCodeType": null,
      "parentCode": null,
      "userDefinedInd": "Y",
      "effectiveFromDate": 1684195200000,
      "effectiveToDate": null
    }
  ],
  "hasMore": false,
  "limit": 50,
  "count": 1,
  "totalRecordCount": 1,
  "links": []
}

Table Impact

Table 3-24 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FDM_SET_FA	Yes	No	No	No
RFM_FDM_SET_FA_TL	Yes	No	No	No
RFM_FDM_LIST	Yes	Yes	No	No
RFM_FDM_LIST_TL	Yes	No	No	No
SVC_RFM_FDM_FISCAL_RECLASS	Yes	Yes	No	No
RFM_FDM_ATTRIB_ITEM	Yes	No	Yes	No

Process Flex Integration Create Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Submits an integration message to the configured fiscal document workflow and scenario. The selected scenario determines the business payload and processing behavior.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/flx/integration/create

Content-Type: application/xml. Response media type: application/xml or application/json.

Input

Table 3-25 flxIntegration

Parameter Name	Required	Data Type	Description
workflowCode	Conditional	String	Workflow identifier when supplied or required by the scenario.
intScenario	Conditional	String	Scenario identifier when supplied or required for scenario selection.
intPrefix	Yes	String	Integration prefix identifying the configured scenario.
intVersion	No	String	Integration flow version; optional in the integration XSD.
intRelease	No	String	Integration release; optional in the integration XSD.
intCode	No	String	Internal integration or queue identifier; can contain a UUID.
intCodeRef	No	String	Reference integration or queue identifier for response flows.
intRequestSystem	Yes	String	Name of the system requesting the integration. Required by the integration XSD.
intRequestCode	No	String	Request identifier in the requesting system.
intKeys	Conditional	XML content	Scenario-specific integration keys, status and additional attributes.
intBody	Yes	XML content	Complete document or message payload for the selected scenario.

The root element is flxIntegration in namespace http://www.oracle.com/retail/flx/integration/v1. Supply scenario keys and payload according to the selected integration definition. In particular, workflowCode is the XML field name; wflwCode is used by other endpoints and is not its replacement.

Table 3-26 Scenario Key Elements

Parameter Name	Data Type	Description
status	String	Scenario-specific message status under intKeys.
msgAttributes	XML content	Additional scenario attributes containing attribCode and attribValue.
attribCode	String	Additional attribute code.
attribValue	String	Additional attribute value.
errors	XML content	Error information when defined by the scenario; errorCode and errorDesc identify each error.

Use lowercase intKeys and status. The placement of msgAttributes and errors is scenario-specific; do not add an errors node below msgAttributes unless the selected scenario defines that structure.

XML Input Envelope

<flxIntegration xmlns="http://www.oracle.com/retail/flx/integration/v1">
  <workflowCode>POFDR</workflowCode>
  <intScenario>poFiscalDocumentReceive</intScenario>
  <intPrefix>poFiscalDocumentReceive</intPrefix>
  <intVersion>1</intVersion>
  <intRelease>26.2.401.0</intRelease>
  <intRequestSystem>supplierSystem</intRequestSystem>
  <intRequestCode>97987987987</intRequestCode>
  <intCode>sourceSystemInternalId</intCode>
  <intBody>Complete Brazilian NFe XML payload</intBody>
</flxIntegration>

Output

Table 3-27 Integration Operation Output

Parameter Name	Data Type	Description
status	String	S or E for the service operation.
requestId	Number	Internal integration request identifier.
docId	Number	Fiscal document identifier.
wfStatusCode	String	Workflow processing status; includes START, SUCCESS, FAIL, WARNING, ERROR and WAITING as applicable.
wfStatusDesc	String	Workflow processing status description.
errors	Array	Errors with errorCode, errorDesc and seqNo.

JSON Output Structure

{
  "status": "E",
  "requestId": 2886,
  "docId": 914,
  "wfStatusCode": "ERROR",
  "wfStatusDesc": "Deduce Key Data Technical Exception",
  "errors": [
    {
      "errorCode": "PACKAGE_ERROR",
      "errorDesc": "Processing error description.",
      "seqNo": 1
    }
  ]
}

Table Impact

Table 3-28 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_CODE_DETAIL	Yes	No	No	No
RFM_CODE_DETAIL_TL	Yes	No	No	No
RFM_WFLW_ERR	Yes	No	No	No
RFM_WFLW_SET	Yes	No	No	No
RFM_WFLW_STA_LOG	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR	Yes	Yes	Yes	Yes
RFM_WFLW_DEF	Yes	No	No	No
RFM_FLX_DOC_FDG	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_HIST	Yes	Yes	Yes	No
RFM_FLX_DOC_FDG_HIST	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_XML	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_XML_HIST	No	Yes	Yes	Yes
RFM_FLX_DOC_FDG_DATA	No	No	No	Yes
RFM_FLX_DOC_FDG_DATA_XML_HIST	No	Yes	Yes	Yes
RFM_FLX_DOC_FDG_DATA_XML	No	Yes	Yes	Yes
RFM_FLX_DOC_FDG_DATA_JSON	No	Yes	Yes	No
RFM_FLX_DOC_FDG_DATA_JSON_HIST	No	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_JSON	No	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_JSON_HIST	No	Yes	Yes	No
RFM_WFLW_SET_VAR	Yes	No	No	No
RFM_WFLW_EXEC_VAR	Yes	No	No	No
RFM_WFLW_SET_ACTION	Yes	No	No	No
RFM_FLX_SET_CONTENT	Yes	No	No	No
RFM_USER_LOCATION	Yes	No	No	No
RFM_FLX_DOC_FDR_KEYS	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDG_KEYS	No	Yes	Yes	No
PACKITEM	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORDLOC	Yes	No	No	No
ORDSKU	Yes	No	No	No
ORDLOC_DISCOUNT	Yes	No	No	No
WH	Yes	No	No	No
ORDER_DISCOUNTS	Yes	No	No	No
PACK_TOTAL_TEMP	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
RFM_XML_GTT	Yes	Yes	No	Yes
RFM_FLX_DOC_FDR_KEYS_HIST	No	Yes	No	No
RFM_FLX_DOC_FDG_KEYS_HIST	No	Yes	No	No

Process Flex Integration Get Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves an integration payload from the configured integration queue. Queue consumption and scenario selection follow the integration configuration. The response body is the payload itself, without an intPayload wrapper.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/flx/integration/get?scenario=nfeStatusVerificationRequest&module=FDR

Response media type: application/xml or application/json.

Input Parameters

Table 3-29 Query Parameters

Parameter Name	Required	Data Type	Description
scenario	Yes	String	Configured integration scenario.
fromDate	No	Date	Start date filter, YYYY-MM-DD.
toDate	No	Date	End date filter, YYYY-MM-DD.
locationCode	No	String	Location code filter.
locationType	No	String	Location type filter.
module	No	String	Fiscal document module filter.

Additional URL query keys are forwarded as integration key filters. requestType is not a fixed parameter of this method; use it only when it is a configured integration key. The payload format and fields depend on the selected scenario.

XML Output Envelope

<flxIntegration xmlns="http://www.oracle.com/retail/flx/integration/v1">
  <intScenario>nfeStatusVerificationRequest</intScenario>
  <intPrefix>nfeStatusVerificationRequest</intPrefix>
  <intRequestSystem>RFM</intRequestSystem>
  <intCode>2ABFD72E58855D68E06340C34C64B9CF</intCode>
  <intBody>Complete scenario payload</intBody>
</flxIntegration>

Table Impact

Table 3-30 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FLX_DOC_FDR_KEYS	Yes	No	No	No
RFM_FLX_DOC_FDR	Yes	No	No	No
RFM_FLX_DOC_FDG_DATA_XML	Yes	No	No	No
RFM_INT_SETUP	Yes	No	No	No
RFM_INT_QUEUE	Yes	No	No	Yes
RFM_INT_XML_PAYLOAD	Yes	No	No	Yes

NFE Manifest Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Requests the manifest operation for a fiscal document identified by its internal document ID.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/flx/fdr/nfeManifest?docId=9999

Response media type: application/json.

Input Parameters

Table 3-31 Query Parameters

Parameter Name	Required	Data Type	Description
docId	Yes	String	Internal fiscal document identifier.

Supply docId in the query string. The method does not bind a JSON request body.

Output

Table 3-32 Operation Status

Parameter Name	Data Type	Description
status	String	S: successful operation; E: operation error.
errors	Array	Error records; null when no errors are returned.

Table 3-33 Manifest Error

Parameter Name	Data Type	Description
errorCode	String	Error code.
errorDesc	String	Error description.
seqNo	Number	Error sequence number.

JSON Output Structure

{
  "status": "S",
  "errors": null
}

Table Impact

Table 3-34 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_CODE_DETAIL	Yes	No	No	No
RFM_CODE_DETAIL_TL	Yes	No	No	No
RFM_WFLW_SET	Yes	No	No	No
RFM_WFLW_EVE_LOG	Yes	No	No	No
RFM_WFLW_STA_LOG	Yes	Yes	No	No
RFM_FLX_DOC_FDR	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_XML	Yes	Yes	Yes	Yes
RFM_WFLW_SET_VAR	Yes	No	No	No
RFM_WFLW_EXEC_VAR	Yes	No	No	No
RFM_WFLW_SET_ACTION	Yes	No	No	No
RFM_WFLW_ERR	No	Yes	No	No
RFM_WFLW_EVE_LOG	No	Yes	No	No
RFM_FLX_SET_CONTENT	Yes	No	No	No
RFM_FLX_DOC_FDR_HIST	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_JSON	No	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_XML_HIST	No	Yes	Yes	No
RFM_FLX_DOC_FDR_KEYS	Yes	Yes	Yes	No

Integration Configuration Get Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Lists configured outgoing integrations with IN_OUT = O and integration type REST or XSD.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/integration/list

Response media type: application/json or application/xml.

No request body or query parameters are required.

Output

Table 3-35 Integration Configuration Collection

Parameter Name	Data Type	Description
collectionSize	Number	Number of configuration items.
items	Array	Integration configuration items.

Table 3-36 Configuration Item

Parameter Name	Data Type	Description
intId	String	Integration identifier.
scenCode	String	Scenario code.
wflwCode	String	Workflow code.
responseIntId	String	For synchronous integrations, response integration ID whose queue receives the response payload.
credentialName	String	Previously registered credential name.
targetUrl	String	Allowlisted HTTPS listener supporting POST and a publicly trusted TLS certificate.
enabled	String	Y/N. Enables or pauses polling and publishing.
backgroundServiceInd	String	Y/N. Whether the background integration engine monitors and processes this integration queue.
intervalSeconds	Number	Polling interval in seconds; integer with up to six digits.
reprocessOnErrorInd	String	Y allows a new response payload to be processed when the document is in ERROR; N retains the default restriction.

Identifier fields in the manage DTO are strings. The database-backed listing can serialize numeric integration identifiers as numbers.

JSON Output Structure

{
  "collectionSize": 1,
  "items": [
    {
      "intId": 3,
      "scenCode": "nfeCancelationRequest",
      "wflwCode": "COMMON",
      "responseIntId": null,
      "credentialName": "CREDENTIAL1",
      "targetUrl": "https://example.com/nfeCancelationRequest",
      "enabled": "Y",
      "backgroundServiceInd": "Y",
      "intervalSeconds": 1,
      "reprocessOnErrorInd": "N"
    }
  ]
}

Table Impact

Table 3-37 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_INT_CONFIG	Yes	No	No	No

Integration Configuration Update Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Updates existing integration configuration. Register credentials before referencing them in credentialName. The listener must support the configured integration contract.

Service Type

Service Type: PUT

REST URL

{{baseUrl}}/services/private/integration/manage

Content-Type: application/json or application/xml. Response media type: application/json or application/xml.

Enabled background integrations are polled at intervalSeconds. The engine publishes queued messages when records are available. Disabling an integration pauses polling; enabling it or changing the interval can require the engine to synchronize its configuration. Avoid frequent configuration changes.

Include the identifiers and the fields to update. Optional configuration values that are not supplied retain the existing configuration according to the update rules. scenCode and wflwCode must be supplied because the Java input model validates them as non-null.

Input

Table 3-38 Manage Collection

Parameter Name	Required	Data Type	Description
collectionSize	Yes	Number	Must equal the number of elements in items.
items	Yes	Array	Configuration items to update.

Table 3-39 Configuration Item

Parameter Name	Required	Data Type	Description
intId	Yes	String	Integration identifier.
scenCode	Yes	String	Scenario code.
wflwCode	Yes	String	Workflow code.
responseIntId	No	String	For synchronous integrations, response integration ID whose queue receives the response payload.
credentialName	No	String	Previously registered credential name.
targetUrl	No	String	Allowlisted HTTPS listener supporting POST and a publicly trusted TLS certificate.
enabled	No	String	Y/N. Enables or pauses polling and publishing.
backgroundServiceInd	No	String	Y/N. Whether the background integration engine monitors and processes this integration queue.
intervalSeconds	No	Number	Polling interval in seconds; integer with up to six digits.
reprocessOnErrorInd	No	String	Y allows a new response payload to be processed when the document is in ERROR; N retains the default restriction.

JSON Input Structure

{
  "collectionSize": 1,
  "items": [
    {
      "intId": "3",
      "scenCode": "nfeCancelationRequest",
      "wflwCode": "COMMON",
      "responseIntId": null,
      "credentialName": "CREDENTIAL1",
      "targetUrl": "https://example.com/nfeCancelationRequest",
      "enabled": "Y",
      "backgroundServiceInd": "Y",
      "intervalSeconds": 1,
      "reprocessOnErrorInd": "N"
    }
  ]
}

Output

Table 3-40 Success Response

Parameter Name	Data Type	Description
status	String	SUCCESS. Returned with HTTP 200.
message	String	Optional success message.

JSON Success Output

{
  "status": "SUCCESS"
}

Business validation failures return HTTP 400 with the service error envelope and businessError information. Validation errors do not use the generic S/E operation status contract.

Table Impact

Table 3-41 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_INT_CONFIG	Yes	No	Yes	No

Documents Get Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves current or historical fiscal document XML payloads in a paginated response.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/documents?scenario=nfeStatusVerificationRequest&module=FDR&pageSize=25&pageNumber=1

Response media type: application/xml.

Input Parameters

Table 3-42 Query Parameters

Parameter Name	Required	Data Type	Description
scenario	Yes	String	Workflow scenario code.
fromDate	No	Date	Start date, YYYY-MM-DD.
toDate	No	Date	End date, YYYY-MM-DD.
gmt	No	String	GMT offset applied to date filters. Default: -03.
locationCode	No	String	Location identifier.
locationType	No	String	Location type.
module	Yes	String	Fiscal document module, declared required by this operation.
docId	No	String	Internal document identifier filter.
wflwCode	No	String	Workflow code filter.
pageSize	No	Number	Maximum records per page. Default: 25. Maximum: 50.
pageNumber	No	Number	Page to retrieve. Default: 1.

The selected module and scenario must be valid for the configured document integration. Additional query keys can be passed as configured integration key filters. requestType is not a fixed standard parameter. With pageSize = 25, pageNumber = 2 selects the second page, records 26 through 50 when available.

Output

Table 3-43 pagedResultsRDO

Parameter Name	Data Type	Description
items	XML content	Zero or more flxIntegration payloads.
hasMore	Boolean	Whether more records are available.
limit	Number	Maximum records on the page.
count	Number	Records returned on the page.
totalRecordCount	Number	Total records matching the filters.

XML Output Structure

<pagedResultsRDO>
  <items>
    <flxIntegration xmlns="http://www.oracle.com/retail/flx/integration/v1">
      <intScenario>nfeStatusVerificationRequest</intScenario>
      <intPrefix>nfeStatusVerificationRequest</intPrefix>
      <intRequestSystem>RFM</intRequestSystem>
      <intCode>2ABFD72E58855D68E06340C34C64B9CF</intCode>
      <intBody>Complete scenario payload</intBody>
    </flxIntegration>
  </items>
  <hasMore>false</hasMore>
  <limit>25</limit>
  <count>1</count>
  <totalRecordCount>1</totalRecordCount>
</pagedResultsRDO>

Table Impact

Table 3-44 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FLX_DOC_FDR_KEYS	Yes	No	No	No
RFM_FLX_DOC_FDR	Yes	No	No	No
RFM_FLX_DOC_FDR_DATA_XML	Yes	No	No	No
RFM_FLX_DOC_FDG_KEYS	Yes	No	No	No
RFM_FLX_DOC_FDG	Yes	No	No	No
RFM_FLX_DOC_FDG_DATA_XML	Yes	No	No	No

Documents Status Get Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves fiscal document and scenario processing statuses in a paginated response.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/documents/status?workflow=POFDR&pageSize=25&pageNumber=1

Response media type: application/json or application/xml.

Input Parameters

Table 3-45 Query Parameters

Parameter Name	Required	Data Type	Description
workflow	Yes	String	Workflow code.
docId	No	String	Internal document identifier.
scenario	No	String	Scenario code.
docStatus	No	String	Document status.
wflwStatus	No	String	Workflow status.
intRequestCode	No	String	Request code from the source system.
locationCode	No	String	Location identifier.
locationType	No	String	Location type.
pageSize	No	Number	Maximum records per page. Default: 25. Maximum: 50.
pageNumber	No	Number	Page to retrieve. Default: 1.

Output

Table 3-46 PageResultsItems

Parameter Name	Data Type	Description
items	Array	Records returned on this page.
hasMore	Boolean	Whether more records are available.
limit	Number	Maximum records on the page.
count	Number	Records returned on the page.
totalRecordCount	Number	Total records matching the filters.
links	Array	Pagination links supplied by the service. Each link identifies a relation and target URI.

Table 3-47 Document Status Record

Parameter Name	Data Type	Description
docId	Number	Internal document identifier.
wflwCode	String	Workflow code.
wflwStatus	String	Workflow status.
wflwStatusDesc	String	Workflow status description.
scenCode	String	Scenario code.
scenCodeDesc	String	Scenario description.
procStatus	String	Scenario processing status.
statusCodeDesc	String	Processing status description.
startTime	Timestamp	Scenario start time. The record serializer can emit an epoch value and a companion startTimeDisplay field.

JSON Output Structure

{
  "items": [
    {
      "docId": 1233,
      "wflwCode": "POFDR",
      "wflwStatus": "CMPLT",
      "wflwStatusDesc": "Completed",
      "scenCode": "endWorkflowOk",
      "scenCodeDesc": "Workflow Completed",
      "procStatus": "SUCCESS",
      "statusCodeDesc": "Workflow Completed",
      "startTime": 1735849166192,
      "startTimeDisplay": "02-Jan-2025 20:19:26"
    }
  ],
  "hasMore": false,
  "limit": 25,
  "count": 1,
  "totalRecordCount": 1,
  "links": []
}

Table Impact

Table 3-48 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FLX_DOC_FDR_KEYS	Yes	No	No	No
RFM_FLX_DOC_FDR	Yes	No	No	No
RFM_FLX_DOC_FDG_KEYS	Yes	No	No	No
RFM_FLX_DOC_FDG	Yes	No	No	No
V_RFM_WFLW_MONITOR	Yes	No	No	No

Ledger Manage Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Creates fiscal ledger entries or cancels existing entries and manages the associated tax records. The service derives ledgerStatus as P for NEW and C for cancellation.

Service Type

Service Type: PUT

REST URL

{{baseUrl}}/services/private/documents/ledger/manage

Content-Type: application/json or application/xml. Response media type: application/json or application/xml.

Input

Table 3-49 Input

Parameter Name	Required	Data Type	Description
items	Yes	Array of RestRfmLedgerInductionRec	Ledger records to process.

Output

Table 3-50 RestRfmLedgerInductionRec

Parameter Name	Data Type	Description
action	String	NEW creates a record; DEL requests cancellation.
ledgerId	Number	Required for DEL; can be omitted for NEW.
ledgerType	String	IN or OUT.
locType	String	Ledger location type.
locId	Number	Ledger location identifier.
participantType	String	Type of the transaction counterpart, using the internal ledger entity type.
participant	Number	Transaction counterpart identifier.
item	String	Item code.
workflow	String	Workflow code.
docItemQty	Number	Item quantity.
docItemUnitCost	Number	Item unit cost.
methodOut	String	FIFO selects oldest entries first; LIFO selects newest entries first.
taxDataRecords	Array of RestRfmLedgerTaxInductionRec	Tax records for the item.

Table 3-51 RestRfmLedgerTaxInductionRec

Parameter Name	Data Type	Description
taxCode	String	Tax code supplied by the fiscal document.
taxBase	Number	Tax calculation base.
taxValue	Number	Tax value for the document item quantity.
taxCreditBase	Number	Tax credit calculation base.
taxCreditValue	Number	Tax credit value for the document item quantity.
taxRate	Number	Tax rate.

Table 3-52 Induction Output

Parameter Name	Data Type	Description
status	String	S or E.
errors	Array of RestRfmInductionErrorRec	Induction validation errors.

Table 3-53 RestRfmInductionErrorRec

Parameter Name	Data Type	Description
rowSeq	Number	Sequence of the input row with the error.
errorMsg	String	Error message.

JSON Input Structure

{
  "items": [
    {
      "action": "NEW",
      "ledgerType": "IN",
      "locType": "S",
      "locId": 7701,
      "participantType": "S",
      "participant": 7700,
      "item": "101350000",
      "workflow": "POFDR",
      "docItemQty": 1,
      "docItemUnitCost": 100,
      "taxDataRecords": [
        {
          "taxCode": "ICMS",
          "taxBase": 100,
          "taxValue": 18,
          "taxCreditBase": 100,
          "taxCreditValue": 18,
          "taxRate": 18
        }
      ]
    }
  ]
}

JSON Error Output

{
  "status": "E",
  "errors": [
    {
      "rowSeq": 1,
      "errorMsg": "Ledger validation error."
    }
  ]
}

Table Impact

Table 3-54 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FISCAL_LEDGER	Yes	Yes	Yes	No
RFM_FISCAL_LEDGER_TAX	Yes	Yes	Yes	No
SVC_RFM_FISCAL_LEDGER	Yes	Yes	Yes	Yes
SVC_RFM_FISCAL_LEDGER_TAX	Yes	Yes	Yes	Yes

Ledger Get Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves fiscal ledger records and tax information using optional filters. The response is paginated.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/documents/ledger?pageSize=25&pageNumber=1

Response media type: application/json or application/xml.

Input Parameters

Table 3-55 Query Parameters

Parameter Name	Required	Data Type	Description
locType	No	String	Location type filter: ST or WH; translated to internal S or W.
locId	No	Number	Location identifier.
participantType	No	String	Counterpart type filter, for example SUPS, ST, WH or PTNR as applicable.
participant	No	Number	Counterpart identifier.
itemId	No	String	Item code.
status	No	String	Ledger status.
ledgerType	No	String	IN or OUT.
workflow	No	String	Workflow code.
fromDate	No	Date	Start date filter, YYYY-MM-DD.
toDate	No	Date	End date filter, YYYY-MM-DD.
pageSize	No	Number	Maximum records per page. Default: 25. Maximum: 50.
pageNumber	No	Number	Page to retrieve. Default: 1.

Output

Table 3-56 PageResultsItems

Parameter Name	Data Type	Description
items	Array	Records returned on this page.
hasMore	Boolean	Whether more records are available.
limit	Number	Maximum records on the page.
count	Number	Records returned on the page.
totalRecordCount	Number	Total records matching the filters.
links	Array	Pagination links supplied by the service. Each link identifies a relation and target URI.

Table 3-57 Fiscal Ledger Record

Parameter Name	Data Type	Description
ledgerId	Number	Ledger identifier.
ledgerStatus	String	Ledger status: P processed or C canceled.
ledgerType	String	IN or OUT.
locType	String	Internal ledger location type.
locId	Number	Location identifier.
participantType	String	Internal counterpart type.
participant	Number	Counterpart identifier.
item	String	Item code.
simplePackInd	String	Simple pack indicator.
workflow	String	Workflow code.
transactionId	String	Source transaction identifier.
ledgerDate	Date	Ledger transaction date.
docId	String	Document identifier.
docLineId	Number	Document line identifier.
docItemUom	String	Document item unit of measure.
docItemQty	Number	Document item quantity.
docItemUnitCost	Number	Document item unit cost.
netReceivedQty	Number	Net received quantity.
canceledQty	Number	Canceled quantity.
balance	Number	Available ledger quantity balance.
refLedgerId	Number	Referenced ledger identifier.
refDocId	String	Referenced document identifier.
refDocLineId	Number	Referenced document line identifier.
refDocModule	String	Referenced document module.
methodOut	String	FIFO or LIFO selection method.
userDefinedInd	String	User-defined record indicator.
taxDataRecords	Array	Associated tax records.

Table 3-58 Fiscal Ledger Tax Record

Parameter Name	Data Type	Description
ledgerId	Number	Related ledger identifier.
taxCode	String	Tax code supplied by the fiscal document.
taxBase	Number	Tax calculation base.
taxValue	Number	Tax value for the document item quantity.
taxCreditBase	Number	Tax credit calculation base.
taxCreditValue	Number	Tax credit value for the document item quantity.
taxRate	Number	Tax rate.

JSON Output Structure

{
  "items": [
    {
      "ledgerId": 825,
      "ledgerStatus": "P",
      "ledgerType": "IN",
      "locType": "S",
      "locId": 7701,
      "participantType": "SUPS",
      "participant": 790011,
      "item": "101350000",
      "workflow": "POFDR",
      "transactionId": "12345",
      "docId": "914",
      "docLineId": 1,
      "docItemQty": 1,
      "docItemUnitCost": 100,
      "netReceivedQty": 1,
      "canceledQty": 0,
      "balance": 1,
      "refDocId": null,
      "refDocModule": null,
      "taxDataRecords": [
        {
          "taxCode": "ICMS",
          "taxBase": 100,
          "taxValue": 18,
          "taxCreditBase": 100,
          "taxCreditValue": 18,
          "taxRate": 18,
          "ledgerId": 825
        }
      ]
    }
  ],
  "hasMore": false,
  "limit": 25,
  "count": 1,
  "totalRecordCount": 1,
  "links": []
}

Table Impact

Table 3-59 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FISCAL_LEDGER	Yes	No	No	No
RFM_FISCAL_LEDGER_TAX	Yes	No	No	No

Document Upload Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Uploads legacy fiscal document data needed as references for returns and RMA documents. Use the configured migration workflow and scenario, such as PODMD and poDocumentMigrationData.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/flx/documents/upload

Content-Type: application/xml. Response media type: application/xml.

Input

Table 3-60 Input Envelope

Parameter Name	Required	Data Type	Description
create	Yes	XML element	Root element containing one or more flxIntegration elements.
flxIntegration	Yes	XML element	Integration record in namespace http://www.oracle.com/retail/flx/integration/v1.

Table 3-61 Migration Integration Record

Parameter Name	Required	Data Type	Description
workflowCode	Conditional	String	Workflow identifier when supplied or required by the scenario.
intScenario	Conditional	String	Scenario identifier when supplied or required for scenario selection.
intPrefix	Yes	String	Integration prefix identifying the configured scenario.
intVersion	No	String	Integration flow version; optional in the integration XSD.
intRelease	No	String	Integration release; optional in the integration XSD.
intCode	No	String	Internal integration or queue identifier; can contain a UUID.
intCodeRef	No	String	Reference integration or queue identifier for response flows.
intRequestSystem	Yes	String	Name of the system requesting the integration. Required by the integration XSD.
intRequestCode	No	String	Request identifier in the requesting system.
intKeys	Conditional	XML content	Scenario-specific integration keys, status and additional attributes.
intBody	Yes	XML content	Complete document or message payload for the selected scenario.

XML Input Envelope

<create>
  <flxIntegration xmlns="http://www.oracle.com/retail/flx/integration/v1">
    <workflowCode>PODMD</workflowCode>
    <intScenario>poDocumentMigrationData</intScenario>
    <intPrefix>poDocumentMigrationData</intPrefix>
    <intVersion>1</intVersion>
    <intRelease>26.2.401.0</intRelease>
    <intRequestSystem>legacySystem</intRequestSystem>
    <intRequestCode>legacy-12345</intRequestCode>
    <intBody>Complete document migration XML payload</intBody>
  </flxIntegration>
</create>

Output

Table 3-62 Response Envelope

Parameter Name	Data Type	Description
response	XML element	Root of the upload response.
document	Repeated XML element	One result for each processed integration record.

Table 3-63 Document Upload Result

Parameter Name	Data Type	Description
status	String	S or E.
intRequestCode	String	Request identifier in the source system.
docId	Number	Fiscal document identifier.
wfStatusCode	String	Workflow processing status; includes START, SUCCESS, FAIL, WARNING, ERROR and WAITING as applicable.
wfStatusDesc	String	Workflow processing status description.
errors	Array	Errors with errorCode, errorDesc and seqNo.

Table 3-64 Upload Error

Parameter Name	Data Type	Description
errorCode	String	Error code.
errorDesc	String	Error description.
seqNo	Number	Error sequence number.

XML Output Structure

<response>
  <document>
    <status>E</status>
    <intRequestCode>legacy-12345</intRequestCode>
    <docId>914</docId>
    <wfStatusCode>ERROR</wfStatusCode>
    <wfStatusDesc>Deduce Key Data Technical Exception</wfStatusDesc>
    <errors><item>
      <errorCode>PACKAGE_ERROR</errorCode>
      <errorDesc>Processing error description.</errorDesc>
      <seqNo>1</seqNo>
    </item></errors>
  </document>
</response>

Table Impact

Table 3-65 Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_CODE_DETAIL	Yes	No	No	No
RFM_CODE_DETAIL_TL	Yes	No	No	No
RFM_WFLW_ERR	Yes	Yes	No	No
RFM_WFLW_SET	Yes	No	No	No
RFM_WFLW_STA_LOG	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR	Yes	Yes	Yes	Yes
RFM_WFLW_DEF	Yes	No	No	No
RFM_FLX_DOC_FDG	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_HIST	Yes	Yes	Yes	No
RFM_FLX_DOC_FDG_HIST	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_XML	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDR_DATA_XML_HIST	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDG_DATA	Yes	No	No	Yes
RFM_FLX_DOC_FDG_DATA_XML_HIST	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDG_DATA_XML	Yes	Yes	Yes	Yes
RFM_WFLW_SET_VAR	Yes	No	No	No
RFM_WFLW_EXEC_VAR	Yes	No	Yes	No
RFM_WFLW_SET_ACTION	Yes	No	No	No
RFM_FLX_SET_CONTENT	Yes	No	No	No
RFM_USER_LOCATION	Yes	No	No	No
RFM_FLX_DOC_FDR_KEYS	Yes	Yes	Yes	Yes
RFM_FLX_DOC_FDG_KEYS	No	Yes	Yes	No
PACKITEM	Yes	No	No	No
ORDHEAD	Yes	No	No	No
ORDLOC	Yes	No	No	No
ORDSKU	Yes	No	No	No
ORDLOC_DISCOUNT	Yes	No	No	No
WH	Yes	No	No	No
ORDER_DISCOUNTS	Yes	No	No	No
PACK_TOTAL_TEMP	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
RFM_XML_GTT	Yes	Yes	No	Yes
RFM_FLX_DOC_FDR_KEYS_HIST	Yes	Yes	No	Yes
RFM_FLX_DOC_FDG_KEYS_HIST	Yes	Yes	No	Yes

Fiscal Document Generation Services

The following services support document requests, approval or cancellation communication, and retrieval of generated documents. Their JSON models are defined in the Fiscal Document Generation Data Models subsection. The full document model and the simplified pre-document model share fiscalDocument as the request root; their accepted fields depend on the operation view.

Fiscal Document Detail Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves detailed fiscal document payloads by document identifier or entity keys for a third-party integration.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/fdg/documentDetail?docId=12345

Response media type: application/json.

Input Parameters

Table 3-66 Query Parameters

Parameter Name	Required	Data Type	Description
docId	No	Number	Internal document identifier.
entityType	No	String	Entity document type.
entityInternalType	No	String	Internal Merchandising entity type.
entityCode	No	String	Internal entity code.

Output

Table 3-67 Output

Parameter Name	Data Type	Description
body	Array of RestFdgHdr	Matching fiscal document headers and nested details. Items have no fiscalDocument wrapper.

Fiscal document dates use the date conversion configured for this operation. See RestFdgHdr in the shared model dictionary.

Fiscal Document Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Submits a detailed fiscal document request, including transaction and item data. The returned request identifier can be used to retrieve the generated documents.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdg/processDoc

Content-Type: application/json. Response media type: application/json.

Input

Table 3-68 Input

Parameter Name	Required	Data Type	Description
fiscalDocument	Yes	RestFdgHdr	Full fiscal document request using the processDoc view.

Output

Table 3-69 Output

Parameter Name	Data Type	Description
body	RestFdgDocStatusRec	Request and document processing information.

The request model is RestFdgDoc, mapped to REST_FDG_DOC_REC. Supply required header values and the transaction-specific detail records described in the shared model dictionary.

Fiscal Pre Document Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Submits a simplified fiscal document request from an inventory or shipment system. The returned request identifier supports subsequent status and document retrieval.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdg/processPreDoc

Content-Type: application/json. Response media type: application/json.

Input

Table 3-70 Input

Parameter Name	Required	Data Type	Description
fiscalDocument	Yes	RestFdgHdr	Simplified request using the processPreDoc view.

Output

Table 3-71 Output

Parameter Name	Data Type	Description
body	RestFdgDocStatusRec	Request and document processing information.

The Java request root is RestFdgDoc. The service maps the simplified request through REST_FDG_HDR_REC; fields exclusive to the full processDoc view are not part of this simplified request.

Fiscal Document Status Process Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Receives a third-party result for fiscal document approval or cancellation and updates processing information.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdg/processDocStatus

Content-Type: application/json. Response media type: application/json.

Input

Table 3-72 Input

Parameter Name	Required	Data Type	Description
body	Yes	RestFdgProcDocStatusRec	Status update record.

Output

Table 3-73 Output

Parameter Name	Data Type	Description
body	RestFdgOpStatusRec	Operation processing status and errors.

JSON Input Structure

{
  "integrationSystemName": "THIRDPARTY",
  "integrationSystemId": "request-12345",
  "requestAction": "A",
  "docId": 12345,
  "docNo": "98765",
  "operationStatus": "S",
  "extDocNo": "98765",
  "docPrintUrl": "https://example.com/print/98765",
  "additionalproperties": null,
  "errors": null
}

Fiscal Document Cancel Request Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Requests cancellation of a fiscal document. Depending on its current state, cancellation can be applied directly or sent to the third party for confirmation.

Service Type

Service Type: POST

REST URL

{{baseUrl}}/services/private/fdg/processDocCancel

Content-Type: application/json. Response media type: application/json.

Input

Table 3-74 Input

Parameter Name	Required	Data Type	Description
body	Yes	RestFdgDocCancel	Cancellation request.

Output

Table 3-75 Output

Parameter Name	Data Type	Description
body	RestFdgOpStatusRec	Operation status and errors.

Fiscal Document Status Detail Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves statuses for one or more documents requested through the document and pre-document services, including document numbers and printing references when available.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/fdg/documentStatusDetail?requestId=12345

Response media type: application/json.

Input Parameters

Table 3-76 Query Parameters

Parameter Name	Required	Data Type	Description
requestId	No	Number	Internal document request identifier.
requestSystem	No	String	Requesting system identifier.
entityType	No	String	Entity document type.
entityInternalType	No	String	Internal Merchandising entity type.
entityCode	No	String	Internal entity code.
country	No	String	Country code filter.

Output

Table 3-77 Output

Parameter Name	Data Type	Description
body	Array of RestFdgDocStatusRec	Matching document status records.

Next Fiscal Document Detail Service

Functional Area

Functional Area: Fiscal Management

Business Overview

Retrieves the next fiscal document ready for third-party processing. The calling system identifiers identify the integration consumer.

Service Type

Service Type: GET

REST URL

{{baseUrl}}/services/private/fdg/nextDocumentDetail?integrationSystemName=THIRDPARTY&integrationSystemId=request-12345

Response media type: application/json.

Input Parameters

Table 3-78 Query Parameters

Parameter Name	Required	Data Type	Description
docId	No	Number	Document identifier filter.
docType	No	String	Document type filter.
entityType	No	String	Entity document type filter.
internalType	No	String	Internal entity type filter.
internalCode	No	String	Internal entity code filter.
integrationSystemName	Yes	String	Calling integration system name. Must not be blank.
integrationSystemId	Yes	String	Calling integration system unique identifier. Must not be blank.

Output

Table 3-79 Output

Parameter Name	Data Type	Description
body	RestFdgDoc	Object containing fiscalDocument with the next document details.

Fiscal Document Generation Data Models

The tables below define the shared JSON fields. Required applies to request fields in the corresponding operation view; read-only fields are response values. Additional business validations depend on document type, transaction and configuration. Types that refer to another RestFdg model use the corresponding table below. DateTime values use ISO 8601; explicitly date-only fields use YYYY-MM-DD. additionalproperties is spelled exactly as shown.

Table 3-80 RestFdgDoc

Parameter Name	Required	Data Type	Description
fiscalDocument	Yes	RestFdgHdr	Fiscal document root.

Table 3-81 RestFdgHdr

Parameter Name	Required	Data Type	Description
docId	Read only	Number	Unique document ID
requestId	Read only	Number	Unique identifier of the document request.
requestSystem	Yes	String	Requester system identifier.
requestAction	No	String	Current action for the request. View: nextDocDetailView.
status	No	String	Status of the document. View: nextDocDetailView.
docNo	No	String	Document Number. If the number is externally generated it will have the same value of EXT_DOC_ID. View: nextDocDetailView.
docType	Yes	String	Type of the document.
docTypeCode	No	String	Document Code. View: nextDocDetailView.
extReqId	No	String	This field contains the external request ID. This is the internal number from system that is requesting a fiscal document. Example: asn_nbr ID from shipments
transactionType	Yes	String	Identifies the transaction that originated the document creation.
issueDate	Yes	DateTime	Issue Date.
dueDate	No	DateTime	Due Date. View: nextDocDetailView.
printerId	No	String	Printer Id. View: nextDocDetailView.
docPrintUrl	No	String	Document printing URL. View: nextDocDetailView.
currencyCode	No	String	Document currency code.
totalTaxAmt	No	Number	Total tax amount. View: nextDocDetailView.
totalNonMerchTaxAmt	No	Number	Total tax amount of allowance/charge. View: nextDocDetailView.
totalAmtInclTax	No	Number	Total amount including taxes. View: nextDocDetailView.
totalAmtExclTax	No	Number	Total amount excluding taxes. View: nextDocDetailView.
totalAllowance	No	Number	Total allowance. View: nextDocDetailView.
totalCharge	No	Number	Total charge. View: nextDocDetailView.
totalRounding	No	Number	The amount to be added to the calculated total cost including tax of the document. View: nextDocDetailView.
terms	No	String	The payment terms associated with the document. View: nextDocDetailView.
docLang	No	String	Document language used for descriptions. View: nextDocDetailView.
deduceTax	No	String	Y requests tax calculation; N indicates that taxes are provided in the request. View: processDocView.
createBy	No	String	User who created the record. View: nextDocDetailView.
createDatetime	No	Date	Creation date and time. View: nextDocDetailView.
lastUpdateBy	No	String	User who last updated the record. View: nextDocDetailView.
lastUpdateDatetime	No	Date	Date and time of the last update. View: nextDocDetailView.
entities	Yes	Array of RestFdgEtt	List of entities.
details	Yes	Array of RestFdgDtl	List of item details.
totaltaxes	No	Array of RestFdgTax	List of total taxes. View: nextDocDetailView.
errors	No	Array of RestFdgError	List of errors. View: nextDocDetailView.
allowanceCharges	No	Array of RestFdgNonMerch	List of allowance/charge. View: nextDocDetailView.
additionalproperties	No	Array of RestFdgExt	List of additional properties. View: nextDocDetailView.
comments	No	Array of RestFdgText	List of comments.
references	No	Array of RestFdgRef	List of references.

Table 3-82 RestFdgDocStatusRec

Parameter Name	Required	Data Type	Description
requestId	Read only	Number	Unique identifier of the document request.
requestSystem	No	String	Requester system identifier.
requestAction	No	String	Current action for the request.
docId	Read only	Number	Unique document ID
docNo	No	String	Document Number. If the number is externally generated it will have the same value of EXT_DOC_ID.
docType	No	String	Type of the document.
status	No	String	Status of the document.
extReqId	No	String	This field contains the external request ID. This is the internal number from system that is requesting a fiscal document. Example: asn_nbr ID from shipments
docPrintUrl	No	String	Document printing URL.
additionalproperties	No	Array of RestFdgExt	List of additional properties.
errors	No	Array of RestFdgError	List of errors.

Table 3-83 RestFdgProcDocStatusRec

Parameter Name	Required	Data Type	Description
integrationSystemName	Yes	String	This field contains the identification name of system that is requesting a fiscal document. This name is provided by system that is requesting.
integrationSystemId	Yes	String	This field contains the unique identifier of the document request. This ID is to have a way to identify which system send this request.
requestAction	Yes	String	This field contains the current action for the request. This action is to third-party know the action to perform with this request. Valid values: A (Approve) or C (Cancel).
docId	Yes	Number	Unique document ID
docNo	No	String	Document Number. If the number is externally generated it will have the same value of EXT_DOC_ID.
operationStatus	Yes	String	Status of the operation.
extDocNo	No	String	Extenal document Number.
docPrintUrl	No	String	Document printing URL.
additionalproperties	No	Array of RestFdgExt	List of additional properties.
errors	No	Array of RestFdgError	List of errors.

Table 3-84 RestFdgDocCancel

Parameter Name	Required	Data Type	Description
docId	Yes	Number	Unique document ID
requestAction	Yes	String	Current action for the request.
additionalproperties	No	Array of RestFdgExt	List of additional properties.
comments	No	Array of RestFdgText	List of comments.

Table 3-85 RestFdgOpStatusRec

Parameter Name	Required	Data Type	Description
status	No	String	Status of the operation.
errors	No	Array of RestFdgError	Errors.

Table 3-86 RestFdgError

Parameter Name	Required	Data Type	Description
errorCode	Yes	String	Erro code.
errorDesc	Yes	String	Error description.

Table 3-87 RestFdgEtt

Parameter Name	Required	Data Type	Description
entityType	Yes	String	Entity doc type. Possible values are SD (sender), RC (Receiver) or CR (Carrier).
entityInternalType	No	String	RMS Entity type. Possible values WH (Wharehouse), ST (Store), SUPP (supplier) or PTNR (Partner).
entityInternalPtnrType	No	String	Specifies the type of partner. Valid values are Bank BK, Agent AG, Freight Forwarder FF, Importer IM, Broker BR, Factory FA, Applicant AP, Consolidator CO, and Consignee CN, Supplier hierarchy level 1 S1, Supplier hierarchy level 2 S2, Supplier hierarchy level 3 S3.
entityCode	No	String	RMS entity code.
name	No	String	The name of the entity. View: processPreDocView.
legalName	No	String	Entity legal name. View: nextDocDetailView.
carrierVehicleRn	No	String	Vehicle Registration Number.
carrierVehicleState	No	String	Vehicle Registration State.
carrierDriverName	No	String	Driver Name.
carrierDriverLn	No	String	Driver License Number.
address	No	RestFdgEttAddr	Entity Address Details. View: nextDocDetailView.
identification	No	Array of RestFdgExt	Entity Identification. View: nextDocDetailView.

Table 3-88 RestFdgEttAddr

Parameter Name	Required	Data Type	Description
street	No	String	The name of the street, road, avenue, way, etc. to which the number of the building is attached.
additionalStreetName	No	String	An additional street name used to further clarify the address.
complement	No	String	Additional information of entity´s address, such as neighborhood, county, etc
city	No	String	The name of the address city.
jurisdictionCode	No	String	Jurisdiction Code.
postalCode	No	String	The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country	No	String	Entity country.
telephone	No	String	Phone number for the contact point.
email	No	String	Email address.
state	No	String	Address State.
contactName	No	String	Contact Name.
additionalproperties	No	Array of RestFdgExt	Entity Address Additional Properties.

Table 3-89 RestFdgDtl

Parameter Name	Required	Data Type	Description
lineNo	No	Number	Item position in the fiscal document, sequential from 1 without gaps. View: nextDocDetailView.
item	Yes	String	Unique alphanumeric value that identifies the item.
itemDesc	No	String	Long description of the item. View: nextDocDetailView.
itemShortDesc	No	String	Shortened description of the item. View: nextDocDetailView.
totalAmt	No	Number	Total amount of the item considering the unit amount x quantity. View: processDocView.
unitAmt	No	Number	Unit amount. View: processDocView.
uom	Yes	String	Unit of measure.
qty	Yes	Number	Quantity
totalTaxAmt	No	Number	Total tax amount. View: processDocView.
totalAmtInclTax	No	Number	Total amount including tax. View: processDocView.
packInd	No	String	Pack indicator. Valid values are Y or N. View: nextDocDetailView.
gtin	No	String	GTIN (Global Trade Item Number) of item. Identifying information for this item, assigned according to a standard system. View: nextDocDetailView.
gtinType	No	String	Code specifying what type the GTIN code is. View: nextDocDetailView.
vpn	No	String	Vendor Product Number associated with the item. View: nextDocDetailView.
totalRounding	No	Number	The amount to be added to the calculated total cost including tax of the document. View: nextDocDetailView.
totalAllowance	No	Number	Total allowance. View: nextDocDetailView.
totalCharge	No	Number	Total charge. View: nextDocDetailView.
taxes	No	Array of RestFdgTax	Item taxes. View: processDocView.
references	No	Array of RestFdgRef	Item references.
allowanceCharges	No	Array of RestFdgNonMerch	Item allowance/Charges. View: processDocView.
packdetails	No	Array of RestFdgDtlPack	Item pack details. View: nextDocDetailView.
additionalproperties	No	Array of RestFdgExt	Item additional properties. View: nextDocDetailView.
comments	No	Array of RestFdgText	Item comments. View: processDocView.

Table 3-90 RestFdgDtlPack

Parameter Name	Required	Data Type	Description
dtlPkgId	No	Number	Detail package unique ID.
dtlId	No	Number	Item Detail unique ID.
item	Yes	String	Item Code.
itemQty	Yes	Number	Item quantity.
itemDesc	No	String	Item description.
uom	No	String	Unit of measure.

Table 3-91 RestFdgTax

Parameter Name	Required	Data Type	Description
taxType	Yes	String	Tax Type. U (for unit taxes) or P (for percentage). View: processDocView.
taxCode	Yes	String	Tax Code. View: processDocView.
taxRate	No	Number	Tax Rate.
taxAmt	No	Number	Tax Amount. View: processDocView.
unitTaxAmt	No	Number	Unit Tax Amount. View: processDocView.
taxBasis	No	Number	Tax basis.
taxCodeDesc	No	String	Tax Code Description. View: processDocView.
additionalproperties	No	Array of RestFdgExt	Item additional properties.
comments	No	Array of RestFdgText	Tax Comments.

Table 3-92 RestFdgNonMerch

Parameter Name	Required	Data Type	Description
chargeInd	Yes	String	Charge indicator. If Y it represents a charge, if N it represents an allowance value.
nonMerchCode	Yes	String	Non-merchandise code.
nonMerchCodeDesc	No	String	Non-merchandise code description.
nonMerchAmt	Yes	Number	Non-merchandise amount.
nonMerchType	No	String	Non-merchandise type.
totalTaxAmt	No	Number	Total tax amount of the Non-merchandise.
taxes	No	Array of RestFdgTax	List of taxes for the non-merchandise.

Table 3-93 RestFdgRef

Parameter Name	Required	Data Type	Description
refType	Yes	String	Specifies the type of the reference.
refCode	Yes	String	Referece Code/value.

Table 3-94 RestFdgText

Parameter Name	Required	Data Type	Description
text	Yes	String	Text.
textGroupId	No	Number	Text group ID. This id identifies a group of text ordered by a sequence.
textGroupSeq	No	Number	Sequence of the text for a given text id.

Table 3-95 RestFdgAttrib

Parameter Name	Required	Data Type	Description
attribGroupCode	No	String	Attrib group code.
attribValue	No	String	Attrib value.
attribDesc	No	String	Attrib desc.
translations	No	Array of RestFdgAttribTl	Translations.

Table 3-96 RestFdgAttribTl

Parameter Name	Required	Data Type	Description
lang	No	String	Lang.
attribDesc	No	String	Attrib desc.

Table 3-97 RestFdgExt

Parameter Name	Required	Data Type	Description
key	Yes	String	Key value of the extension.
value	Yes	String	value of the extension.
type	Yes	String	Extension Type. Valid values are VARCHAR, NUMBER or DATE.
description	No	String	Description of the extension value.

Batch Processes

rfmfdmreclass

Table 3-98 Module Details

Property	Value
Module Name	rfmfdmreclass.ksh
Description	Processes fiscal reclassification records in NEW or PENDING status and removes fiscal attributes for item/supplier relationships that no longer exist.
Functional Area	Rfm
Module Type	Admin – Ad hoc
Module Technology	Ksh / SQL*Plus / PL/SQL
Catalog ID
Wrapper Script	rmswrap_shell.ksh

Schedule

Oracle Retail Merchandising Batch Schedule

Design Overview

This batch processes new and pending fiscal reclassification requests for items and entities. It verifies the fiscal attribute data, performs the required validations and applies the changes to the corresponding fiscal classifications. Each request is evaluated independently, so an unsuccessful request does not prevent other requests from being processed.

The batch also removes fiscal attributes associated with item/supplier relationships that no longer exist, keeping fiscal classification data consistent with the current merchandising relationships.

The script requires a database connection. Runtime connection details are supplied by the configured batch environment.

Restart/Recovery

The script has no checkpoint-based restart mechanism. On another execution, the routine selects groups that remain in NEW or PENDING status. Records in ERROR status are not automatically included by this selection; review and resolve their classification errors before making them eligible for processing again.

Reclassification processing and item/supplier attribute cleanup are separate SQL executions, each with its own commit or rollback handling. Completion of the batch does not establish that every reclassification group succeeded. Review the workflow status and error records for the affected groups.

Key Tables Affected

TABLE	SELECT	INSERT	UPDATE	DELETE
SVC_RFM_FDM_FISCAL_RECLASS	Yes	No	Yes	Yes
RFM_WFLW_SET	Yes	No	No	No
RFM_WFLW_SET_VAR	Yes	No	No	No
RFM_WFLW_EXEC_VAR	Yes	No	No	No
RFM_WFLW_SET_ACTION	Yes	No	No	No
RFM_WFLW_ERR	No	Yes	No	No
RFM_WFLW_EVE_LOG	No	Yes	No	No
RFM_WFLW_STA_LOG	Yes	Yes	Yes	No
RFM_FDM_ATTRIB_ITEM	Yes	Yes	Yes	No
RFM_FDM_ATTRIB_ITEMLOC	Yes	Yes	Yes	No
RFM_FDM_ATTRIB_ITEMSUPP	Yes	Yes	Yes	Yes
RFM_FDM_ATTRIB_LOCATION	Yes	Yes	Yes	No
RFM_FDM_ATTRIB_PARTNER	Yes	Yes	Yes	No
RFM_FDM_ATTRIB_SUPPLIER	Yes	Yes	Yes	No
ITEM_SUPPLIER	Yes	No	No	No
RFM_FDM_SET_FA	Yes	No	No	No
ADDR	Yes	No	Yes	No
ADD_TYPE_MODULE	Yes	No	No	No

Design Assumptions

Fiscal attribute definitions and the RECLASS workflow must be configured before execution. The runtime uses the Merchandising business date returned by GET_VDATE.

The script uses the Korn shell, SQL*Plus and the batch library under MMHOME/oracle/lib/bin. MMHOME and ORACLE_HOME must identify the configured runtime environment.

The ORDCUST fiscal attribute process uses a separate processing path and is not part of this batch.

fdrmanifest

Table 3-99 Module Details

Property	Value
Module Name	fdrmanifest.ksh
Description	Identifies fiscal receiving documents eligible for a manifest request and starts the configured workflow scenario.
Functional Area	Rfm
Module Type	Admin – Ad hoc
Module Technology	Ksh / SQL*Plus / PL/SQL
Catalog ID
Wrapper Script	rmswrap_shell.ksh

Schedule

Oracle Retail Merchandising Batch Schedule

Design Overview

This batch identifies purchase order fiscal receiving documents that have reached the applicable manifestation deadline and initiates their manifest requests. Eligibility depends on the current document status and the manifest days value captured for the location when the document was received.

The batch starts the corresponding fiscal document workflow processing. The manifestation is confirmed through the subsequent integration response from SEFAZ.

The script requires a database connection. Runtime connection details are supplied by the configured batch environment.

Restart/Recovery

The script has no explicit checkpoint. A subsequent execution evaluates the eligibility criteria again using the current workflow state and document data.

A failure returned by workflow initialization or processing stops the selection routine. The shell SQL block commits a successful call and rolls back a failed call. Review workflow state and queued integration messages before deciding whether a request needs to be repeated.

Key Tables Affected

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_CODE_DETAIL	Yes	No	No	No
RFM_CODE_DETAIL_TL	Yes	No	No	No
RFM_WFLW_SET	Yes	No	No	No
RFM_WFLW_EVE_LOG	Yes	Yes	No	No
RFM_WFLW_STA_LOG	Yes	Yes	No	No
RFM_FLX_DOC_FDR	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_XML	Yes	Yes	Yes	Yes
RFM_WFLW_SET_VAR	Yes	No	No	No
RFM_WFLW_EXEC_VAR	Yes	No	No	No
RFM_WFLW_SET_ACTION	Yes	No	No	No
RFM_WFLW_ERR	No	Yes	No	No
RFM_FLX_SET_CONTENT	Yes	No	No	No
RFM_FLX_DOC_FDR_HIST	Yes	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_JSON	No	Yes	Yes	No
RFM_FLX_DOC_FDR_DATA_XML_HIST	No	Yes	Yes	No
RFM_FLX_DOC_FDR_KEYS	Yes	Yes	Yes	No
V_RFM_WFLW_MONITOR	Yes	No	No	No
V_RFM_FLX_DOC_FDR_DATA	Yes	No	No	No

Design Assumptions

The POFDR workflow and manifest request integration must be configured. The document must contain the applicable nfeManifestDays value.

The script uses the Korn shell, SQL*Plus, MMHOME/oracle/lib/bin/rmsksh.lib and the configured ORACLE_HOME.

rfmfinpost

Table 3-100 Module Details

Property	Value
Module Name	rfmfinpost.ksh
Description	Extracts financial data from fiscal document integration records and places the resulting data in financial staging tables.
Functional Area	Rfm
Module Type	Admin – Ad hoc
Module Technology	Ksh / SQL*Plus / PL/SQL
Catalog ID
Wrapper Script	rmswrap_shell.ksh

Schedule

Oracle Retail Merchandising Batch Schedule

Design Overview

This batch extracts financial information from fiscal documents and prepares it for integration with an external financial system. Based on the configured financial rules, it creates the applicable accounts payable and general ledger staging records.

The batch supports selection by processing status and document, allowing eligible records to be processed or retried. It records the outcome for each document so that unsuccessful records can be reviewed and reprocessed. The staged data is made available to the financial publication batches.

This batch job has the following runtime parameters:

Table 3-101 Runtime Parameters

Parameter	Description
Connection	Database connection used by the batch. The runtime can supply the configured Oracle Wallet connection.
STATUS	Requested processing status. A is the default selector and is converted to NULL in PL/SQL; this selection excludes P, D and E. N selects new records, E selects error records, and F selects failed records.
DOC_ID	Document ID to process, or ANY to omit the document ID filter. The record must exist in RFM_FIN_POST_STG and satisfy the STATUS selection.

Restart/Recovery

Reprocessing uses the STATUS and DOC_ID selection. The document ID filter is combined with the status filter and does not override it. ANY removes the document ID filter. Records skipped because they were locked can be considered again in a later execution.

For document results E or F, the routine records an error message and increments RETRY_COUNT. Correct the underlying data or configuration before requesting the applicable retry. The shell SQL block rolls back a technical failure returned by the package; document-level error statuses can be committed as part of a completed call.

Key Tables Affected

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FIN_POST_STG	Yes	No	Yes	No
RFM_SET_CROSS_REF	Yes	No	No	No
RFM_AP_STAGE_HEAD	No	Yes	No	No
RFM_AP_STAGE_DETAIL	No	Yes	No	No
RFM_FINANCIALS_STAGE	No	Yes	No	No
RFM_DOC_CROSS_REF_GTT	Yes	Yes	No	Yes
RFM_DOC_ITEM_CROSS_REF_GTT	Yes	Yes	No	Yes
RFM_SET_SOB	Yes	No	No	No
ITEM_MASTER	Yes	No	No	No
TERMS_HEAD	Yes	No	No	No
ORDHEAD	Yes	No	No	No
STORE	Yes	No	No	No
WH	Yes	No	No	No
RFM_FLX_DOC_FDR_KEYS_HIST	Yes	No	No	No
RFM_FLX_DOC_FDG_KEYS_HIST	Yes	No	No	No
V_RFM_FLX_DOC_FDR_DATA_HIST	Yes	No	No	No
V_RFM_FLX_DOC_FDG_DATA_HIST	Yes	No	No	No

Design Assumptions

Fiscal document integration records and RFM_FIN_POST_STG control records must already exist. Financial cross references, set-of-books configuration and the required Merchandising reference data must be available.

The script uses the Korn shell, SQL*Plus and MMHOME/oracle/lib/bin/rmsksh.lib. The default document selector is ANY.

rfm_fif_ap_publish

Table 3-102 Module Details

Property	Value
Module Name	rfm_fif_ap_publish.ksh
Description	Transforms RFM payable staging data and populates the financial integration publish tables.
Functional Area	Rfm
Module Type	Admin – Ad hoc
Module Technology	Ksh / SQL*Plus / PL/SQL
Catalog ID
Wrapper Script	rmswrap_shell.ksh

Schedule

Oracle Retail Merchandising Batch Schedule

Design Overview

This batch prepares staged accounts payable information from fiscal documents for financial integration. It transforms invoice header and detail data into the required publication format, using the configured external references for suppliers or partners, payment terms, organizational units and taxes.

After publication, the batch retains the processed staging data in history and updates the financial integration status. The published information is available for subsequent extraction and delivery to the external financial system.

The script requires a database connection. Runtime connection details are supplied by the configured batch environment.

Restart/Recovery

The script has no explicit checkpoint. Header and detail processing are separate SQL*Plus executions. A failure in the detail phase does not automatically undo a header publication completed by the preceding execution.

Review FIF_AP_HEAD_PUBLISH, FIF_AP_DETAIL_PUBLISH, the active and historical RFM staging tables, and the AP/GL control status before restarting after a partial publication. The header insert has no explicit duplicate-prevention condition in this processing path.

Staging cleanup and control-record queries use NOWAIT row locking. Resolve the reported lock or data error and verify the completed phase before deciding which processing remains necessary.

Key Tables Affected

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FIN_POST_STG	Yes	No	Yes	Yes
RFM_FIN_POST_STG_HIST	No	Yes	No	No
RFM_AP_STAGE_HEAD	Yes	No	No	Yes
RFM_AP_STAGE_HEAD_HIST	Yes	Yes	No	No
RFM_AP_STAGE_DETAIL	Yes	No	No	Yes
RFM_AP_STAGE_DETAIL_HIST	No	Yes	No	No
FIF_AP_HEAD_PUBLISH	No	Yes	No	No
FIF_AP_DETAIL_PUBLISH	No	Yes	No	No
RMS_PLSQL_BATCH_CONFIG	Yes	No	No	No
CODE_DETAIL	Yes	No	No	No
SUPS	Yes	No	No	No
PARTNER	Yes	No	No	No
TERMS_HEAD	Yes	No	No	No
ORG_UNIT	Yes	No	No	No
VAT_CODES	Yes	No	No	No

Design Assumptions

RFM payable staging data must be prepared before this batch runs. Supplier or partner, payment terms, organizational unit and tax code references supply external publication values.

MAX_CHUNK_SIZE is read from RMS_PLSQL_BATCH_CONFIG for RFM_FIF_AP_PUBLISH_SQL. The default is 10000 when the configured value is NULL.

The accounting segment delimiter is obtained from CODE_DETAIL using CODE_TYPE FIFD and CODE DLMTR. A missing delimiter prevents processing. The routine also checks the applicable organizational unit external references and tax code external reference values.

The script uses MMHOME/oracle/lib/bin/rmsksh.lib and RETAIL_HOME/oracle/lib/bin/batch_wrapper.lib. When RMS_BATCH_USER is set, the connection is taken from UP; otherwise, the first script argument supplies the connection.

rfm_fif_gl_publish

Table 3-103 Module Details

Property	Value
Module Name	rfm_fif_gl_publish.ksh
Description	Transforms RFM general ledger staging data and populates the financial integration general ledger publish table.
Functional Area	Rfm
Module Type	Admin – Ad hoc
Module Technology	Ksh / SQL*Plus / PL/SQL
Catalog ID
Wrapper Script	rmswrap_shell.ksh

Schedule

Oracle Retail Merchandising Batch Schedule

Design Overview

This batch prepares staged general ledger information from fiscal documents for financial integration. It transforms accounting entries into the required publication format using the applicable set-of-books configuration.

After publication, the batch retains the processed staging data in history and updates the financial integration status. The published accounting information is available for subsequent extraction and delivery to the external financial system.

The script requires a database connection. Runtime connection details are supplied by the configured batch environment.

Restart/Recovery

The script has no explicit checkpoint. Verify active staging, staging history, FIF_GL_PUBLISH and the financial control record before reprocessing an interrupted execution.

The routine uses NOWAIT row locking for staging cleanup and control-record processing. A lock error or other package failure causes the shell SQL block to roll back that failed execution. Retry after resolving the reported error and confirming which records remain in active staging.

Key Tables Affected

TABLE	SELECT	INSERT	UPDATE	DELETE
RFM_FIN_POST_STG	Yes	No	Yes	Yes
RFM_FIN_POST_STG_HIST	No	Yes	No	No
RFM_FINANCIALS_STAGE	Yes	No	No	Yes
RFM_FINANCIALS_STAGE_HIST	Yes	Yes	No	No
FIF_GL_PUBLISH	No	Yes	No	No
FIF_GL_SETUP	Yes	No	No	No
RMS_PLSQL_BATCH_CONFIG	Yes	No	No	No

Design Assumptions

RFM_FINANCIALS_STAGE must contain the records to publish, and FIF_GL_SETUP must include the matching set-of-books configuration.

MAX_CHUNK_SIZE is read from RMS_PLSQL_BATCH_CONFIG for RFM_FIF_GL_PUBLISH_SQL. The default is 10000 when the configured value is NULL.

The script uses MMHOME/oracle/lib/bin/rmsksh.lib and RETAIL_HOME/oracle/lib/bin/batch_wrapper.lib. When RMS_BATCH_USER is set, UP supplies the connection; otherwise, the first script argument is used.