Jump to

• Request
• Response

Create a territory

post

/crmRestApi/resources/11.13.18.05/salesTerritories

Request

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.
• Upsert-Mode:
  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

• CoverageModel: string
  Title: Coverage

  Maximum Length: 30

  Default Value: SALES_ACCOUNT_CENTRIC

  Identifies whether the territory coverage is based on sales account attributes or partner attributes.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the territory.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Indicates the date at the end of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Indicates the date at the beginning of the date range within which the row is effective.
• EligibleForQuotaFlag: boolean
  Title: Eligible for Quota

  Maximum Length: 1

  Default Value: false

  Indicates whether the territory is unlikely to change, and therefore Quota can be entered against the proposed definition.
• ForecastedByParentTerritoryFlag: boolean
  Title: Forecast Invisible to Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether a territory's parent includes it's forecast.
• ForecastParticipationCode: string
  Title: Enable Forecasting

  Maximum Length: 30

  Default Value: REVENUE

  The code that indicates the forecast participation of the territory, such as REVENUE.
• LatestVersionFlag: boolean
  Title: Latest Version

  Maximum Length: 1

  Default Value: true

  Indicates the latest active version of the territory.
• Name(required): string
  Title: Territory Name

  Maximum Length: 60

  The name of the territory.
• Owner(required): string
  Title: Owner

  Maximum Length: 360

  The owner of the territory.
• OwnerResourceId(required): integer (int64)
  Title: Resource ID

  The identifier of the territory owner resource from resources.
• OwnerTrans: string
  Title: Owner

  Maximum Length: 255

  The name of the owner.
• ParentTerritoryId: integer (int64)
  Title: Parent Territory ID

  The identifier of parent territory.
• ParentTerritoryLovSwitcher: string
  The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.
• ParentTerritoryTrans: string
  The name of the parent territory.
• ParentUniqueTerritoryNumber: string
  Title: Parent Territory Unique Number

  Maximum Length: 30

  The public unique identifier of the parent territory.
• PartnerId: integer (int64)
  Title: Partner ID

  The identifier of the partner associated to the territory.
• PartnerName: string
  Title: Partner

  Maximum Length: 360

  The partner associated to the territory.
• PartnerNumber: string
  Title: Partner Number

  Maximum Length: 30

  The number of the partner.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The identifier of the program that a partner is participating in.
• ProgramName: string
  Title: Partner Program

  Maximum Length: 150

  The specific program that a partner is participating in.
• ProposalNumber: string
  Title: Proposal Number

  Maximum Length: 30

  The number of the proposal with which the territory is associated.
• ReviseQuotaFlag: boolean
  Title: Revise Quota

  Maximum Length: 1

  Indicates whether a submitted quota needs to be updated.
• RevisionDescription: string
  Title: Revision Description

  Maximum Length: 1000

  Allows a user to note why the quota needs to be revised.
• RevisionReason: string
  Title: Revision Reason

  Maximum Length: 30

  Allows a user to note why the quota needs to be revised.
• SourceTerrId: integer (int64)
  Title: Source Territory ID

  The territory that the selected dimensions are being inherited from.
• SourceTerrLastUpdateDate: string (date-time)
  Title: Source Territory Last Update Date

  The date the attribute of the source territory was last updated. This is related to inheritance of dimensions by recipient territories from source territories.
• SourceTerrName: string
  Title: Source Territory

  Maximum Length: 60

  The territory that the selected dimensions are being inherited from.
• SourceTerrVersionId: integer (int64)
  Title: Source Territory Version ID

  The identifier of the source territory version.
• SourceUniqueTerritoryNumber: string
  Title: Source Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the source territory.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status the territory is in, such as FINALIZED.
• TerritoryCoverage: array Territory Coverages
  Title: Territory Coverages

  The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.
• TerritoryFunctionCode: string
  Title: Territory Function

  Maximum Length: 30

  The business function associated with the territory.
• TerritoryId: integer (int64)
  Title: Territory ID

  The identifier of the territory.
• TerritoryLevel: integer (int64)
  Title: Territory Level

  The level of the territory in the territory hierarchy.
• TerritoryLineOfBusiness: array Territory Business
  Title: Territory Business

  The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.
• TerritoryNumber: string
  Title: Territory Number

  Maximum Length: 30

  The identification number for the active territory.
• TerritoryResource: array Territory Resources
  Title: Territory Resources

  The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The identifier of territory version.
• TerrProposalId: integer (int64)
  Title: Territory Proposal ID

  The identifier of territory proposal.
• TypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: PRIME

  Identifies type of the territory.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The unique identification number for the territory.

