POST CustomerList/GetCustomerList

Returns a list of customers selected with CustomerGUIDs or CustomerIDs and all customers that match a Location, Salesperson, Classification, and First Name or Last Name.

Request Information

URI Parameters

Body Parameters

A JSON string that includes the list of CustomerGUID, CustomerID, Location, Salesperson, Classification, or Name combinations

ClsCustomerListRequest
NameDescriptionTypeAdditional Information
CustomerListRequestItems

Collection of ClsCustomerListRequestItem
ClassificationTypeFilter

ClassificationFilterTypeEnum
LastModifiedOnOrAfterUtc

Filter the list of Customers to those changed on or after the supplied UTC date and time. (optional)

 date
LastModifiedOnOrBeforeUtc

Filter the list of Customers to those changed on or before the supplied UTC date and time. (optional)

 date
ActiveCustomerFilter

Filters the list of Customers by their Active/Inactive status. Use "Active", "Inactive", or "All" (optional, default is "Active")

 string
LastModifiedExcludingBalancesOnOrAfterUTC

Filter the list of Customers to those changed on or after the supplied UTC date and time (excluding balance changes). (optional)

 date
LastModifiedExcludingBalancesOnOrBeforeUTC

Filter the list of Customers to those changed on or before the supplied UTC date and time (excluding balance changes). (optional)

 date

Request Formats

application/json, text/json

Sample: 
{
  "CustomerListRequestItems": [
    {
      "CustomerGUID": "sample string 1",
      "CustomerID": "sample string 2",
      "Classification": "sample string 3",
      "xref1": "sample string 4",
      "xref2": "sample string 5",
      "xref3": "sample string 6",
      "xref4": "sample string 7",
      "Location": "sample string 8",
      "Salesperson": "sample string 9",
      "Name": "sample string 10",
      "NameMatchType": "sample string 11"
    },
    {
      "CustomerGUID": "sample string 1",
      "CustomerID": "sample string 2",
      "Classification": "sample string 3",
      "xref1": "sample string 4",
      "xref2": "sample string 5",
      "xref3": "sample string 6",
      "xref4": "sample string 7",
      "Location": "sample string 8",
      "Salesperson": "sample string 9",
      "Name": "sample string 10",
      "NameMatchType": "sample string 11"
    }
  ],
  "ClassificationTypeFilter": 0,
  "LastModifiedOnOrAfterUtc": "2024-11-21T09:35:36.7038068+00:00",
  "LastModifiedOnOrBeforeUtc": "2024-11-21T09:35:36.7038068+00:00",
  "ActiveCustomerFilter": "sample string 1",
  "LastModifiedExcludingBalancesOnOrAfterUTC": "2024-11-21T09:35:36.7038068+00:00",
  "LastModifiedExcludingBalancesOnOrBeforeUTC": "2024-11-21T09:35:36.7038068+00:00"
}

application/xml, text/xml

