Jump to

• Request
• Response
• Examples

Download a payment request file

get

/api/erp/integrations/resources/v1/payables/paymentRequest/files/{fileId}/data

Downloads an incoming payment request file or logical document from the object store as a binary stream.

Request

Path Parameters

• fileId(required): string
  Unique identifier of the incoming file or logical document to download.

  Example:

  44671

Query Parameters

• flowCode: string
  Name of the Document IO flow associated with the payment request file.

  Example:

  FIN_AP_IMPORT_PAYABLES_PAYMENT_REQUEST

• type(required): string
  Type of document to download. Valid values are incoming and logical.

  Example:

  logical

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

The payment request file was retrieved successfully.

Back to Top

Examples

The following example shows how to download an incoming payment request file or logical document by submitting a GET request on the REST resource using cURL.

curl --location 'https://servername.fa.us2.oraclecloud.com/api/erp/integrations/resources/v1/payables/paymentRequest/files/44671/data?type=logical' \
--header 'Authorization: Bearer <Bearer Token>' \

Example Response Body

A successful response returns the requested file as an application/octet-stream binary stream.

Back to Top