{
    "required":[
        "Name",
        "Owner",
        "OwnerResourceId"
    ],
    "type":"object",
    "properties":{
        "TerritoryId":{
            "title":"Territory ID",
            "type":"integer",
            "description":"The identifier of the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identification number for the territory.",
            "nullable":true
        },
        "ParentUniqueTerritoryNumber":{
            "title":"Parent Territory Unique Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the parent territory.",
            "nullable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner of the territory.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the territory.",
            "nullable":true
        },
        "ReviseQuotaFlag":{
            "title":"Revise Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a submitted quota needs to be updated.",
            "nullable":true
        },
        "SourceTerrVersionId":{
            "title":"Source Territory Version ID",
            "type":"integer",
            "description":"The identifier of the source territory version.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner associated to the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status the territory is in, such as FINALIZED.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LatestVersionFlag":{
            "title":"Latest Version",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the latest active version of the territory.",
            "nullable":false,
            "default":true
        },
        "Name":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false
        },
        "RevisionDescription":{
            "title":"Revision Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Allows a user to note why the quota needs to be revised.",
            "nullable":true
        },
        "EligibleForQuotaFlag":{
            "title":"Eligible for Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the territory is unlikely to change, and therefore Quota can be entered against the proposed definition.",
            "nullable":true,
            "default":false
        },
        "TerritoryResource":{
            "title":"Territory Resources",
            "type":"array",
            "description":"The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryResource-item-post-request"
            }
        },
        "SourceTerrLastUpdateDate":{
            "title":"Source Territory Last Update Date",
            "type":"string",
            "description":"The date the attribute of the source territory was last updated. This is related to inheritance of dimensions by recipient territories from source territories.",
            "format":"date-time",
            "nullable":true
        },
        "SourceTerrId":{
            "title":"Source Territory ID",
            "type":"integer",
            "description":"The territory that the selected dimensions are being inherited from.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"The business function associated with the territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The identifier of the territory owner resource from resources.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "TerritoryCoverage":{
            "title":"Territory Coverages",
            "type":"array",
            "description":"The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-post-request"
            }
        },
        "ParentTerritoryTrans":{
            "type":"string",
            "description":"The name of the parent territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":true
        },
        "TerritoryLevel":{
            "title":"Territory Level",
            "type":"integer",
            "description":"The level of the territory in the territory hierarchy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies type of the territory.",
            "nullable":false,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The identifier of the program that a partner is participating in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceTerrName":{
            "title":"Source Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The territory that the selected dimensions are being inherited from.",
            "nullable":true
        },
        "TerritoryNumber":{
            "title":"Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The identification number for the active territory.",
            "nullable":false
        },
        "RevisionReason":{
            "title":"Revision Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Allows a user to note why the quota needs to be revised.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The partner associated to the territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoverageModel":{
            "title":"Coverage",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies whether the territory coverage is based on sales account attributes or partner attributes.",
            "nullable":true,
            "default":"SALES_ACCOUNT_CENTRIC",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProgramName":{
            "title":"Partner Program",
            "maxLength":"150",
            "type":"string",
            "description":"The specific program that a partner is participating in.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ForecastedByParentTerritoryFlag":{
            "title":"Forecast Invisible to Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a territory's parent includes it's forecast.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the forecast participation of the territory, such as REVENUE.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the partner.",
            "nullable":false
        },
        "ParentTerritoryLovSwitcher":{
            "type":"string",
            "description":"The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.",
            "nullable":true
        },
        "TerritoryLineOfBusiness":{
            "title":"Territory Business",
            "type":"array",
            "description":"The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryLineOfBusiness-item-post-request"
            }
        },
        "OwnerTrans":{
            "title":"Owner",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the proposal with which the territory is associated.",
            "nullable":false
        },
        "ParentTerritoryId":{
            "title":"Parent Territory ID",
            "type":"integer",
            "description":"The identifier of parent territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "SourceUniqueTerritoryNumber":{
            "title":"Source Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the source territory.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":true
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The identifier of territory proposal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Territory Coverages

Type: array

Title: Territory Coverages

The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.

Show Source

• Array of: object salesTerritories-TerritoryCoverage-item-post-request

{
    "title":"Territory Coverages",
    "type":"array",
    "description":"The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-post-request"
    }
}

Nested Schema : Territory Business

Type: array

Title: Territory Business

The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.

Show Source

• Array of: object schema

{
    "title":"Territory Business",
    "type":"array",
    "description":"The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryLineOfBusiness-item-post-request"
    }
}

Nested Schema : Territory Resources

Type: array

Title: Territory Resources

The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.

Show Source

• Array of: object schema

{
    "title":"Territory Resources",
    "type":"array",
    "description":"The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryResource-item-post-request"
    }
}

Nested Schema : salesTerritories-TerritoryCoverage-item-post-request

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The identifier for the customer inclusion or exclusion.
• AccountTypeCode: string
  Title: Account Type Code

  Maximum Length: 30

  The code for the account type in the territory coverage.
• AddressCity: string
  Title: City

  Maximum Length: 60

  The city of the address dimension in the territory coverage.
• AddressCountry: string
  Title: Country

  Maximum Length: 2

  The country of the address dimension in the territory coverage.
• AddressCounty: string
  Title: County

  Maximum Length: 60

  The county of the address dimension in the territory coverage.
• AddressElementAttribute1: string
  Title: Additional Attribute 1

  Maximum Length: 150

  The additional attribute 1 of the address dimension in the territory coverage.
• AddressElementAttribute2: string
  Title: Additional Attribute 2

  Maximum Length: 150

  The additional attribute 2 of the address dimension in the territory coverage.
• AddressElementAttribute3: string
  Title: Additional Attribute 3

  Maximum Length: 150

  The additional attribute 3 of the address dimension in the territory coverage.
• AddressElementAttribute4: string
  Title: Additional Attribute 4

  Maximum Length: 150

  The additional attribute 4 of the address dimension in the territory coverage.
• AddressElementAttribute5: string
  Title: Additional Attribute 5

  Maximum Length: 150

  The additional attribute 5 of the address dimension in the territory coverage.
• AddressPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address dimension in the territory coverage.
• AddressProvince: string
  Title: Province

  Maximum Length: 60

  The province of the address dimension in the territory coverage.
• AddressState: string
  Title: State

  Maximum Length: 60

  The state of the address dimension in the territory coverage.
• Auxiliary1Code: string
  Title: Auxiliary 1 Code

  Maximum Length: 30

  The auxiliary 1 code in the territory coverage.
• Auxiliary2Code: string
  Title: Auxiliary 2 Code

  Maximum Length: 30

  The auxiliary 2 code in the territory coverage.
• Auxiliary3Code: string
  Title: Auxiliary 3 Code

  Maximum Length: 30

  The auxiliary 3 code in the territory coverage.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  The identifier for the business unit in the territory coverage.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 255

  The name for the business unit in the territory coverage.
• CoverageId: integer (int64)
  Title: Coverage ID

  The unique identifier of the territory coverage rule.
