Jump to

• Request
• Response

Create a goal objective

post

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}/child/SalesObjectives

Request

Path Parameters

• BusinessPlanId(required): integer(int64)
  The unique identifier of the business plan.
• GoalNumber(required): string
  The identifier for the goal number.

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account

  The unique identifier of the account assigned to the objective.
• AccountName: string
  Title: Account

  The account name for a sales objective target.
• ActualValue: integer
  Title: Attainment

  The actual attainment value for the objective.
• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The unique identifier of the business plan.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Maximum Length: 64

  The alternate key identifier for the business plan.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the objective.
• EndDisplayPeriodName(required): string
  Title: End Period Name

  Maximum Length: 60

  The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.
• EndPeriodName: string
  Title: Period End Internal Name

  Maximum Length: 15

  The internal name of the end period for the objective.
• GeographyId: integer (int64)
  Title: Geography

  The unique identifier for the geography.
• GeographyKey: string
  The geography key of the geography.
• GeographyName: string
  Title: Geography

  Maximum Length: 255

  The name of the geography, such as JAPAC, EMEA, or Americas.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• GoalNumber: string
  Title: Goal Number

  The unique alternative identifier of the goal.
• Initiatives: array Initiatives
  Title: Initiatives

  The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
• Name(required): string
  Title: Name

  Maximum Length: 60

  The name of the objective.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• ObjectiveNumber: string
  Title: Number

  Maximum Length: 30

  The alternate key identifier for the objective.
• ObjectiveOwnerId: integer (int64)
  Title: Owner ID

  The identification key for the resource who owns the sales objective.
• ObjectiveTypeCode(required): string
  Title: Objective Type Code

  Maximum Length: 30

  The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.
• ObjectiveTypeName(required): string
  Title: Type

  Maximum Length: 60

  The type of the objective.
• OrigCreationDate: string (date-time)
  Title: Original Creation Date

  The date when the objective was originally created in an external system.
• OwnerPartyNumber: string
  Title: Owner Number

  The unique alternative identifier of the owner.
• PeriodTypeCode(required): string
  Title: Period Type Code

  Maximum Length: 30

  The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.
• ProductGroupId: integer (int64)
  Title: Product Group

  The unique identifier for the product group.
• ProductGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group.
• ProductGroupReferenceNumber: string
  Title: Reference Number

  Maximum Length: 50

  The reference number for the product Group.
• StartDisplayPeriodName(required): string
  Title: Start Period Name

  Maximum Length: 60

  The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.
• StartPeriodName: string
  Title: Period Start Internal Name

  Maximum Length: 15

  The internal name of the start period for the objective.
• TargetValue: integer
  Title: Target

  The unique identifier for the target of the objective.

{
    "required":[
        "EndDisplayPeriodName",
        "Name",
        "ObjectiveTypeCode",
        "ObjectiveTypeName",
        "PeriodTypeCode",
        "StartDisplayPeriodName"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the objective.",
            "nullable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"The unique identifier for the geography.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "type":"string",
            "description":"The unique alternative identifier of the owner.",
            "nullable":true
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan.",
            "nullable":false
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the objective.",
            "nullable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "GeographyKey":{
            "type":"string",
            "description":"The geography key of the geography.",
            "nullable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectiveNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the objective.",
            "nullable":false
        },
        "OrigCreationDate":{
            "title":"Original Creation Date",
            "type":"string",
            "description":"The date when the objective was originally created in an external system.",
            "format":"date-time",
            "nullable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Initiatives":{
            "title":"Initiatives",
            "type":"array",
            "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-post-request"
            }
        },
        "ProductGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier for the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The reference number for the product Group.",
            "nullable":false
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective.",
            "nullable":true
        },
        "GoalNumber":{
            "title":"Goal Number",
            "type":"string",
            "description":"The unique alternative identifier of the goal.",
            "nullable":true
        },
        "ObjectiveTypeName":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the objective.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ObjectiveOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identification key for the resource who owns the sales objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectiveTypeCode":{
            "title":"Objective Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.",
            "nullable":false
        },
        "StartPeriodName":{
            "title":"Period Start Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the start period for the objective.",
            "nullable":true
        },
        "EndPeriodName":{
            "title":"Period End Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the end period for the objective.",
            "nullable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective.",
            "nullable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The account name for a sales objective target.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AccountId",
                    "TransientPartyType"
                ]
            }
        }
    }
}

