Create transactions
/fscmRestApi/resources/11.13.18.05/cycleCountTransactions
Request
-
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.
- application/json
object
-
countLines: array
Count Lines
Title:
Count Lines
The Count Lines resource manages transaction details for the count sequence. -
ErrorCode: string
Contains a value or is empty. Value: name of the error message from the request. Empty: the request was successful.
-
ErrorExplanation: string
Contains a value or is empty. Value: error message from the request. Empty: the request was successful.
-
ErrorUniqueTransactionId: string
Contains a value or is empty. Value: uniquely identifies the transaction of the failed record. Empty: the request was successful.
-
ReturnStatus: string
Indicates whether the warehouse successfully completed the request.
array
Count Lines
object
-
Comments: string
Maximum Length:
240
Comments that describe the count request. If the transaction requires an adjustment, then the warehouse adds these comments to the reference on the adjustment transaction. -
ConsignmentAgreementNumber: string
Maximum Length:
30
Consignment agreement number for the consigned item. -
CountDate: string
(date)
Date when the warehouse counted the count request. If this date is empty, then the warehouse uses the current date for the count date. If necessary, it also uses this date as the transaction date and the approval date for the adjustment transaction.
-
CountedByEmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the count.
-
CountedByEmployeeName: string
Maximum Length:
240
Name of employee who performed the count. -
countLinesDFF: array
Flexfields for Count Lines
Title:
Flexfields for Count Lines
The Flexfields for Count Lines resource manages details of the descriptive flexfields that reference the count lines. -
CountName: string
Maximum Length:
30
Name of the cycle count. -
CountQuantity: number
Quantity counted for this count request.
-
CountSequence: integer
(int64)
Sequence that identifies an open count request for the cycle count. If the warehouse finds an open count request for the count sequence, then it runs the transaction for this count request. If the warehouse does not find an open count request for the count sequence, then it treats the transaction as an unscheduled count.
-
CountUnitOfMeasure: string
Maximum Length:
25
Unit of measure that the count quantity uses. -
CountUOM: string
Maximum Length:
3
Contains a value or is empty. Value: serial number. Empty: serials do not control the item. -
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count sequence.
-
CycleCountHeaderId: integer
(int64)
Value that uniquely identifies the cycle count.
-
inventoryAttributesDFF: array
Flexfields for Tracking Attributes
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the count lines. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
Item: string
Maximum Length:
300
Name of the inventory item. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Maximum Length:
2000
Name of the locator. -
Lot: string
Maximum Length:
80
Contains a value or is empty. Value: lot number. Empty: lots do not control the item. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OwningEntityCode: string
Maximum Length:
240
Abbreviation that identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the organization identifier. -
OwningEntityId: integer
(int64)
Value that uniquely identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the organization identifier.
-
OwningType: string
Maximum Length:
30
Contains 1 or 2. 1: the item is consigned. 2: the item is consigned owned. -
ProcurementBU: string
Maximum Length:
240
Name of the procurement business unit for the consigned item. -
Reason: string
Maximum Length:
30
Reason for the count request. If the transaction requires an adjustment, then the warehouse adds this reason to the reference on the adjustment transaction. -
Revision: string
Maximum Length:
18
Contains a value or is empty. Value: revision of the item. Empty: revisions do not control the item. -
SecondaryCountQuantity: number
Quantity counted for this count request in the secondary unit of measure.
-
SecondaryUnitOfMeasure: string
Maximum Length:
25
Secondary unit of measure that the count quantity uses. -
SecondaryUOM: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that the count quantity uses. -
SerialNumber: string
Maximum Length:
80
Contains a value or is empty. Value: serial number. Empty: serials do not control the item. -
Subinventory: string
Maximum Length:
10
Name of the subinventory. -
TransactionReasonId: integer
(int64)
Value that uniquely identifies the transaction reason.
-
UniqueTransactionId: integer
(int64)
Value that uniquely identifies the input count transaction. The system creates this value so the requestor does not need to provide it.
-
VendorName: string
Maximum Length:
240
Name of the vendor for the consigned item. -
VendorNumber: string
Maximum Length:
30
Vendor number for the consigned item.
array
Flexfields for Count Lines
array
Flexfields for Tracking Attributes
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for the count line. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for the count line. -
CcEntryInterfaceId: integer
(int64)
Value that uniquely identifies the count sequence for the interface record.
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for tracking attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for tracking attributes. -
CcEntryInterfaceId: integer
(int64)
Value that uniquely identifies the count sequence for the interface record.
-
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country. This attribute is associated with a feature that requires opt in. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Value that identifies the project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
Response
- application/json
Default Response
-
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.
object
-
countLines: array
Count Lines
Title:
Count Lines
The Count Lines resource manages transaction details for the count sequence. -
ErrorCode: string
Contains a value or is empty. Value: name of the error message from the request. Empty: the request was successful.
-
ErrorExplanation: string
Contains a value or is empty. Value: error message from the request. Empty: the request was successful.
-
ErrorUniqueTransactionId: string
Contains a value or is empty. Value: uniquely identifies the transaction of the failed record. Empty: the request was successful.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnStatus: string
Indicates whether the warehouse successfully completed the request.
array
Count Lines
array
Links
object
-
Comments: string
Maximum Length:
240
Comments that describe the count request. If the transaction requires an adjustment, then the warehouse adds these comments to the reference on the adjustment transaction. -
ConsignmentAgreementNumber: string
Maximum Length:
30
Consignment agreement number for the consigned item. -
CountDate: string
(date)
Date when the warehouse counted the count request. If this date is empty, then the warehouse uses the current date for the count date. If necessary, it also uses this date as the transaction date and the approval date for the adjustment transaction.
-
CountedByEmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the count.
-
CountedByEmployeeName: string
Maximum Length:
240
Name of employee who performed the count. -
countLinesDFF: array
Flexfields for Count Lines
Title:
Flexfields for Count Lines
The Flexfields for Count Lines resource manages details of the descriptive flexfields that reference the count lines. -
CountName: string
Maximum Length:
30
Name of the cycle count. -
CountQuantity: number
Quantity counted for this count request.
-
CountSequence: integer
(int64)
Sequence that identifies an open count request for the cycle count. If the warehouse finds an open count request for the count sequence, then it runs the transaction for this count request. If the warehouse does not find an open count request for the count sequence, then it treats the transaction as an unscheduled count.
-
CountUnitOfMeasure: string
Maximum Length:
25
Unit of measure that the count quantity uses. -
CountUOM: string
Maximum Length:
3
Contains a value or is empty. Value: serial number. Empty: serials do not control the item. -
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count sequence.
-
CycleCountHeaderId: integer
(int64)
Value that uniquely identifies the cycle count.
-
inventoryAttributesDFF: array
Flexfields for Tracking Attributes
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the count lines. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
Item: string
Maximum Length:
300
Name of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Maximum Length:
2000
Name of the locator. -
Lot: string
Maximum Length:
80
Contains a value or is empty. Value: lot number. Empty: lots do not control the item. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OwningEntityCode: string
Maximum Length:
240
Abbreviation that identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the organization identifier. -
OwningEntityId: integer
(int64)
Value that uniquely identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the organization identifier.
-
OwningType: string
Maximum Length:
30
Contains 1 or 2. 1: the item is consigned. 2: the item is consigned owned. -
ProcurementBU: string
Maximum Length:
240
Name of the procurement business unit for the consigned item. -
Reason: string
Maximum Length:
30
Reason for the count request. If the transaction requires an adjustment, then the warehouse adds this reason to the reference on the adjustment transaction. -
Revision: string
Maximum Length:
18
Contains a value or is empty. Value: revision of the item. Empty: revisions do not control the item. -
SecondaryCountQuantity: number
Quantity counted for this count request in the secondary unit of measure.
-
SecondaryUnitOfMeasure: string
Maximum Length:
25
Secondary unit of measure that the count quantity uses. -
SecondaryUOM: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that the count quantity uses. -
SerialNumber: string
Maximum Length:
80
Contains a value or is empty. Value: serial number. Empty: serials do not control the item. -
Subinventory: string
Maximum Length:
10
Name of the subinventory. -
TransactionReasonId: integer
(int64)
Value that uniquely identifies the transaction reason.
-
UniqueTransactionId: integer
(int64)
Value that uniquely identifies the input count transaction. The system creates this value so the requestor does not need to provide it.
-
VendorName: string
Maximum Length:
240
Name of the vendor for the consigned item. -
VendorNumber: string
Maximum Length:
30
Vendor number for the consigned item.
array
Flexfields for Count Lines
array
Flexfields for Tracking Attributes
array
Links
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for the count line. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for the count line. -
CcEntryInterfaceId: integer
(int64)
Value that uniquely identifies the count sequence for the interface record.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for tracking attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for tracking attributes. -
CcEntryInterfaceId: integer
(int64)
Value that uniquely identifies the count sequence for the interface record.
-
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Value that identifies the project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
array
Links
- countLines
-
Parameters:
- cycleCountTransactionsUniqID:
$request.path.cycleCountTransactionsUniqID
The Count Lines resource manages transaction details for the count sequence. - cycleCountTransactionsUniqID:
Examples
This example describes how to process cycle count transactions.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example processes cycle count transactions for item CYC01-100, that occur on 2011-07-14, in subinventory FGI, in organization M1, counted by employee 57, for cycle count CC-RRF:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/cycleCountTransactions"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "countLines": [ { "OrganizationCode": "M1", "CountName": "CC-RRF", "Item": "CYC01-100", "CountQuantity" : 510, "CountUnitOfMeasure": "Each", "CountDate": "2011-07-14", "CountedByEmployeeId" : 57, "Subinventory": "FGI" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ReturnStatus" : "SUCCESS", "ErrorCode" : null, "ErrorExplanation" : null, "ErrorUniqueTransactionId" : "0", "countLines" : [ { "UniqueTransactionId" : 300100090015943, "OrganizationId" : null, "OrganizationCode" : "M1", "CycleCountHeaderId" : null, "CountName" : "CC-RRF", "CycleCountEntryId" : null, "CountSequence" : null, "InventoryItemId" : null, "Item" : "CYC01-100", "Revision" : null, "Subinventory" : "FGI", "LocatorId" : null, "Lot" : null, "SerialNumber" : null, "CountUOM" : null, "CountUnitOfMeasure" : "Each", "CountQuantity" : 510, "CountDate" : "2011-07-14", "SecondaryCountQuantity" : null, "SecondaryUnitOfMeasure" : null, "SecondaryUOM" : null, "CountedByEmployeeName" : null, "CountedByEmployeeId" : 57, "Comments" : null, "Reason" : null, "TransactionReasonId" : null, "OwningType" : null, "OwningEntityId" : null, "OwningEntityCode" : null, "ProcurementBU" : null, "VendorName" : null, "VendorNumber" : null, "ConsignmentAgreementNumber" : null, "LocatorName" : null } ] }