Get a list of Frequency types

GET /api/v1/static/frequencies/{type}

Path parameters

type string Required

Optional parameter. Type parameter is optional and defaults to all options. Valid optional options are [single, recurring].

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  name string
  
  value string
  
  unitCount integer
  
  unit string
  
  annualised_multiplier integer

GET /api/v1/static/frequencies/{type}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/static/frequencies/{"value"=>"", "summary"=>"When the value is omitted"}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "name": "Daily",
      "unit": "day",
      "value": "daily",
      "unitCount": 1,
      "annualised_multiplier": 365
    },
    {
      "name": "Weekly",
      "unit": "week",
      "value": "weekly",
      "unitCount": 1,
      "annualised_multiplier": 52.143
    },
    {
      "name": "Fortnightly",
      "unit": "week",
      "value": "fortnightly",
      "unitCount": 2,
      "annualised_multiplier": 26.0715
    },
    {
      "name": "Four Weekly",
      "unit": "week",
      "value": "four_weekly",
      "unitCount": 4,
      "annualised_multiplier": 13.03575
    },
    {
      "name": "Monthly",
      "unit": "month",
      "value": "monthly",
      "unitCount": 1,
      "annualised_multiplier": 12
    },
    {
      "name": "Bimonthly",
      "unit": "month",
      "value": "bimonthly",
      "unitCount": 2,
      "annualised_multiplier": 6
    },
    {
      "name": "Quarterly",
      "unit": "month",
      "value": "quarterly",
      "unitCount": 3,
      "annualised_multiplier": 4
    },
    {
      "name": "Biannually",
      "unit": "month",
      "value": "biannually",
      "unitCount": 6,
      "annualised_multiplier": 2
    },
    {
      "name": "Annually",
      "unit": "year",
      "value": "annually",
      "unitCount": 1,
      "annualised_multiplier": 1
    }
  ]
}