Home / API Documentation

Get Program Info By Program Type Id

Method: GET api/v1/Setup/GetProgramByProgramTypeId?programtypeid={programtypeid}

Response Format:

application/json

Required Parameters Description Additional information
programtypeid
Program Type Id

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        {
  "programtypeid": 1,
  "companyid": 2,
  "isactive": true,
  "utctimestamp": "2025-04-20T02:43:04.4843103+00:00",
  "utclastchanged": "2025-04-20T02:43:04.4843103+00:00",
  "lastchangedby": "sample string 5",
  "scheduletype": 6,
  "glcashaccount": 7,
  "reportcategory": 8,
  "timeentry": 64,
  "isrenewal": 10,
  "renewalinterval": 11,
  "renewalterm": 12,
  "renewalcreateinvoice": 13,
  "renewalinspectinactive": 14,
  "prepaydiscount": 15.0,
  "prepaydiscounttypeid": 16,
  "boosterinterval": 17,
  "glrenewaldebit": 18,
  "programcategory": 19,
  "billingmonthcount": 20,
  "targetrequired": true,
  "servicetypeid": 22,
  "hidesvcamount": true,
  "hasguarantee": true,
  "reportcategoryid2": 25,
  "reportcategoryid3": 26,
  "reportcategoryid4": 27,
  "reportcategoryid5": 28,
  "useallowances": true,
  "eligibletobereversed": 30,
  "month1revenue": 31.1,
  "month2revenue": 32.1,
  "usedeferredrevenue": true,
  "deferredrevenueglid": 34,
  "deferredrevenueinterval": 35,
  "month10revenue": 36.1,
  "month11revenue": 37.1,
  "month3revenue": 38.1,
  "month4revenue": 39.1,
  "month5revenue": 40.1,
  "month6revenue": 41.1,
  "month7revenue": 42.1,
  "month8revenue": 43.1,
  "month9revenue": 44.1,
  "glrenewalcredit": 45,
  "defaultcomminterval": 46,
  "defaultestimatetype": 47,
  "programservice": 48,
  "programfrecuency": 49,
  "deferredrevenuedurationmethod": 50,
  "deferredrevenueduration": 51,
  "deferredrevenuedelay": 52,
  "deferredrevenuewarrantytypes": "sample string 53",
  "programtype": 54,
  "servicetype": 55,
  "taxgroupid": 56,
  "autopayeligible": true,
  "autopayinterval": 58,
  "portalrenewaldiscount": true,
  "payincreaseformid": "sample string 60",
  "prepayformid": "sample string 61",
  "lowdollarformid": "sample string 62",
  "lowdollarformid2": "sample string 63",
  "billinginterval": 64,
  "renewalstartafter": 65,
  "islinktopayplan": true,
  "showonmobiledevice": true,
  "iscallagentitem": true,
  "isproratedprogram": true,
  "feb_multiplier": 70,
  "aug_multiplier": 71,
  "dec_multiplier": 72,
  "sep_multiplier": 73,
  "permanentrenewalmonth": 74,
  "oct_multiplier": 75,
  "apr_multiplier": 76,
  "nov_multiplier": 77,
  "jul_multiplier": 78,
  "jun_multiplier": 79,
  "jan_multiplier": 80,
  "mar_multiplier": 81,
  "may_multiplier": 82,
  "renewalemailmsg": "sample string 83",
  "ismultirenewal": true,
  "outstandingrenewal": true,
  "programname": {
    "programtypeid": 1,
    "programname": "sample string 2",
    "utctimestamp": "2025-04-20T02:43:04.4843103+00:00",
    "utclastchanged": "2025-04-20T02:43:04.4843103+00:00",
    "lastchangedby": "sample string 3",
    "pialetternote": "sample string 4"
  }
};