POST v1/Generic/GetCustomerList

Request Information

URI Parameters

None.

Body Parameters

CustomerDataRequest
NameDescriptionTypeAdditional information
FilterCriteria

string

None.
FilterType

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "FilterCriteria": "sample string 1",
  "FilterType": "sample string 2"
}

application/xml, text/xml

Sample: 
<CustomerDataRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FilterCriteria>sample string 1</FilterCriteria>
  <FilterType>sample string 2</FilterType>
</CustomerDataRequest>

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 'CustomerDataRequest'.

Response Information

Resource Description

Collection of CustomerDataResponse
NameDescriptionTypeAdditional information
CustomerId

string

None.
CustomerName

string

None.
TermsCode

string

None.
ContactId

string

None.
ContactFirstName

string

None.
ContactLastName

string

None.
ContactEmail

string

None.
AddressLine1

string

None.
AddressLine2

string

None.
AddressLine3

string

None.
City

string

None.
StateCode

string

None.
ZipCode

string

None.
DefaultPayerContactId

integer

None.
AccountingID

string

None.
SyncToken

string

None.
Website

string

None.
TaxAccountingID

string

None.
TermsAccountingID

string

None.
Company

string

None.
Attn

string

None.
CountryCode

string

None.
BillingAttn

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerId": "sample string 1",
    "CustomerName": "sample string 2",
    "TermsCode": "sample string 3",
    "ContactId": "sample string 4",
    "ContactFirstName": "sample string 5",
    "ContactLastName": "sample string 6",
    "ContactEmail": "sample string 7",
    "AddressLine1": "sample string 8",
    "AddressLine2": "sample string 9",
    "AddressLine3": "sample string 10",
    "City": "sample string 11",
    "StateCode": "sample string 12",
    "ZipCode": "sample string 13",
    "DefaultPayerContactId": 1,
    "AccountingID": "sample string 14",
    "SyncToken": "sample string 15",
    "Website": "sample string 16",
    "TaxAccountingID": "sample string 17",
    "TermsAccountingID": "sample string 18",
    "Company": "sample string 19",
    "Attn": "sample string 20",
    "CountryCode": "sample string 21",
    "BillingAttn": "sample string 22"
  },
  {
    "CustomerId": "sample string 1",
    "CustomerName": "sample string 2",
    "TermsCode": "sample string 3",
    "ContactId": "sample string 4",
    "ContactFirstName": "sample string 5",
    "ContactLastName": "sample string 6",
    "ContactEmail": "sample string 7",
    "AddressLine1": "sample string 8",
    "AddressLine2": "sample string 9",
    "AddressLine3": "sample string 10",
    "City": "sample string 11",
    "StateCode": "sample string 12",
    "ZipCode": "sample string 13",
    "DefaultPayerContactId": 1,
    "AccountingID": "sample string 14",
    "SyncToken": "sample string 15",
    "Website": "sample string 16",
    "TaxAccountingID": "sample string 17",
    "TermsAccountingID": "sample string 18",
    "Company": "sample string 19",
    "Attn": "sample string 20",
    "CountryCode": "sample string 21",
    "BillingAttn": "sample string 22"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerDataResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerDataResponse>
    <CustomerId>sample string 1</CustomerId>
    <CustomerName>sample string 2</CustomerName>
    <TermsCode>sample string 3</TermsCode>
    <PayerId>sample string 4</PayerId>
    <PayerFirstName>sample string 5</PayerFirstName>
    <PayerLastName>sample string 6</PayerLastName>
    <PayerEmail>sample string 7</PayerEmail>
    <AddressLine1>sample string 8</AddressLine1>
    <AddressLine2>sample string 9</AddressLine2>
    <AddressLine3>sample string 10</AddressLine3>
    <City>sample string 11</City>
    <StateCode>sample string 12</StateCode>
    <ZipCode>sample string 13</ZipCode>
    <DefaultPayerContactId>1</DefaultPayerContactId>
    <ExternalAccountingID>sample string 14</ExternalAccountingID>
    <ExternalSyncToken>sample string 15</ExternalSyncToken>
    <Website>sample string 16</Website>
    <TaxAccountingID>sample string 17</TaxAccountingID>
    <TermsAccountingID>sample string 18</TermsAccountingID>
    <Company>sample string 19</Company>
    <Attn>sample string 20</Attn>
    <CountryCode>sample string 21</CountryCode>
    <BillingAttn>sample string 22</BillingAttn>
  </CustomerDataResponse>
  <CustomerDataResponse>
    <CustomerId>sample string 1</CustomerId>
    <CustomerName>sample string 2</CustomerName>
    <TermsCode>sample string 3</TermsCode>
    <PayerId>sample string 4</PayerId>
    <PayerFirstName>sample string 5</PayerFirstName>
    <PayerLastName>sample string 6</PayerLastName>
    <PayerEmail>sample string 7</PayerEmail>
    <AddressLine1>sample string 8</AddressLine1>
    <AddressLine2>sample string 9</AddressLine2>
    <AddressLine3>sample string 10</AddressLine3>
    <City>sample string 11</City>
    <StateCode>sample string 12</StateCode>
    <ZipCode>sample string 13</ZipCode>
    <DefaultPayerContactId>1</DefaultPayerContactId>
    <ExternalAccountingID>sample string 14</ExternalAccountingID>
    <ExternalSyncToken>sample string 15</ExternalSyncToken>
    <Website>sample string 16</Website>
    <TaxAccountingID>sample string 17</TaxAccountingID>
    <TermsAccountingID>sample string 18</TermsAccountingID>
    <Company>sample string 19</Company>
    <Attn>sample string 20</Attn>
    <CountryCode>sample string 21</CountryCode>
    <BillingAttn>sample string 22</BillingAttn>
  </CustomerDataResponse>
</ArrayOfCustomerDataResponse>