4 ReST Services

This chapter gives an overview of the Invoice Matching ReSTful Web service implementation and the APIs used in Invoice Matching. For more information on the ReST architectural style applied for building Web services, see Oracle Retail Invoice Matching Cloud Service Document Maintenance ReST Services on My Oracle Support.

Documents – Create Credit Memo Cost

Business Overview

This REST service provides the ability to create credit memo costs via the induction pattern. Any induction template key with a template type of ‘Credit Memo Cost’ (TEMPLATE_TYPE = ‘CRDMEC’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/creditMemoCost 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/creditMemoCost

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json 
Accept: application/json 
Accept-Language: en-US 
Accept-Version: 19.3 

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "dealType": "",
      "deal": "",
      "dealComponent": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "fixedDealDetails": [
        {
          "location": "",
          "locationType": "",
          "department": "",
          "class": "",
          "subclass": "",
          "income": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "fixedDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "complexDealDetails": [
        {
          "location": "",
          "locationType": "",
          "item": "",
          "income": "",
          "turnoverUnits": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxPerUnit": "",
          "complexDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "taxPerUnit": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	dealType	varchar	Type of deal (F - Fixed, C - complex, N - Non-merchandise)
document	deal	numeric	Deal identifier
document	dealComponent	numeric	Deal component identifier
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	fixedDealDetails	entity list	Fixed Deal Details
document	complexDealDetails	entity list	Complex Deal Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
fixed deal details	location	numeric	Fixed Deal Location identifier
fixed deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
fixed deal details	department	numeric	Department identifier
fixed deal details	class	numeric	Class identifier
fixed deal details	subclass	numeric	Subclass identifier
fixed deal details	income	numeric	Income
fixed deal details	taxCode	varchar	Tax Code
fixed deal details	taxRate	numeric	Tax Rate
fixed deal details	taxBasis	numeric	Tax Basis
fixed deal details	fixedDealDetailsTaxes	entity list	Fixed Deal Details Taxes
fixed deal details taxes	taxCode	varchar	Tax Code
fixed deal details taxes	taxRate	numeric	Tax Rate
fixed deal details taxes	taxBasis	numeric	Tax Basis
complex deal details	location	numeric	Complex Deal Location identifier
complex deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
complex deal details	item	numeric	Item identifier
complex deal details	income	numeric	Income
complex deal details	turnoverUnits	numeric	Turnover Units
complex deal details	taxCode	varchar	Tax Code
complex deal details	taxRate	numeric	Tax Rate
complex deal details	taxBasis	numeric	Tax Basis
complex deal details	taxPerUnit	numeric	Tax Per Unit
complex deal details	complexDealDetailsTaxes	entity list	Complex Deal Details Taxes
complex deal details taxes	taxCode	varchar	Tax Code
complex deal details taxes	taxRate	numeric	Tax Rate
complex deal details taxes	taxBasis	numeric	Tax Basis
complex deal details taxes	taxPerUnit	numeric	Tax Per Unit
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Credit Memo Quantity

Business Overview

This REST service provides the ability to create credit memo quantities via the induction pattern. Any induction template key with a template type of ‘Credit Memo Quantity’ (TEMPLATE_TYPE = ‘CRDMEQ’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/creditMemoQuantity 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/creditMemoQuantity 

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "rtvOrderNo": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment Method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	rtvOrderNo	varchar	Return To Vendor order number
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Credit Note

Business Overview

This REST service provides the ability to create credit notes via the induction pattern. Any induction template key with a template type of ‘Credit Note’ (TEMPLATE_TYPE = ‘CRDNT’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/creditNote 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/creditNote

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "vendorId": "",
      "vendorType": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalDiscount": "",
      "rtvOrderNo": "",
      "referenceInvoice": "",
      "referenceCreditNoteRequest": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "dealType": "",
      "deal": "",
      "dealComponent": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "fixedDealDetails": [
        {
          "location": "",
          "locationType": "",
          "department": "",
          "class": "",
          "subclass": "",
          "income": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "fixedDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "complexDealDetails": [
        {
          "location": "",
          "locationType": "",
          "item": "",
          "income": "",
          "turnoverUnits": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxPerUnit": "",
          "complexDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "taxPerUnit": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	vendorId	numeric	Vendor identifier
document	vendorType	varchar	Type of vendor
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalDiscount	numeric	Total discount
document	rtvOrderNo	varchar	Return to vendor order number
document	referenceInvoice	varchar	Reference invoice
document	referenceCreditNoteRequest	varchar	Reference credit note request
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	dealType	varchar	Type of deal (F - Fixed, C - complex, N - Non-merchandise)
document	deal	numeric	Deal identifier
document	dealComponent	numeric	Deal component identifier
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	fixedDealDetails	entity list	Fixed Deal Details
document	complexDealDetails	entity list	Complex Deal Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
fixed deal details	location	numeric	Fixed Deal Location identifier
fixed deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
fixed deal details	department	numeric	Department identifier
fixed deal details	class	numeric	Class identifier
fixed deal details	subclass	numeric	Subclass identifier
fixed deal details	income	numeric	Income
fixed deal details	taxCode	varchar	Tax Code
fixed deal details	taxRate	numeric	Tax Rate
fixed deal details	taxBasis	numeric	Tax Basis
fixed deal details	fixedDealDetailsTaxes	entity list	Fixed Deal Details Taxes
fixed deal details taxes	taxCode	varchar	Tax Code
fixed deal details taxes	taxRate	numeric	Tax Rate
fixed deal details taxes	taxBasis	numeric	Tax Basis
complex deal details	location	numeric	Complex Deal Location identifier
complex deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
complex deal details	item	numeric	Item identifier
complex deal details	income	numeric	Income
complex deal details	turnoverUnits	numeric	Turnover Units
complex deal details	taxCode	varchar	Tax Code
complex deal details	taxRate	numeric	Tax Rate
complex deal details	taxBasis	numeric	Tax Basis
complex deal details	taxPerUnit	numeric	Tax Per Unit
complex deal details	complexDealDetailsTaxes	entity list	Complex Deal Details Taxes
complex deal details taxes	taxCode	varchar	Tax Code
complex deal details taxes	taxRate	numeric	Tax Rate
complex deal details taxes	taxBasis	numeric	Tax Basis
complex deal details taxes	taxPerUnit	numeric	Tax Per Unit
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Credit Note Request Cost

Business Overview

This REST service provides the ability to create credit note request costs via the induction pattern. Any induction template key with a template type of ‘Credit Note Request Cost’ (TEMPLATE_TYPE = ‘CRDNRC’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/creditNoteRequestCost 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/creditNoteRequestCost

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "dealType": "",
      "deal": "",
      "dealComponent": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "fixedDealDetails": [
        {
          "location": "",
          "locationType": "",
          "department": "",
          "class": "",
          "subclass": "",
          "income": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "fixedDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "complexDealDetails": [
        {
          "location": "",
          "locationType": "",
          "item": "",
          "income": "",
          "turnoverUnits": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxPerUnit": "",
          "complexDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "taxPerUnit": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	dealType	varchar	Type of deal (F - Fixed, C - complex, N - Non-merchandise)
document	deal	numeric	Deal identifier
document	dealComponent	numeric	Deal component identifier
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	fixedDealDetails	entity list	Fixed Deal Details
document	complexDealDetails	entity list	Complex Deal Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
fixed deal details	location	numeric	Fixed Deal Location identifier
fixed deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
fixed deal details	department	numeric	Department identifier
fixed deal details	class	numeric	Class identifier
fixed deal details	subclass	numeric	Subclass identifier
fixed deal details	income	numeric	Income
fixed deal details	taxCode	varchar	Tax Code
fixed deal details	taxRate	numeric	Tax Rate
fixed deal details	taxBasis	numeric	Tax Basis
fixed deal details	fixedDealDetailsTaxes	entity list	Fixed Deal Details Taxes
fixed deal details taxes	taxCode	varchar	Tax Code
fixed deal details taxes	taxRate	numeric	Tax Rate
fixed deal details taxes	taxBasis	numeric	Tax Basis
complex deal details	location	numeric	Complex Deal Location identifier
complex deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
complex deal details	item	numeric	Item identifier
complex deal details	income	numeric	Income
complex deal details	turnoverUnits	numeric	Turnover Units
complex deal details	taxCode	varchar	Tax Code
complex deal details	taxRate	numeric	Tax Rate
complex deal details	taxBasis	numeric	Tax Basis
complex deal details	taxPerUnit	numeric	Tax Per Unit
complex deal details	complexDealDetailsTaxes	entity list	Complex Deal Details Taxes
complex deal details taxes	taxRate	numeric	Tax Rate
complex deal details taxes	taxBasis	numeric	Tax Basis
complex deal details taxes	taxPerUnit	numeric	Tax Per Unit
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Credit Note Request Quantity

Business Overview

This REST service provides the ability to create credit note request quantities via the induction pattern. Any induction template key with a template type of ‘Credit Note Request Quantity’ (TEMPLATE_TYPE = ‘CRDNRQ’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/creditNoteRequestQuantity  

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/creditNoteRequestQuantity

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N./A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "rtvOrderNo": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	rtvOrderNo	varchar	Return To Vendor order number
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": "" 
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Debit Memo Cost

Business Overview

This REST service provides the ability to create debit memo costs through the induction pattern. Any induction template key with a template type of ‘Debit Memo Cost’ (TEMPLATE_TYPE = ‘DEBMEC’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/debitMemoCost 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/debitMemoCost 

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json 
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "dealType": "",
      "deal": "",
      "dealComponent": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "fixedDealDetails": [
        {
          "location": "",
          "locationType": "",
          "department": "",
          "class": "",
          "subclass": "",
          "income": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "fixedDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "complexDealDetails": [
        {
          "location": "",
          "locationType": "",
          "item": "",
          "income": "",
          "turnoverUnits": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxPerUnit": "",
          "complexDealDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "taxPerUnit": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	dealType	varchar	Type of deal (F - Fixed, C - complex, N - Non-merchandise)
document	deal	numeric	Deal identifier
document	dealComponent	numeric	Deal component identifier
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	fixedDealDetails	entity list	Fixed Deal Details
document	complexDealDetails	entity list	Complex Deal Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
fixed deal details	location	numeric	Fixed Deal Location identifier
fixed deal details	locationType	varchar	Type of location (W - Warehouse, S - Store)
fixed deal details	department	numeric	Department identifier
fixed deal details	class	numeric	Class identifier
fixed deal details	subclass	numeric	Subclass identifier
fixed deal details	income	numeric	Income
fixed deal details	taxCode	varchar	Tax Code
fixed deal details	taxRate	numeric	Tax Rate
fixed deal details	taxBasis	numeric	Tax Basis
fixed deal details	fixedDealDetailsTaxes	entity list	Fixed Deal Details Taxes
fixed deal details taxes	taxCode	varchar	Tax Code
fixed deal details taxes	taxRate	numeric	Tax Rate
fixed deal details taxes	taxBasis	numeric	Tax Basis
complex deal details	location	numeric	Complex Deal Location identifier
complex deal details	locationType	varchar	Type of Location
complex deal details	item	numeric	Item identifier
complex deal details	income	numeric	Income
complex deal details	turnoverUnits	numeric	Turnover Units
complex deal details	taxCode	varchar	Tax Code
complex deal details	taxRate	numeric	Tax Rate
complex deal details	taxBasis	numeric	Tax Basis
complex deal details	taxPerUnit	numeric	Tax Per Unit
complex deal details	complexDealDetailsTaxes	entity list	Complex Deal Details Taxes
complex deal details taxes	taxCode	varchar	Tax Code
complex deal details taxes	taxRate	numeric	Tax Rate
complex deal details taxes	taxBasis	numeric	Tax Basis
complex deal details taxes	taxPerUnit	numeric	Tax Per Unit
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Debit Memo Quantity

Business Overview

This REST service provides the ability to create debit memo quantities via the induction pattern. Any induction template key with a template type of ‘Debit Memo Quantity’ (TEMPLATE_TYPE = ‘DEBMEQ’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/debitMemoQuantity 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/debitMemoQuantity 

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "rtvOrderNo": "",
      "referenceInvoice": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "reasonCodeDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "reasonCode": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "reasonCodeDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	rtvOrderNo	varchar	Return To Vendor order number
document	referenceInvoice	varchar	Reference invoice
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	reasonCodeDetails	entity list	Reason Code Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
reason code details	upc	varchar	Universal product code
reason code details	vpn	varchar	Vendor product number
reason code details	item	varchar	Item identifer
reason code details	reasonCode	varchar	Reason code
reason code details	quantity	numeric	Item quantity
reason code details	unitCost	numeric	Item unit cost
reason code details	taxCode	varchar	Item Tax Code
reason code details	taxRate	numeric	Item Tax Rate
reason code details	taxBasis	numeric	Item Tax Basis
reason code details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
reason code details	comment	varchar	Comment
reason code details	reasonCodeDetailsTaxes	entity list	Reason Code Details Taxes
reason code details taxes	taxCode	varchar	Item Tax Code
reason code details taxes	taxRate	numeric	Item Tax Rate
reason code details taxes	taxBasis	numeric	Item Tax Basis
reason code details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": "" 
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Merchandise Invoice

Business Overview

This REST service provides the ability to create merchandise invoices via the induction pattern. Any induction template key with a template type of ‘Merchandising Invoice’ (TEMPLATE_TYPE = ‘MRCHI’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/merchandiseInvoice 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/merchandiseInvoice 

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalQuantity": "",
      "totalDiscount": "",
      "freightPaymentType": "",
      "manuallyPaid": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "merchandiseDetails": [
        {
          "upc": "",
          "vpn": "",
          "item": "",
          "quantity": "",
          "unitCost": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "unitTaxPerUnit": "",
          "comment": "",
          "merchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": "",
              "unitTaxPerUnit": ""
            }
          ]
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "purchaseOrders": [
        {
          "orderNo": ""
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalQuantity	numeric	Total quantity
document	totalDiscount	numeric	Total discount
document	freightPaymentType	varchar	Freight payment type
document	manuallyPaid	varchar	Manually paid indicator (Y - Yes, N - No)
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	merchandiseDetails	entity list	Merchandise Details
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	purchaseOrders	entity list	Purchase Orders for multi-PO invoices
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
merchandise details	upc	varchar	Universal product code
merchandise details	vpn	varchar	Vendor product number
merchandise details	item	varchar	Item identifer
merchandise details	quantity	numeric	Item quantity
merchandise details	unitCost	numeric	Item unit cost
merchandise details	taxCode	varchar	Item Tax Code
merchandise details	taxRate	numeric	Item Tax Rate
merchandise details	taxBasis	numeric	Item Tax Basis
merchandise details	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
merchandise details	comment	varchar	Comment
merchandise details	merchandiseDetailsTaxes	entity list	Merchandise Details Taxes
merchandise details taxes	taxCode	varchar	Item Tax Code
merchandise details taxes	taxRate	numeric	Item Tax Rate
merchandise details taxes	taxBasis	numeric	Item Tax Basis
merchandise details taxes	unitTaxPerUnit	numeric	Item Unit Tax Per Unit
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
additional purchase orders	orderNo	numeric	Order number
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": "" 
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Create Non-Merchandise Invoice

Business Overview

This REST service provides the ability to create non-merchandise invoices via the induction pattern. Any induction template key with a template type of ‘Non-Merchandising Invoice’ (TEMPLATE_TYPE = ‘NMRCHI’) can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/nonMerchandiseInvoice 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/nonMerchandiseInvoice 

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "documents": [
    {
      "transactionNumber": "",
      "document": "",
      "groupId": "",
      "vendorType": "",
      "vendorId": "",
      "supplierSite": "",
      "documentDate": "",
      "orderNo": "",
      "location": "",
      "locationType": "",
      "paymentTerms": "",
      "paymentMethod": "",
      "currencyCode": "",
      "exchangeRate": "",
      "totalCostExTax": "",
      "taxAmount": "",
      "totalDiscount": "",
      "manuallyPaid": "",
      "reference1": "",
      "reference2": "",
      "reference3": "",
      "reference4": "",
      "comment": "",
      "thirdPartyPayee": "",
      "bestTermsDate": "",
      "taxBreakdown": [
        {
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "taxAmount": ""
        }
      ],
      "nonMerchandiseDetails": [
        {
          "nonMerchCode": "",
          "nonMerchAmount": "",
          "taxCode": "",
          "taxRate": "",
          "taxBasis": "",
          "nonMerchandiseDetailsTaxes": [
            {
              "taxCode": "",
              "taxRate": "",
              "taxBasis": ""
            }
          ]
        }
      ],
      "attachments": [
        {
          "attachmentName": "",
          "attachmentDescription": "",
          "attachmentType": "",
          "attachmentUrl": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
document induction	templateKey	varchar	Template Key for the induction template used to determine the allowed fields
document induction	documents	entity list	Documents to create
document	transactionNumber	numeric	Unique identifier for single document transaction. User given, can be any number but must be unique within a single request
document	document	varchar	Vendor document identifier
document	groupId	numeric	Group identifier
document	vendorType	varchar	Type of vendor
document	vendorId	varchar	Vendor identifier
document	supplierSite	numeric	Supplier site identifier
document	documentDate	varchar	Document date
document	orderNo	numeric	Order number
document	location	numeric	Location identifier
document	locationType	varchar	Type of location (W - Warehouse, S - Store)
document	paymentTerms	numeric	Payment terms
document	paymentMethod	varchar	Payment method (LC - Letter of Credit, WT - Wire Transfer, OA - Open Account)
document	currencyCode	varchar	Three character currency code (Ex. USD)
document	exchangeRate	numeric	Currency exchange rate
document	totalCostExTax	numeric	Total cost excluding tax
document	taxAmount	numeric	Total tax
document	totalDiscount	numeric	Total discount
document	manuallyPaid	varchar	Manually paid indicator (Y - Yes, N - No)
document	reference1	varchar	Document reference 1
document	reference2	varchar	Document reference 2
document	reference3	varchar	Document reference 3
document	reference4	varchar	Document reference 4
document	comment	varchar	Comment
document	thirdPartyPayee	varchar	Third party payee vendor identifier
document	bestTermsDate	varchar	Best terms date
document	taxBreakdown	entity list	Tax Breakdown of header taxes on the document
document	nonMerchandiseDetails	entity list	Non-Merchandise Details
document	attachments	entity list	Document Attachments
tax breakdown	taxCode	varchar	Header Tax code
tax breakdown	taxRate	numeric	Header Tax rate
tax breakdown	taxBasis	numeric	Header Tax Basis
tax breakdown	taxAmount	numeric	Header Tax Amount
non merchandise details	nonMerchCode	varchar	Non-merchandise Code
non merchandise details	nonMerchAmount	numeric	Non-merchandise Amount
non merchandise details	taxCode	varchar	Non-merchandise Tax Code
non merchandise details	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details	taxBasis	numeric	Non-merchandise Tax Basis
non merchandise details	nonMerchandiseDetailsTaxes	entity list	Non-Merchandise Details Taxes
non merchandise details taxes	taxCode	varchar	Non-merchandise Tax Code
non merchandise details taxes	taxRate	numeric	Non-merchandise Tax Rate
non merchandise details taxes	taxBasis	numeric	Non-merchandise Tax Basis
attachment	attachmentName	varchar	Attachment Name
attachment	attachmentDescription	varchar	Attachment Description
attachment	attachmentType	varchar	Attachment Type (DOC - Document, IMG - Image, OT - Other)
attachment	attachmentUrl	varchar	Attachment URL

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of sub entity JSON objects (see the structure of the Request Body above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890)

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234)

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22)

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM)

Date and time values should be given in the preferred date and time format of the authenticated user for the request, the default is M/d/yy h:mm a (for example,1/31/22 11:50 PM)

Response Codes

202 - Accepted

The request was successful and the body has been submitted for asynchronous processing.

Response Body

{
  "injectId": "" 
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Get Induction Status

Business Overview

This REST service provides the ability to read the induction status for any induction process. It can be used to verify the status of asynchronous web service create document requests.

Service Type

GET

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/induction/v1/status 

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/induction/v1/status 

Request Headers

Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Accept-Language: en-US 
Accept-Version: 19.3 

URL Query Parameters

KEY	TYPE	VALUE
injectId	numeric	Inject ID returned from any of the create induction services

Request Body

N/A

Response Codes

200 - OK

The request was successful and the induction process has completed with the given business errors (if any).

Response Body

{
  "injectId": "",
  "status": "",
  "errors": [
    {
      "transactionNumber": "",
      "documentErrors": [
        {
          "message": "",
          "context": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.
asynchronous induction	status	varchar	Status of the induction process
asynchronous induction	errors	entity list	Induction processing errors
induction errors	transactionNumber	numeric	Unique identifier for single document transaction from create request
induction errors	documentErrors	entity list	Document creation errors
document errors	message	varchar	Error message
document errors	context	varchar	Error context

202 - Accepted

The request was successful, but the induction process has not completed yet.

Response Body

{
  "injectId": "",
  "status": ""
}

ENTITY	KEY	TYPE	VALUE
asynchronous induction	injectId	numeric	Identifier for the asynchronous induction process.
asynchronous induction	status	varchar	Status of the induction process

Use the Documents – Get Induction Status request to poll for the results of the asynchronous process.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Supplier Options Upload

Business Overview

This REST service provides the ability to create Supplier options at supplier, supplier, site or supplier group level with the induction pattern. Any induction template key with a template type of ‘Supplier Options Webservice Upload’ (TEMPLATE_TYPE = 'SUPOPT') can be used.

Service Type

POST

REST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/foundation/supplier/v1/supplieroptions

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/foundation/supplier/v1/supplieroptions

Request Headers

Content-Type: application/json 
Accept: application/json 
Accept-Language: <locale> 
Accept-Version: <application_version> 

Example

Content-Type: application/json 
Accept: application/json 
Accept-Language: en-US 
Accept-Version: 19.3 

URL Query Parameters

N/A

Request Body

{
  "templateKey": "",
  "supplierOptions": [
    {
      "supLevel": "",
      "masterSupplier": "",
      "supplier": "",
      "supplierSite": "",
      "supplierGroupId": "",
      "externalSupplierGroupId": "",
      "supplierGroupDesc": "",
      "supplierGroupMembers": [
        {
          "supplier": "",
          "deleteInd": ""
        }
      ],
      "matchStgyId": "",
      "sendDebitMemo": "",
      "manuallyPaidInd": "",
      "useInvoiceTerm": "",
      "rogDateAllowed": "",
      "holdDocument": "",
      "matchTotalQuantity": "",
      "totalHeaderQuantity": "",
      "onlineParentMatch": "",
      "apReviewer": "",
      "closeOpenReceiptDays": "",
      "disceprancyDaysBeforeRouting": "",
      "defaultMatchKey": "",
      "skuCompliancePercentage": "",
      "automatchAcrossMultiPoInd": "",
      "allowMasterPoMatching": ""
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
Supplier Options induction	templateKey	Varchar	Template Key for the induction template used to determine the allowed fields
Supplier Options induction	supplierOptions	Entity list	List of supplier options entities to be created or updated
SupplierOptions	supLevel	Varchar	Level of supplier options. Allowed values are:’S’ – Supplier, ‘SS’- Supplier Site, ‘SG’ – Supplier Group
SupplierOptions	masterSupplier	Varchar	Indicator if options define master supplier options (Y/N)
SupplierOptions	Supplier	Numeric	Supplier ID when supplier level is ‘S’. Should be null otherwise.
SupplierOptions	supplierSite	Numeric	Supplier site ID when supplier level is ‘SS’. Should be null otherwise.
SupplierOptions	supplierGroupId	Numeric	Supplier group ID when supplier level is ‘SG’. Should be null otherwise.
SupplierOptions	externalSupplierGroupId	Numeric	Supplier group ID sent from the external system
SupplierOptions	supplierGroupDesc	Varchar	Supplier group descriptions
SupplierOptions	supplierGroupMembers	Entity list	List of suppliers for a supplier group
supplierGroupMembers	Supplier	Numeric	Supplier ID for a supplier to be a member of a supplier group
supplierGroupMembers	deleteInd	Varchar	Remove supplier from the supplier group (Y/N)
SupplierOptions	matchStgyId	Numeric	If of the matching strategy for invoice matching
SupplierOptions	sendDebitMemo	Varchar	Should Debit memo be sent or Credit Note Request be sent to suppliers (Y/N)
SupplierOptions	manuallyPaidInd	Varchar	It will indicate whether the supplier invoices are manually paid (Y/N)
SupplierOptions	useInvoiceTerm	Varchar	Should invoice payment terms always be used for supplier payments (Y/N)
SupplierOptions	rogDateAllowed	Varchar	Should receipt of goods date be considered for best terms calculations (Y/N)
SupplierOptions	holdDocument	Varchar	Should document holding from posting be used (Y/N)
SupplierOptions	matchTotalQuantity	Varchar	Should total quantity be used for invoice matching (Y/N)
SupplierOptions	totalHeaderQuantity	Varchar	Should document header quantity be required (Y/N)
SupplierOptions	onlineParentMatch	Varchar	Should style level matching be used for online matching (Y/N)
SupplierOptions	apReviewer	Varchar	Define the user name for the application user responsible for the supplier
SupplierOptions	closeOpenReceiptDays	Numeric	When unmatched receipts should be automatically closed for matching
SupplierOptions	disceprancyDaysBeforeRouting	Numeric	When discrepancy should be triggered prior to the document’s due data
SupplierOptions	defaultMatchKey	Varchar	Default matching key. ‘PO’ – purchase order ‘POL’ – purchase order/location ‘SL’ – supplier/location ‘SSL’ – supplier site/ location ‘SGL’ – supplier group/location
SupplierOptions	skuCompliancePercentage	Numeric	Define SKU compliance percentage required for style-level matching
SupplierOptions	automatchAcrossMultiPoInd	Varchar	Is auto-match across purchase orders allowed (Y/N)
SupplierOptions	allowMasterPoMatching	Varchar	Is master PO matching allowed (Y/N)

Note:

Values can be skipped, even if they are on the induction template and they will be provided as NULL.

Values designated as "Entity List" are lists of subentity JSON objects (see the structure above).

Entity Identifiers should be given as Long Integers with numeric characters ONLY (for example, 1234567890).

Decimal values should be given in the preferred date format of the authenticated user for the request, the default is #,###.#### with the decimal point and following digits being optional (for example, -1,234.5678 or -1,234).

Date values should be given in the preferred date format of the authenticated user for the request, the default is M/d/yy (for example, 1/31/22).

Time values should be given in the preferred time format of the authenticated user for the request, the default is h:mm a (for example, 11:50 PM).

Date and time values should be given in the preferred date and time format of the authenticated user for the request. The default is M/d/yy h:mm a (for example,1/31/22 11:50 PM).

Response Codes

202 - Accepted

The request was successful, and the body has been submitted for asynchronous processing.

Response Body

 {
  "status": "",
  "injectId": "",
  "supplierOptions": [
    {
      "reqId": "",
      "supLevel": "",
      "status": "",
      "supplierGroupId": "",
      "externalSupplierGroupId": "",
      "errors": [
        {
          "reqId": "",
          "errorCode": "",
          "errorDesc": ""
        }
      ]
    }
  ]
}

ENTITY	KEY	TYPE	VALUE
response	status	Varchar	Aggregated requests status
response	injectId	Numeric	Inject id of the group of supplier options requests
response	supplierOptions	Entity list	List of supplier options requests
supplierOptions	reqId	Numeric	Request ID (sequentially system generated)
supplierOptions	supLevel	Varchar	Supplier options level (see level desc in request)
supplierOptions	status	Varchar	Per request status (SUCCESS/FAILURE/SUCCESS_WITH_ERRORS)
supplierOptions	supplierGroupId	Numeric	Internal supplier group ID
supplierOptions	externalSupplierGroupId	Numeric	External ID of a supplier group
response	errors	Entity list	List of errors, if any
error	reqId	Numeric	Request ID
error	errorCode	Varchar	Error code identifying the error
error	errorDesc	Varchar	Error descriptions

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Documents – Invoice Force Pay

Business Overview

This REST service provides the ability to prepay one or more ReIM invoice documents. The service accepts invoice prepayment request records and returns per-invoice processing status, including the total number of invoices submitted and prepaid.

Service Type

POST

ReST URL

https://<host>[:<port>]/<context_root>/services/private/Reim/document/prepayment

Example

https://example.us.oracle.com/ReimRestService/services/private/Reim/document/prepayment

Request Headers

Content-Type: application/json
Accept: application/json
Accept-Language: <locale>
Accept-Version: <application_version>

Example

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.3

URL Query Parameters

N/A

Request Body

[
  {
    "reqId": 1,
    "documentId": "100000001",
    "supplierId": "2401",
    "supplierSiteId": "1",
    "supplierPaymentTermsId": "PREPAY",
    "orderNo": "4500001234"
  }
]

ENTITY	KEY	TYPE	VALUE
document prepay	reqId	numeric	Request identifier used to correlate the input row with the invoice response.
document prepay	documentId	varchar	ReIM document refers to the ext_doc_id for the invoice to prepay.
document prepay	supplierId	varchar	Supplier identifier associated with the document.
document prepay	supplierSiteId	varchar	Supplier site identifier associated with the document.
document prepay	supplierPaymentTermsId	varchar	Supplier payment terms identifier to use for the prepayment.
document prepay	orderNo	varchar	Purchase order number associated with the invoice document.

Note:

• The request body is a JSON array of DocumentPrepaymentRequest objects.

• Use reqId to correlate each submitted invoice with the corresponding invoice result in the response.

• Values should match valid ReIM document, supplier, supplier site, payment terms, and purchase order values.

Response Codes

200 - OK

The request was successful, and the prepayment results are returned in the response body.

400 - Bad Request

The request was NOT successful due to an issue with the headers, query parameters, or body of the request.

500 - Internal Server Error

The request was NOT successful due to an internal server error. Contact a system administrator to determine the cause of the issue.

Response Body

{
  "processId": 1111,
  "injectId": 2111111,
  "totalInvoices": 1,
  "totalPrepaid": 1,
  "invoices": [
    {
      "reqId": 1,
      "documentId": "100000001",
      "workspaceId": "",
      "status": "SUCCESS",
      "errors": []
    }
  ]
}

Response Body Fields

ENTITY	KEY	TYPE	VALUE
document prepay response	processId	numeric	Unique Identifier for the JSON payload process.
document prepay response	injectId	numeric	Unique Identifier for the Inject Table Data.
document prepay response	totalInvoices	numeric	Total invoice records submitted in the request.
document prepay response	totalPrepaid	numeric	Number of invoice records successfully prepaid.
document prepay response	invoices	entity list	Per-invoice processing results.
document prepay invoice response	reqId	numeric	Request identifier from the submitted input row.
document prepay invoice response	documentId	varchar	Document refers to the ext_doc_id for the processed invoice.
document prepay invoice response	workspaceId	numeric	Workspace ID for the invoice present in the im_doc_invc_search_ws table.
document prepay invoice response	status	varchar	Processing status for the invoice.
document prepay invoice response	errors	varchar list	Error messages returned for the invoice, when the prepayment fails or is rejected.

Document - Approve

Business Overview

This REST service approves eligible ReIM deal documents in one request. Every item is identified using external business values. Valid documents move from SUBMIT to APPRVE; invalid items fail independently without preventing other valid items from being approved.

Service Definition

Property	Value
Method	POST
REST URL	https://<host>[:<port>]/<context_root>/services/private/Reim/document/v1/approve
Required privilege	APPROVE_DEAL_BILLBACKS_PRIV
Content type	application/json
Process template	DOCAPP
Process key	REIM_DEAL_DOC_APPROVE

Request Headers

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: <application_version>

Request Body

{
  "requests": [
    {
      "requestId": "10001",
      "document": "DEAL-DOC-001",
      "type": "CRDNRC",
      "vendor": "1001",
      "doc_date": "11-FEB-26"
    },
    {
      "requestId": "10002",
      "document": "DEAL-DOC-002",
      "type": "DEBMEC",
      "vendor": "1001",
      "doc_date": "11-FEB-26"
    }
  ]
}

Field	Type	Required	Description
requests	Array	Yes	Non-empty list of approval requests.
requestId	String	Yes	Caller correlation identifier. It must contain 1-10 numeric digits. The first occurrence is processed; later duplicate occurrences fail.
document	String	Yes	External document ID, mapped to IM_DOC_HEAD.EXT_DOC_ID.
type	String	Yes	Document type. Approval accepts only CRDNRC and DEBMEC.
vendor	String	Yes	Numeric vendor ID. It must identify an active parent supplier.
doc_date	String	Conditional	Document date in DD-MON-YY format, for example 11-FEB-26. English month abbreviations are used.

Document-date identification: when IM_SYSTEM_OPTIONS.INCL_DOC_DATE_FOR_DUPL_CHECK = 'Y', the complete date is required and participates in identification. Otherwise, when INCL_DOC_YEAR_FOR_DUPL_CHECK = 'Y', the date is required and its year participates. When both options are N, doc_date is optional.

Eligibility and Validation

• The document must be uniquely identified by document, type, vendor and the configured date rule.

• The vendor must be numeric and must exist as an active parent supplier.

• The document type must be CRDNRC or DEBMEC.

• The document must be associated with a Fixed, Complex or Non-Merchandise deal.

• The current document status must be SUBMIT.

• The row must be available for update; a concurrent lock produces DOCUMENT_LOCKED.

• For duplicate request IDs or duplicate document entries, only the later occurrence fails.

Processing Flow

1. The service validates the request envelope and each requestId.

2. A processId and injectId are allocated. Tracking rows are created in IM_INJECT_STATUS and IM_INJECT_REQUEST, including the original JSON payload.

3. All request items are batch-inserted into the session-specific global temporary table IM_DOCUMENT_MODIFY_GTT.

4. A single call to REIM_DOCUMENT_SQL.DOC_APPROVE validates the staged set. Rules run over all rows rather than executing validation queries once per request.

5. Eligible rows are locked and updated from SUBMIT to APPRVE. Validation failures are stored in the GTT and persisted to IM_PROCESS_ERROR with their REQ_* rule and dynamic context.

6. The service pulls all results from the GTT in original request order and builds one response item for every input item.

7. IM_INJECT_STATUS is completed as FULL_SUCCESS, SUCCESS_WITH_ERRORS or FAILURE.

Response Body

{
  "processId": 7942,
  "injectId": 2561445,
  "requests": [
    {
      "requestId": "10001",
      "status": "APPRVE",
      "errorCode": null,
      "errorMessage": null
    },
    {
      "requestId": "10002",
      "status": null,
      "errorCode": "INVALID_VENDOR",
      "errorMessage": "Invalid Vendor '78954'."
    }
  ]
}

Field	Description
processId	Process identifier used for persisted request errors.
injectId	Manage Request identifier used to view the overall request and its errors.
requests[].status	APPRVE when approval succeeds; otherwise null.
requests[].errorCode	Machine-readable item error code; null
requests[].errorMessage	Localized seeded rule message combined with request-specific context; null on success.

HTTP Response Codes

• 200 OK - The request was processed. The body can contain both successful and failed item results.

• 400 Bad Request - Malformed JSON, missing/empty requests, a null item, or an invalid requestId. Missing document, type, vendor and business-validation failures are returned as item results under HTTP 200.

• 401 Unauthorized - Authentication failed.

• 403 Forbidden - The user does not have APPROVE_DEAL_BILLBACKS_PRIV.

• 500 Internal Server Error - An unexpected technical failure caused the transaction to roll back.

Item Error Codes

Error code	Rule shown in View Errors	Description
DUPLICATE_REQUEST_ID	REQ_DUPLICATE_REQUEST_ID	A later item repeats a requestId.
DOCUMENT_REQUIRED	REQ_DOCUMENT_REQUIRED	Document is null or blank.
TYPE_REQUIRED	REQ_TYPE_REQUIRED	Type is null or blank.
VENDOR_REQUIRED	REQ_VENDOR_REQUIRED	Vendor is null or blank.
INVALID_DOCUMENT_TYPE	REQ_INVALID_DOCUMENT_TYPE	Type is not CRDNRC or DEBMEC.
INVALID_DOCUMENT_DATE	REQ_INVALID_DOCUMENT_DATE	doc_date is not valid DD-MON-YY.
DOC_DATE_REQUIRED	REQ_DOC_DATE_REQUIRED	Date is required by duplicate-check configuration.
INVALID_VENDOR	REQ_INVALID_VENDOR	Vendor is non-numeric or is not an active parent supplier.
DUPLICATE_DOCUMENT_REQUEST	REQ_DUPLICATE_DOCUMENT_REQUEST	A later request identifies the same document.
DOCUMENT_NOT_FOUND	REQ_DOCUMENT_NOT_FOUND	No document matches the supplied document, type, vendor and date criteria.
DUP_VEND_DOC_NUM	REQ_DUP_VEND_DOC_NUM	More than one document matches the supplied document, type, vendor and date criteria.
INVALID_DEAL_DOCUMENT	REQ_INVALID_DEAL_DOCUMENT	The document is not associated with an eligible deal.
INVALID_DOCUMENT_STATUS	REQ_INVALID_DOCUMENT_STATUS	The document is not in SUBMIT status.
DOCUMENT_LOCKED	REQ_DOCUMENT_LOCKED	The document is locked by another transaction.

Manage Request and View Errors

Search Manage Request by the returned injectId. The request name is Deal Document Approve Through Rest Service. View Errors displays the request number, document type, vendor, document number, the REQ_* rule in Error Type, and the complete seeded message plus dynamic context in Error Details.

Implementation and Test Coverage

The REST resource delegates to the shared DocumentModifyServiceEJBBean. The data objects are DocumentApprovalRequest(s) and DocumentApprovalResponse(s). Automated coverage includes business-object contract tests, EJB/service tests, application-module and operation tests, PL/SQL integration tests for REIM_DOCUMENT_SQL, and a dedicated ImProcessErrorsVOImplIntTest for the Manage Request error mapping.

Document - Delete

Business Overview

This REST service deletes eligible ReIM documents in one request. Each item is identified using external business information. The API uses the same Java UI and PL/SQL delete functionality as Document Search: successful items return DELETE, while business failures are returned independently with a null status.

Service Definition

Property	Value
Method	POST
REST URL	https://<host>[:<port>]/<context_root>/services/private/Reim/document/v1/delete
Required privilege	DELETE_DOCUMENTS_PRIV
Content type	application/json
Process template	DOCDEL
Process key	REIM_DOCUMENT_DELETE

Request Headers

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: <application_version>

Request Body

{
  "requests": [
    {
      "requestId": "10001",
      "document": "DOC-DELETE-001",
      "type": "MRCHI",
      "vendor": "2001",
      "doc_date": "12-FEB-26"
    },
    {
      "requestId": "10002",
      "document": "DOC-DELETE-002",
      "type": "CRDNRC",
      "vendor": "2001",
      "doc_date": "12-FEB-26"
    }
  ]
}

Field	Type	Required	Description
requests	Array	Yes	Non-empty list of delete requests.
requestId	String	Yes	Caller correlation identifier containing 1-10 numeric digits. The first occurrence is processed; later duplicates fail.
document	String	Yes	External document ID, mapped to IM_DOC_HEAD.EXT_DOC_ID.
type	String	Yes	ReIM document type corresponding to the document.
vendor	String	Yes	Numeric vendor ID. It must identify an active parent supplier.
doc_date	String	Yes	Document date in DD-MON-YY format, for example 11-FEB-26. The public JSON key is doc_date.

Supported types are MRCHI, NMRCHI, CRDNT, CRDNRC, CRDNRQ, CRDNRT, CRDNRA, CRDMEC, CRDMEQ, CRDMEA, DEBMEC, DEBMEQ, DEBMET and DEBMEA.

Processing Flow

1. The service validates the request envelope and each requestId.

2. A processId and injectId are allocated. IM_INJECT_STATUS and IM_INJECT_REQUEST are created, including the original payload.

3. All request items are batch-inserted into the session-specific IM_DOCUMENT_MODIFY_GTT.

4. A single call to REIM_DOCUMENT_SQL.DOC_DELETE runs set-based required-field, date, vendor, duplicate and document-identification validation over the complete staged set.

5. Validated documents are selected from IM_DOCUMENT_MODIFY_GTT and locked in IM_DOC_HEAD. Each document is then temporarily staged in IM_DOC_INVC_SEARCH_WS to invoke the existing UI DELETE_DOCS flow. The temporary workspace record is removed after processing.

6. All PL/SQL validation failures are persisted to IM_PROCESS_ERROR. When several delete rules fail for one item, every rule is retained for View Errors and the response returns the configured primary error.

7. Results are pulled from the GTT in request order. IM_INJECT_STATUS is completed as FULL_SUCCESS, SUCCESS_WITH_ERRORS or FAILURE.

Credit memo warning: a credit memo created by reversing a debit memo returns CREDIT_MEMO_WARNING; deletion is not performed because this REST contract has no confirmation flag.

Response Body

{
  "processId": 7739,
  "injectId": 2556436,
  "requests": [
    {
      "requestId": "10001",
      "status": "DELETE",
      "errorCode": null,
      "errorMessage": null
    },
    {
      "requestId": "10002",
      "status": null,
      "errorCode": "PREPAID_DOCUMENT",
      "errorMessage": "Selected document is prepaid."
    }
  ]
}

Field	Description
processId	Process identifier used for persisted request errors.
injectId	Manage Request identifier for request and error review.
requests[].status	DELETE when deletion succeeds; otherwise null.
requests[].errorCode	Machine-readable business error code; null on success.
requests[].errorMessage	Seeded rule message combined with request-specific context; null on success.

HTTP Response Codes

• 200 OK - Request processed; successful and failed items may be mixed.

• 400 Bad Request - Malformed JSON, missing/empty requests, a null item, or an invalid requestId. Missing document/type/vendor/date and other business failures are item results under HTTP 200.

• 401 Unauthorized - Authentication failed.

• 403 Forbidden - The user does not have DELETE_DOCUMENTS_PRIV.

• 500 Internal Server Error - Unexpected technical failure; the transaction is rolled back.

Item Error Codes

Error code	Rule shown in View Errors	Description
DUPLICATE_REQUEST_ID	REQ_DUPLICATE_REQUEST_ID	A later item repeats a requestId.
DOCUMENT_REQUIRED	REQ_DOCUMENT_REQUIRED	Document is null or blank.
TYPE_REQUIRED	REQ_TYPE_REQUIRED	Type is null or blank.
VENDOR_REQUIRED	REQ_VENDOR_REQUIRED	Vendor is null or blank.
DOC_DATE_REQUIRED	REQ_DELETE_DOC_DATE_REQUIRED	doc_date is null or blank.
INVALID_DOCUMENT_TYPE	REQ_DELETE_INVALID_DOCUMENT_TYPE	The supplied type is not supported.
INVALID_DOCUMENT_DATE	REQ_DELETE_INVALID_DOCUMENT_DATE	doc_date is not valid DD-MON-YY.
INVALID_VENDOR	REQ_INVALID_VENDOR	Vendor is non-numeric or is not an active parent supplier.
DUPLICATE_DOCUMENT_REQUEST	REQ_DUPLICATE_DOCUMENT_REQUEST	A later request identifies the same document.
DOCUMENT_NOT_FOUND	REQ_DOCUMENT_NOT_FOUND	No document matches the supplied document, type, vendor and date.
DUP_VEND_DOC_NUM	REQ_DUP_VEND_DOC_NUM	More than one document matches the supplied external information.
DOCUMENT_ALREADY_DELETED	REQ_DOCUMENT_ALREADY_DELETED	The document is already deleted.
DOCUMENT_LOCKED	REQ_DOCUMENT_LOCKED	The document is locked by another transaction.
CREDIT_MEMO_WARNING	REQ_CREDIT_MEMO_WARNING	The credit memo was created by reversing a debit memo.
DIRTY_RECORD	REQ_DIRTY_RECORD	The document was modified by another user.
PREPAID_DOCUMENT	REQ_PREPAID_DOCUMENT	Prepaid documents cannot be deleted.
CHILD_INVOICE	REQ_CHILD_INVOICE	The document has child invoices.
MRCHI_STATUS	REQ_MRCHI_STATUS	Merchandise invoice status is not eligible.
UNAPPR_CRDNT	REQ_UNAPPR_CRDNT	Credit note status is not eligible.
CRDNT_REQ	REQ_CRDNT_REQ	Credit note request cannot be deleted.
DEBIT_MEMO_STATUS	REQ_DEBIT_MEMO_STATUS	Debit memo status is not eligible.
CREDIT_MEMO_STATUS	REQ_CREDIT_MEMO_STATUS	Credit memo status is not eligible.
NON_MERCH_STATUS	REQ_NON_MERCH_STATUS	Non-merchandise invoice status is not eligible.
RESLN_ACTION	REQ_RESLN_ACTION	A resolution action is pending.
PARTIAL_MATCH	REQ_PARTIAL_MATCH	The document is matched, partially matched or has a pending resolution.
PROCESS_GENERATED_DOC	REQ_PROCESS_GENERATED_DOC	The document is process generated.
CROSS_REF_DOC	REQ_CROSS_REF_DOC	Another document cross-references the selected document.

Manage Request and View Errors

Search Manage Request by injectId. The request name is Document Delete Through Rest Service. View Errors shows the REQ_* rule in Error Type and the complete seeded message plus dynamic context in Error Details.

Implementation and Test Coverage

The REST resource delegates to the shared DocumentModifyServiceEJBBean. The data objects are DocumentDeleteRequest(s) and DocumentDeleteResponse(s). Automated coverage includes business-object tests, EJB/service and application-module tests, operation tests, database-backed REIM_DOCUMENT_SQL integration tests, and the dedicated ImProcessErrorsVOImplIntTest.

Document - Unmatch

Business Overview

This REST service unmatches eligible ReIM documents in one request. Each item is identified using external business information. It delegates to the same PL/SQL flow as Match Inquiry; successful items finish in URMTCH, while validation failures are returned independently with a null status.

Service Definition

Property	Value
Method	POST
REST URL	https://<host>[:<port>]/<context_root>/services/private/Reim/document/v1/unmatch
Required privilege	DOCUMENT_UNMATCH_PRIV
Content type	application/json
Process template	DOCUNM
Process key	REIM_DOCUMENT_UNMATCH

Request Headers

Content-Type: application/json
Accept: application/json
Accept-Language: en-US
Accept-Version: <application_version>

Request Body

{
  "requests": [
    {
      "requestId": "10001",
      "document": "INV-10001",
      "type": "MRCHI",
      "vendor": "2001",
      "doc_date": "12-FEB-26"
    }
  ]
}

Field	Type	Required	Description
requests	Array	Yes	Non-empty list of unmatch requests.
requestId	String	Yes	Caller correlation identifier containing 1-10 numeric digits. The first occurrence is processed; later duplicates fail.
document	String	Yes	External document ID, mapped to IM_DOC_HEAD.EXT_DOC_ID.
type	String	Yes	ReIM document type corresponding to the document.
vendor	String	Yes	Numeric vendor ID. It must identify an active parent supplier.
doc_date	String	Yes	Document date in DD-MON-YY format, for example 11-FEB-26. The public JSON key is doc_date.

Supported types are MRCHI, NMRCHI, CRDNT, CRDNRC, CRDNRQ, CRDNRT, CRDNRA, CRDMEC, CRDMEQ, CRDMEA, DEBMEC, DEBMEQ, DEBMET and DEBMEA.

Processing Flow

1. The service validates the request envelope and each requestId.

2. A processId and injectId are allocated. IM_INJECT_STATUS and IM_INJECT_REQUEST are created, including the original payload.

3. All items are batch-inserted into the session-specific IM_DOCUMENT_MODIFY_GTT.

4. A single call to REIM_UNDO_MATCH_SQL.DOC_UNMATCH runs set-based required-field, date, vendor, duplicate and document-identification validation over the staged set.

5. For every valid row, the package invokes the existing PERFORM_UNMTCH_DOC flow. Its validation and reversal logic covers posted/deleted documents, matched-outside-ReIM, tax resolution, child resolution documents, order-cost/RUA conditions, summary matching, written-off receipts and record locks. Valid unmatches use the existing shipment, invoice, receipt, resolution, match-history and posting reversals.

6. All PL/SQL validation comments are persisted to IM_PROCESS_ERROR. The first applicable rule is returned in the response, while all applicable rules remain available in View Errors.

7. After the existing unmatch flow completes, the requested document must persist with status URMTCH. Otherwise the item returns UNMATCH_NOT_ELIGIBLE.

8. Results are pulled from the GTT in request order. IM_INJECT_STATUS is completed as FULL_SUCCESS, SUCCESS_WITH_ERRORS or FAILURE.

Response Body

{
  "processId": 7737,
  "injectId": 2556434,
  "requests": [
    {
      "requestId": "10001",
      "status": "URMTCH",
      "errorCode": null,
      "errorMessage": null
    },
    {
      "requestId": "10002",
      "status": null,
      "errorCode": "MATCHED_OUTSIDE",
      "errorMessage": "This document was not matched in ReIM so it cannot be unmatched."
    }
  ]
}

Field	Description
processId	Process identifier used for persisted request errors.
injectId	Manage Request identifier for request and error review.
requests[].status	URMTCH when unmatch succeeds; otherwise null.
requests[].errorCode	Machine-readable business error code; null on success.
requests[].errorMessage	Seeded rule message combined with request-specific context; null on success.

HTTP Response Codes

• 200 OK - Request processed; successful and failed items may be mixed.

• 400 Bad Request - Malformed JSON, missing/empty requests, a null item, or an invalid requestId. Missing document/type/vendor/date and other business failures are item results under HTTP 200.

• 401 Unauthorized - Authentication failed.

• 403 Forbidden - The user does not have DOCUMENT_UNMATCH_PRIV.

• 500 Internal Server Error - Unexpected technical failure; the transaction is rolled back.

Item Error Codes

Error code	Rule shown in View Errors	Description
DUPLICATE_REQUEST_ID	REQ_DUPLICATE_REQUEST_ID	A later item repeats a requestId.
DOCUMENT_REQUIRED	REQ_DOCUMENT_REQUIRED	Document is null or blank.
TYPE_REQUIRED	REQ_TYPE_REQUIRED	Type is null or blank.
VENDOR_REQUIRED	REQ_VENDOR_REQUIRED	Vendor is null or blank.
DOC_DATE_REQUIRED	REQ_UNMATCH_DOC_DATE_REQUIRED	doc_date is null or blank.
INVALID_DOCUMENT_TYPE	REQ_UNMATCH_INVALID_DOCUMENT_TYPE	The supplied type is not supported.
INVALID_DOCUMENT_DATE	REQ_INVALID_DOCUMENT_DATE	doc_date is not valid DD-MON-YY.
INVALID_VENDOR	REQ_INVALID_VENDOR	Vendor is non-numeric or is not an active parent supplier.
DUPLICATE_DOCUMENT_REQUEST	REQ_DUPLICATE_DOCUMENT_REQUEST	A later request identifies the same document.
DOCUMENT_NOT_FOUND	REQ_DOCUMENT_NOT_FOUND	No document matches the supplied document, type, vendor and date.
DUP_VEND_DOC_NUM	REQ_DUP_VEND_DOC_NUM	More than one document matches the supplied external information.
POSTED_INVOICE	REQ_UNMATCH_POSTED_INVOICE	A document involved in the match is posted.
DELETE_INVOICE	REQ_UNMATCH_DELETE_INVOICE	A document involved in the match is deleted.
MATCHED_OUTSIDE	REQ_UNMATCH_MATCHED_OUTSIDE	The document was not matched in ReIM.
TAX_RESOLVED	REQ_UNMATCH_TAX_RESOLVED	The document participated in a tax resolution.
CHILD_POSTED	REQ_UNMATCH_CHILD_POSTED	A resolution document is posted.
CHILD_MATCHED	REQ_UNMATCH_CHILD_MATCHED	A resolution document is in match status.
CHILD_DWNLD	REQ_UNMATCH_CHILD_DWNLD	A resolution document is downloaded.
RCA_MISMATCH	REQ_UNMATCH_RCA_MISMATCH	Order cost differs from the value used at match time.
RUA_NEGATIVE	REQ_UNMATCH_RUA_NEGATIVE	RUA reversal would create a negative shipment quantity.
SMRY_MATCHED	REQ_UNMATCH_SMRY_MATCHED	A detail-match document has since been summary matched.
RCPT_WRITEOFF	REQ_UNMATCH_RCPT_WRITEOFF	A shipment in the match has been written off.
RECORDS_LOCKED	REQ_UNMATCH_RECORDS_LOCKED	Another user is updating required records.
UNMATCH_NOT_ELIGIBLE	REQ_UNMATCH_NOT_ELIGIBLE	The operation returned without persisting the requested document as URMTCH.

Manage Request and View Errors

Search Manage Request by injectId. The request name is Document Unmatch Through Rest Service. View Errors shows the REQ_* rule in Error Type and the complete seeded message plus dynamic context in Error Details.

Implementation and Test Coverage

The REST resource delegates to the shared DocumentModifyServiceEJBBean. The data objects are DocumentUnmatchRequest(s) and DocumentUnmatchResponse(s). Automated coverage includes business-object tests, EJB/service and application-module tests, operation tests, database-backed REIM_UNDO_MATCH_SQL integration tests, and the dedicated ImProcessErrorsVOImplIntTest.