InventoryCountPlan

Represents a plan to count inventory at a location. This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Inventory Count must be enabled.

Fields

CountInterval

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The interval between the planned start dates of two consecutive assessments related to this plan. For example, if the Count Interval is 5 and the Count Interval Unit of Measure is Monthly, then the interval between the planned start dates of the assessments is five months.

CountIntervalUnitOfMeasure

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The unit of measure of the interval between two consecutive assessments related to this plan. If you select Once, only one assessment is created.
  • Default value: Once
  • Possible values:
    • Day
    • Month
    • Once
    • Quarter
    • Week
    • Year

CountWindowDays

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of days between the planned start and end date of each assessment related to this plan. For example, if the count window days is 5, and the planned start date of an assessment in this plan is January 4, 2024 at 9:00 AM, then the planned end date of that assessment is January 9, 2024 at 9:00 AM. If you don't specify a value, then the count interval is considered as the count window.

Description

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The description of the inventory count plan.

EndDateTime

  • Type: dateTime
  • Properties: Create, Filter, Sort, Update
  • Description: The date when the inventory count is planned to end.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

LocationId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The location associated with the inventory count plan.

    This field is a relationship field.

  • Relationship Name: Location
  • Refers To: Location

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the inventory count plan.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the owner of this object.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

StartDateTime

  • Type: dateTime
  • Properties: Create, Filter, Sort, Update
  • Description: The date when the inventory count is planned to start.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies the status of the inventory count plan.
  • Default value: Draft
  • Possible values:
    • Active
    • Draft
    • Inactive

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

InventoryCountPlanFeed
Feed tracking is available for the object.
InventoryCountPlanHistory
History is available for tracked fields of the object.
InventoryCountPlanShare
Sharing is available for the object.