Jump to

• Request
• Response
• Examples

Get one definition

get

/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}

Request

Path Parameters

• CycleCountHeaderId(required): integer(int64)
  Value that uniquely identifies the cycle count definition.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 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 : cycleCountDefinitions-item-response

Type: object

Show Source

• AbcAssigmentGroup: string
  Maximum Length: 40

  Name of the ABC group that the warehouse uses to initialize the item classification in the cycle count.
• AbcAssignmentGroupId: integer (int64)
  Title: ABC Assignment Group

  Value that uniquely identifies the ABC group that the warehouse uses to initialize the item classification.
• ApprovalRequired: string
  Maximum Length: 80

  Value that determines whether or not the warehouse requires approval. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• ApprovalRequiredCode: integer (int64)
  Title: Approval required

  Value that indicates whether or not the warehouse requires approval.
• ApprovalType: string
  Maximum Length: 80

  Type of approval that the warehouse requires for an adjustment transaction. A list of accepted values is defined in the lookup type INV_APPROVAL_REQ.
• ApprovalTypeCode: string
  Title: Approval Type

  Maximum Length: 30

  Value that determines the type of approval that the warehouse requires for adjustment transactions. A list of accepted values is defined in the lookup type INV_APPROVAL_REQ.
• AutomaticallySchedule: string
  Maximum Length: 80

  Value that determines whether or not the warehouse schedules the counts. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• AutomaticallyScheduleCode: integer (int64)
  Title: Automatically schedule

  Value that indicates whether or not the warehouse schedules the counts. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• CategorySynchronizationMode: string
  Mode of item category synchronization. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.
• CategorySynchronizationModeCode: string
  Abbreviation that identifies the item category synchronization mode. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.
• CountByCategoryFlag: boolean
  Title: Enable cycle count by item category

  Contains one of the following values: true or false. If true, then enable the cycle count by item category. If false, then do not enable the cycle count by item category. The default value is false.
• countCategories: array Categories
  Title: Categories

  The Categories resource manages the item categories that the warehouse can use in the cycle count.
• countCategoryItems: array Category Items
  Title: Category Items

  The Category Items resource manages the category items that the warehouse can use in the cycle count.
• countClasses: array Classes
  Title: Classes

  The Classes resource manages the count classes that the warehouse can use in the cycle count.
• countItems: array Items
  Title: Items

  The Items resource manages the items that the warehouse can use in the cycle count.
• countSubinventories: array Subinventories
  Title: Subinventories

  The Subinventories resource manages the subinventories that the warehouse can use with the cycle count.
• CountZeroQuantity: string
  Maximum Length: 80

  Value that determines whether the warehouse schedules a cycle count for an item when the on-hand quantity is zero. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• CountZeroQuantityCode: integer (int64)
  Title: Count Zero Quantity

  Value that indicates whether the warehouse schedules a cycle count for an item when the on-hand quantity is zero. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• CycleCountHeaderId: integer (int64)
  Value that uniquely identifies the cycle count definition.
• CycleCountName: string
  Title: Count Name

  Maximum Length: 30

  Name of the cycle count.
• DeleteAdditionalCategoryItemsFlag: boolean
  Contains one of the following values: true or false. If true, then delete the additional items during item category synchronization. If false, then do not delete the additional items during item category synchronization. This attribute does not have a default value.
• DeleteAdditionalItemsFlag: boolean
  Contains one of the following values: true or false. If true, then delete the additional items during ABC synchronization. If false, then do not delete the additional items during ABC synchronization. This attribute does not have a default value.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the cycle count.
• DFF: array Flexfields for Cycle Count Definitions
  Title: Flexfields for Cycle Count Definitions

  The Flexfields for Cycle Count Definitions resource manages the details about cycle counts.
• DisplaySuggestedQuantity: string
  Maximum Length: 80

  Value that determines whether or not to display the on-hand quantity for the cycle count sequence. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• DisplaySuggestedQuantityCode: integer (int64)
  Title: Display suggested quantity

  Value that indicates whether or not to display the on-hand quantity for the cycle count sequence. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• EndDate: string (date)
  Title: End Date

  Date when this cycle count becomes inactive.
