Create a contract asset transaction
post
/fscmRestApi/resources/11.13.18.05/contractAssetTransactions
Request
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:
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(required): 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(required): 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. -
Id: integer
(int64)
The unique identifier of the transaction.
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 : contractAssetTransactions-ContractAssetTransactionDetail-item-post-request
Type:
Show Source
object
-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetQuantity: number
The quantity of the asset.
-
Id: integer
(int64)
The unique identifier of the transaction detail.
-
ObjectVersionNumber: integer
(int32)
The object version number.
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 : 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.
Links
- ContractAssetTransactionDetail
-
Parameters:
- TransactionExecSequenceId:
$request.path.TransactionExecSequenceId
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. - TransactionExecSequenceId: