Jump to

• Request
• Response

Update one transaction

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationBatchTransactions/{TransactionId}

Request

Path Parameters

• TransactionId(required): integer(int64)
  Value that uniquely identifies the transaction.

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : spendClassificationBatchTransactions-item-response

Type: object

Show Source

• AdditionalDescription: string
  Read Only: true

  Maximum Length: 255

  Additional description of a line in the transaction.
• AppliedRules: string
  Read Only: true

  Maximum Length: 4000

  Names of the rules that have been used to normalize the data set transactions or override the category prediction.
• BatchId: integer (int64)
  Read Only: true

  Value that uniquely identifies the batch.
• BusinessUnit: string
  Read Only: true

  Maximum Length: 200

  Name of the business unit.
• ClassificationAttribute1: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute10: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute11: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute12: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute13: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute14: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute15: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute16: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute17: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute18: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute19: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute2: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute20: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute3: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute4: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute5: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute6: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute7: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute8: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationAttribute9: string
  Read Only: true

  Maximum Length: 4000

  Additional attribute mapped during spend classification configuration to influence classification results.
• ClassificationStatus: string
  Read Only: true

  Maximum Length: 80

  Status used to group transactions based on the classification confidence returned during the classification process.
• ConfidencePercentage: number
  Read Only: true

  Percentage that determines the certainty of category prediction.
• CostCenter: string
  Read Only: true

  Maximum Length: 320

  Value that identifies the cost center used on the transaction.
• DataSetName: string
  Read Only: true

  Maximum Length: 80

  Name of the data set.
• DataSourceTransactionId: number
  Read Only: true

  Value that uniquely identifies the nature of transaction in the source application.
• ExistingCategoryCode: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that uniquely identifies the existing category.
• ExistingCategoryCodeValue: string
  Read Only: true

  Maximum Length: 2000

  Value that uniquely identifies the existing category.
• Item: string
  Read Only: true

  Maximum Length: 100

  Value that uniquely identifies the item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the item.
• LineAmount: number
  Read Only: true

  Amount of the transaction.
• LineDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the line in a transaction.
• LineNumber: string
  Read Only: true

  Number that identifies the line in a transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualCategoryCode: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that uniquely identifies the manually classified category.
• ManualCategoryCodeValue: string
  Read Only: true

  Maximum Length: 2000

  Value that uniquely identifies the manually classified category.
• PredictedCategoryCode: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that uniquely identifies the predicted category.
• PredictedCategoryCodeValue: string
  Read Only: true

  Maximum Length: 2000

  Value that uniquely identifies the predicted category.
• SourceTransactionId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the transaction in the source application.
• SupplierName: string
  Read Only: true

  Maximum Length: 300

  Name of the supplier.
• SupplierSite: string
  Read Only: true

  Maximum Length: 100

  Name of the supplier site.
• TaxonomyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the taxonomy.
• TransactionDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the transaction.
• TransactionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transaction.
• TransactionNumber: string
  Read Only: true

  Maximum Length: 320

  Number that identifies the transaction in the application.

{
    "type":"object",
    "properties":{
        "AdditionalDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Additional description of a line in the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedRules":{
            "maxLength":4000,
            "type":"string",
            "description":"Names of the rules that have been used to normalize the data set transactions or override the category prediction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the batch.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":200,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute1":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute10":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute11":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute12":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute13":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute14":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute15":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute16":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute17":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute18":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute19":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute2":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute20":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute3":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute4":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute5":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute6":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute7":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute8":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationAttribute9":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional attribute mapped during spend classification configuration to influence classification results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status used to group transactions based on the classification confidence returned during the classification process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfidencePercentage":{
            "type":"number",
            "description":"Percentage that determines the certainty of category prediction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":7,
                "scale":3
            },
            "x-queryable":true
        },
        "CostCenter":{
            "maxLength":320,
            "type":"string",
            "description":"Value that identifies the cost center used on the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceTransactionId":{
            "type":"number",
            "description":"Value that uniquely identifies the nature of transaction in the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingCategoryCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the existing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingCategoryCodeValue":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that uniquely identifies the existing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineAmount":{
            "type":"number",
            "description":"Amount of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the line in a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"string",
            "description":"Number that identifies the line in a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualCategoryCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the manually classified category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualCategoryCodeValue":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that uniquely identifies the manually classified category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PredictedCategoryCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the predicted category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PredictedCategoryCodeValue":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that uniquely identifies the predicted category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the taxonomy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":320,
            "type":"string",
            "description":"Number that identifies the transaction in the application.",
            "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"
            }
        }
    }
}

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."
        }
    }
}

Back to Top