Home / API / ASP.NET Web API Details

GET api/v1/Account/GetAccountByAccountNum?accountnum={accountnum}

Description

Get Account Info By Account Number

Request Information

Parameters

NameDescriptionAdditional information
accountnum
Account Number

Define this parameter in the request URI.

Response Information

Account Information

Response body formats

application/json, text/json

Sample:
{
  "accountid": 1,
  "companyid": 2,
  "accountnum": "sample string 3",
  "billingaddressid": 4,
  "primarycontactid": 5,
  "billingcenterid": 6,
  "languageid": 7,
  "localeid": 8,
  "sendinvoice": true,
  "emailinvoice": true,
  "sendstatement": true,
  "emailstatement": true,
  "instructions": "sample string 13",
  "utctimestamp": "2025-02-23T06:05:46.732485+00:00",
  "utclastchanged": "2025-02-23T06:05:46.732485+00:00",
  "lastchangedby": "sample string 15",
  "laststatementdate": "2025-02-23T06:05:46.732485+00:00",
  "mysearch": "sample string 16",
  "donotmarket": true,
  "financialhold": true,
  "senttocollections": true,
  "allowcwp": true,
  "allowautobill": 21,
  "financialholdignore": true,
  "surchargeexempt": true,
  "exportrenewal": true,
  "hidebalance": true,
  "nopriceincrease": true,
  "nofincharge": true,
  "primarynote": "sample string 28",
  "isactive": 29,
  "termid": 30,
  "stmprintgroupid": 31,
  "hidecollection": true,
  "donotbillforfuturesvc": true,
  "rfcnum": "sample string 34",
  "senttofinancing": true,
  "branchlocalbilling": true,
  "masteraccountid": 37,
  "taxidentificationnum": "sample string 38",
  "financedept": "sample string 39",
  "masteraccountsubid": 40,
  "jdeaccountid": 41,
  "seniorcitizen": true,
  "agencycodeid": 43,
  "paperless": 44,
  "originalbilltoreferencenumber": "sample string 45",
  "focuscustid": 46,
  "focuscuslocno": 47,
  "verificationcode": "bc5d26fa-1555-432d-b09c-107538691d7d",
  "portaloptout": true,
  "portalnoticesent": 50,
  "correspondencemail": true,
  "marketingmail": true,
  "notificationsmail": true,
  "accounttype": 54,
  "mainaccountid": 55,
  "senttocollectionsdate": "2025-02-23T06:05:46.7335207+00:00",
  "discounttypeid": 56,
  "registrationnum": "sample string 57",
  "loginattempt": 1,
  "lastloginattemp": "2025-02-23T06:05:46.7340409+00:00",
  "emailrenewal": true,
  "mailrenewal": true,
  "lastchangepaperless": "sample string 60",
  "orkinstatement": true,
  "orkinstatementdetails": true,
  "EnableLoginDescription": true,
  "AcuntAlertMessage": "sample string 63",
  "AccountAlertMessage": "sample string 64",
  "barterid": 65,
  "allowyia": true,
  "convbranchid": 67,
  "laststatementemaildate": "2025-02-23T06:05:46.7340409+00:00",
  "signatureobtained": true,
  "usewebportallogins": true,
  "seniordiscounttypeid": 70,
  "UniqueId": "e9284f77-da27-46ca-81c8-4f5170628562",
  "PymAccountId": "ab8cb568-360e-4bcb-8d98-2ebff1aebe1d",
  "secondarynote": "sample string 72",
  "sentarmcollectiondate": "2025-02-23T06:05:46.7345608+00:00",
  "sentarmcollection": true,
  "udfdynamicid": "sample string 73"
}

application/xml, text/xml