Sample: 
<CustomerListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
  <ActiveCustomerFilter>sample string 1</ActiveCustomerFilter>
  <ClassificationTypeFilter>NoFilter</ClassificationTypeFilter>
  <CustomerListRequestItems>
    <CustomerListRequestItem>
      <Classification>sample string 3</Classification>
      <CustomerGUID>sample string 1</CustomerGUID>
      <CustomerID>sample string 2</CustomerID>
      <Location>sample string 8</Location>
      <Name>sample string 10</Name>
      <NameMatchType>sample string 11</NameMatchType>
      <Salesperson>sample string 9</Salesperson>
      <xref1>sample string 4</xref1>
      <xref2>sample string 5</xref2>
      <xref3>sample string 6</xref3>
      <xref4>sample string 7</xref4>
    </CustomerListRequestItem>
    <CustomerListRequestItem>
      <Classification>sample string 3</Classification>
      <CustomerGUID>sample string 1</CustomerGUID>
      <CustomerID>sample string 2</CustomerID>
      <Location>sample string 8</Location>
      <Name>sample string 10</Name>
      <NameMatchType>sample string 11</NameMatchType>
      <Salesperson>sample string 9</Salesperson>
      <xref1>sample string 4</xref1>
      <xref2>sample string 5</xref2>
      <xref3>sample string 6</xref3>
      <xref4>sample string 7</xref4>
    </CustomerListRequestItem>
  </CustomerListRequestItems>
  <LastModifiedExcludingBalancesOnOrAfterUTC>2024-11-21T09:35:36.7038068+00:00</LastModifiedExcludingBalancesOnOrAfterUTC>
  <LastModifiedExcludingBalancesOnOrBeforeUTC>2024-11-21T09:35:36.7038068+00:00</LastModifiedExcludingBalancesOnOrBeforeUTC>
  <LastModifiedOnOrAfterUtc>2024-11-21T09:35:36.7038068+00:00</LastModifiedOnOrAfterUtc>
  <LastModifiedOnOrBeforeUtc>2024-11-21T09:35:36.7038068+00:00</LastModifiedOnOrBeforeUtc>
</CustomerListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsCustomerListRequest'.

Response Information

Resource Description

Returns a list of customers selected with CustomerGUIDs or CustomerIDs and all customers that match a Location, Salesperson, Classification, and First Name or Last Name.

AgvCustomerList
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
Count

Count of how many Customer JSON dictionaries.

 string
CustomerRecords

