SalesProcessSetup allows users to manage the different sales processes available for opportunities in Maximizer CRM.

A sales process is a predefined sequence of stages that guides users through managing and closing opportunities. See below some considerations for SalesProcessSetup:

The SalesProcessSetup object is composed only by a key (autogenerated) and a description for the Sales Process.\
The stages for every Sales Process can be managed using the object SalesStageSetup.

MetaData

Read SalesProcessSetup metadata (simple)

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

Read SalesProcessSetup 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": "/SalesProcessSetup"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

SalesProcessSetup CRUD

Create - SalesProcessSetup

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "SalesProcessSetup": {
        "Data": {
            "Key": null, // Will be generated automatically
            "Description": "Sales process for opportunities" // Mandatory
        }
    }
}

Read - SalesProcessSetup

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

Update - SalesProcessSetup

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesProcessSetup": {
        "Data": {
            "Key": "U2FsZXNQcm9jZXNzCTI1MDEwMTAwMDAwMDA3NDI1OTI2MTBHCTA=", // Mandatory
            "Description": "Description Updated"
        }
    }
}

Delete - SalesProcessSetup

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "SalesProcessSetup": {
        "Data": {
            "Key": "U2FsZXNQcm9jZXNzCTIzMDMwMjAwMDA1MTMxOTcxNjUzMUcJMA==" // Mandatory
        }
    }
}