REST API for Oracle Fusion Cloud Procurement

Update a batch

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Request

Path Parameters

BatchNumber(required): integer(int64)

Number that uniquely identifies the batch.

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

BatchFileContent: string

Value that contains the transaction details in a batch.
CategoryId: string

Value that uniquely identifies the category.
ClassificationCompletionPercentage: number

Percentage indicating the batch's classification progress.
ClassificationStep: string

Maximum Length: 30

Name of different steps within the classification process.
CorrectionsDataSet: string

Name of the data set created using manually classified transactions.
DataSet: string

Maximum Length: 2000

Abbreviation that identifies the data set.
OperationName: string

Name of the operation performed on a batch.
TransactionId: string

Value that uniquely identifies the transaction.
TransactionsEndDate: string (date-time)

Maximum transaction date available in the transactions within a batch.
TransactionsStartDate: string (date-time)

Minimum transaction date available in the transactions within a batch.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"string",
            "description":"Value that uniquely identifies the category.",
            "nullable":true
        },
        "BatchFileContent":{
            "type":"string",
            "description":"Value that contains the transaction details in a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsEndDate":{
            "type":"string",
            "description":"Maximum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Name of the operation performed on a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSet":{
            "maxLength":"2000",
            "type":"string",
            "description":"Abbreviation that identifies the data set.",
            "nullable":true
        },
        "CorrectionsDataSet":{
            "type":"string",
            "description":"Name of the data set created using manually classified transactions.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionId":{
            "type":"string",
            "description":"Value that uniquely identifies the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsStartDate":{
            "type":"string",
            "description":"Minimum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true
        },
        "ClassificationStep":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of different steps within the classification process.",
            "nullable":true
        },
        "ClassificationCompletionPercentage":{
            "type":"number",
            "description":"Percentage indicating the batch's classification progress.",
            "nullable":true
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : spendClassificationBatches-item-response

Type: object

Show Source

BatchFileContent: string

Value that contains the transaction details in a batch.
BatchName: string

Read Only: true

Maximum Length: 255

Name of the batch.
BatchNumber: integer (int64)

Read Only: true

Number that uniquely identifies the batch.
CategoryId: string

Value that uniquely identifies the category.
ClassificationCompletedOn: string (date-time)

Read Only: true

Date and time when the classification process completed for the batch.
ClassificationCompletionPercentage: number

Percentage indicating the batch's classification progress.
ClassificationInitiatedOn: string (date-time)

Read Only: true

Date and time when the classification process started for the batch.
ClassificationStep: string

Maximum Length: 30

Name of different steps within the classification process.
CorrectionsDataSet: string

Name of the data set created using manually classified transactions.
CurrencyCode: string

Read Only: true

Maximum Length: 15

Abbreviation that identifies the currency for the transaction amount in a batch.
DataSet: string

Maximum Length: 2000

Abbreviation that identifies the data set.
DataSetName: string

Read Only: true

Maximum Length: 255

Name of the data set.
KnowledgeBase: string

Read Only: true

Maximum Length: 30

Pattern or knowledge within the data set.
links: array Links

Title: Links

The link relations associated with the resource instance.
NumberOfTransactions: number

Read Only: true

Count of the number of transactions in a batch.
OperationName: string

Name of the operation performed on a batch.
Status: string

Read Only: true

Maximum Length: 80

Status of the batch.
StatusCode: string

Read Only: true

Maximum Length: 20

Abbreviation that identifies the status of a batch.
TaxonomyCode: string

Read Only: true

Maximum Length: 90

Abbreviation that identifies the taxonomy.
TaxonomyName: string

Read Only: true

Maximum Length: 80

Name of the taxonomy.
TotalSpendAmount: number

Read Only: true

Total of all the transaction amounts in a batch.
TransactionId: string

Value that uniquely identifies the transaction.
TransactionsEndDate: string (date-time)

Maximum transaction date available in the transactions within a batch.
TransactionsStartDate: string (date-time)

Minimum transaction date available in the transactions within a batch.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"string",
            "description":"Value that uniquely identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchFileContent":{
            "type":"string",
            "description":"Value that contains the transaction details in a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "BatchNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Name of the operation performed on a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSet":{
            "maxLength":"2000",
            "type":"string",
            "description":"Abbreviation that identifies the data set.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfTransactions":{
            "type":"number",
            "description":"Count of the number of transactions in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the status of a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"string",
            "description":"Value that uniquely identifies the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsStartDate":{
            "type":"string",
            "description":"Minimum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCompletionPercentage":{
            "type":"number",
            "description":"Percentage indicating the batch's classification progress.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency for the transaction amount in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionsEndDate":{
            "type":"string",
            "description":"Maximum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "KnowledgeBase":{
            "maxLength":"30",
            "type":"string",
            "description":"Pattern or knowledge within the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyCode":{
            "maxLength":"90",
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassificationInitiatedOn":{
            "type":"string",
            "description":"Date and time when the classification process started for the batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationCompletedOn":{
            "type":"string",
            "description":"Date and time when the classification process completed for the batch.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalSpendAmount":{
            "type":"number",
            "description":"Total of all the transaction amounts in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectionsDataSet":{
            "type":"string",
            "description":"Name of the data set created using manually classified transactions.",
            "nullable":true,
            "x-queryable":false
        },
        "ClassificationStep":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of different steps within the classification process.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

Reset a Batch

This example describes how to reset a batch.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Example Request Body

The following example includes the contents of the request body in JSON format.

{"OperationName":"RESET"}

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

Approve a Batch

This example describes how to approve a batch.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Example Request Body

The following example includes the contents of the request body in JSON format.

{"OperationName":"APPROVE"}

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

Classify an Existing Batch

This example describes how to classify an existing batch.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Example Request Body

The following example includes the contents of the request body in JSON format.

{"OperationName":"RECLASSIFY"}

Example Response Body

The following example includes the contents of the response body in JSON format.

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

Create a Training Set Using Maually Updated Transaction Records

This example describes how to create a training set using maually updated transaction records.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Example Request Body

The following example includes the contents of the request body in JSON format.

"{
 ""CorrectionsDataSet"": ""Q1manualCorr""
 ""OperationName"":""CREATETRAININGSET""
}"

Example Response Body

The following example includes the contents of the response body in JSON format.

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

Correct Transaction Records

This example describes how to manually correct transaction records.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

Example Request Body

The following example includes the contents of the request body in JSON format.

"{
 ""TransactionId"":""166091,166092"",
 ""CategoryId"":""8000006,8000008"",
 ""OperationName"":""MANUALCORRECTION""
}"

Example Response Body

The following example includes the contents of the response body in JSON format.

"{
  ""BatchNumber"" : 9010,
  ""StatusCode"" : ""ORA_POI_COMPLETED"",
  ""Status"" : ""Complete"",
  ""BatchName"" : ""BATCHAUTOTESTE2E"",
  ""KnowledgeBase"" : ""DATASETAUTOKNWBASEE2E"",
  ""TaxonomyCode"" : ""ORA_POI_CUSTOM3"",
  ""TaxonomyName"" : ""Custom taxonomy 3"",
  ""ClassificationInitiatedOn"" : ""2021-05-17T15:35:41+00:00"",
  ""ClassificationCompletedOn"" : ""2021-05-17T15:36:22+00:00"",
  ""NumberOfTransactions"" : 50,
  ""TotalSpendAmount"" : 174041.823,
  ""CurrencyCode"" : ""USD"",
  ""OperationName"" : null,
  ""DataSetName"" : ""DATASETCLASIFYAUTOE2E"",
  ""CorrectionsDataSet"" : null,
  ""BatchFileContent"" : null,
  ""TransactionId"" : ""166091,166092"",
  ""CategoryId"" : ""8000006,8000008"",
  ""@context"" : {
  ...
  }
}"