Sample:
<accountmodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <AccountAlertMessage>sample string 64</AccountAlertMessage>
  <AcuntAlertMessage>sample string 63</AcuntAlertMessage>
  <EnableLoginDescription>true</EnableLoginDescription>
  <PymAccountId>ab8cb568-360e-4bcb-8d98-2ebff1aebe1d</PymAccountId>
  <UniqueId>e9284f77-da27-46ca-81c8-4f5170628562</UniqueId>
  <accountid>1</accountid>
  <accountnum>sample string 3</accountnum>
  <accounttype>54</accounttype>
  <agencycodeid>43</agencycodeid>
  <allowautobill>21</allowautobill>
  <allowcwp>true</allowcwp>
  <allowyia>true</allowyia>
  <barterid>65</barterid>
  <billingaddressid>4</billingaddressid>
  <billingcenterid>6</billingcenterid>
  <branchlocalbilling>true</branchlocalbilling>
  <companyid>2</companyid>
  <convbranchid>67</convbranchid>
  <correspondencemail>true</correspondencemail>
  <discounttypeid>56</discounttypeid>
  <donotbillforfuturesvc>true</donotbillforfuturesvc>
  <donotmarket>true</donotmarket>
  <emailinvoice>true</emailinvoice>
  <emailrenewal>true</emailrenewal>
  <emailstatement>true</emailstatement>
  <exportrenewal>true</exportrenewal>
  <financedept>sample string 39</financedept>
  <financialhold>true</financialhold>
  <financialholdignore>true</financialholdignore>
  <focuscuslocno>47</focuscuslocno>
  <focuscustid>46</focuscustid>
  <hidebalance>true</hidebalance>
  <hidecollection>true</hidecollection>
  <instructions>sample string 13</instructions>
  <isactive>29</isactive>
  <jdeaccountid>41</jdeaccountid>
  <languageid>7</languageid>
  <lastchangedby>sample string 15</lastchangedby>
  <lastchangepaperless>sample string 60</lastchangepaperless>
  <lastloginattemp>2025-02-23T06:05:46.7340409+00:00</lastloginattemp>
  <laststatementdate>2025-02-23T06:05:46.732485+00:00</laststatementdate>
  <laststatementemaildate>2025-02-23T06:05:46.7340409+00:00</laststatementemaildate>
  <localeid>8</localeid>
  <loginattempt>1</loginattempt>
  <mailrenewal>true</mailrenewal>
  <mainaccountid>55</mainaccountid>
  <marketingmail>true</marketingmail>
  <masteraccountid>37</masteraccountid>
  <masteraccountsubid>40</masteraccountsubid>
  <mysearch>sample string 16</mysearch>
  <nofincharge>true</nofincharge>
  <nopriceincrease>true</nopriceincrease>
  <notificationsmail>true</notificationsmail>
  <originalbilltoreferencenumber>sample string 45</originalbilltoreferencenumber>
  <orkinstatement>true</orkinstatement>
  <orkinstatementdetails>true</orkinstatementdetails>
  <paperless>44</paperless>
  <portalnoticesent>50</portalnoticesent>
  <portaloptout>true</portaloptout>
  <primarycontactid>5</primarycontactid>
  <primarynote>sample string 28</primarynote>
  <registrationnum>sample string 57</registrationnum>
  <rfcnum>sample string 34</rfcnum>
  <secondarynote>sample string 72</secondarynote>
  <sendinvoice>true</sendinvoice>
  <sendstatement>true</sendstatement>
  <seniorcitizen>true</seniorcitizen>
  <seniordiscounttypeid>70</seniordiscounttypeid>
  <sentarmcollection>true</sentarmcollection>
  <sentarmcollectiondate>2025-02-23T06:05:46.7345608+00:00</sentarmcollectiondate>
  <senttocollections>true</senttocollections>
  <senttocollectionsdate>2025-02-23T06:05:46.7335207+00:00</senttocollectionsdate>
  <senttofinancing>true</senttofinancing>
  <signatureobtained>true</signatureobtained>
  <stmprintgroupid>31</stmprintgroupid>
  <surchargeexempt>true</surchargeexempt>
  <taxidentificationnum>sample string 38</taxidentificationnum>
  <termid>30</termid>
  <udfdynamicid>sample string 73</udfdynamicid>
  <usewebportallogins>true</usewebportallogins>
  <utclastchanged>2025-02-23T06:05:46.732485+00:00</utclastchanged>
  <utctimestamp>2025-02-23T06:05:46.732485+00:00</utctimestamp>
  <verificationcode>bc5d26fa-1555-432d-b09c-107538691d7d</verificationcode>
</accountmodel>