Add Attachments to

Purchasing Documents Using

ERP Object Attachment Service
Oracle Procurement Cloud Release 13 (update 18C)

WHITE PAPER / SEPTEMBER 7, 2018

DISCLAIMER
The following is intended to outline our general product direction. It is intended for information
purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any
material, code, or functionality, and should not be relied upon in making purchasing decisions. The
development, release, and timing of any features or functionality described for Oracle’s products
remains at the sole discretion of Oracle.

DISCLAIMERS FOR PRE-RELEASE, PRE-GA PRODUCTS

The revenue recognition disclaimer on this page is required for any white paper that
addresses future functionality or for products that are not yet generally available (GA). If you
are unsure whether your white paper needs the disclaimer, read the revenue recognition policy.
If you have further questions about your content and the disclaimer requirements, e-mail
REVREC_US@oracle.com. If you do not need the disclaimer, you may delete it and the page that it
appears. First, display hidden characters by clicking on the Paragraph icon on the Home toolbar. It is
a small, square icon that appears to the left of the Quick Style Gallery. Then, highlight all the text on
this page and press the Delete key. Notice that there is a section break displayed as a double-dotted
line at the bottom of this page. Continue to press Delete until the page disappears and your cursor is
on the Table of Contents page. Be sure not to remove the section break, or the formatting of the title
page will be incorrect. Delete this note before publishing.
The testing disclaimer in the TM block on the last page (highlighted in yellow) is provided by the
FCC. It must appear in the TM block for all pre-release, pre-GA products. Be sure to remove the
yellow highlighting before publishing. When the product becomes GA, update your collateral by
removing the disclaimer from the TM block. If your product is already GA, delete the disclaimer from
the TM block.
Important: If your product is not GA, then you cannot include any regulatory compliance information
in the white paper. Regulatory compliance information may be included for GA products only if you
have completed all required safety and emissions testing, and you have received the certificates
issued by the testing organization.

2 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

Table of Contents
Introduction .................................................................................................. 4

Uploading Attachments................................................................................ 4

Downloading Attachments ........................................................................... 5

Security........................................................................................................ 6

Sample Payload........................................................................................... 6

Uploading attachment to the order header .................................................................................. 6

Uploading attachment to the agreement line ............................................................................... 6

Downloading order header attachment........................................................................................ 7

3 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

INTRODUCTION

Business enterprises use attachments to provide key additional information

about purchasing documents. Attachments can be text, files, or URLs.

ERP Object Attachment Service is a utility web service that you can use to
upload attachments to Oracle Procurement Cloud Purchasing purchase
agreements and purchase orders. Use this service to upload attachments
to documents at the desired level.

UPLOADING ATTACHMENTS
The uploadAttachment operation for ErpObjectAttachmentService uploads attachments for the
specified purchasing document.

The operation works only for purchasing documents created by import or web service. Documents
must be in Incomplete or Open status. If documents are in Open status, they must have bypassed
human approvals and must not have been communicated, acknowledged, or signed. They must also
not have a change document open or a change implemented.

Request Payload
ELEMENT NAME TYPE DESCRIPTION

Indicates the product application business entity name for which the upload of an attachment is desired. Valid
entityName String entity names for Purchasing are:
PO_HEADERS – for purchase order header attachments
PO_LINES – for purchase order line attachments
PO_LINE_LOCATIONS – for purchase order schedule attachments
PO_PA_HEADERS – for purchase agreement header attachments
PO_PA_LINES – for purchase agreement line attachments
PO_PA_PRICE_BREAKS – for purchase agreement price break attachments

Indicates the category name associated with a parent business entity for which the attachment upload is desired.
categoryName String Valid names for Purchasing are:
MISC – seeded miscellaneous category
TO_SUPPLIER – category of attachments addressed to the supplier
FROM_SUPPLIER – category of attachments from the supplier
TO_BUYER – category of attachments address to the buyer
TO_RECEIVER – category of attachments addressed to the receiver
TO_APPROVER – category of attachments addressed to the approver
TO_PAYABLES – category of attachments addressed to payables
PO_INTERNAL – category of attachments internal to the document

User option to specify whether duplicate file attachments are allowed. Valid options are: yes, no.
allowDuplicate String

List of elements, each containing the details of the attachment to upload. The details include the user keys,
attachmentRows attachment type, title, text, and URL.

attachmentRows Attributes
ATTRIBUTE NAME TYPE DESCRIPTION

Provide the document number in this attribute.

UserKeyA String

Provide the sold-to legal entity name in this attribute.

UserKeyB String

Provide the document line number if you would like to load the attachment at the order or agreement line level.
UserKeyC String Specify the value #NULL if unused.

4 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

 Provide the schedule or price break number if you would like to load the attachment at that level.
UserKeyD String Specify the value #NULL if unused.

Keep this key with value #NULL.

UserKeyE String

AttachmentType String Type of the attachment. Valid values are: FILE, TEXT, URL.

Indicates the title of the attachment. Attachments of any file type such as FILE, TEXT, or URL must have a title.
Title String Examples: SampleFile.doc, SampleFile.txt, SampleURL

Attachment Text/Url. Examples:

Content String
URL: <ns2:Content>http://fusiontax.idc.oracle.com/publish/html/logs/ ERPIntegration.txt</ns2:Content>

Text: <ns2:Content>Testing text attachments</ns2:Content>

File (encode the source data to a Base64 string (base64 encoding)):

<ns2:Content>VGVzdGluZyBmaWxlIGF0dGFjaG1lbnQu</ns2:Content>

DOW NLOADING ATTACHMENTS

The downloadAttachment operation for ErpObjectAttachmentService downloads the attachments for
the specified purchasing document.

The operation has the same document eligibility criteria as the upload operation.

Request Payload
ELEMENT NAME TYPE DESCRIPTION

Element containing the details of the Attachment to be downloaded. The details include the entity name,
attachment String category name and user keys.

Attributes
ATTRIBUTE NAME TYPE DESCRIPTION

Indicates the product application business entity name for which the download of an attachment is desired. Valid
EntityName String entity names for Purchasing are:
PO_HEADERS – for purchase order header attachments
PO_LINES – for purchase order line attachments
PO_LINE_LOCATIONS – for purchase order schedule attachments
PO_PA_HEADERS – for purchase agreement header attachments
PO_PA_LINES – for purchase agreement line attachments
PO_PA_PRICE_BREAKS – for purchase agreement price break attachments

Indicates the category name associated with a parent business entity for which the attachment download is
CategoryName String desired. Valid names for Purchasing are:
MISC – seeded miscellaneous category
TO_SUPPLIER – category of attachments addressed to the supplier
FROM_SUPPLIER – category of attachments from the supplier
TO_BUYER – category of attachments address to the buyer
TO_RECEIVER – category of attachments addressed to the receiver
TO_APPROVER – category of attachments addressed to the approver
TO_PAYABLES – category of attachments addressed to payables
PO_INTERNAL – category of attachments internal to the document

Provide the document number in this attribute.

UserKeyA String

Provide the sold-to legal entity name in this attribute.

UserKeyB String

Provide the document line number if you would like to download the attachment at the order or agreement line
UserKeyC String level. Specify the value #NULL if unused.

Provide the schedule or price break number if you would like to download the attachment at that level.
UserKeyD String Specify the value #NULL if unused.

Keep this key with value #NULL.

UserKeyE String

5 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

SECURITY
The following table lists the privileges to perform the service operations, and the duty roles that each
privilege is granted to. The seeded Procurement Manager and Buyer job roles have the FSCM Load
Interface Administration duty role.

Privilege to Duty Role Mapping

PRIVILEGE CODE GRANTED TO ROLE CODE GRANTED TO ROLE NAME

