Jump to

• Request
• Response

Get one inventory

get

/fscmRestApi/resources/11.13.18.05/physicalInventories/{physicalInventoriesUniqID}

Request

Path Parameters

• physicalInventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and PhysicalInventoryId ---for the Physical Inventories resource and used to uniquely identify an instance of Physical Inventories. The client should not generate the hash key value. Instead, the client should query on the Physical Inventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Physical Inventories.
  
  For example: physicalInventories?q=OrganizationId=<value1>;PhysicalInventoryId=<value2>

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

Type: object

Show Source

• AllowAllSubinventories: string
  Value that indicates whether all or specific subinventories must be included in the physical inventory. A list of accepted values is defined in the lookup type INV_SUBINVENTORIES_FLAG. The default value is All.
• AllowAllSubinventoriesCode: string
  Title: Subinventories to Count

  Maximum Length: 30

  Default Value: 1

  Value that indicates all or specific subinventories included in the physical inventory. A list of accepted values is defined in the lookup type INV_SUBINVENTORIES_FLAG. The default value is 1.
• AllowDynamicTags: string
  Value that indicates if the dynamic tag creation is permitted in the physical inventory. Contains one of the following values: Yes or No. If Yes, then dynamic tag creation is permitted. If No, then dynamic tag creation is not permitted. This attribute does not have a default value.
• AllowDynamicTagsCode: string
  Title: Dynamic tags allowed

  Maximum Length: 30

  Value that indicates if the dynamic tag creation is permitted in the physical Inventory. Contains one of the following values: 1 or 2. If 1, then dynamic tag creation is permitted. If 2, then dynamic tag creation is not permitted. This attribute does not have a default value.
• ApprovalRequired: string
  Value that indicates the level of approval required to post the physical inventory adjustments. A list of accepted values is defined in the lookup type INV_REQ_APPROVALS. This attribute does not have a default value.
• ApprovalRequiredCode: string
  Title: Approval Type

  Maximum Length: 30

  Value that indicates the level of approval required to post physical inventory adjustments. A list of accepted values is defined in the lookup type INV_REQ_APPROVALS. This attribute does not have a default value.
• ApprovalToleranceNegative: number
  Title: Negative Quantity Tolerance Percentage

  Percent below the on-hand quantity that the adjustment transaction can vary. If the adjustment transaction exceeds the percent, then the adjustment transaction requires approval. For example, if Negative Quantity Tolerance Percentage is 10, and if the adjustment transaction requires an 11% negative adjustment to on-hand quantity, then the transaction requires approval.
• ApprovalTolerancePositive: number
  Title: Positive Quantity Tolerance Percentage

  Percent above the on-hand quantity that the adjustment transaction can vary. If the adjustment transaction exceeds the percent, then the adjustment transaction requires approval. For example, if Positive Quantity Tolerance Percentage is 10, and if the adjustment transaction requires an 11% positive adjustment to on-hand quantity, then the transaction requires approval.
• CostVarianceNegative: number
  Title: Negative Adjustment Value Tolerance

  Total value of a physical inventory adjustment that is less than the current value of the item. The user specifies this limit.
• CostVariancePositive: number
  Title: Positive Adjustment Value Tolerance

  Total value of a physical inventory adjustment that is greater than the current value of the item. The user specifies this limit.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the physical inventory.
• ExcludeNegativeBalance: string
  Value that indicates if the items with negative on-hand balances are excluded from physical counts. Contains one of the following values: Yes or No. If Yes, then items with negative on-hand balances are excluded from physical count. If No, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.
• ExcludeNegativeBalanceCode: string
  Title: Exclude negative balances

  Maximum Length: 30

  Value that indicates that items with negative on-hand balances are excluded from physical counts. Contains one of the following values: Y or N. If Y, then items with negative on-hand balances are excluded from physical count. If N, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.
• ExcludeZeroBalance: string
  Value that indicates that items with zero on-hand balances are excluded from physical counts. Contains one of the following values: Yes or No. If Yes, then items with negative on-hand balances are excluded from physical count. If No, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.
