SalesStageSetup allows users to manage the stages of a sales process for opportunities in Maximizer CRM.

Sales Stages are the sequential steps within a sales process that represent key milestones from initial engagement to closing an opportunity. See below some considerations for SalesStageSetup:

The SalesStageSetup object consists of an autogenerated key and four main fields:
- ProcessSetupKey: The key of the Sales Process Setup this stage belongs to.\
- Description: The name of the stage.\
- TargetAge: The expected number of days for activities in this stage.\
- ProbabilityClose: The likelihood of a successful outcome at this stage.

MetaData

Read SalesStageSetup metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/SalesStageSetup"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read SalesStageSetup metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "Sortable": 1,
                "Nullable": 1,
                "Assignable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "HasOption": 1,
                "DisplayValue": 1,
                "Inactive": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/SalesStageSetup"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

SalesStageSetup CRUD

Create - SalesStageSetup

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "SalesStageSetup": {
        "Data": {
            "Key": null, // Will be generated automatically
            "SalesProcessSetupKey": "U2FsZXNQcm9jZXNzCTI1MDEwMTAwMDAwMDA3NDI1OTI2MTBHCTA=", // Mandatory
            "Description": "First contact", // Mandatory
            // Likelihood that user expects a successful outcome for the opportunity, given that it has reached the specified stage.
            "ProbabilityClose": 10,
            // Number of days that user expect the activities in that stage to take.
            "TargetAge": 5
        }
    }
}

Read - SalesStageSetup

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "SalesStageSetup": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Description": 1,
                "SalesProcessSetupKey": 1,
                "TargetAge": 1,
                "ProbabilityClose": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

Update - SalesStageSetup

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesStageSetup": {
        "Data": {
            "Key": "U2FsZXNQcm9jZXNzU3RhZ2VTZXR1cAkyNTAxMDIwMDAwMDAwOTE0MTI1NDYwRwkw", // Mandatory
            "SalesProcessSetupKey": "U2FsZXNQcm9jZXNzCURFRkFVTFQJMA==",
            "Description": "Sales Stage updated",
            "ProbabilityClose": 35,
            "TargetAge": 20
        }
    }
}

Delete - SalesStageSetup

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesStageSetup": {
        "Data": {
            "Key": "U2FsZXNQcm9jZXNzU3RhZ2VTZXR1cAkyNTAxMDIwMDAwMDAwOTE0MTI1NDYwRwkw" // Mandatory
        }
    }
}