FUN_FSCM_LOAD_INTERFACES_PRIV ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY FSCM Load Interface Administration

SAMPLE PAYLOAD

Uploading attachment to the order header

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:uploadAttachment
xmlns:ns1="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/types/">
<ns1:entityName>PO_HEADERS</ns1:entityName>
<ns1:categoryName>MISC</ns1:categoryName>
<ns1:allowDuplicate>yes</ns1:allowDuplicate>
<ns1:attachmentRows
xmlns:ns2="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/">
<ns2:UserKeyA>10503277</ns2:UserKeyA>
<ns2:UserKeyB>Vision Operations</ns2:UserKeyB>
<ns2:UserKeyC>#NULL</ns2:UserKeyC>
<ns2:UserKeyD>#NULL</ns2:UserKeyD>
<ns2:UserKeyE>#NULL</ns2:UserKeyE>
<ns2:AttachmentType>FILE</ns2:AttachmentType>
<ns2:Title>SampleFILE.doc</ns2:Title>
<ns2:Content>VGVzdGluZyBmaWxlIGF0dGFjaG1lbnQu</ns2:Content>
</ns1:attachmentRows>
</ns1:uploadAttachment>
</soap:Body>
</soap:Envelope>

Uploading attachment to the agreement line

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:uploadAttachment
xmlns:ns1="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/types/">
<ns1:entityName>PO_PA_LINES</ns1:entityName>
<ns1:categoryName>MISC</ns1:categoryName>
<ns1:allowDuplicate>yes</ns1:allowDuplicate>
<ns1:attachmentRows
xmlns:ns2="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/">
<ns2:UserKeyA>10503277</ns2:UserKeyA>

6 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

 <ns2:UserKeyB>Vision Operations</ns2:UserKeyB>
<ns2:UserKeyC>1</ns2:UserKeyC>
<ns2:UserKeyD>#NULL</ns2:UserKeyD>
<ns2:UserKeyE>#NULL</ns2:UserKeyE>
<ns2:AttachmentType>FILE</ns2:AttachmentType>
<ns2:Title>SampleFILE.doc</ns2:Title>
<ns2:Content> VGVzdGluZyBmaWxlIGF0dGFjaG1lbnQu</ns2:Content>
</ns1:attachmentRows>
</ns1:uploadAttachment>
</soap:Body>
</soap:Envelope>

Downloading order header attachment

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:downloadAttachment
xmlns:ns1="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/types/">
<ns1:attachment
xmlns:ns2="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationServ
ice/">
<ns2:EntityName>PO_HEADERS</ns2:EntityName>
<ns2:CategoryName>MISC</ns2:CategoryName>
<ns2:UserKeyA>10503277</ns2:UserKeyA>
<ns2:UserKeyB>Vision Operations</ns2:UserKeyB>
<ns2:UserKeyC>#NULL</ns2:UserKeyC>
<ns2:UserKeyD>#NULL</ns2:UserKeyD>
<ns2:UserKeyE>#NULL</ns2:UserKeyE>
</ns1:attachment>
</ns1:downloadAttachment>
</soap:Body>
</soap:Envelope>

7 W HITE PAPER / Purchasing Documents Using ERP Object Attachment Service

ORACLE CORPORATION

Worldwide Headquarters
500 Oracle Parkway, Redwood Shores, CA 94065 USA

Worldwide Inquiries
TELE + 1.650.506.7000 + 1.800.ORACLE1
FAX + 1.650.506.7200
oracle.com

CONNECT W ITH US
Call +1.800.ORACLE1 or visit oracle.com. Outside North America, find your local office at oracle.com/contact.

blogs.oracle.com/oracle facebook.com/oracle twitter.com/oracle

Copyright © 2018, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the contents hereof are
subject to change without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed
orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any
liability with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This document may not be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or
registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks
of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0918
Navigate to Purchasing Transactions from Reports
August 2018