Home / API Documentation

Get Branch Info By Branch Id

Method: GET api/v1/Setup/GetBranchByBranchId?branchid={branchid}

Response Format:

application/json

Required Parameters Description Additional information
branchid
Branch Id

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        {
  "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-02-23T06:27:59.271029+00:00",
  "utclastchanged": "2025-02-23T06:27:59.271029+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"
};