Get all contract asset transactions
get
/fscmRestApi/resources/11.13.18.05/contractAssetTransactions
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:- ContractAssetTxnByExecSeqId: Finds the contract asset transaction with the specified transaction execution sequence identifier.
Finder Variables:- TransactionExecSequenceId; integer; The unique identifier of the transaction execution sequence.
- PrimaryKey: Finds the contract asset transaction with the specified transaction identifier.
Finder Variables:- Id; integer; The unique identifier of the transaction.
- ContractAssetTxnByExecSeqId: Finds the contract asset transaction with the specified transaction execution sequence identifier.
-
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:- AssetBillToAccountId; integer; The unique identifier of the asset bill.
- AssetBillToAccountSiteId; integer; The unique identifier of the bill to account site.
- AssetBillToActSiteUseId; integer; The unique identifier of the bill to account site use.
- AssetId; integer; The unique identifier of the asset.
- AssetPriorQuantity; number; The asset prior quantity.
- AssetQuantity; number; The quantity of the asset.
- AssetReplacedById; integer; The unique identifier of the asset replaced.
- AssetReplacementPhase; string; The phase of the asset replacement.
- AssetReplacementProcess; string; The process of the asset replacement.
- AssetReturnDate; string; The return date of the asset.
- AssetReturnOrderId; integer; The unique identifier of the asset return order.
- AssetReturnOrderLineId; integer; The unique identifier of the return order line.
- AssetReturnOrderLineNumber; string; The asset return order line number.
- AssetReturnOrderNumber; string; The asset return order number.
- AssetSalesOrderId; integer; The unique identifier of the sales order.
- AssetSalesOrderLineId; integer; The unique identifier of the sales order line.
- AssetSalesOrderLineNumber; string; The sales order line number.
- AssetSalesOrderNumber; string; The sales order number.
- AssetSalesOrderSystem; string; The sales order system.
- AssetShipDate; string; The date when the asset is shipped.
- AssetShipToPartyId; integer; The unique identifier of the party to whom the asset it shipped.
- AssetShipToPartySiteId; integer; The unique identifier of the party site to which the asset is shipped.
- AssetSoldByBUId; integer; The unique identifier of the asset sold by BU.
- AssetSoldToPartyId; integer; The unique identifier of the party to whom the asset is sold.
- AssetTransactionEventCode; string; The transaction event code.
- AssetTransactionEventDate; string; The date of the transaction event.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- Id; integer; The unique identifier of the transaction.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- TransactionExecSequenceId; integer; The unique identifier of the transaction execution sequence.
- TransactionProcessPhase; string; The transaction process phase.
-
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 : contractAssetTransactions
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 : contractAssetTransactions-item-response
Type:
Show Source
object
-
AssetBillToAccountId: integer
(int64)
The unique identifier of the asset bill.
-
AssetBillToAccountSiteId: integer
(int64)
The unique identifier of the bill to account site.
-
AssetBillToActSiteUseId: integer
(int64)
The unique identifier of the bill to account site use.
-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetPriorQuantity: number
The asset prior quantity.
-
AssetQuantity: number
The quantity of the asset.
-
AssetReplacedById: integer
(int64)
The unique identifier of the asset replaced.
-
AssetReplacementPhase: string
Maximum Length:
30
The phase of the asset replacement. -
AssetReplacementProcess: string
Maximum Length:
30
The process of the asset replacement. -
AssetReturnDate: string
(date)
The return date of the asset.
-
AssetReturnOrderId: integer
(int64)
The unique identifier of the asset return order.
-
AssetReturnOrderLineId: integer
(int64)
The unique identifier of the return order line.
-
AssetReturnOrderLineNumber: string
Maximum Length:
120
The asset return order line number. -
AssetReturnOrderNumber: string
Maximum Length:
120
The asset return order number. -
AssetSalesOrderId: integer
(int64)
The unique identifier of the sales order.
-
AssetSalesOrderLineId: integer
(int64)
The unique identifier of the sales order line.
-
AssetSalesOrderLineNumber: string
Maximum Length:
120
The sales order line number. -
AssetSalesOrderNumber: string
Maximum Length:
120
The sales order number. -
AssetSalesOrderSystem: string
Maximum Length:
30
The sales order system. -
AssetShipDate: string
(date)
The date when the asset is shipped.
-
AssetShipToPartyId: integer
(int64)
The unique identifier of the party to whom the asset it shipped.
-
AssetShipToPartySiteId: integer
(int64)
The unique identifier of the party site to which the asset is shipped.
-
AssetSoldByBUId: integer
(int64)
The unique identifier of the asset sold by BU.
-
AssetSoldToPartyId: integer
(int64)
The unique identifier of the party to whom the asset is sold.
-
AssetTransactionEventCode: string
Maximum Length:
60
The transaction event code. -
AssetTransactionEventDate: string
(date)
The date of the transaction event.
-
ContractAssetTransactionDetail: array
Contract Asset Transaction Details
Title:
Contract Asset Transaction Details
The contract asset transaction details resource is used to view and create the asset transaction details. The contract asset transaction detail object has details such as customer asset, quantity etc. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Id: integer
(int64)
The unique identifier of the transaction.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionExecSequenceId: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the transaction execution sequence. -
TransactionProcessPhase: string
Read Only:
true
Maximum Length:9
The transaction process phase.
Nested Schema : Contract Asset Transaction Details
Type:
array
Title:
Contract Asset Transaction Details
The contract asset transaction details resource is used to view and create the asset transaction details. The contract asset transaction detail object has details such as customer asset, quantity etc.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contractAssetTransactions-ContractAssetTransactionDetail-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetQuantity: number
The quantity of the asset.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Id: integer
(int64)
The unique identifier of the transaction detail.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number.
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.