JSON dictionary of Product.

 Collection of ClsCustomer

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "CustomerRecords": [
    null,
    {
      "FederalPermitList": [],
      "StatePermitList": [],
      "CustDeptPriceDefs": [],
      "CustJDCAccounts": [],
      "CustContacts": [],
      "CustClassifications": [],
      "ExtraChargesCust": [],
      "CustAttributes": [],
      "CustRelationship": [],
      "CustDate": [],
      "CustDetail": [],
      "CustNotify": [],
      "GRCustGBPool": [],
      "CustBankAccounts": [],
      "LocationID": "sample string 25",
      "CustomerGUID": "sample string 26",
      "CustomerID": "sample string 27",
      "OldGrowerID": "sample string 28",
      "GrowerYN": true,
      "FirstName": "sample string 30",
      "LastName": "sample string 31",
      "AddressLine1": "sample string 32",
      "AddressLine2": "sample string 33",
      "AddressLine3": "sample string 34",
      "Address4": "sample string 35",
      "City": "sample string 36",
      "State": "sample string 37",
      "Zip": "sample string 38",
      "PhoneNumber": "sample string 39",
      "PhoneNumber2": "sample string 40",
      "PESTNUM": "sample string 41",
      "Pestexp": "sample string 42",
      "NOTES": "sample string 43",
      "Salesman": "sample string 44",
      "GROUP": "sample string 45",
      "MISC1": true,
      "MISC2": true,
      "MISC3": true,
      "MISC4": true,
      "MISC5": true,
      "MISC6": true,
      "xref1": "sample string 52",
      "xref2": "sample string 53",
      "xref3": "sample string 54",
      "xref4": "sample string 55",
      "PRICEING": 56,
      "TempCust": true,
      "PreviousID": "sample string 58",
      "GeoCode": "sample string 59",
      "Territory": "sample string 60",
      "County": "sample string 61",
      "Country": "sample string 62",
      "TaxRate": 63.1,
      "OracleID": "sample string 64",
      "OracleAddrID": "sample string 65",
      "EditStatus": "sample string 66",
      "AddrLat": 67,
      "AddrLon": 68,
      "ACSID": "sample string 69",
      "Sttaxcode": "sample string 70",
      "Adjtaxcode": "sample string 71",
      "HealthID": "sample string 72",
      "ProspectYN": true,
      "AgrianCustID": "sample string 74",
      "AgrianStatePermitGrowerId": "sample string 75",
      "CompanyName1099": "sample string 76",
      "GLN": "sample string 77",
      "PrintDollarsPerAcreOnInvoice": true,
      "Begyear": 80.1,
      "Begmth": 81.1,
      "curbal": 82.1,
      "uacash": 83.1,
      "begyearpp": 84.1,
      "CurbalPP": 85.1,
      "Credlim": 86.1,
      "finchrgper": 87.1,
      "opened": "sample string 88",
      "laststatement": "sample string 89",
      "lastreviewed": "sample string 90",
      "credstatus": "sample string 91",
      "overlimthis": 92,
      "overlimlast": 93.1,
      "highbalthis": 94.1,
      "highballast": 95.1,
      "printstatment": "sample string 96",
      "CredNotes": "sample string 97",
      "WIP": 98.1,
      "OverDueBalance": 99.1,
      "PORequiredYN": true,
      "AvailableCredit": 101.1,
      "SSNTaxIDNum": "sample string 102",
      "CreditActive": true,
      "CreditLineName": "sample string 104",
      "CreditLineAmt": 105.1,
      "budget": 106.1,
      "CreditNeverSend": true,
      "Type1099": "sample string 108",
      "Paid1099": 109.1,
      "BegYearBB": 110.1,
      "box3": 111.1,
      "box6": 112.1,
      "Box31099": 113.1,
      "Box61099": 114.1,
      "AcctNum": "sample string 117",
      "AcctType": "",
      "ABARouteNum": "",
      "PrintBBStatement": "",
      "month1": 0.0,
      "month2": 0.0,
      "month3": 0.0,
      "month4": 0.0,
      "month5": 0.0,
      "month6": 0.0,
      "month7": 0.0,
      "month8": 0.0,
      "month9": 0.0,
      "month10": 0.0,
      "month11": 0.0,
      "month12": 0.0,
      "month1pp": 0.0,
      "month2pp": 0.0,
      "month3pp": 0.0,
      "month4pp": 0.0,
      "month5pp": 0.0,
      "month6pp": 0.0,
      "month7pp": 0.0,
      "month8pp": 0.0,
      "month9pp": 0.0,
      "month10pp": 0.0,
      "month11pp": 0.0,
      "month12pp": 0.0,
      "Month1BB": 0.0,
      "Month2BB": 0.0,
      "Month3BB": 0.0,
      "Month4BB": 0.0,
      "Month5BB": 0.0,
      "Month6BB": 0.0,
      "Month7BB": 0.0,
      "Month8BB": 0.0,
      "Month9BB": 0.0,
      "Month10BB": 0.0,
      "Month11BB": 0.0,
      "Month12BB": 0.0,
      "CustPatBDay": "",
      "CustPatActiveMember": false,
      "CustPatActiveMemberExists": false,
      "CustPatWithHold1099": false,
      "CustPatWithhold1099Exists": false,
      "CustPatBDayExists": false,
      "CustPatCorporation": false,
      "ReasonExpDate": "",
      "TaxID": "",
      "taxable": false,
      "Reason": "",
      "Discount": "",
      "GSTTaxable": false,
      "PSTTaxable": false,
      "GrainTaxExempt": false,
      "ACHUniqueID": 0,
      "ACHAcctDesc": "",
      "ACHAcctNum": "",
      "ACHAcctType": "",
      "ACHABARouteNum": "",
      "GRCustUniqueID": 0,
      "CondoGrowerID": "",
      "MNLeinHolderID": "",
      "LastModifiedUTC": "0001-01-01T00:00:00",
      "LastModifiedExcludingBalancesUTC": null
    }
  ]
}

application/xml, text/xml

