Get all transactions
get
/fscmRestApi/resources/11.13.18.05/spendClassificationBatchTransactions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- BatchTransactionFinder: Finds transactions according to the specified business unit , and transaction number.
Finder Variables:- bindBusinessUnit; string.
- bindTransactionNumber; string.
- PrimaryKey: Finds transactions according to the specified primary key criteria.
Finder Variables:- TransactionId; integer; Value that uniquely identifies the transaction.
- BatchTransactionFinder: Finds transactions according to the specified business unit , and transaction number.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdditionalDescription; string; Additional description of a line in the transaction.
- AppliedRules; string; Names of the rules that have been used to normalize the data set transactions or override the category prediction.
- BatchId; integer; Value that uniquely identifies the batch.
- BusinessUnit; string; Name of the business unit.
- ClassificationAttribute1; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute10; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute11; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute12; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute13; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute14; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute15; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute16; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute17; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute18; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute19; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute2; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute20; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute3; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute4; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute5; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute6; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute7; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute8; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationAttribute9; string; Additional attribute mapped during spend classification configuration to influence classification results.
- ClassificationStatus; string; Status used to group transactions based on the classification confidence returned during the classification process.
- ConfidencePercentage; number; Percentage that determines the certainty of category prediction.
- CostCenter; string; Value that identifies the cost center used on the transaction.
- DataSetName; string; Name of the data set.
- DataSourceTransactionId; number; Value that uniquely identifies the nature of transaction in the source application.
- ExistingCategoryCode; string; Abbreviation that uniquely identifies the existing category.
- ExistingCategoryCodeValue; string; Value that uniquely identifies the existing category.
- Item; string; Value that uniquely identifies the item.
- ItemDescription; string; Description of the item.
- LineAmount; number; Amount of the transaction.
- LineDescription; string; Description of the line in a transaction.
- LineNumber; string; Number that identifies the line in a transaction.
- ManualCategoryCode; string; Abbreviation that uniquely identifies the manually classified category.
- ManualCategoryCodeValue; string; Value that uniquely identifies the manually classified category.
- PredictedCategoryCode; string; Abbreviation that uniquely identifies the predicted category.
- PredictedCategoryCodeValue; string; Value that uniquely identifies the predicted category.
- SourceTransactionId; string; Value that uniquely identifies the transaction in the source application.
- SupplierName; string; Name of the supplier.
- SupplierSite; string; Name of the supplier site.
- TaxonomyId; integer; Value that uniquely identifies the taxonomy.
- TransactionDescription; string; Description of the transaction.
- TransactionId; integer; Value that uniquely identifies the transaction.
- TransactionNumber; string; Number that identifies the transaction in the application.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : spendClassificationBatchTransactions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : spendClassificationBatchTransactions-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.