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.