Sample: 
<AgvCustomerList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer">
  <CustomerRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
    <d2p1:ClsCustomer i:nil="true" />
    <d2p1:ClsCustomer>
      <d2p1:ABARouteNum></d2p1:ABARouteNum>
      <d2p1:ACHABARouteNum></d2p1:ACHABARouteNum>
      <d2p1:ACHAcctDesc></d2p1:ACHAcctDesc>
      <d2p1:ACHAcctNum></d2p1:ACHAcctNum>
      <d2p1:ACHAcctType></d2p1:ACHAcctType>
      <d2p1:ACHUniqueID>0</d2p1:ACHUniqueID>
      <d2p1:ACSID>sample string 69</d2p1:ACSID>
      <d2p1:AcctNum>sample string 117</d2p1:AcctNum>
      <d2p1:AcctType></d2p1:AcctType>
      <d2p1:AddrLat>67</d2p1:AddrLat>
      <d2p1:AddrLon>68</d2p1:AddrLon>
      <d2p1:Address4>sample string 35</d2p1:Address4>
      <d2p1:AddressLine1>sample string 32</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 33</d2p1:AddressLine2>
      <d2p1:AddressLine3>sample string 34</d2p1:AddressLine3>
      <d2p1:Adjtaxcode>sample string 71</d2p1:Adjtaxcode>
      <d2p1:AgrianCustID>sample string 74</d2p1:AgrianCustID>
      <d2p1:AgrianStatePermitGrowerId>sample string 75</d2p1:AgrianStatePermitGrowerId>
      <d2p1:AvailableCredit>101.1</d2p1:AvailableCredit>
      <d2p1:BegYearBB>110.1</d2p1:BegYearBB>
      <d2p1:Begmth>81.1</d2p1:Begmth>
      <d2p1:Begyear>80.1</d2p1:Begyear>
      <d2p1:Box31099>113.1</d2p1:Box31099>
      <d2p1:Box61099>114.1</d2p1:Box61099>
      <d2p1:City>sample string 36</d2p1:City>
      <d2p1:CompanyName1099>sample string 76</d2p1:CompanyName1099>
      <d2p1:CondoGrowerID></d2p1:CondoGrowerID>
      <d2p1:Country>sample string 62</d2p1:Country>
      <d2p1:County>sample string 61</d2p1:County>
      <d2p1:CredNotes>sample string 97</d2p1:CredNotes>
      <d2p1:CreditActive>true</d2p1:CreditActive>
      <d2p1:CreditLineAmt>105.1</d2p1:CreditLineAmt>
      <d2p1:CreditLineName>sample string 104</d2p1:CreditLineName>
      <d2p1:CreditNeverSend>true</d2p1:CreditNeverSend>
      <d2p1:Credlim>86.1</d2p1:Credlim>
      <d2p1:CurbalPP>85.1</d2p1:CurbalPP>
      <d2p1:CustAttributes />
      <d2p1:CustBankAccounts />
      <d2p1:CustClassifications />
      <d2p1:CustContacts />
      <d2p1:CustDate />
      <d2p1:CustDeptPriceDefs />
      <d2p1:CustDetail />
      <d2p1:CustJDCAccounts />
      <d2p1:CustNotify />
      <d2p1:CustPatActiveMember>false</d2p1:CustPatActiveMember>
      <d2p1:CustPatActiveMemberExists>false</d2p1:CustPatActiveMemberExists>
      <d2p1:CustPatBDay></d2p1:CustPatBDay>
      <d2p1:CustPatBDayExists>false</d2p1:CustPatBDayExists>
      <d2p1:CustPatCorporation>false</d2p1:CustPatCorporation>
      <d2p1:CustPatWithHold1099>false</d2p1:CustPatWithHold1099>
      <d2p1:CustPatWithhold1099Exists>false</d2p1:CustPatWithhold1099Exists>
      <d2p1:CustRelationship />
      <d2p1:CustomerGUID>sample string 26</d2p1:CustomerGUID>
      <d2p1:CustomerID>sample string 27</d2p1:CustomerID>
      <d2p1:Discount></d2p1:Discount>
      <d2p1:EditStatus>sample string 66</d2p1:EditStatus>
      <d2p1:ExtraChargesCust xmlns:d4p1="http://schemas.datacontract.org/2004/07/SKY.Core.AR" />
      <d2p1:FederalPermitList />
      <d2p1:FirstName>sample string 30</d2p1:FirstName>
      <d2p1:GLN>sample string 77</d2p1:GLN>
      <d2p1:GRCustGBPool />
      <d2p1:GRCustUniqueID>0</d2p1:GRCustUniqueID>
      <d2p1:GROUP>sample string 45</d2p1:GROUP>
      <d2p1:GSTTaxable>false</d2p1:GSTTaxable>
      <d2p1:GeoCode>sample string 59</d2p1:GeoCode>
      <d2p1:GrainTaxExempt>false</d2p1:GrainTaxExempt>
      <d2p1:GrowerYN>true</d2p1:GrowerYN>
      <d2p1:HealthID>sample string 72</d2p1:HealthID>
      <d2p1:LastModifiedExcludingBalancesUTC i:nil="true" />
      <d2p1:LastModifiedUTC>0001-01-01T00:00:00</d2p1:LastModifiedUTC>
      <d2p1:LastName>sample string 31</d2p1:LastName>
      <d2p1:LocationID>sample string 25</d2p1:LocationID>
      <d2p1:MISC1>true</d2p1:MISC1>
      <d2p1:MISC2>true</d2p1:MISC2>
      <d2p1:MISC3>true</d2p1:MISC3>
      <d2p1:MISC4>true</d2p1:MISC4>
      <d2p1:MISC5>true</d2p1:MISC5>
      <d2p1:MISC6>true</d2p1:MISC6>
      <d2p1:MNLeinHolderID></d2p1:MNLeinHolderID>
      <d2p1:Month10BB>0</d2p1:Month10BB>
      <d2p1:Month11BB>0</d2p1:Month11BB>
      <d2p1:Month12BB>0</d2p1:Month12BB>
      <d2p1:Month1BB>0</d2p1:Month1BB>
      <d2p1:Month2BB>0</d2p1:Month2BB>
      <d2p1:Month3BB>0</d2p1:Month3BB>
      <d2p1:Month4BB>0</d2p1:Month4BB>
      <d2p1:Month5BB>0</d2p1:Month5BB>
      <d2p1:Month6BB>0</d2p1:Month6BB>
      <d2p1:Month7BB>0</d2p1:Month7BB>
      <d2p1:Month8BB>0</d2p1:Month8BB>
      <d2p1:Month9BB>0</d2p1:Month9BB>
      <d2p1:NOTES>sample string 43</d2p1:NOTES>
      <d2p1:OldGrowerID>sample string 28</d2p1:OldGrowerID>
      <d2p1:OracleAddrID>sample string 65</d2p1:OracleAddrID>
      <d2p1:OracleID>sample string 64</d2p1:OracleID>
      <d2p1:OverDueBalance>99.1</d2p1:OverDueBalance>
      <d2p1:PESTNUM>sample string 41</d2p1:PESTNUM>
      <d2p1:PORequiredYN>true</d2p1:PORequiredYN>
      <d2p1:PRICEING>56</d2p1:PRICEING>
      <d2p1:PSTTaxable>false</d2p1:PSTTaxable>
      <d2p1:Paid1099>109.1</d2p1:Paid1099>
      <d2p1:Pestexp>sample string 42</d2p1:Pestexp>
      <d2p1:PhoneNumber>sample string 39</d2p1:PhoneNumber>
      <d2p1:PhoneNumber2>sample string 40</d2p1:PhoneNumber2>
      <d2p1:PreviousID>sample string 58</d2p1:PreviousID>
      <d2p1:PrintBBStatement></d2p1:PrintBBStatement>
      <d2p1:PrintDollarsPerAcreOnInvoice>true</d2p1:PrintDollarsPerAcreOnInvoice>
      <d2p1:ProspectYN>true</d2p1:ProspectYN>
      <d2p1:Reason></d2p1:Reason>
      <d2p1:ReasonExpDate></d2p1:ReasonExpDate>
      <d2p1:SSNTaxIDNum>sample string 102</d2p1:SSNTaxIDNum>
      <d2p1:Salesman>sample string 44</d2p1:Salesman>
      <d2p1:State>sample string 37</d2p1:State>
      <d2p1:StatePermitList />
      <d2p1:Sttaxcode>sample string 70</d2p1:Sttaxcode>
      <d2p1:TaxID></d2p1:TaxID>
      <d2p1:TaxRate>63.1</d2p1:TaxRate>
      <d2p1:TempCust>true</d2p1:TempCust>
      <d2p1:Territory>sample string 60</d2p1:Territory>
      <d2p1:Type1099>sample string 108</d2p1:Type1099>
      <d2p1:WIP>98.1</d2p1:WIP>
      <d2p1:Zip>sample string 38</d2p1:Zip>
      <d2p1:begyearpp>84.1</d2p1:begyearpp>
      <d2p1:box3>111.1</d2p1:box3>
      <d2p1:box6>112.1</d2p1:box6>
      <d2p1:budget>106.1</d2p1:budget>
      <d2p1:credstatus>sample string 91</d2p1:credstatus>
      <d2p1:curbal>82.1</d2p1:curbal>
      <d2p1:finchrgper>87.1</d2p1:finchrgper>
      <d2p1:highballast>95.1</d2p1:highballast>
      <d2p1:highbalthis>94.1</d2p1:highbalthis>
      <d2p1:lastreviewed>sample string 90</d2p1:lastreviewed>
      <d2p1:laststatement>sample string 89</d2p1:laststatement>
      <d2p1:month1>0</d2p1:month1>
      <d2p1:month10>0</d2p1:month10>
      <d2p1:month10pp>0</d2p1:month10pp>
      <d2p1:month11>0</d2p1:month11>
      <d2p1:month11pp>0</d2p1:month11pp>
      <d2p1:month12>0</d2p1:month12>
      <d2p1:month12pp>0</d2p1:month12pp>
      <d2p1:month1pp>0</d2p1:month1pp>
      <d2p1:month2>0</d2p1:month2>
      <d2p1:month2pp>0</d2p1:month2pp>
      <d2p1:month3>0</d2p1:month3>
      <d2p1:month3pp>0</d2p1:month3pp>
      <d2p1:month4>0</d2p1:month4>
      <d2p1:month4pp>0</d2p1:month4pp>
      <d2p1:month5>0</d2p1:month5>
      <d2p1:month5pp>0</d2p1:month5pp>
      <d2p1:month6>0</d2p1:month6>
      <d2p1:month6pp>0</d2p1:month6pp>
      <d2p1:month7>0</d2p1:month7>
      <d2p1:month7pp>0</d2p1:month7pp>
      <d2p1:month8>0</d2p1:month8>
      <d2p1:month8pp>0</d2p1:month8pp>
      <d2p1:month9>0</d2p1:month9>
      <d2p1:month9pp>0</d2p1:month9pp>
      <d2p1:opened>sample string 88</d2p1:opened>
      <d2p1:overlimlast>93.1</d2p1:overlimlast>
      <d2p1:overlimthis>92</d2p1:overlimthis>
      <d2p1:printstatment>sample string 96</d2p1:printstatment>
      <d2p1:taxable>false</d2p1:taxable>
      <d2p1:uacash>83.1</d2p1:uacash>
      <d2p1:xref1>sample string 52</d2p1:xref1>
      <d2p1:xref2>sample string 53</d2p1:xref2>
      <d2p1:xref3>sample string 54</d2p1:xref3>
      <d2p1:xref4>sample string 55</d2p1:xref4>
    </d2p1:ClsCustomer>
  </CustomerRecords>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvCustomerList>