Jump to

• Request
• Response

Get all sales methods

get

/crmRestApi/resources/11.13.18.05/salesMethodsLOV

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AltKey: Finds a sales method record with an alternate key.
    Finder Variables:
    • SalesMethodNumber; string; A GUID-based column that has been created to be an alternate key for data migration.
  • PrimaryKey: Finds sales methods records with the specified primary key.
    Finder Variables:
    • SalesMethodId; integer; The identifier for sales method to which the sales stage belongs.
  • SalesMethodByBUFinder: Finds sales methods records by set identifier and business unit identifier.
    Finder Variables:
    • BindBUId; integer; The unique identifier of a business unit.
    • BindOpportunityType; string; Display the different types of opportunity such as new, renewal and expansion.
    • BindSetId; string; The sales method lookup value's reference data set identifier.
  • SalesMethodFinder: Finds active sales methods records by set identifier.
    Finder Variables:
    • BindOpportunityType; string; Display the different types of opportunity such as new, renewal, and expansion.
    • BindSetId; string; The sales method lookup value's reference data set identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BUId; integer; The unique identifier for a business unit.
  • DefaultSalesMethodFlag; boolean; Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.
  • DefaultSalesMethodForExpansionFlag; boolean; The default sales method for an expansion opportunity.
  • DefaultSalesMethodForRenewalFlag; boolean; The default sales method for a renewal opportunity.
  • DeletedFlag; boolean; Indicates whether the sales method has been deleted.
  • DescriptionText; string; The description of the sales method.
  • Name; string; The name of the sales method.
  • OpportunityType; string; Indicates if the type of opportunity is New, Renewal, or an Expansion.
  • OptyCloseWindow; integer; The sales method opportunity close window.
  • RevnLineSetEnabledFlag; boolean; Indicates whether revenue line set will be enabled when using this sales method.
  • SalesMethodId; integer; The unique identifier of a sales method.
  • SalesMethodNumber; string; A GUID-based column that has been created to be an alternate key for data migration.
  • SetName; string; The sales method reference data set identifier name.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : salesMethodsLOV

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesMethodsLOV-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object salesMethodsLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesMethodsLOV-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : salesMethodsLOV-item-response

Type: object

Show Source

• BUId: integer
  Read Only: true

  The unique identifier for a business unit.
• ConflictId: integer (int64)
  Default Value: 0

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the record was created.
• DefaultSalesMethodFlag: boolean
  Title: Default Sales Method

  Read Only: true

  Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.
• DefaultSalesMethodForExpansionFlag: boolean
  Title: Default Sales Method for Expansion

  Read Only: true

  The default sales method for an expansion opportunity.
• DefaultSalesMethodForRenewalFlag: boolean
  Title: Default Sales Method for Renewal

  Read Only: true

  The default sales method for a renewal opportunity.
• DeletedFlag: boolean
  Title: Disabled

  Maximum Length: 2

  Default Value: false

  Indicates whether the sales method has been deleted.
• DescriptionText: string
  Title: Description

  Maximum Length: 255

  The description of the sales method.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time the last update was made.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The details of user who made the last update.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  Maximum Length: 50

  The name of the sales method.
• OpportunityType: string
  Title: Opportunity Type

  Maximum Length: 30

  Indicates if the type of opportunity is New, Renewal, or an Expansion.
• OptyCloseWindow: integer (int64)
  Title: Close Window

  The sales method opportunity close window.
• RevnLineSetEnabledFlag: boolean
  Title: Revenue Line-Set Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether revenue line set will be enabled when using this sales method.
• SalesMethodId: integer (int64)
  The unique identifier of a sales method.
• SalesMethodNumber: string
  Title: Sales Method Number

  Maximum Length: 64

  A GUID-based column that has been created to be an alternate key for data migration.
• SetIdP: integer (int64)
  Read Only: true

  The sales method lookup value's reference data set identifier.
• SetName: string
  Title: Set

  Read Only: true

  Maximum Length: 80

  The sales method reference data set identifier name.
• UserLastUpdateDate: string (date-time)
  The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as a different mobile database, or the server.

{
    "type":"object",
    "properties":{
        "BUId":{
            "type":"integer",
            "description":"The unique identifier for a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultSalesMethodFlag":{
            "title":"Default Sales Method",
            "type":"boolean",
            "description":"Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultSalesMethodForExpansionFlag":{
            "title":"Default Sales Method for Expansion",
            "type":"boolean",
            "description":"The default sales method for an expansion opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultSalesMethodForRenewalFlag":{
            "title":"Default Sales Method for Renewal",
            "type":"boolean",
            "description":"The default sales method for a renewal opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Disabled",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether the sales method has been deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the last update was made.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The details of user who made the last update.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityType":{
            "title":"Opportunity Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the type of opportunity is New, Renewal, or an Expansion.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyCloseWindow":{
            "title":"Close Window",
            "type":"integer",
            "description":"The sales method opportunity close window.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "RevnLineSetEnabledFlag":{
            "title":"Revenue Line-Set Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether revenue line set will be enabled when using this sales method.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SalesMethodId":{
            "type":"integer",
            "description":"The unique identifier of a sales method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesMethodNumber":{
            "title":"Sales Method Number",
            "maxLength":64,
            "type":"string",
            "description":"A GUID-based column that has been created to be an alternate key for data migration.",
            "nullable":false,
            "x-queryable":true
        },
        "SetIdP":{
            "type":"integer",
            "description":"The sales method lookup value's reference data set identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SetName":{
            "title":"Set",
            "maxLength":80,
            "type":"string",
            "description":"The sales method reference data set identifier name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as a different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top