GET api/v1/Setup/GetBranchesListInCompanyByCompanyId?companyid={companyid}&page={page}&pagelimit={pagelimit}

Home / API / ASP.NET Web API Details

GET api/v1/Setup/GetBranchesListInCompanyByCompanyId?companyid={companyid}&page={page}&pagelimit={pagelimit}

Description

Get Branches Info Inside Company By Company Id

Request Information

Parameters

Name	Description	Additional information
companyid		Define this parameter in the request URI.
page		Define this parameter in the request URI.
pagelimit		Define this parameter in the request URI.

Response Information

List of Branches Information Inside Company by Page Number

Response body formats

application/json, text/json

Sample:

[
  {
    "branchid": 1,
    "companyid": 2,
    "branchname": "sample string 3",
    "companyname": "sample string 4",
    "districtname": "sample string 5",
    "regionname": "sample string 6",
    "contactid": 7,
    "streetaddressid": 8,
    "mailingaddressid": 9,
    "currentperiod": 10,
    "glprefix": "sample string 11",
    "glsuffix": "sample string 12",
    "isbillingcenter": true,
    "isservicecenter": true,
    "utctimestamp": "2025-10-25T03:58:09.2152716+00:00",
    "utclastchanged": "2025-10-25T03:58:09.2152716+00:00",
    "lastchangedby": "sample string 16",
    "licensenumber": "sample string 17",
    "isactive": true,
    "notifyemailmsg": "sample string 19",
    "notifyemailsubject": "sample string 20",
    "utcoffset": 21,
    "defaulttaxtypeid": 22,
    "surchargeaddpayplan": true,
    "surchargecreditgl": 24,
    "surchargetaxable": true,
    "surchargetype": 26,
    "surchargevalue": 27.0,
    "surchangeprintwo": true,
    "surchargetaxtypeid": 29,
    "allowpayment": true,
    "remittancetext1": "sample string 31",
    "remittancetext2": "sample string 32",
    "remittancetext3": "sample string 33",
    "remittancetext4": "sample string 34",
    "remittancetext5": "sample string 35",
    "remittancetext6": "sample string 36",
    "remittancetext7": "sample string 37",
    "termid": 38,
    "faxnumber": "sample string 39",
    "materialpermitnum": "sample string 40",
    "welcomeletterheader": "sample string 41",
    "welcomelettertext": "sample string 42",
    "branchdistrictid": 43,
    "branchregionid": 44,
    "branchsalescenterid": 45,
    "branchcallcenterid": 46,
    "branchadmincenterid": 47,
    "geotaxkey": "sample string 48",
    "allowanceremainderglid": 49,
    "webportalbatchowner": 50,
    "customercode": "sample string 51",
    "ccexpirynotice": 52,
    "prebilldateformat": 53,
    "callagentcontactuserid": 54,
    "defaultsscaroute": 55,
    "alloweftpayment": true,
    "collectionagencyID": 1,
    "collectionagencytype": 64,
    "collagencycustomerid": "sample string 57"
  },
  {
    "branchid": 1,
    "companyid": 2,
    "branchname": "sample string 3",
    "companyname": "sample string 4",
    "districtname": "sample string 5",
    "regionname": "sample string 6",
    "contactid": 7,
    "streetaddressid": 8,
    "mailingaddressid": 9,
    "currentperiod": 10,
    "glprefix": "sample string 11",
    "glsuffix": "sample string 12",
    "isbillingcenter": true,
    "isservicecenter": true,
    "utctimestamp": "2025-10-25T03:58:09.2152716+00:00",
    "utclastchanged": "2025-10-25T03:58:09.2152716+00:00",
    "lastchangedby": "sample string 16",
    "licensenumber": "sample string 17",
    "isactive": true,
    "notifyemailmsg": "sample string 19",
    "notifyemailsubject": "sample string 20",
    "utcoffset": 21,
    "defaulttaxtypeid": 22,
    "surchargeaddpayplan": true,
    "surchargecreditgl": 24,
    "surchargetaxable": true,
    "surchargetype": 26,
    "surchargevalue": 27.0,
    "surchangeprintwo": true,
    "surchargetaxtypeid": 29,
    "allowpayment": true,
    "remittancetext1": "sample string 31",
    "remittancetext2": "sample string 32",
    "remittancetext3": "sample string 33",
    "remittancetext4": "sample string 34",
    "remittancetext5": "sample string 35",
    "remittancetext6": "sample string 36",
    "remittancetext7": "sample string 37",
    "termid": 38,
    "faxnumber": "sample string 39",
    "materialpermitnum": "sample string 40",
    "welcomeletterheader": "sample string 41",
    "welcomelettertext": "sample string 42",
    "branchdistrictid": 43,
    "branchregionid": 44,
    "branchsalescenterid": 45,
    "branchcallcenterid": 46,
    "branchadmincenterid": 47,
    "geotaxkey": "sample string 48",
    "allowanceremainderglid": 49,
    "webportalbatchowner": 50,
    "customercode": "sample string 51",
    "ccexpirynotice": 52,
    "prebilldateformat": 53,
    "callagentcontactuserid": 54,
    "defaultsscaroute": 55,
    "alloweftpayment": true,
    "collectionagencyID": 1,
    "collectionagencytype": 64,
    "collagencycustomerid": "sample string 57"
  }
]