• ExcludeZeroBalanceCode: string
  Title: Exclude zero balances

  Maximum Length: 30

  Value that indicates that items with zero on-hand balances are excluded from physical counts. Contains one of the following values: Y or N. If Y, then items with negative on-hand balances are excluded from physical count. If N, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.
• FifthTagGenerationSequence: string
  Fifth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.
• FifthTagGenerationSequenceCode: string
  Title: Sequence 5

  Maximum Length: 30

  Abbreviation that identifies the fifth sequence that the user defines when the application creates the physical inventory tag.
• FirstTagGenerationSequence: string
  First user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.
• FirstTagGenerationSequenceCode: string
  Title: Sequence 1

  Maximum Length: 30

  Abbreviation that identifies the first sequence that the user defines when the application creates the physical inventory tag.
• FourthTagGenerationSequence: string
  Fourth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.
• FourthTagGenerationSequenceCode: string
  Title: Sequence 4

  Maximum Length: 30

  Abbreviation that identifies the fourth sequence that the user defines when the application creates the physical inventory tag.
• FreezeDate: string (date-time)
  Title: Snapshot Date

  Date when the application no longer allows changes to inventory.
• LastAdjustmentDate: string (date-time)
  Title: Adjustment Date

  Date when the application most recently adjusted the transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextTagNumber: string
  Title: Starting Default Tag

  Maximum Length: 40

  Next tag number in the sequence of tag numbers that the application creates for this physical inventory.
• NumberBlankTags: integer
  Title: Number of Blank Tags

  Number of empty tags to create.
• NumberOfSkus: integer (int64)
  Number of stock keeping units where the application no longer permits changes. These units reside in physical inventory.
• OrganizationCode: string
  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• PhysicalInventoryDate: string (date)
  Title: Date

  Date when the person physically counted the inventory.
• physicalInventoryDFFs: array Flexfields
  Title: Flexfields

  The Flexfields for Physical Inventories resource manages descriptive flexfields for physical inventories.
• PhysicalInventoryId: integer (int64)
  Value that uniquely identifies the physical inventory.
• PhysicalInventoryName: string
  Title: Physical Inventory

  Maximum Length: 30

  Name of the physical inventory.
• physicalInventorySubinventories: array Subinventories
  Title: Subinventories

  The Physical Inventory Subinventories resource manages operations on physical inventory subinventories.
• SecondTagGenerationSequence: string
  Second user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.
• SecondTagGenerationSequenceCode: string
  Title: Sequence 2

  Maximum Length: 30

  Abbreviation that identifies the second sequence that the user defines when the application creates the physical inventory tag.
• SeventhTagGenerationSequence: string
  Seventh user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.
• SeventhTagGenerationSequenceCode: string
  Title: Sequence 7

  Maximum Length: 30

  Abbreviation that identifies the seventh sequence that the user defines when the application creates the physical inventory tag.
• ShowSerialNumbers: string
  Value that indicates if the dynamic tag creation is permitted in the physical inventory. Contains one of the following values: Yes or No. If Yes, then serial numbers are displayed on physical inventory tags. If No, then serial numbers are not displayed on physical inventory tags. This attribute does not have a default value.
• ShowSerialNumbersCode: string
  Title: Show serial numbers on tags

  Maximum Length: 1

  Value that indicates if the dynamic tag creation is permitted in the physical Inventory. Contains one of the following values: 1 or 2. If 1, then serial numbers are displayed on physical inventory tags. If 2, then serial numbers are not displayed on physical inventory tags. This attribute does not have a default value.
• SixthTagGenerationSequence: string
  Sixth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.
• SixthTagGenerationSequenceCode: string
  Title: Sequence 6

  Maximum Length: 30

  Abbreviation that identifies the sixth sequence that the user defines when the application creates the physical inventory tag.
• StartBlankTagNumber: string
  Title: Starting Blank Tag

  Maximum Length: 40

  Starting empty tag number or the next empty tag number to create.