• Frequency: string
  Maximum Length: 80

  Value that determines the time interval to use between two consecutive scheduling runs for a cycle count. A list of accepted values is defined in the lookup type INV_CC_SCHED_TIME.
• FrequencyCode: string
  Title: Frequency

  Maximum Length: 30

  Value that indicates the time interval to use between two consecutive scheduling runs for a cycle count. A list of accepted values is defined in the lookup type INV_CC_SCHED_TIME.
• IncludedSubinventoriesCount: integer
  Read Only: true

  Number of subinventories included in the cycle count.
• LastScheduledDate: string (date)
  Title: Last Scheduled Date

  Date when the last cycle count was scheduled to run by the warehouse.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualCountsAllowed: string
  Maximum Length: 80

  Value that determines whether or not the warehouse can use this cycle count to enter an unscheduled count. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• ManualCountsAllowedCode: integer (int64)
  Value that indicates whether or not the warehouse can use this cycle count to enter an unscheduled count. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• ManualCountSequencePrefix: string
  Title: Manual Count Sequence Prefix

  Maximum Length: 3

  Prefix for a manual count sequence.
• MaximumDaysBeforeLate: integer (int64)
  Title: Maximum Days Before Late

  Number of days after creation before the warehouse considers a scheduled count as late.
• MaximumRecounts: integer (int64)
  Title: Maximum Recounts

  Maximum number of recounts that the warehouse uses on a cycle count.
• NegativeAdjustmentTolerance: number
  Title: Negative Adjustment Value Tolerance

  Negative currency tolerance. If the currency falls below this tolerance, then the warehouse requires approval for the adjustment transaction.
• NegativeHitMissPercentage: number
  Title: Negative Hit and Miss Percentage

  Negative percent tolerance that the warehouse uses for hit or miss analysis.
• NegativeTolerancePercentage: number
  Title: Negative Quantity Tolerance Percentage

  Negative percent tolerance. If the adjustment falls below this tolerance, then the warehouse requires approval for the adjustment transaction.
• NextScheduledDate: string (date)
  Title: Next Scheduled Date

  Date when the next cycle count is scheduled to run by the warehouse.
• OrganizationCode: string
  Maximum Length: 18

  Value that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the inventory organization.
• PositiveAdjustmentTolerance: number
  Title: Positive Adjustment Value Tolerance

  Positive currency tolerance. If the currency exceeds this tolerance, then the warehouse requires approval for the adjustment transaction.
• PositiveHitMissPercentage: number
  Positive percent tolerance that the warehouse uses for hit or miss analysis.
• PositiveTolerancePercentage: number
  Title: Positive Quantity Tolerance Percentage

  Positive percent tolerance. If the adjustment exceeds this tolerance, then the warehouse requires approval for the adjustment transaction.
• RecordCountSerials: string
  Maximum Length: 80

  Value that determines the detail level to use when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• RecordCountSerialsCode: integer (int64)
  Title: Record count serials

  Value that indicates the detail level to use when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• SerialCountOption: string
  Maximum Length: 80

  Value that determines whether or not to include serial items when creating the count. A list of accepted values is defined in the lookup type INV_CC_SERIAL_COUNT_OPTIONS.
• SerialCountOptionCode: string
  Title: Serial Numbers per Count

  Maximum Length: 30

  Default Value: 2

  Value that indicates whether or not to include serial items when creating the count. A list of accepted values is defined in the lookup type INV_CC_SERIAL_COUNT_OPTIONS.
• SerialDiscrepancyAllowed: string
  Maximum Length: 80

  Value that determines whether or not to allow discrepancy when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• SerialDiscrepancyCode: integer (int64)
  Title: Serial discrepancy allowed

  Value that indicates whether or not to allow discrepancy when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• SerializedItemsAllowed: string
  Maximum Length: 80

  Value that determines whether or not to use the cycle count to count serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• SerializedItemsAllowedCode: integer (int64)
  Value that indicates whether or not to use the cycle count to count serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• SerialNumberAdjustment: string
  Maximum Length: 80

  Value that determines whether or not to adjust for serial items. A list of accepted values is defined in the lookup type INV_CC_SERIAL_ADJ_OPTIONS.