• CoverageNumber: string
  Title: Coverage Number

  Maximum Length: 30

  The public unique identifier of the territory coverage rule.
• CoverageTypeCode: string
  Title: Coverage Type Code

  Maximum Length: 30

  The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.
• CustomerSizeCode: string
  Title: Customer Size Code

  Maximum Length: 30

  The code for the customer size in the territory coverage.
• Extension10Code: string
  Title: Extension 10 Code

  Maximum Length: 30

  The extension 10 code in the territory coverage.
• Extension1Code: string
  Title: Extension 1 Code

  Maximum Length: 30

  The extension 1 code in the territory coverage.
• Extension2Code: string
  Title: Extension 2 Code

  Maximum Length: 30

  The extension 2 code in the territory coverage.
• Extension3Code: string
  Title: Extension 3 Code

  Maximum Length: 30

  The extension 3 code in the territory coverage.
• Extension4Code: string
  Title: Extension 4 Code

  Maximum Length: 30

  The extension 4 code in the territory coverage.
• Extension5Code: string
  Title: Extension 5 Code

  Maximum Length: 30

  The extension 5 code in the territory coverage.
• Extension6Code: string
  Title: Extension 6 Code

  Maximum Length: 30

  The extension 6 code in the territory coverage.
• Extension7Code: string
  Title: Extension 7 Code

  Maximum Length: 30

  The extension 7 code in the territory coverage.
• Extension8Code: string
  Title: Extension 8 Code

  Maximum Length: 30

  The extension 8 code in the territory coverage.
• Extension9Code: string
  Title: Extension 9 Code

  Maximum Length: 30

  The extension 9 code in the territory coverage.
• GeographyHighId: integer (int64)
  Title: Geography High ID

  The identifier for the higher geography in the range in the territory coverage.
• GeographyHighName: string
  Title: Geography High Name

  The name for the higher geography in the range in the territory coverage.
• GeographyId: integer (int64)
  Title: Geography ID

  The identifier for the geography in the territory coverage.
• GeographyName: string
  Title: Geography

  The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.
• IncludeHierarchyFlag: boolean
  Title: Include Hierarchy

  Maximum Length: 1

  Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
• IndustryCode: string
  Title: Industry Code

  Maximum Length: 30

  The code for the industry in the territory coverage.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The identifier for the inventory item in the territory coverage.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The identifier for the inventory organization in the territory coverage.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The code for the organization type in the territory coverage.
• OriginalReference: string
  Title: Original Reference

  Maximum Length: 300

  The origin source system reference of the account or contact.
• PartnerId: integer (int64)
  Title: Partner ID

  The identifier of the partner inclusion or exclusion.
• PartnerNumber: string
  Title: Partner Number

  Maximum Length: 30

  The public unique identifier of the partner inclusion or exclusion.
• ProductGroupId: integer (int64)
  Title: Product Group ID

  The identifier for the product group in the territory coverage.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  The number for the product group in the territory coverage.
• SalesChannelCode: string
  Title: Sales Channel Code

  Maximum Length: 30

  The code for the sales channel in the territory coverage.
• SubSalesChannelCode: string
  Title: Subsales Channel Code

  Maximum Length: 30

  The code for the sub sales channel in the territory coverage.