• TagType: string
  Type of physical inventory tags generated when the generate tags action is started. A list of accepted values is defined in the lookup type INV_GENERATE_TAG_TYPE. This attribute does not have a default value.
• TagTypeCode: string
  Title: Tag Type

  Maximum Length: 30

  Value that indicates the types of physical inventory tags generated when the generate tags action is started. A list of accepted values is defined in the lookup type INV_GENERATE_TAG_TYPE. This attribute does not have a default value.
• ThirdTagGenerationSequence: string
  Third user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.
• ThirdTagGenerationSequenceCode: string
  Title: Sequence 3

  Maximum Length: 30

  Abbreviation that identifies the third sequence that the user defines when the application creates the physical inventory tag.
• TotalAdjustmentValue: number
  Total value of all adjustments in physical inventory.

{
    "type":"object",
    "properties":{
        "ThirdTagGenerationSequenceCode":{
            "title":"Sequence 3",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the third sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ThirdTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "AllowDynamicTags":{
            "type":"string",
            "description":"Value that indicates if the dynamic tag creation is permitted in the physical inventory. Contains one of the following values: Yes or No. If Yes, then dynamic tag creation is permitted. If No, then dynamic tag creation is not permitted. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FifthTagGenerationSequenceCode":{
            "title":"Sequence 5",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the fifth sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FifthTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "ThirdTagGenerationSequence":{
            "type":"string",
            "description":"Third user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the physical inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ExcludeNegativeBalance":{
            "type":"string",
            "description":"Value that indicates if the items with negative on-hand balances are excluded from physical counts. Contains one of the following values: Yes or No. If Yes, then items with negative on-hand balances are excluded from physical count. If No, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhysicalInventoryName":{
            "title":"Physical Inventory",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the physical inventory.",
            "nullable":false,
            "x-queryable":true
        },
        "ApprovalTolerancePositive":{
            "title":"Positive Quantity Tolerance Percentage",
            "type":"number",
            "description":"Percent above the on-hand quantity that the adjustment transaction can vary. If the adjustment transaction exceeds the percent, then the adjustment transaction requires approval. For example, if Positive Quantity Tolerance Percentage is 10, and if the adjustment transaction requires an 11% positive adjustment to on-hand quantity, then the transaction requires approval.",
            "nullable":true,
            "x-queryable":true
        },
        "StartBlankTagNumber":{
            "title":"Starting Blank Tag",
            "maxLength":"40",
            "type":"string",
            "description":"Starting empty tag number or the next empty tag number to create.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstTagGenerationSequenceCode":{
            "title":"Sequence 1",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the first sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FirstTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "SixthTagGenerationSequenceCode":{
            "title":"Sequence 6",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the sixth sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SixthTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "SecondTagGenerationSequence":{
            "type":"string",
            "description":"Second user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "OrganizationCode"
                ]
            },
            "x-queryable":true
        },
        "TagTypeCode":{
            "title":"Tag Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the types of physical inventory tags generated when the generate tags action is started. A list of accepted values is defined in the lookup type INV_GENERATE_TAG_TYPE. This attribute does not have a default value.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "TagType"
                ]
            },
            "x-queryable":true
        },
        "SixthTagGenerationSequence":{
            "type":"string",
            "description":"Sixth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalAdjustmentValue":{
            "type":"number",
            "description":"Total value of all adjustments in physical inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "CostVarianceNegative":{
            "title":"Negative Adjustment Value Tolerance",
            "type":"number",
            "description":"Total value of a physical inventory adjustment that is less than the current value of the item. The user specifies this limit.",
            "nullable":true,
            "x-queryable":true
        },
        "LastAdjustmentDate":{
            "title":"Adjustment Date",
            "type":"string",
            "description":"Date when the application most recently adjusted the transaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SeventhTagGenerationSequenceCode":{
            "title":"Sequence 7",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the seventh sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SeventhTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "ApprovalRequiredCode":{
            "title":"Approval Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the level of approval required to post physical inventory adjustments. A list of accepted values is defined in the lookup type INV_REQ_APPROVALS. This attribute does not have a default value.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ApprovalRequired"
                ]
            },
            "x-queryable":true
        },
        "NextTagNumber":{
            "title":"Starting Default Tag",
            "maxLength":"40",
            "type":"string",
            "description":"Next tag number in the sequence of tag numbers that the application creates for this physical inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ExcludeZeroBalanceCode":{
            "title":"Exclude zero balances",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates that items with zero on-hand balances are excluded from physical counts. Contains one of the following values: Y or N. If Y, then items with negative on-hand balances are excluded from physical count. If N, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExcludeZeroBalance"
                ]
            },
            "x-queryable":true
        },
        "FirstTagGenerationSequence":{
            "type":"string",
            "description":"First user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowSerialNumbers":{
            "type":"string",
            "description":"Value that indicates if the dynamic tag creation is permitted in the physical inventory. Contains one of the following values: Yes or No. If Yes, then serial numbers are displayed on physical inventory tags. If No, then serial numbers are not displayed on physical inventory tags. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FourthTagGenerationSequence":{
            "type":"string",
            "description":"Fourth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApprovalRequired":{
            "type":"string",
            "description":"Value that indicates the level of approval required to post the physical inventory adjustments. A list of accepted values is defined in the lookup type INV_REQ_APPROVALS. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "physicalInventoryDFFs":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Physical Inventories resource manages descriptive flexfields for physical inventories.",
            "items":{
                "$ref":"#/components/schemas/physicalInventories-physicalInventoryDFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "FreezeDate":{
            "title":"Snapshot Date",
            "type":"string",
            "description":"Date when the application no longer allows changes to inventory.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CostVariancePositive":{
            "title":"Positive Adjustment Value Tolerance",
            "type":"number",
            "description":"Total value of a physical inventory adjustment that is greater than the current value of the item. The user specifies this limit.",
            "nullable":true,
            "x-queryable":true
        },
        "PhysicalInventoryDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when the person physically counted the inventory.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FourthTagGenerationSequenceCode":{
            "title":"Sequence 4",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the fourth sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FourthTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "AllowDynamicTagsCode":{
            "title":"Dynamic tags allowed",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates if the dynamic tag creation is permitted in the physical Inventory. Contains one of the following values: 1 or 2. If 1, then dynamic tag creation is permitted. If 2, then dynamic tag creation is not permitted. This attribute does not have a default value.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "AllowDynamicTags"
                ]
            },
            "x-queryable":true
        },
        "ApprovalToleranceNegative":{
            "title":"Negative Quantity Tolerance Percentage",
            "type":"number",
            "description":"Percent below the on-hand quantity that the adjustment transaction can vary. If the adjustment transaction exceeds the percent, then the adjustment transaction requires approval. For example, if Negative Quantity Tolerance Percentage is 10, and if the adjustment transaction requires an 11% negative adjustment to on-hand quantity, then the transaction requires approval.",
            "nullable":true,
            "x-queryable":true
        },
        "PhysicalInventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the physical inventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "physicalInventorySubinventories":{
            "title":"Subinventories",
            "type":"array",
            "description":"The Physical Inventory Subinventories resource manages operations on physical inventory subinventories.",
            "items":{
                "$ref":"#/components/schemas/physicalInventories-physicalInventorySubinventories-item-response"
            }
        },
        "ExcludeNegativeBalanceCode":{
            "title":"Exclude negative balances",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates that items with negative on-hand balances are excluded from physical counts. Contains one of the following values: Y or N. If Y, then items with negative on-hand balances are excluded from physical count. If N, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExcludeNegativeBalance"
                ]
            },
            "x-queryable":true
        },
        "FifthTagGenerationSequence":{
            "type":"string",
            "description":"Fifth user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeventhTagGenerationSequence":{
            "type":"string",
            "description":"Seventh user-defined sequence in which the physical inventory tags are generated. A list of accepted values is defined in the lookup type INV_TAG_GEN_SEQUENCE. There is no default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExcludeZeroBalance":{
            "type":"string",
            "description":"Value that indicates that items with zero on-hand balances are excluded from physical counts. Contains one of the following values: Yes or No. If Yes, then items with negative on-hand balances are excluded from physical count. If No, then items with negative on-hand balances are not excluded from physical count. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagType":{
            "type":"string",
            "description":"Type of physical inventory tags generated when the generate tags action is started. A list of accepted values is defined in the lookup type INV_GENERATE_TAG_TYPE. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowSerialNumbersCode":{
            "title":"Show serial numbers on tags",
            "maxLength":"1",
            "type":"string",
            "description":"Value that indicates if the dynamic tag creation is permitted in the physical Inventory. Contains one of the following values: 1 or 2. If 1, then serial numbers are displayed on physical inventory tags. If 2, then serial numbers are not displayed on physical inventory tags. This attribute does not have a default value.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShowSerialNumbers"
                ]
            },
            "x-queryable":true
        },
        "NumberBlankTags":{
            "title":"Number of Blank Tags",
            "type":"integer",
            "description":"Number of empty tags to create.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondTagGenerationSequenceCode":{
            "title":"Sequence 2",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the second sequence that the user defines when the application creates the physical inventory tag.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondTagGenerationSequence"
                ]
            },
            "x-queryable":true
        },
        "NumberOfSkus":{
            "type":"integer",
            "description":"Number of stock keeping units where the application no longer permits changes. These units reside in physical inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowAllSubinventoriesCode":{
            "title":"Subinventories to Count",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates all or specific subinventories included in the physical inventory. A list of accepted values is defined in the lookup type INV_SUBINVENTORIES_FLAG. The default value is 1.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "dependencies":[
                    "AllowAllSubinventories"
                ]
            },
            "x-queryable":true
        },
        "AllowAllSubinventories":{
            "type":"string",
            "description":"Value that indicates whether all or specific subinventories must be included in the physical inventory. A list of accepted values is defined in the lookup type INV_SUBINVENTORIES_FLAG. The default value is All.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : Flexfields

Type: array

Title: Flexfields

The Flexfields for Physical Inventories resource manages descriptive flexfields for physical inventories.

Show Source

• Array of: object physicalInventories-physicalInventoryDFFs-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields for Physical Inventories resource manages descriptive flexfields for physical inventories.",
    "items":{
        "$ref":"#/components/schemas/physicalInventories-physicalInventoryDFFs-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Subinventories

Type: array

Title: Subinventories

The Physical Inventory Subinventories resource manages operations on physical inventory subinventories.

Show Source

• Array of: object physicalInventories-physicalInventorySubinventories-item-response

{
    "title":"Subinventories",
    "type":"array",
    "description":"The Physical Inventory Subinventories resource manages operations on physical inventory subinventories.",
    "items":{
        "$ref":"#/components/schemas/physicalInventories-physicalInventorySubinventories-item-response"
    }
}

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 : physicalInventories-physicalInventoryDFFs-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context value of the physical inventory.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• PhysicalInventoryId: integer (int64)
  Value that uniquely identifies the physical inventory.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhysicalInventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the physical inventory.",
            "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",
            "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 value of the physical inventory.",
            "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"
    }
}

Nested Schema : physicalInventories-physicalInventorySubinventories-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Subinventories that the physical inventory contains.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Subinventories that the physical inventory contains.",
            "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"
    }
}

Links

physicalInventoryDFFs

Operation: /fscmRestApi/resources/11.13.18.05/physicalInventories/{physicalInventoriesUniqID}/child/physicalInventoryDFFs

Parameters:

• physicalInventoriesUniqID: $request.path.physicalInventoriesUniqID

The Flexfields for Physical Inventories resource manages descriptive flexfields for physical inventories.

physicalInventorySubinventories

Operation: /fscmRestApi/resources/11.13.18.05/physicalInventories/{physicalInventoriesUniqID}/child/physicalInventorySubinventories

Parameters:

• physicalInventoriesUniqID: $request.path.physicalInventoriesUniqID

The Physical Inventory Subinventories resource manages operations on physical inventory subinventories.

Back to Top