Nested Schema : Initiatives

Type: array

Title: Initiatives

The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.

Show Source

• Array of: object schema

{
    "title":"Initiatives",
    "type":"array",
    "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The identification key for business plan.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• InitiativeId: integer (int64)
  Title: Initiative ID

  The unique identifier for initiative.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier for the lead associated with the business plan.
• LeadNumber: string
  Title: Lead Number

  Unique identifier for lead.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier for objective.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity associated with the business plan.
• OptyNumber: string
  Title: Opportunity Number

  Unique identifier for opportunity.

{
    "type":"object",
    "properties":{
        "InitiativeId":{
            "title":"Initiative ID",
            "type":"integer",
            "description":"The unique identifier for initiative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier for objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The identification key for business plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"Unique identifier for lead.",
            "nullable":false
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier for the lead associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"Unique identifier for opportunity.",
            "nullable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : businessPlans-Goals-SalesObjectives-item-response

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account

  The unique identifier of the account assigned to the objective.
• AccountName: string
  Title: Account

  The account name for a sales objective target.
• AccountNumber: string
  Read Only: true

  Maximum Length: 30

  Unique identifier of a party in the TCA registry.
• ActualValue: integer
  Title: Attainment

  The actual attainment value for the objective.
• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The unique identifier of the business plan.
• BusinessPlanName: string
  Title: Business Plan

  Read Only: true

  Maximum Length: 275

  The name of the business plan for the objective.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Maximum Length: 64

  The alternate key identifier for the business plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the objective can be deleted. The default value is true.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the objective.
• EndDisplayPeriodName: string
  Title: End Period Name

  Maximum Length: 60

  The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.
• EndPeriodName: string
  Title: Period End Internal Name

  Maximum Length: 15

  The internal name of the end period for the objective.
• GeographyId: integer (int64)
  Title: Geography

  The unique identifier for the geography.
• GeographyKey: string
  The geography key of the geography.
• GeographyName: string
  Title: Geography

  Maximum Length: 255

  The name of the geography, such as JAPAC, EMEA, or Americas.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• GoalNumber: string
  Title: Goal Number

  The unique alternative identifier of the goal.
• Initiatives: array Initiatives
  Title: Initiatives

  The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 60

  The name of the objective.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• ObjectiveNumber: string
  Title: Number

  Maximum Length: 30

  The alternate key identifier for the objective.
• ObjectiveOwnerId: integer (int64)
  Title: Owner ID

  The identification key for the resource who owns the sales objective.
• ObjectiveTypeCode: string
  Title: Objective Type Code

  Maximum Length: 30

  The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.
• ObjectiveTypeName: string
  Title: Type

  Maximum Length: 60

  The type of the objective.
• OrigCreationDate: string (date-time)
  Title: Original Creation Date

  The date when the objective was originally created in an external system.
• OwnerPartyName: string
  Title: Owner

  Read Only: true

  Name of the owner of the sales objective.
• OwnerPartyNumber: string
  Title: Owner Number

  The unique alternative identifier of the owner.
• PeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The last date the object is active.
• PeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The first date the object is active.
• PeriodTypeCode: string
  Title: Period Type Code

  Maximum Length: 30

  The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.
• PeriodTypeName: string
  Title: Period

  Read Only: true

  Maximum Length: 80

  The name of the period type for the objective.
• ProductGroupId: integer (int64)
  Title: Product Group

  The unique identifier for the product group.
• ProductGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group.
• ProductGroupReferenceNumber: string
  Title: Reference Number

  Maximum Length: 50

  The reference number for the product Group.
• StartDisplayPeriodName: string
  Title: Start Period Name

  Maximum Length: 60

  The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.
• StartPeriodName: string
  Title: Period Start Internal Name

  Maximum Length: 15

  The internal name of the start period for the objective.
• TargetValue: integer
  Title: Target

  The unique identifier for the target of the objective.
• UnitOfMeasureCode: string
  Title: Unit of Measure Code

  Read Only: true

  Maximum Length: 30

  The code indicating the unit of measure for the objective.
• UnitOfMeasureName: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 80

  The unit of measure of the objective.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the objective can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the unit of measure for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"The unique identifier for the geography.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "type":"string",
            "description":"The unique alternative identifier of the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GeographyKey":{
            "type":"string",
            "description":"The geography key of the geography.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "maxLength":275,
            "type":"string",
            "description":"The name of the business plan for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrigCreationDate":{
            "title":"Original Creation Date",
            "type":"string",
            "description":"The date when the objective was originally created in an external system.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Initiatives":{
            "title":"Initiatives",
            "type":"array",
            "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-response"
            }
        },
        "ProductGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier for the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The reference number for the product Group.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodTypeName":{
            "title":"Period",
            "maxLength":80,
            "type":"string",
            "description":"The name of the period type for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"Name of the owner of the sales objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GoalNumber":{
            "title":"Goal Number",
            "type":"string",
            "description":"The unique alternative identifier of the goal.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveTypeName":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the objective.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ObjectiveOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identification key for the resource who owns the sales objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of a party in the TCA registry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveTypeCode":{
            "title":"Objective Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.",
            "nullable":false,
            "x-queryable":true
        },
        "StartPeriodName":{
            "title":"Period Start Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the start period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "EndPeriodName":{
            "title":"Period End Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the end period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasureName":{
            "title":"Unit of Measure",
            "maxLength":80,
            "type":"string",
            "description":"The unit of measure of the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The account name for a sales objective target.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AccountId",
                    "TransientPartyType"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Initiatives

Type: array

Title: Initiatives

The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.

Show Source

• Array of: object businessPlans-Goals-SalesObjectives-Initiatives-item-response

{
    "title":"Initiatives",
    "type":"array",
    "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-response"
    }
}

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 : businessPlans-Goals-SalesObjectives-Initiatives-item-response

Type: object

Show Source

• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The identification key for business plan.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Read Only: true

  Maximum Length: 64

  The number of the business plan for which an initiative was created.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Lists who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CustomerId: integer (int64)
  Title: Customer ID

  Read Only: true

  The customer identifier that is associated with the business plan.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• InitiativeId: integer (int64)
  Title: Initiative ID

  The unique identifier for initiative.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier for the lead associated with the business plan.
• LeadNumber: string
  Title: Lead Number

  Unique identifier for lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier for objective.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity associated with the business plan.
• OptyNumber: string
  Title: Opportunity Number

  Unique identifier for opportunity.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Lists who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier for objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The number of the business plan for which an initiative was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"Unique identifier for lead.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The customer identifier that is associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InitiativeId":{
            "title":"Initiative ID",
            "type":"integer",
            "description":"The unique identifier for initiative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The identification key for business plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier for the lead associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"Unique identifier for opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "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."
        }
    }
}

Links

Initiatives

Operation: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}/child/SalesObjectives/{ObjectiveId}/child/Initiatives

Parameters:

• BusinessPlanId: $request.path.BusinessPlanId
• GoalNumber: $request.path.GoalNumber
• ObjectiveId: $request.path.ObjectiveId

The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.

LovSalesObjectiveTypeVO

Operation: /crmRestApi/resources/11.13.18.05/salesObjectiveTypes

Parameters:

• finder: SalesObjectiveTypeFinder%3BBindObjectiveTypeCode%3D{ObjectiveTypeCode}

The list of values indicating the type of the sales objective.

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectiveTypeName; Target Attribute: Name
• Display Attribute: Name

ProductGroupViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/productGroups

Parameters:

• finder: ProductGroupList

The list of values of the sales objective product group.

The following properties are defined on the LOV link relation:

• Source Attribute: ProductGroupName; Target Attribute: ProdGroupName
• Display Attribute: ProdGroupName

RatedCurrenciesVO

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The list of values for the currency conversion rate type associated with the sales objective, such as US Dollar or Indian Rupee.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

SalesGLEndPeriodPickTimeListToViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLEndPeriodTimesLOV

Parameters:

• finder: EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

The list of values of the display names for the sales objective end period.

The following properties are defined on the LOV link relation:

• Source Attribute: EndDisplayPeriodName; Target Attribute: PeriodName
• Display Attribute: PeriodName

SalesGLStartPeriodPickerTimeListViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLStartPeriodTimesLOV

Parameters:

• finder: StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

The list of values of the display names for the sales objective start period.

The following properties are defined on the LOV link relation:

• Source Attribute: StartDisplayPeriodName; Target Attribute: PeriodName
• Display Attribute: PeriodName

SalesObjectiveGLPeriodTypeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes

The list of values indicating the type of the sales objective period.

The following properties are defined on the LOV link relation:

• Source Attribute: PeriodTypeCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top