• TerrDimensionCode: string
  Title: Territory Dimension Code

  Maximum Length: 5

  The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of territory version.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The identifier for the customer inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The identifier for the geography in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Extension3Code":{
            "title":"Extension 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 3 code in the territory coverage.",
            "nullable":true
        },
        "SubSalesChannelCode":{
            "title":"Subsales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sub sales channel in the territory coverage.",
            "nullable":true
        },
        "Extension1Code":{
            "title":"Extension 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 1 code in the territory coverage.",
            "nullable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the address dimension in the territory coverage.",
            "nullable":true
        },
        "GeographyHighName":{
            "title":"Geography High Name",
            "type":"string",
            "description":"The name for the higher geography in the range in the territory coverage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyHighId"
                ]
            }
        },
        "Extension4Code":{
            "title":"Extension 4 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 4 code in the territory coverage.",
            "nullable":true
        },
        "IndustryCode":{
            "title":"Industry Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the industry in the territory coverage.",
            "nullable":true
        },
        "Extension5Code":{
            "title":"Extension 5 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 5 code in the territory coverage.",
            "nullable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The identifier for the inventory item in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The identifier for the business unit in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The identifier for the inventory organization in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Auxiliary1Code":{
            "title":"Auxiliary 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 1 code in the territory coverage.",
            "nullable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the customer size in the territory coverage.",
            "nullable":true
        },
        "Extension6Code":{
            "title":"Extension 6 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 6 code in the territory coverage.",
            "nullable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the account type in the territory coverage.",
            "nullable":true
        },
        "SalesChannelCode":{
            "title":"Sales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sales channel in the territory coverage.",
            "nullable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address dimension in the territory coverage.",
            "nullable":true
        },
        "CoverageNumber":{
            "title":"Coverage Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory coverage rule.",
            "nullable":false
        },
        "GeographyHighId":{
            "title":"Geography High ID",
            "type":"integer",
            "description":"The identifier for the higher geography in the range in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AddressElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 1 of the address dimension in the territory coverage.",
            "nullable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 2 of the address dimension in the territory coverage.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 3 of the address dimension in the territory coverage.",
            "nullable":true
        },
        "TerrDimensionCode":{
            "title":"Territory Dimension Code",
            "maxLength":"5",
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number for the product group in the territory coverage.",
            "nullable":false
        },
        "AddressElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 4 of the address dimension in the territory coverage.",
            "nullable":true
        },
        "OriginalReference":{
            "title":"Original Reference",
            "maxLength":"300",
            "type":"string",
            "description":"The origin source system reference of the account or contact.",
            "nullable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 5 of the address dimension in the territory coverage.",
            "nullable":true
        },
        "Extension7Code":{
            "title":"Extension 7 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 7 code in the territory coverage.",
            "nullable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the organization type in the territory coverage.",
            "nullable":true
        },
        "Auxiliary3Code":{
            "title":"Auxiliary 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 3 code in the territory coverage.",
            "nullable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country of the address dimension in the territory coverage.",
            "nullable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address dimension in the territory coverage.",
            "nullable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address dimension in the territory coverage.",
            "nullable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory coverage rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Extension8Code":{
            "title":"Extension 8 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 8 code in the territory coverage.",
            "nullable":true
        },
        "Extension9Code":{
            "title":"Extension 9 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 9 code in the territory coverage.",
            "nullable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"255",
            "type":"string",
            "description":"The name for the business unit in the territory coverage.",
            "nullable":true
        },
        "Auxiliary2Code":{
            "title":"Auxiliary 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 2 code in the territory coverage.",
            "nullable":true
        },
        "Extension10Code":{
            "title":"Extension 10 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 10 code in the territory coverage.",
            "nullable":true
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the territory coverage type.\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\nIn case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.",
            "nullable":false
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The identifier for the product group in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GeographyName":{
            "title":"Geography",
            "type":"string",
            "description":"The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            }
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the partner inclusion or exclusion.",
            "nullable":false
        },
        "Extension2Code":{
            "title":"Extension 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 2 code in the territory coverage.",
            "nullable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address dimension in the territory coverage.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• LobCode: string
  Title: Line of Business Code

  Maximum Length: 30

  The code for the line of business.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.
• TerrLobId: integer (int64)
  Title: Line of Business ID

  The unique identifier of the territory line of business.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LobCode":{
            "title":"Line of Business Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the line of business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerrLobId":{
            "title":"Line of Business ID",
            "type":"integer",
            "description":"The unique identifier of the territory line of business.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AdministratorFlag: boolean
  Title: Team Member Administrator

  Maximum Length: 1

  Indicates whether the resource is an administrator of the territory.
• FunctionCode: string
  Title: Team Member Function

  Maximum Length: 30

  The code for the function of the resource associated with the territory.
• ManageForecastFlag: boolean
  Title: Forecasting Delegate

  Maximum Length: 1

  Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource from the resource manager.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.
• TerrResourceId: integer (int64)
  Title: Territory Resource ID

  The unique identifier of the territory team member.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true
        },
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerrResourceId":{
            "title":"Territory Resource ID",
            "type":"integer",
            "description":"The unique identifier of the territory team member.",
            "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 : salesTerritories-item-response

Type: object

Show Source

• CoverageModel: string
  Title: Coverage

  Maximum Length: 30

  Default Value: SALES_ACCOUNT_CENTRIC

  Identifies whether the territory coverage is based on sales account attributes or partner attributes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the territory was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user has access to delete the record. If the value is True, then the user has the access. The default value is False.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the territory.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Indicates the date at the end of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Indicates the date at the beginning of the date range within which the row is effective.
• EligibleForQuotaFlag: boolean
  Title: Eligible for Quota

  Maximum Length: 1

  Default Value: false

  Indicates whether the territory is unlikely to change, and therefore Quota can be entered against the proposed definition.
• ForecastedByParentTerritoryFlag: boolean
  Title: Forecast Invisible to Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether a territory's parent includes it's forecast.
• ForecastParticipationCode: string
  Title: Enable Forecasting

  Maximum Length: 30

  Default Value: REVENUE

  The code that indicates the forecast participation of the territory, such as REVENUE.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the territory was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory.
• LatestVersionFlag: boolean
  Title: Latest Version

  Maximum Length: 1

  Default Value: true

  Indicates the latest active version of the territory.
• links: array Links
  Title: Links

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

  Maximum Length: 60

  The name of the territory.
• OrganizationName: string
  Title: Organization

  Read Only: true

  The name of owner's organization.
• Owner: string
  Title: Owner

  Maximum Length: 360

  The owner of the territory.
• OwnerEmail: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 320

  The email address of the territory owner resource.
• OwnerResourceId: integer (int64)
  Title: Resource ID

  The identifier of the territory owner resource from resources.
• OwnerResourceNumber: string
  Title: Owner Registry ID

  Read Only: true

  Maximum Length: 30

  The registry ID of the owner.
• OwnerTrans: string
  Title: Owner

  Maximum Length: 255

  The name of the owner.
• ParentTerritoryId: integer (int64)
  Title: Parent Territory ID

  The identifier of parent territory.
• ParentTerritoryLovSwitcher: string
  The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.
• ParentTerritoryNumber: string
  Title: Parent Territory Number

  Read Only: true

  Maximum Length: 30

  The coverage number for the territory.
• ParentTerritoryTrans: string
  The name of the parent territory.
• ParentUniqueTerritoryNumber: string
  Title: Parent Territory Unique Number

  Maximum Length: 30

  The public unique identifier of the parent territory.
• PartnerId: integer (int64)
  Title: Partner ID

  The identifier of the partner associated to the territory.
• PartnerName: string
  Title: Partner

  Maximum Length: 360

  The partner associated to the territory.
• PartnerNumber: string
  Title: Partner Number

  Maximum Length: 30

  The number of the partner.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The identifier of the program that a partner is participating in.
• ProgramName: string
  Title: Partner Program

  Maximum Length: 150

  The specific program that a partner is participating in.
• ProposalNumber: string
  Title: Proposal Number

  Maximum Length: 30

  The number of the proposal with which the territory is associated.
• ReviseQuotaFlag: boolean
  Title: Revise Quota

  Maximum Length: 1

  Indicates whether a submitted quota needs to be updated.
• RevisionDescription: string
  Title: Revision Description

  Maximum Length: 1000

  Allows a user to note why the quota needs to be revised.
• RevisionReason: string
  Title: Revision Reason

  Maximum Length: 30

  Allows a user to note why the quota needs to be revised.
• SourceTerrId: integer (int64)
  Title: Source Territory ID

  The territory that the selected dimensions are being inherited from.
• SourceTerrLastUpdateDate: string (date-time)
  Title: Source Territory Last Update Date

  The date the attribute of the source territory was last updated. This is related to inheritance of dimensions by recipient territories from source territories.
• SourceTerrName: string
  Title: Source Territory

  Maximum Length: 60

  The territory that the selected dimensions are being inherited from.
• SourceTerrVersionId: integer (int64)
  Title: Source Territory Version ID

  The identifier of the source territory version.
• SourceUniqueTerritoryNumber: string
  Title: Source Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the source territory.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status the territory is in, such as FINALIZED.
• TerritoryCoverage: array Territory Coverages
  Title: Territory Coverages

  The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.
• TerritoryFunctionCode: string
  Title: Territory Function

  Maximum Length: 30

  The business function associated with the territory.
• TerritoryHierarchyUniqueTerritoryNumber: string
  Title: Territory Hierarchy Unique Territory Number

  Read Only: true

  Maximum Length: 30

  The unique alternate identifier of the territory at the top of the hierarchy to be exported.
• TerritoryId: integer (int64)
  Title: Territory ID

  The identifier of the territory.
• TerritoryLevel: integer (int64)
  Title: Territory Level

  The level of the territory in the territory hierarchy.
• TerritoryLineOfBusiness: array Territory Business
  Title: Territory Business

  The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.
• TerritoryNumber: string
  Title: Territory Number

  Maximum Length: 30

  The identification number for the active territory.
• TerritoryResource: array Territory Resources
  Title: Territory Resources

  The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The identifier of territory version.
• TerrProposalId: integer (int64)
  Title: Territory Proposal ID

  The identifier of territory proposal.
• TypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: PRIME

  Identifies type of the territory.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The unique identification number for the territory.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the user has access to update the record. If the value is True, then the user has the access. The default value is False.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the territory was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identification number for the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner of the territory.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SourceTerrVersionId":{
            "title":"Source Territory Version ID",
            "type":"integer",
            "description":"The identifier of the source territory version.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner associated to the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status the territory is in, such as FINALIZED.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionDescription":{
            "title":"Revision Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Allows a user to note why the quota needs to be revised.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryResource":{
            "title":"Territory Resources",
            "type":"array",
            "description":"The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryResource-item-response"
            }
        },
        "SourceTerrLastUpdateDate":{
            "title":"Source Territory Last Update Date",
            "type":"string",
            "description":"The date the attribute of the source territory was last updated. This is related to inheritance of dimensions by recipient territories from source territories.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnerResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The identifier of the territory owner resource from resources.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryCoverage":{
            "title":"Territory Coverages",
            "type":"array",
            "description":"The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTerritoryTrans":{
            "type":"string",
            "description":"The name of the parent territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryLevel":{
            "title":"Territory Level",
            "type":"integer",
            "description":"The level of the territory in the territory hierarchy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The identifier of the program that a partner is participating in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTerrName":{
            "title":"Source Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The territory that the selected dimensions are being inherited from.",
            "nullable":true,
            "x-queryable":true
        },
        "RevisionReason":{
            "title":"Revision Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Allows a user to note why the quota needs to be revised.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The partner associated to the territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Partner Program",
            "maxLength":"150",
            "type":"string",
            "description":"The specific program that a partner is participating in.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record. If the value is True, then the user has the access. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ForecastedByParentTerritoryFlag":{
            "title":"Forecast Invisible to Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a territory's parent includes it's forecast.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the forecast participation of the territory, such as REVENUE.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentTerritoryLovSwitcher":{
            "type":"string",
            "description":"The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerTrans":{
            "title":"Owner",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The identifier of territory proposal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "type":"string",
            "description":"The name of owner's organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryId":{
            "title":"Territory ID",
            "type":"integer",
            "description":"The identifier of the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentUniqueTerritoryNumber":{
            "title":"Parent Territory Unique Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the parent territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviseQuotaFlag":{
            "title":"Revise Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a submitted quota needs to be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestVersionFlag":{
            "title":"Latest Version",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the latest active version of the territory.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EligibleForQuotaFlag":{
            "title":"Eligible for Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the territory is unlikely to change, and therefore Quota can be entered against the proposed definition.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.  If the value is True, then the user has the access. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceTerrId":{
            "title":"Source Territory ID",
            "type":"integer",
            "description":"The territory that the selected dimensions are being inherited from.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"The business function associated with the territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerEmail":{
            "title":"Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the territory owner resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "OwnerResourceNumber":{
            "title":"Owner Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The registry ID of the owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies type of the territory.",
            "nullable":false,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryHierarchyUniqueTerritoryNumber":{
            "title":"Territory Hierarchy Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the territory at the top of the hierarchy to be exported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The identification number for the active territory.",
            "nullable":false,
            "x-queryable":true
        },
        "CoverageModel":{
            "title":"Coverage",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies whether the territory coverage is based on sales account attributes or partner attributes.",
            "nullable":true,
            "default":"SALES_ACCOUNT_CENTRIC",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the partner.",
            "nullable":false,
            "x-queryable":true
        },
        "TerritoryLineOfBusiness":{
            "title":"Territory Business",
            "type":"array",
            "description":"The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryLineOfBusiness-item-response"
            }
        },
        "ParentTerritoryNumber":{
            "title":"Parent Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The coverage number for the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the proposal with which the territory is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentTerritoryId":{
            "title":"Parent Territory ID",
            "type":"integer",
            "description":"The identifier of parent territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceUniqueTerritoryNumber":{
            "title":"Source Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the source territory.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the territory was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Territory Coverages

Type: array

Title: Territory Coverages

The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.

Show Source

• Array of: object salesTerritories-TerritoryCoverage-item-response

{
    "title":"Territory Coverages",
    "type":"array",
    "description":"The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
    }
}

Nested Schema : Territory Business

Type: array

Title: Territory Business

The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.

Show Source

• Array of: object salesTerritories-TerritoryLineOfBusiness-item-response

{
    "title":"Territory Business",
    "type":"array",
    "description":"The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryLineOfBusiness-item-response"
    }
}

Nested Schema : Territory Resources

Type: array

Title: Territory Resources

The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.

Show Source

• Array of: object salesTerritories-TerritoryResource-item-response

{
    "title":"Territory Resources",
    "type":"array",
    "description":"The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryResource-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 : salesTerritories-TerritoryCoverage-item-response

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The identifier for the customer inclusion or exclusion.
• AccountName: string
  Title: Customer Account

  Read Only: true

  Maximum Length: 360

  The name of the customer inclusion.
• AccountTypeCode: string
  Title: Account Type Code

  Maximum Length: 30

  The code for the account type in the territory coverage.
• AddressCity: string
  Title: City

  Maximum Length: 60

  The city of the address dimension in the territory coverage.
• AddressCountry: string
  Title: Country

  Maximum Length: 2

  The country of the address dimension in the territory coverage.
• AddressCounty: string
  Title: County

  Maximum Length: 60

  The county of the address dimension in the territory coverage.
• AddressElementAttribute1: string
  Title: Additional Attribute 1

  Maximum Length: 150

  The additional attribute 1 of the address dimension in the territory coverage.
• AddressElementAttribute2: string
  Title: Additional Attribute 2

  Maximum Length: 150

  The additional attribute 2 of the address dimension in the territory coverage.
• AddressElementAttribute3: string
  Title: Additional Attribute 3

  Maximum Length: 150

  The additional attribute 3 of the address dimension in the territory coverage.
• AddressElementAttribute4: string
  Title: Additional Attribute 4

  Maximum Length: 150

  The additional attribute 4 of the address dimension in the territory coverage.
• AddressElementAttribute5: string
  Title: Additional Attribute 5

  Maximum Length: 150

  The additional attribute 5 of the address dimension in the territory coverage.
• AddressPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address dimension in the territory coverage.
• AddressProvince: string
  Title: Province

  Maximum Length: 60

  The province of the address dimension in the territory coverage.
• AddressState: string
  Title: State

  Maximum Length: 60

  The state of the address dimension in the territory coverage.
• Auxiliary1Code: string
  Title: Auxiliary 1 Code

  Maximum Length: 30

  The auxiliary 1 code in the territory coverage.
• Auxiliary2Code: string
  Title: Auxiliary 2 Code

  Maximum Length: 30

  The auxiliary 2 code in the territory coverage.
• Auxiliary3Code: string
  Title: Auxiliary 3 Code

  Maximum Length: 30

  The auxiliary 3 code in the territory coverage.
• AuxiliaryDimension1: string
  Title: Auxiliary 1

  Read Only: true

  The auxiliary 1 name in the territory coverage.
• AuxiliaryDimension2: string
  Title: Auxiliary 2

  Read Only: true

  The auxiliary 2 name in the territory coverage.
• AuxiliaryDimension3: string
  Title: Auxiliary 3

  Read Only: true

  The auxiliary 3 name in the territory coverage.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  The identifier for the business unit in the territory coverage.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 255

  The name for the business unit in the territory coverage.
• CoverageId: integer (int64)
  Title: Coverage ID

  The unique identifier of the territory coverage rule.
• CoverageNumber: string
  Title: Coverage Number

  Maximum Length: 30

  The public unique identifier of the territory coverage rule.
• CoverageTypeCode: string
  Title: Coverage Type Code

  Maximum Length: 30

  The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the territory coverage was created.
• CustomerSizeCode: string
  Title: Customer Size Code

  Maximum Length: 30

  The code for the customer size in the territory coverage.
• DimensionName: string
  Title: Dimension Name

  Read Only: true

  Maximum Length: 60

  The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.
• Extension1: string
  Title: Extension 1

  Read Only: true

  Maximum Length: 255

  The extension 1 name in the territory coverage.
• Extension10: string
  Title: Extension 10

  Read Only: true

  Maximum Length: 255

  The extension 10 name in the territory coverage.
• Extension10Code: string
  Title: Extension 10 Code

  Maximum Length: 30

  The extension 10 code in the territory coverage.
• Extension1Code: string
  Title: Extension 1 Code

  Maximum Length: 30

  The extension 1 code in the territory coverage.
• Extension2: string
  Title: Extension 2

  Read Only: true

  Maximum Length: 255

  The extension 2 name in the territory coverage.
• Extension2Code: string
  Title: Extension 2 Code

  Maximum Length: 30

  The extension 2 code in the territory coverage.
• Extension3: string
  Title: Extension 3

  Read Only: true

  Maximum Length: 255

  The extension 3 name in the territory coverage.
• Extension3Code: string
  Title: Extension 3 Code

  Maximum Length: 30

  The extension 3 code in the territory coverage.
• Extension4: string
  Title: Extension 4

  Read Only: true

  Maximum Length: 255

  The extension 4 name in the territory coverage.
• Extension4Code: string
  Title: Extension 4 Code

  Maximum Length: 30

  The extension 4 code in the territory coverage.
• Extension5: string
  Title: Extension 5

  Read Only: true

  Maximum Length: 255

  The extension 5 name in the territory coverage.
• Extension5Code: string
  Title: Extension 5 Code

  Maximum Length: 30

  The extension 5 code in the territory coverage.
• Extension6: string
  Title: Extension 6

  Read Only: true

  Maximum Length: 255

  The extension 6 name in the territory coverage.
• Extension6Code: string
  Title: Extension 6 Code

  Maximum Length: 30

  The extension 6 code in the territory coverage.
• Extension7: string
  Title: Extension 7

  Read Only: true

  Maximum Length: 255

  The extension 7 name in the territory coverage.
• Extension7Code: string
  Title: Extension 7 Code

  Maximum Length: 30

  The extension 7 code in the territory coverage.
• Extension8: string
  Title: Extension 8

  Read Only: true

  Maximum Length: 255

  The extension 8 name in the territory coverage.
• Extension8Code: string
  Title: Extension 8 Code

  Maximum Length: 30

  The extension 8 code in the territory coverage.
• Extension9: string
  Title: Extension 9

  Read Only: true

  Maximum Length: 255

  The extension 9 name in the territory coverage.
• Extension9Code: string
  Title: Extension 9 Code

  Maximum Length: 30

  The extension 9 code in the territory coverage.
• GeographyHighId: integer (int64)
  Title: Geography High ID

  The identifier for the higher geography in the range in the territory coverage.
• GeographyHighName: string
  Title: Geography High Name

  The name for the higher geography in the range in the territory coverage.
• GeographyId: integer (int64)
  Title: Geography ID

  The identifier for the geography in the territory coverage.
• GeographyName: string
  Title: Geography

  The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.
• IncludeHierarchyFlag: boolean
  Title: Include Hierarchy

  Maximum Length: 1

  Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
• IndustryCode: string
  Title: Industry Code

  Maximum Length: 30

  The code for the industry in the territory coverage.
• IndustryName: string
  Title: Industry

  Read Only: true

  The name of the industry in the territory coverage.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The identifier for the inventory item in the territory coverage.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The identifier for the inventory organization in the territory coverage.
• ItemName: string
  Title: Item Name

  Read Only: true

  Maximum Length: 240

  The name for the item in the territory coverage.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The number for the item in the territory coverage.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory coverage was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• OrganizationType: string
  Title: Organization Type

  Read Only: true

  The name of the organization type in the territory coverage.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The code for the organization type in the territory coverage.
• OriginalReference: string
  Title: Original Reference

  Maximum Length: 300

  The origin source system reference of the account or contact.
• PartnerId: integer (int64)
  Title: Partner ID

  The identifier of the partner inclusion or exclusion.
• PartnerName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner inclusion.
• PartnerNumber: string
  Title: Partner Number

  Maximum Length: 30

  The public unique identifier of the partner inclusion or exclusion.
• ProductGroupId: integer (int64)
  Title: Product Group ID

  The identifier for the product group in the territory coverage.
• ProductGroupName: string
  Title: Product Group Name

  Read Only: true

  Maximum Length: 250

  The name for the product group in the territory coverage.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  The number for the product group in the territory coverage.
• RegistryId: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the customer inclusion.
• SalesChannelCode: string
  Title: Sales Channel Code

  Maximum Length: 30

  The code for the sales channel in the territory coverage.
• SubSalesChannelCode: string
  Title: Subsales Channel Code

  Maximum Length: 30

  The code for the sub sales channel in the territory coverage.
• TerrDimensionCode: string
  Title: Territory Dimension Code

  Maximum Length: 5

  The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of territory version.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "Extension7":{
            "title":"Extension 7",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 7 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the territory coverage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension8":{
            "title":"Extension 8",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 8 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9":{
            "title":"Extension 9",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 9 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The identifier for the customer inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The identifier for the geography in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Extension1":{
            "title":"Extension 1",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3Code":{
            "title":"Extension 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension2":{
            "title":"Extension 2",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name for the product group in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3":{
            "title":"Extension 3",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubSalesChannelCode":{
            "title":"Subsales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sub sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension4":{
            "title":"Extension 4",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 4 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension5":{
            "title":"Extension 5",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 5 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension6":{
            "title":"Extension 6",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 6 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension1Code":{
            "title":"Extension 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AuxiliaryDimension1":{
            "title":"Auxiliary 1",
            "type":"string",
            "description":"The auxiliary 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Auxiliary1Code"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuxiliaryDimension3":{
            "title":"Auxiliary 3",
            "type":"string",
            "description":"The auxiliary 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuxiliaryDimension2":{
            "title":"Auxiliary 2",
            "type":"string",
            "description":"The auxiliary 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyHighName":{
            "title":"Geography High Name",
            "type":"string",
            "description":"The name for the higher geography in the range in the territory coverage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyHighId"
                ]
            },
            "x-queryable":true
        },
        "Extension4Code":{
            "title":"Extension 4 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 4 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "IndustryName":{
            "title":"Industry",
            "type":"string",
            "description":"The name of the industry in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IndustryCode":{
            "title":"Industry Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the industry in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension5Code":{
            "title":"Extension 5 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 5 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The identifier for the inventory item in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The identifier for the business unit in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The identifier for the inventory organization in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Auxiliary1Code":{
            "title":"Auxiliary 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the customer size in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension6Code":{
            "title":"Extension 6 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 6 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the account type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesChannelCode":{
            "title":"Sales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageNumber":{
            "title":"Coverage Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory coverage rule.",
            "nullable":false,
            "x-queryable":true
        },
        "GeographyHighId":{
            "title":"Geography High ID",
            "type":"integer",
            "description":"The identifier for the higher geography in the range in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 1 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the customer inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 2 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 3 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Territory Dimension Code",
            "maxLength":"5",
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number for the product group in the territory coverage.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Customer Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer inclusion.",
            "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 territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 4 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalReference":{
            "title":"Original Reference",
            "maxLength":"300",
            "type":"string",
            "description":"The origin source system reference of the account or contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 5 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension7Code":{
            "title":"Extension 7 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 7 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the organization type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary3Code":{
            "title":"Auxiliary 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The number for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory coverage rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Extension8Code":{
            "title":"Extension 8 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 8 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9Code":{
            "title":"Extension 9 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 9 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"255",
            "type":"string",
            "description":"The name for the business unit in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary2Code":{
            "title":"Auxiliary 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension10Code":{
            "title":"Extension 10 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 10 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the territory coverage type.\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\nIn case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The identifier for the product group in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "type":"string",
            "description":"The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "type":"string",
            "description":"The name of the organization type in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension10":{
            "title":"Extension 10",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 10 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionName":{
            "title":"Dimension Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the partner inclusion or exclusion.",
            "nullable":false,
            "x-queryable":true
        },
        "Extension2Code":{
            "title":"Extension 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory coverage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salesTerritories-TerritoryLineOfBusiness-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the territory line of business.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the territory line of business was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the territory line of business was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory line of business.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory line of business.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LobCode: string
  Title: Line of Business Code

  Maximum Length: 30

  The code for the line of business.
• Meaning: string
  Title: Line of Business

  Read Only: true

  Maximum Length: 80

  The meaning of the line of business.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.
• TerrLobId: integer (int64)
  Title: Line of Business ID

  The unique identifier of the territory line of business.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the territory line of business was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LobCode":{
            "title":"Line of Business Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the line of business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerrLobId":{
            "title":"Line of Business ID",
            "type":"integer",
            "description":"The unique identifier of the territory line of business.",
            "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"
            }
        },
        "Meaning":{
            "title":"Line of Business",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the territory line of business 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  territory line of business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salesTerritories-TerritoryResource-item-response

Type: object

Show Source

• AdministratorFlag: boolean
  Title: Team Member Administrator

  Maximum Length: 1

  Indicates whether the resource is an administrator of the territory.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the territory team member was created.
• Email: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the resource.
• FunctionCode: string
  Title: Team Member Function

  Maximum Length: 30

  The code for the function of the resource associated with the territory.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory team member was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory team member.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory team member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManageForecastFlag: boolean
  Title: Forecasting Delegate

  Maximum Length: 1

  Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.
• Manager: string
  Read Only: true

  Maximum Length: 360

  The name of the manager.
• OrganizationName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  The name of the organization of the resource.
• OwnerFlag: boolean
  Title: Owner

  Read Only: true

  Indicates whether the team member is the owner.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource from the resource manager.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 360

  The name of the resource associated with the territory.
• ResourceNumber: string
  Title: Resource Registry ID

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the territory resource from the resource manager.
• RoleName: string
  Title: Team Member Role

  Read Only: true

  Maximum Length: 60

  The name of the team member role associated with the resource.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.
• TerrResourceId: integer (int64)
  Title: Territory Resource ID

  The unique identifier of the territory team member.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory team member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource associated with the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the team member is the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Manager":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Team Member Role",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the team member role associated with the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory resource from the resource manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "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"
            }
        },
        "TerrResourceId":{
            "title":"Territory Resource ID",
            "type":"integer",
            "description":"The unique identifier of the territory team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory team member 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 territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

EnabledTypeCodesViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE%2CBindLookupCode%3D{TypeCode}

The list of values for the territory type, such as PRIME or OVERLAY.

The following properties are defined on the LOV link relation:

• Source Attribute: TypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ExtendedResourcePickerViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/resources

The list of values for the territory owner resource. The territory owner is the person responsible for sales in the territory.

The following properties are defined on the LOV link relation:

• Source Attribute: Owner; Target Attribute: ResourceName
• Display Attribute: ResourceName, PrimaryPhoneNumber, EmailAddress, OrganizationName, RoleName, ReportsTo

LookupYesNoViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The list of values to indicate if the forecast for the territory is made at the parent territory level. The valid values are Yes and No.

The following properties are defined on the LOV link relation:

• Source Attribute: ForecastedByParentTerritoryFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

PartnerPickerPVOViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

The list of values for the name of the territory partner. The territory partner identifies the partner organization associated with the territory when the territory type is Partner.

The following properties are defined on the LOV link relation:

• Source Attribute: PartnerName; Target Attribute: PartyName
• Display Attribute: PartyName

TerritoryCoverage

Operation: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage

Parameters:

• UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber

The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.

TerritoryFunctionViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION%2CBindLookupCode%3D{TerritoryFunctionCode}

The list of values for the function of the territory, such as Primary or Sales Support.

The following properties are defined on the LOV link relation:

• Source Attribute: TerritoryFunctionCode; Target Attribute: LookupCode
• Display Attribute: Meaning

TerritoryLineOfBusiness

Operation: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness

Parameters:

• UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber

The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.

TerritoryResource

Operation: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource

Parameters:

• UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber

The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.

ValidForecastParticipationCodeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DORA_MOT_TERR_ENABLE_FCASTING

The list of values for the forecast participation, such as Revenue or Nonrevenue. The territory forecast participation indicates whether the territory is being forecasted, and if yes, whether it participates in revenue forecasting, non-revenue forecasting, or both.

The following properties are defined on the LOV link relation:

• Source Attribute: ForecastParticipationCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ValidRevisionReasonViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DMOT_QUOTA_REASON

The list of values for the user-defined reason for revising the quota, such as Resource added, Dimension changed, and so on. The territory revision reason explains to the quota administrator the reason for revising the quota for the territory.

The following properties are defined on the LOV link relation:

• Source Attribute: RevisionReason; Target Attribute: LookupCode
• Display Attribute: Meaning

ValidStatusCodeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DMOT_TERRITORY_VERSION_STATUS

The list of values for the territory version status, such as DRAFT or FINALIZED.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ValidateCoverageModel

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DMOT_TERR_COVERAGE_MODEL

The list of values to indicate if the dimension of the territory is based on account attributes or partner attributes, such as Customer Centric or Partner Centric.

The following properties are defined on the LOV link relation:

• Source Attribute: CoverageModel; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top