Settings

Currency

Currency is used in many metrics, and requires it to be set. Values are choosen within the list of Currency Code : https://www.iban.com/currency-codes

Set Currency

POST /settings/currencies
request
{
    "currency" : "EUR"
}
response
{
    "message" : "Currency set.",
    "success" : true,
    "statusCode" : 200
}

Get Currency

GET /settings/currencies
response
{
    "message" : "Currency set.",
    "success" : true,
    "statusCode" : 200,
    "currency" : "EUR"
}

Periods

Period represent the unit of targeting/reporting traditionnally use in your sales environment.

You may decide to run your sales team motivation, targets, pace at different cadence.

Period
value
e.g

weekly

w1 to w52

w3 is 3rd week of Jan

monthly

m1 to m12

m4 is april

quarterly

Q1 to Q4

Q2 ranges from April 1st to June 31st

Depending on your willing to drive your sales team at your own pace, based on your business and sales management behavior, you will set the period accordingly.

Periods are used in :

  • Quota/Target Setting

  • Pipeline Metrics

  • Trending for both pipeline and member

  • Reviews and Forecasting cadences

Set Periods

PUT /settings/periods
request
{
    "period" : "monthly"
}
response
{
    "message" : "Period set.",
    "success" : true,
    "statusCode" : 200
}

Targets

Quartz enables to define team members targets (a.k.a quotas) for each period, so it can build pipeline to cover and other volume metrics.

This requires the period to be defined. Targets are passed through the payload request as a array in JSON, with one element per period timely ordered. (e.g 4 elements if choosen period is quarterly, or 12 if the choosen period is monthly). Targets are expressed in currency.

Set Member Targets

POST /settings/targets
request
{
    "member_id" : "m-32frp-54ghZ-Ed5S3-T9jik",
    "targets" : [200000, 320000, 450000, 700000] // 200000 for Q1, 320000 for Q2,.. 
}
response
{
    "message" : "Targets set.",
    "success" : true,
    "statusCode" : 200
}

Get Member Targets

GET /settings/targets
request
{
    "member_id" : "m-32frp-54ghZ-Ed5S3-T9jik",
    "targets" : [200000, 320000, 450000, 700000] // 200000 for Q1, 320000 for Q2,..
}

Last updated

Was this helpful?