Home / API Documentation

Get Program List By Company

Method: GET api/v1/Program/GetProgramsListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}

Response Format:

application/json

Required Parameters Description Additional information
companyid
int

Define this parameter in the request URI.

page
int, default value 1

Define this parameter in the request URI.

pagelimit
int, default value 500

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        [
  {
    "programtypeid": 1,
    "companyid": 2,
    "isactive": true,
    "utctimestamp": "2025-02-23T06:05:13.3688171+00:00",
    "utclastchanged": "2025-02-23T06:05:13.3688171+00:00",
    "lastchangedby": "sample string 4",
    "scheduletype": 5,
    "glcashaccount": 6,
    "reportcategory": 7,
    "timeentry": 8,
    "isrenewal": 9,
    "renewalinterval": 10,
    "renewalterm": 11,
    "renewalcreateinvoice": 12,
    "renewalinspectinactive": 13,
    "prepaydiscount": 14.0,
    "prepaydiscounttypeid": 15,
    "boosterinterval": 16,
    "glrenewaldebit": 17,
    "programcategory": 18,
    "billingmonthcount": 19,
    "targetrequired": true,
    "servicetypeid": 21,
    "hidesvcamount": true,
    "hasguarantee": true,
    "reportcategoryid2": 24,
    "reportcategoryid3": 25,
    "reportcategoryid4": 26,
    "reportcategoryid5": 27,
    "useallowances": true,
    "eligibletobereversed": 29,
    "month1revenue": 30.1,
    "month2revenue": 31.1,
    "usedeferredrevenue": true,
    "deferredrevenueglid": 33,
    "deferredrevenueinterval": 34,
    "month10revenue": 35.1,
    "month11revenue": 36.1,
    "month3revenue": 37.1,
    "month4revenue": 38.1,
    "month5revenue": 39.1,
    "month6revenue": 40.1,
    "month7revenue": 41.1,
    "month8revenue": 42.1,
    "month9revenue": 43.1,
    "glrenewalcredit": 44,
    "defaultcomminterval": 45,
    "defaultestimatetype": 46,
    "programservice": 47,
    "programfrecuency": 48,
    "deferredrevenuedurationmethod": 49,
    "deferredrevenueduration": 50,
    "deferredrevenuedelay": 51,
    "deferredrevenuewarrantytypes": "sample string 52",
    "programtype": 53,
    "servicetype": 54,
    "taxgroupid": 55,
    "autopayeligible": true,
    "autopayinterval": 57,
    "portalrenewaldiscount": true,
    "payincreaseformid": "sample string 59",
    "prepayformid": "sample string 60",
    "lowdollarformid": "sample string 61",
    "lowdollarformid2": "sample string 62",
    "billinginterval": 63,
    "renewalstartafter": 64,
    "islinktopayplan": true,
    "showonmobiledevice": true,
    "iscallagentitem": true,
    "isproratedprogram": true,
    "feb_multiplier": 69,
    "aug_multiplier": 70,
    "dec_multiplier": 71,
    "sep_multiplier": 72,
    "permanentrenewalmonth": 73,
    "oct_multiplier": 74,
    "apr_multiplier": 75,
    "nov_multiplier": 76,
    "jul_multiplier": 77,
    "jun_multiplier": 78,
    "jan_multiplier": 79,
    "mar_multiplier": 80,
    "may_multiplier": 81,
    "renewalemailmsg": "sample string 82",
    "ismultirenewal": true,
    "outstandingrenewal": true,
    "measurementgroupid": 85,
    "uselfpricechart": true,
    "AvailableAsEstimateOrProposal": true,
    "usestatementinformation": true,
    "defaultrouteid": 89,
    "defaultrenewalfee": 90.0,
    "programname": {
      "programtypeid": 1,
      "programname": "sample string 2",
      "utctimestamp": "2025-02-23T06:05:13.3719727+00:00",
      "utclastchanged": "2025-02-23T06:05:13.3719727+00:00",
      "lastchangedby": "sample string 3",
      "pialetternote": "sample string 4"
    }
  },
  {
    "programtypeid": 1,
    "companyid": 2,
    "isactive": true,
    "utctimestamp": "2025-02-23T06:05:13.3688171+00:00",
    "utclastchanged": "2025-02-23T06:05:13.3688171+00:00",
    "lastchangedby": "sample string 4",
    "scheduletype": 5,
    "glcashaccount": 6,
    "reportcategory": 7,
    "timeentry": 8,
    "isrenewal": 9,
    "renewalinterval": 10,
    "renewalterm": 11,
    "renewalcreateinvoice": 12,
    "renewalinspectinactive": 13,
    "prepaydiscount": 14.0,
    "prepaydiscounttypeid": 15,
    "boosterinterval": 16,
    "glrenewaldebit": 17,
    "programcategory": 18,
    "billingmonthcount": 19,
    "targetrequired": true,
    "servicetypeid": 21,
    "hidesvcamount": true,
    "hasguarantee": true,
    "reportcategoryid2": 24,
    "reportcategoryid3": 25,
    "reportcategoryid4": 26,
    "reportcategoryid5": 27,
    "useallowances": true,
    "eligibletobereversed": 29,
    "month1revenue": 30.1,
    "month2revenue": 31.1,
    "usedeferredrevenue": true,
    "deferredrevenueglid": 33,
    "deferredrevenueinterval": 34,
    "month10revenue": 35.1,
    "month11revenue": 36.1,
    "month3revenue": 37.1,
    "month4revenue": 38.1,
    "month5revenue": 39.1,
    "month6revenue": 40.1,
    "month7revenue": 41.1,
    "month8revenue": 42.1,
    "month9revenue": 43.1,
    "glrenewalcredit": 44,
    "defaultcomminterval": 45,
    "defaultestimatetype": 46,
    "programservice": 47,
    "programfrecuency": 48,
    "deferredrevenuedurationmethod": 49,
    "deferredrevenueduration": 50,
    "deferredrevenuedelay": 51,
    "deferredrevenuewarrantytypes": "sample string 52",
    "programtype": 53,
    "servicetype": 54,
    "taxgroupid": 55,
    "autopayeligible": true,
    "autopayinterval": 57,
    "portalrenewaldiscount": true,
    "payincreaseformid": "sample string 59",
    "prepayformid": "sample string 60",
    "lowdollarformid": "sample string 61",
    "lowdollarformid2": "sample string 62",
    "billinginterval": 63,
    "renewalstartafter": 64,
    "islinktopayplan": true,
    "showonmobiledevice": true,
    "iscallagentitem": true,
    "isproratedprogram": true,
    "feb_multiplier": 69,
    "aug_multiplier": 70,
    "dec_multiplier": 71,
    "sep_multiplier": 72,
    "permanentrenewalmonth": 73,
    "oct_multiplier": 74,
    "apr_multiplier": 75,
    "nov_multiplier": 76,
    "jul_multiplier": 77,
    "jun_multiplier": 78,
    "jan_multiplier": 79,
    "mar_multiplier": 80,
    "may_multiplier": 81,
    "renewalemailmsg": "sample string 82",
    "ismultirenewal": true,
    "outstandingrenewal": true,
    "measurementgroupid": 85,
    "uselfpricechart": true,
    "AvailableAsEstimateOrProposal": true,
    "usestatementinformation": true,
    "defaultrouteid": 89,
    "defaultrenewalfee": 90.0,
    "programname": {
      "programtypeid": 1,
      "programname": "sample string 2",
      "utctimestamp": "2025-02-23T06:05:13.3719727+00:00",
      "utclastchanged": "2025-02-23T06:05:13.3719727+00:00",
      "lastchangedby": "sample string 3",
      "pialetternote": "sample string 4"
    }
  }
];