Jump to

• Request
• Response
• Examples

Import a payment request file

post

/api/erp/integrations/resources/v1/payables/paymentRequest/files/import

Uploads a file to the specified location in the object store and asynchronously processes the payment request document for import into Payables interface tables.

Request

There are no request parameters for this operation.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file(required): string (binary)
  Payment request file to upload to Document IO.
• flowCode: string
  Name of the Document IO flow associated with the upload.

  Example: FIN_AP_IMPORT_PAYABLES_PAYMENT_REQUEST
• payload: object payload
  Additional Properties Allowed: true

  Additional metadata provided to Document IO for processing the payment request.

{
    "type":"object",
    "required":[
        "file"
    ],
    "properties":{
        "file":{
            "type":"string",
            "format":"binary",
            "description":"Payment request file to upload to Document IO."
        },
        "flowCode":{
            "type":"string",
            "description":"Name of the Document IO flow associated with the upload.",
            "example":"FIN_AP_IMPORT_PAYABLES_PAYMENT_REQUEST"
        },
        "payload":{
            "type":"object",
            "description":"Additional metadata provided to Document IO for processing the payment request.",
            "additionalProperties":true
        }
    }
}

Nested Schema : payload

Type: object

Additional Properties Allowed: true

Additional metadata provided to Document IO for processing the payment request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The payment request import request was received successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• links: array links
  Links associated with the payment request import request.
• message(required): string
  Message describing the result of submitting the payment request import request.

  Example: Request successfully received.
• requestId(required): string
  Unique request identifier or flow execution identifier assigned to the uploaded file. Use this value to track processing of the payment request.

  Example: 300100655797606
• status(required): string
  Status returned for the payment request import request. A value of SUCCESS indicates that the asynchronous processing request was accepted.

  Example: SUCCESS

{
    "type":"object",
    "required":[
        "status",
        "message",
        "requestId"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Status returned for the payment request import request. A value of SUCCESS indicates that the asynchronous processing request was accepted.",
            "example":"SUCCESS"
        },
        "message":{
            "type":"string",
            "description":"Message describing the result of submitting the payment request import request.",
            "example":"Request successfully received."
        },
        "requestId":{
            "type":"string",
            "description":"Unique request identifier or flow execution identifier assigned to the uploaded file. Use this value to track processing of the payment request.",
            "example":"300100655797606"
        },
        "links":{
            "type":"array",
            "description":"Links associated with the payment request import request.",
            "items":{
                "type":"object",
                "required":[
                    "rel",
                    "href",
                    "resourcePath"
                ],
                "properties":{
                    "rel":{
                        "type":"string",
                        "description":"Relationship between the link and the import request.",
                        "example":"collection"
                    },
                    "href":{
                        "type":"string",
                        "format":"uri",
                        "description":"Fully qualified URL for monitoring the import request.",
                        "example":"https://example.com/api/erp/integrations/resources/v1/payables/paymentRequest/requests/300100655797606"
                    },
                    "resourcePath":{
                        "type":"string",
                        "description":"Relative path used to monitor the import request.",
                        "example":"/requests/300100655797606"
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: array

Links associated with the payment request import request.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Links associated with the payment request import request.",
    "items":{
        "type":"object",
        "required":[
            "rel",
            "href",
            "resourcePath"
        ],
        "properties":{
            "rel":{
                "type":"string",
                "description":"Relationship between the link and the import request.",
                "example":"collection"
            },
            "href":{
                "type":"string",
                "format":"uri",
                "description":"Fully qualified URL for monitoring the import request.",
                "example":"https://example.com/api/erp/integrations/resources/v1/payables/paymentRequest/requests/300100655797606"
            },
            "resourcePath":{
                "type":"string",
                "description":"Relative path used to monitor the import request.",
                "example":"/requests/300100655797606"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(required): string (uri)
  Fully qualified URL for monitoring the import request.

  Example: https://example.com/api/erp/integrations/resources/v1/payables/paymentRequest/requests/300100655797606
• rel(required): string
  Relationship between the link and the import request.

  Example: collection
• resourcePath(required): string
  Relative path used to monitor the import request.

  Example: /requests/300100655797606

{
    "type":"object",
    "required":[
        "rel",
        "href",
        "resourcePath"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship between the link and the import request.",
            "example":"collection"
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"Fully qualified URL for monitoring the import request.",
            "example":"https://example.com/api/erp/integrations/resources/v1/payables/paymentRequest/requests/300100655797606"
        },
        "resourcePath":{
            "type":"string",
            "description":"Relative path used to monitor the import request.",
            "example":"/requests/300100655797606"
        }
    }
}

400 Response

Bad Request. The request parameters or uploaded file are invalid.

401 Response

Unauthorized. The bearer token is missing or invalid.

500 Response

An unexpected internal server error occurred.

Body ()

Root Schema : schema

Type: object

Show Source

• errorCode(required): integer (int32)
  Document IO error code that identifies the type of processing failure.

  Example: 4134
• errorDescription(required): string
  A brief description of an error.

  Example: An unexpected error occurred. Please contact support.

{
    "type":"object",
    "required":[
        "errorCode",
        "errorDescription"
    ],
    "properties":{
        "errorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Document IO error code that identifies the type of processing failure.",
            "example":4134
        },
        "errorDescription":{
            "type":"string",
            "description":"A brief description of an error.",
            "example":"An unexpected error occurred. Please contact support."
        }
    }
}

Back to Top

Examples

The following example shows how to upload a supplier invoice file to Document IO by submitting a POST request on the REST resource using cURL.

curl --location 'https://servername.fa.us2.oraclecloud.com/api/erp/integrations/resources/v1/payables/paymentRequest/files/import' \
--header 'Authorization: Bearer <Bearer Token>' \
--form 'file=@<FILEPATH>' \
--form 'payload=<METADATA>' \
--form 'flowCode=<@<FILEPATH>>'

Response Body Example

The following shows an example of the response body in JSON format.

{
  "status": "SUCCESS",
  "message": "Request successfully received.",
  "requestId": "300100655871592",
  "links": [
    {
      "rel": "collection",
      "href": "https://servername.fa.us2.oraclecloud.com/api/erp/integrations/resources/v1/payables/paymentRequest/requests/300100655871592",
      "resourcePath": "/requests/300100655871592"
    }
  ]
}

Back to Top