• SerialNumberAdjustmentCode: string
  Title: Serial Number Adjustment

  Maximum Length: 30

  Value that indicates whether or not to adjust for serial items. A list of accepted values is defined in the lookup type INV_CC_SERIAL_ADJ_OPTIONS.
• StartDate: string (date)
  Title: Start Date

  Date when this cycle count becomes active.
• StartingCountSequence: integer (int64)
  Title: Starting Count Sequence

  Starting number that the warehouse uses for the count sequence for the next scheduling run of the cycle count.
• SynchronizationMode: string
  Value that determines the ABC synchronization mode. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.
• SynchronizationModeCode: string
  Name of the ABC group that the warehouse uses to initialize the item classification in the cycle count.
• SynchronizeAbcAssociationFlag: boolean
  Contains one of the following values: true or false. If true, then synchronize the ABC classes and items during ABC synchronization. If false, then do not synchronize the ABC classes and items during ABC synchronization. This attribute does not have a default value.
• SynchronizeItemCategoryAssociationFlag: boolean
  Contains one of the following values: true or false. If true, then synchronize the count category items during item category synchronization. If false, then do not synchronize the count category items during item category synchronization. This attribute does not have a default value.
• WorkdaySchedule: string
  Maximum Length: 240

  Workday schedule that the count references.
• WorkdayScheduleCode: integer (int64)
  Title: Workday Schedule

  Value that identifies the workday schedule that the cycle count references.