application/xml, text/xml

Sample:

<ArrayOfsetupbranchmodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <setupbranchmodel>
    <allowanceremainderglid>49</allowanceremainderglid>
    <alloweftpayment>true</alloweftpayment>
    <allowpayment>true</allowpayment>
    <branchadmincenterid>47</branchadmincenterid>
    <branchcallcenterid>46</branchcallcenterid>
    <branchdistrictid>43</branchdistrictid>
    <branchid>1</branchid>
    <branchname>sample string 3</branchname>
    <branchregionid>44</branchregionid>
    <branchsalescenterid>45</branchsalescenterid>
    <callagentcontactuserid>54</callagentcontactuserid>
    <ccexpirynotice>52</ccexpirynotice>
    <collagencycustomerid>sample string 57</collagencycustomerid>
    <collectionagencyID>1</collectionagencyID>
    <collectionagencytype>64</collectionagencytype>
    <companyid>2</companyid>
    <companyname>sample string 4</companyname>
    <contactid>7</contactid>
    <currentperiod>10</currentperiod>
    <customercode>sample string 51</customercode>
    <defaultsscaroute>55</defaultsscaroute>
    <defaulttaxtypeid>22</defaulttaxtypeid>
    <districtname>sample string 5</districtname>
    <faxnumber>sample string 39</faxnumber>
    <geotaxkey>sample string 48</geotaxkey>
    <glprefix>sample string 11</glprefix>
    <glsuffix>sample string 12</glsuffix>
    <isactive>true</isactive>
    <isbillingcenter>true</isbillingcenter>
    <isservicecenter>true</isservicecenter>
    <lastchangedby>sample string 16</lastchangedby>
    <licensenumber>sample string 17</licensenumber>
    <mailingaddressid>9</mailingaddressid>
    <materialpermitnum>sample string 40</materialpermitnum>
    <notifyemailmsg>sample string 19</notifyemailmsg>
    <notifyemailsubject>sample string 20</notifyemailsubject>
    <prebilldateformat>53</prebilldateformat>
    <regionname>sample string 6</regionname>
    <remittancetext1>sample string 31</remittancetext1>
    <remittancetext2>sample string 32</remittancetext2>
    <remittancetext3>sample string 33</remittancetext3>
    <remittancetext4>sample string 34</remittancetext4>
    <remittancetext5>sample string 35</remittancetext5>
    <remittancetext6>sample string 36</remittancetext6>
    <remittancetext7>sample string 37</remittancetext7>
    <streetaddressid>8</streetaddressid>
    <surchangeprintwo>true</surchangeprintwo>
    <surchargeaddpayplan>true</surchargeaddpayplan>
    <surchargecreditgl>24</surchargecreditgl>
    <surchargetaxable>true</surchargetaxable>
    <surchargetaxtypeid>29</surchargetaxtypeid>
    <surchargetype>26</surchargetype>
    <surchargevalue>27</surchargevalue>
    <termid>38</termid>
    <utclastchanged>2025-10-25T03:58:09.2152716+00:00</utclastchanged>
    <utcoffset>21</utcoffset>
    <utctimestamp>2025-10-25T03:58:09.2152716+00:00</utctimestamp>
    <webportalbatchowner>50</webportalbatchowner>
    <welcomeletterheader>sample string 41</welcomeletterheader>
    <welcomelettertext>sample string 42</welcomelettertext>
  </setupbranchmodel>
  <setupbranchmodel>
    <allowanceremainderglid>49</allowanceremainderglid>
    <alloweftpayment>true</alloweftpayment>
    <allowpayment>true</allowpayment>
    <branchadmincenterid>47</branchadmincenterid>
    <branchcallcenterid>46</branchcallcenterid>
    <branchdistrictid>43</branchdistrictid>
    <branchid>1</branchid>
    <branchname>sample string 3</branchname>
    <branchregionid>44</branchregionid>
    <branchsalescenterid>45</branchsalescenterid>
    <callagentcontactuserid>54</callagentcontactuserid>
    <ccexpirynotice>52</ccexpirynotice>
    <collagencycustomerid>sample string 57</collagencycustomerid>
    <collectionagencyID>1</collectionagencyID>
    <collectionagencytype>64</collectionagencytype>
    <companyid>2</companyid>
    <companyname>sample string 4</companyname>
    <contactid>7</contactid>
    <currentperiod>10</currentperiod>
    <customercode>sample string 51</customercode>
    <defaultsscaroute>55</defaultsscaroute>
    <defaulttaxtypeid>22</defaulttaxtypeid>
    <districtname>sample string 5</districtname>
    <faxnumber>sample string 39</faxnumber>
    <geotaxkey>sample string 48</geotaxkey>
    <glprefix>sample string 11</glprefix>
    <glsuffix>sample string 12</glsuffix>
    <isactive>true</isactive>
    <isbillingcenter>true</isbillingcenter>
    <isservicecenter>true</isservicecenter>
    <lastchangedby>sample string 16</lastchangedby>
    <licensenumber>sample string 17</licensenumber>
    <mailingaddressid>9</mailingaddressid>
    <materialpermitnum>sample string 40</materialpermitnum>
    <notifyemailmsg>sample string 19</notifyemailmsg>
    <notifyemailsubject>sample string 20</notifyemailsubject>
    <prebilldateformat>53</prebilldateformat>
    <regionname>sample string 6</regionname>
    <remittancetext1>sample string 31</remittancetext1>
    <remittancetext2>sample string 32</remittancetext2>
    <remittancetext3>sample string 33</remittancetext3>
    <remittancetext4>sample string 34</remittancetext4>
    <remittancetext5>sample string 35</remittancetext5>
    <remittancetext6>sample string 36</remittancetext6>
    <remittancetext7>sample string 37</remittancetext7>
    <streetaddressid>8</streetaddressid>
    <surchangeprintwo>true</surchangeprintwo>
    <surchargeaddpayplan>true</surchargeaddpayplan>
    <surchargecreditgl>24</surchargecreditgl>
    <surchargetaxable>true</surchargetaxable>
    <surchargetaxtypeid>29</surchargetaxtypeid>
    <surchargetype>26</surchargetype>
    <surchargevalue>27</surchargevalue>
    <termid>38</termid>
    <utclastchanged>2025-10-25T03:58:09.2152716+00:00</utclastchanged>
    <utcoffset>21</utcoffset>
    <utctimestamp>2025-10-25T03:58:09.2152716+00:00</utctimestamp>
    <webportalbatchowner>50</webportalbatchowner>
    <welcomeletterheader>sample string 41</welcomeletterheader>
    <welcomelettertext>sample string 42</welcomelettertext>
  </setupbranchmodel>
</ArrayOfsetupbranchmodel>