{
    "type":"object",
    "properties":{
        "PositiveHitMissPercentage":{
            "type":"number",
            "description":"Positive percent tolerance that the warehouse uses for hit or miss analysis.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "SerialNumberAdjustmentCode":{
            "title":"Serial Number Adjustment",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether or not to adjust for serial items. A list of accepted values is defined in the lookup type INV_CC_SERIAL_ADJ_OPTIONS.",
            "nullable":true,
            "x-queryable":true
        },
        "StartingCountSequence":{
            "title":"Starting Count Sequence",
            "type":"integer",
            "description":"Starting number that the warehouse uses for the count sequence for the next scheduling run of the cycle count.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Cycle Count Definitions",
            "type":"array",
            "description":"The Flexfields for Cycle Count Definitions resource manages the details about cycle counts.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CountByCategoryFlag":{
            "title":"Enable cycle count by item category",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then enable the cycle count by item category. If false, then do not enable the cycle count by item category. The default value is false.",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "countCategoryItems":{
            "title":"Category Items",
            "type":"array",
            "description":"The Category Items resource manages the category items that the warehouse can use in the cycle count.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-countCategoryItems-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when this cycle count becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SerialCountOption":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to include serial items when creating the count. A list of accepted values is defined in the lookup type INV_CC_SERIAL_COUNT_OPTIONS.",
            "nullable":false,
            "x-queryable":true
        },
        "FrequencyCode":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the time interval to use between two consecutive scheduling runs for a cycle count. A list of accepted values is defined in the lookup type INV_CC_SCHED_TIME.",
            "nullable":true,
            "x-queryable":true
        },
        "PositiveAdjustmentTolerance":{
            "title":"Positive Adjustment Value Tolerance",
            "type":"number",
            "description":"Positive currency tolerance. If the currency exceeds this tolerance, then the warehouse requires approval for the adjustment transaction.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "SerializedItemsAllowed":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to use the cycle count to count serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySuggestedQuantityCode":{
            "title":"Display suggested quantity",
            "type":"integer",
            "description":"Value that indicates whether or not to display the on-hand quantity for the cycle count sequence. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkdaySchedule":{
            "maxLength":"240",
            "type":"string",
            "description":"Workday schedule that the count references.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludedSubinventoriesCount":{
            "type":"integer",
            "description":"Number of subinventories included in the cycle count.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApprovalType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of approval that the warehouse requires for an adjustment transaction. A list of accepted values is defined in the lookup type INV_APPROVAL_REQ.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialCountOptionCode":{
            "title":"Serial Numbers per Count",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether or not to include serial items when creating the count. A list of accepted values is defined in the lookup type INV_CC_SERIAL_COUNT_OPTIONS.",
            "nullable":true,
            "default":"2",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountZeroQuantity":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether the warehouse schedules a cycle count for an item when the on-hand quantity is zero. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialDiscrepancyAllowed":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to allow discrepancy when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "CountZeroQuantityCode":{
            "title":"Count Zero Quantity",
            "type":"integer",
            "description":"Value that indicates whether the warehouse schedules a cycle count for an item when the on-hand quantity is zero. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteAdditionalItemsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then delete the additional items during ABC synchronization. If false, then do not delete the additional items during ABC synchronization. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualCountsAllowed":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not the warehouse can use this cycle count to enter an unscheduled count. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "CycleCountHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategorySynchronizationMode":{
            "type":"string",
            "description":"Mode of item category synchronization. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.",
            "nullable":true,
            "x-queryable":true
        },
        "NegativeTolerancePercentage":{
            "title":"Negative Quantity Tolerance Percentage",
            "type":"number",
            "description":"Negative percent tolerance. If the adjustment falls below this tolerance, then the warehouse requires approval for the adjustment transaction.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "DisplaySuggestedQuantity":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to display the on-hand quantity for the cycle count sequence. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "SynchronizeAbcAssociationFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then synchronize the ABC classes and items during ABC synchronization. If false, then do not synchronize the ABC classes and items during ABC synchronization. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "SerialDiscrepancyCode":{
            "title":"Serial discrepancy allowed",
            "type":"integer",
            "description":"Value that indicates whether or not to allow discrepancy when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "countSubinventories":{
            "title":"Subinventories",
            "type":"array",
            "description":"The Subinventories resource manages the subinventories that the warehouse can use with the cycle count.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-countSubinventories-item-response"
            }
        },
        "AbcAssignmentGroupId":{
            "title":"ABC Assignment Group",
            "type":"integer",
            "description":"Value that uniquely identifies the ABC group that the warehouse uses to initialize the item classification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "CountByCategoryFlag"
                ]
            },
            "x-queryable":true
        },
        "CycleCountName":{
            "title":"Count Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cycle count.",
            "nullable":false,
            "x-queryable":true
        },
        "AbcAssigmentGroup":{
            "maxLength":"40",
            "type":"string",
            "description":"Name of the ABC group that the warehouse uses to initialize the item classification in the cycle count.",
            "nullable":true,
            "x-queryable":true
        },
        "AutomaticallyScheduleCode":{
            "title":"Automatically schedule",
            "type":"integer",
            "description":"Value that indicates whether or not the warehouse schedules the counts. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cycle count.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalTypeCode":{
            "title":"Approval Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that determines the type of approval that the warehouse requires for adjustment transactions. A list of accepted values is defined in the lookup type INV_APPROVAL_REQ.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumberAdjustment":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to adjust for serial items. A list of accepted values is defined in the lookup type INV_CC_SERIAL_ADJ_OPTIONS.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumRecounts":{
            "title":"Maximum Recounts",
            "type":"integer",
            "description":"Maximum number of recounts that the warehouse uses on a cycle count.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NegativeHitMissPercentage":{
            "title":"Negative Hit and Miss Percentage",
            "type":"number",
            "description":"Negative percent tolerance that the warehouse uses for hit or miss analysis.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CategorySynchronizationModeCode":{
            "type":"string",
            "description":"Abbreviation that identifies the item category synchronization mode. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.",
            "nullable":true,
            "x-queryable":false
        },
        "NextScheduledDate":{
            "title":"Next Scheduled Date",
            "type":"string",
            "description":"Date when the next cycle count is scheduled to run by the warehouse.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalRequiredCode":{
            "title":"Approval required",
            "type":"integer",
            "description":"Value that indicates whether or not the warehouse requires approval.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalRequired":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not the warehouse requires approval. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteAdditionalCategoryItemsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then delete the additional items during item category synchronization. If false, then do not delete the additional items during item category synchronization. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordCountSerials":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines the detail level to use when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "countClasses":{
            "title":"Classes",
            "type":"array",
            "description":"The Classes resource manages the count classes that the warehouse can use in the cycle count.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-countClasses-item-response"
            }
        },
        "SynchronizeItemCategoryAssociationFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then synchronize the count category items during item category synchronization. If false, then do not synchronize the count category items during item category synchronization. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "PositiveTolerancePercentage":{
            "title":"Positive Quantity Tolerance Percentage",
            "type":"number",
            "description":"Positive percent tolerance. If the adjustment exceeds this tolerance, then the warehouse requires approval for the adjustment transaction.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "countItems":{
            "title":"Items",
            "type":"array",
            "description":"The Items resource manages the items that the warehouse can use in the cycle count.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-countItems-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when this cycle count becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NegativeAdjustmentTolerance":{
            "title":"Negative Adjustment Value Tolerance",
            "type":"number",
            "description":"Negative currency tolerance. If the currency falls below this tolerance, then the warehouse requires approval for the adjustment transaction.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "ManualCountsAllowedCode":{
            "type":"integer",
            "description":"Value that indicates whether or not the warehouse can use this cycle count to enter an unscheduled count. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordCountSerialsCode":{
            "title":"Record count serials",
            "type":"integer",
            "description":"Value that indicates the detail level to use when counting serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SynchronizationModeCode":{
            "type":"string",
            "description":"Name of the ABC group that the warehouse uses to initialize the item classification in the cycle count.",
            "nullable":true,
            "x-queryable":false
        },
        "AutomaticallySchedule":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not the warehouse schedules the counts. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "SynchronizationMode":{
            "type":"string",
            "description":"Value that determines the ABC synchronization mode. A list of accepted values is defined in the lookup type INV_CC_SYNC_MODE.",
            "nullable":true,
            "x-queryable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Date when the last cycle count was scheduled to run by the warehouse.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SerializedItemsAllowedCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to use the cycle count to count serial items. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkdayScheduleCode":{
            "title":"Workday Schedule",
            "type":"integer",
            "description":"Value that identifies the workday schedule that the cycle count references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumDaysBeforeLate":{
            "title":"Maximum Days Before Late",
            "type":"integer",
            "description":"Number of days after creation before the warehouse considers a scheduled count as late.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManualCountSequencePrefix":{
            "title":"Manual Count Sequence Prefix",
            "maxLength":"3",
            "type":"string",
            "description":"Prefix for a manual count sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "Frequency":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines the time interval to use between two consecutive scheduling runs for a cycle count. A list of accepted values is defined in the lookup type INV_CC_SCHED_TIME.",
            "nullable":true,
            "x-queryable":true
        },
        "countCategories":{
            "title":"Categories",
            "type":"array",
            "description":"The Categories resource manages the item categories that the warehouse can use in the cycle count.",
            "items":{
                "$ref":"#/components/schemas/cycleCountDefinitions-countCategories-item-response"
            }
        }
    }
}

Nested Schema : Categories

Type: array

Title: Categories

The Categories resource manages the item categories that the warehouse can use in the cycle count.

Show Source

• Array of: object cycleCountDefinitions-countCategories-item-response

{
    "title":"Categories",
    "type":"array",
    "description":"The Categories resource manages the item categories that the warehouse can use in the cycle count.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-countCategories-item-response"
    }
}

Nested Schema : Category Items

Type: array

Title: Category Items

The Category Items resource manages the category items that the warehouse can use in the cycle count.

Show Source

• Array of: object cycleCountDefinitions-countCategoryItems-item-response

{
    "title":"Category Items",
    "type":"array",
    "description":"The Category Items resource manages the category items that the warehouse can use in the cycle count.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-countCategoryItems-item-response"
    }
}

Nested Schema : Classes

Type: array

Title: Classes

The Classes resource manages the count classes that the warehouse can use in the cycle count.

Show Source

• Array of: object cycleCountDefinitions-countClasses-item-response

{
    "title":"Classes",
    "type":"array",
    "description":"The Classes resource manages the count classes that the warehouse can use in the cycle count.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-countClasses-item-response"
    }
}

Nested Schema : Items

Type: array

Title: Items

The Items resource manages the items that the warehouse can use in the cycle count.

Show Source

• Array of: object cycleCountDefinitions-countItems-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The Items resource manages the items that the warehouse can use in the cycle count.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-countItems-item-response"
    }
}

Nested Schema : Subinventories

Type: array

Title: Subinventories

The Subinventories resource manages the subinventories that the warehouse can use with the cycle count.

Show Source

• Array of: object cycleCountDefinitions-countSubinventories-item-response

{
    "title":"Subinventories",
    "type":"array",
    "description":"The Subinventories resource manages the subinventories that the warehouse can use with the cycle count.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-countSubinventories-item-response"
    }
}

Nested Schema : Flexfields for Cycle Count Definitions

Type: array

Title: Flexfields for Cycle Count Definitions

The Flexfields for Cycle Count Definitions resource manages the details about cycle counts.

Show Source

• Array of: object cycleCountDefinitions-DFF-item-response

{
    "title":"Flexfields for Cycle Count Definitions",
    "type":"array",
    "description":"The Flexfields for Cycle Count Definitions resource manages the details about cycle counts.",
    "items":{
        "$ref":"#/components/schemas/cycleCountDefinitions-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : cycleCountDefinitions-countCategories-item-response

Type: object

Show Source

• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative percent that the warehouse allows the value to vary for each item that resides in this category.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive percent that the warehouse allows the value to vary for each item that resides in this category.
• CategoryDescription: string
  Maximum Length: 255

  Description of the category that the cycle count includes.
• CategoryId: integer (int64)
  Title: ABC Class

  Value that uniquely identifies the category name that the cycle count includes.
• CategoryName: string
  Maximum Length: 255

  Name of the category that the cycle count includes.
• CountCategoryId: integer (int64)
  Value that uniquely identifies the category of the cycle count.
• CountsPerYear: integer (int64)
  Title: Counts per Year

  Number of counts for each year that this category includes.
• HitAndMissNegativePercentage: number
  Title: Negative

  Negative percent tolerance that the warehouse uses for hit or miss analysis for this count category.
• HitAndMissPostivePercentage: number
  Title: Positive

  Positive percent tolerance that the warehouse uses for hit or miss analysis for this count category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for this category.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for this category.

{
    "type":"object",
    "properties":{
        "CountCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category of the cycle count.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "title":"ABC Class",
            "type":"integer",
            "description":"Value that uniquely identifies the category name that the cycle count includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for this category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the value to vary for each item that resides in this category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "HitAndMissNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent tolerance that the warehouse uses for hit or miss analysis for this count category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for this category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the category that the cycle count includes.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the category that the cycle count includes.",
            "nullable":true,
            "x-queryable":true
        },
        "HitAndMissPostivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent tolerance that the warehouse uses for hit or miss analysis for this count category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the value to vary for each item that resides in this category.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CountsPerYear":{
            "title":"Counts per Year",
            "type":"integer",
            "description":"Number of counts for each year that this category includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

Nested Schema : cycleCountDefinitions-countCategoryItems-item-response

Type: object

Show Source

• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative adjustment that the warehouse allows the value to vary for the category item.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive adjustment that the warehouse allows the value to vary for the category item.
• CategoryDescription: string
  Maximum Length: 255

  Description of the count category that the category item references.
• CategoryId: integer (int64)
  Value that uniquely identifies the count category that the category item references.
• CategoryName: string
  Maximum Length: 255

  Name of the count category that the category item references.
• CountCategoryItemId: integer (int64)
  Value that uniquely identifies the category item that the cycle count definition references.
• IncludeInScheduleFlag: boolean
  Default Value: false

  Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the category item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the category item.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the category item.
• LastScheduledDate: string (date-time)
  Title: Last Scheduled Date

  Date when the warehouse scheduled this category item for counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for the category item.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for the category item.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the count category that the category item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CountCategoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "IncludeInScheduleFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the category item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Date when the warehouse scheduled this category item for counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the category item.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the count category that the category item references.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the count category that the category item references.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        }
    }
}

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 : cycleCountDefinitions-countClasses-item-response

Type: object

Show Source

• AbcClass: string
  Maximum Length: 255

  Name of the ABC class that the cycle count includes.
• AbcClassId: integer (int64)
  Title: ABC Class

  Value that uniquely identifies the ABC class that the cycle count includes.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative percent that the warehouse allows the value to vary for each item that resides in this class.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive percent that the warehouse allows the value to vary for each item that resides in this class.
• CountsPerYear: integer (int64)
  Title: Counts per Year

  Number of counts for each year that this class includes.
• CycleCountClassId: integer (int64)
  Value that uniquely identifies the class of the cycle count.
• HitAndMissNegativePercentage: number
  Title: Negative

  Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• HitAndMissPostivePercentage: number
  Title: Positive

  Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for this class.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for this class.

{
    "type":"object",
    "properties":{
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "HitAndMissNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "AbcClassId":{
            "title":"ABC Class",
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the cycle count includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AbcClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ABC class that the cycle count includes.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HitAndMissPostivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CycleCountClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the class of the cycle count.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CountsPerYear":{
            "title":"Counts per Year",
            "type":"integer",
            "description":"Number of counts for each year that this class includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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 : cycleCountDefinitions-countItems-item-response

Type: object

Show Source

• AbcClass: string
  Maximum Length: 40

  Name of the ABC class that the item references.
• AbcClassId: integer (int64)
  Value that uniquely identifies the ABC class that the item references.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative adjustment that the warehouse allows the value to vary for the item.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive adjustment that the warehouse allows the value to vary for the item.
• CountUOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure for the current count.
• CountUOMCode: string
  Read Only: true

  Maximum Length: 3

  Value that identifies the unit of measure for the current count.
• CycleCountItemId: integer (int64)
  Value that uniquely identifies the item that the cycle count definition references.
• IncludeInSchedule: string
  Maximum Length: 80

  Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInScheduleCode: integer
  Default Value: 2

  Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• LastScheduledDate: string (date-time)
  Title: Last Scheduled Date

  Value that indicates the most recent date that the warehouse scheduled this item for counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotControlCode: integer
  Read Only: true

  Identifies all the lot control items for a cycle count definition.
• PrimaryImageURL: string
  Read Only: true

  Maximum Length: 4000

  Value that provides a reference to the image of the item for which the count sequence is generated.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.
• SerialNumberControlCode: integer
  Read Only: true

  Identifies all the serial control items for a cycle count definition.

{
    "type":"object",
    "properties":{
        "CycleCountItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncludeInSchedule":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeInScheduleCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false,
            "default":"2",
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CountUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the current count.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"integer",
            "description":"Identifies all the serial control items for a cycle count definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Value that indicates the most recent date that the warehouse scheduled this item for counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LotControlCode":{
            "type":"integer",
            "description":"Identifies all the lot control items for a cycle count definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CountUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the unit of measure for the current count.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbcClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AbcClass":{
            "maxLength":"40",
            "type":"string",
            "description":"Name of the ABC class that the item references.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"5"
            },
            "x-queryable":true
        },
        "PrimaryImageURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the count sequence is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : cycleCountDefinitions-countSubinventories-item-response

Type: object

Show Source

• Description: string
  Read Only: true

  Maximum Length: 255

  Value that provides the description of the subinventory.
• IncludeInCount: string
  Maximum Length: 255

  Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInCountCode: integer (int64)
  Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that the warehouse includes in this count definition.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that provides the description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInCountCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncludeInCount":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that the warehouse includes in this count definition.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : cycleCountDefinitions-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for cycle counts.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CycleCountHeaderId: integer (int64)
  Value that uniquely identifies the cycle count definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CycleCountHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for cycle counts.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/DFF

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Flexfields for Cycle Count Definitions resource manages the details about cycle counts.

countCategories

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countCategories

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Categories resource manages the item categories that the warehouse can use in the cycle count.

countCategoryItems

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countCategoryItems

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Category Items resource manages the category items that the warehouse can use in the cycle count.

countClasses

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countClasses

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Classes resource manages the count classes that the warehouse can use in the cycle count.

countItems

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countItems

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Items resource manages the items that the warehouse can use in the cycle count.

countSubinventories

Operation: /fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countSubinventories

Parameters:

• CycleCountHeaderId: $request.path.CycleCountHeaderId

The Subinventories resource manages the subinventories that the warehouse can use with the cycle count.

Back to Top

Examples

This example describes how to get one cycle count definition.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/cycleCountDefinitions?q=CycleCountHeaderId=value"

For example, the following command gets cycle count definition 300100002756508 in organization M1:

curl -u username:password "https://servername/fscmRestApi/resources/version/cycleCountDefinitions?q=OrganizationCode=M1;CycleCountHeaderId=300100002756508"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "CycleCountHeaderId" : 300100002756508,
    "CycleCountName" : "CC-RRF",
    "Description" : null,
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Tall Manufacturing\t\t",
    "AbcAssignmentGroupId" : null,
    "AbcAssigmentGroup" : null,
    "AutomaticallyScheduleCode" : 1,
    "AutomaticallySchedule" : "Yes",
    "FrequencyCode" : "1",
    "Frequency" : "Daily",
    "WorkdayScheduleCode" : 100000016383004,
    "WorkdaySchedule" : "BJ-CC1",
    "LastScheduledDate" : "2011-11-29",
    "NextScheduledDate" : "2011-11-30",
    "ApprovalRequiredCode" : 1,
    "ApprovalRequired" : "Yes",
    "ApprovalTypeCode" : "2",
    "ApprovalType" : "If out of tolerance",
    "PositiveTolerancePercentage" : null,
    "NegativeTolerancePercentage" : null,
    "PositiveAdjustmentTolerance" : null,
    "NegativeAdjustmentTolerance" : null,
    "StartingCountSequence" : 4,
    "MaximumDaysBeforeLate" : 1,
    "MaximumRecounts" : null,
    "StartDate" : "2011-11-29",
    "EndDate" : null,
    "ManualCountsAllowedCode" : 1,
    "ManualCountsAllowed" : "Yes",
    "ManualCountSequencePrefix" : null,
    "CountZeroQuantityCode" : 1,
    "CountZeroQuantity" : "Yes",
    "DisplaySuggestedQuantityCode" : 1,
    "DisplaySuggestedQuantity" : "Yes",
    "SerializedItemsAllowedCode" : 1,
    "SerializedItemsAllowed" : "Yes",
    "SerialCountOptionCode" : "1",
    "SerialCountOption" : "Multiple",
    "SerialNumberAdjustmentCode" : "1",
    "SerialNumberAdjustment" : "Adjust if possible",
    "RecordCountSerialsCode" : 1,
    "RecordCountSerials" : "Yes",
    "SerialDiscrepancyCode" : 1,
    "SerialDiscrepancyAllowed" : "Yes",
    "PositiveHitMissPercentage" : null,
    "NegativeHitMissPercentage" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions/300100002756508",
      "name" : "cycleCountDefinitions",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions/300100002756508",
      "name" : "cycleCountDefinitions",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions/300100002756508/child/countSubinventories",
      "name" : "countSubinventories",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions/300100002756508/child/countItems",
      "name" : "countItems",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions/300100002756508/child/countClasses",
      "name" : "countClasses",
      "kind" : "collection"
    } ]
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/logisticsApi/resources/version/cycleCountDefinitions",
    "name" : "cycleCountDefinitions",
    "kind" : "collection"
  } ]
}

Back to Top