POST api/GetCustomers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Where	Collection of Dictionary of string [key] and Object [value]	None.
Company	string	None.
Environment	string	None.
EndPoint	string	None.
Scope	string	None.
Type	string	None.
Arguments	Collection of Dictionary of string [key] and Object [value]	None.
IsArray	boolean	None.
TypedFilters	Collection of Filter	None.

Request Formats

application/json, text/json

Sample:

{
  "Where": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ],
  "Company": "sample string 1",
  "Environment": "sample string 2",
  "EndPoint": "sample string 3",
  "Scope": "sample string 4",
  "Type": "sample string 5",
  "Arguments": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ],
  "IsArray": false,
  "TypedFilters": [
    {
      "CustomCheckTag": "sample string 1",
      "AnswerValue": "sample string 2"
    },
    {
      "CustomCheckTag": "sample string 1",
      "AnswerValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DFV_BC">
  <Arguments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
  </Arguments>
  <Company>sample string 1</Company>
  <EndPoint>sample string 3</EndPoint>
  <Environment>sample string 2</Environment>
  <Scope>sample string 4</Scope>
  <Type>sample string 5</Type>
  <Where xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
  </Where>
</ApiRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Customers

Name	Type	Additional information
No.	string	None.
Name	string	None.
Address	string	None.
City	string	None.
County	string	None.
Post Code	string	None.
Country/Region Code	string	None.
VAT Registration No.	string	None.
Fiscal Code	string	None.
Payment Method Code	string	None.
Payment Terms Code	string	None.
Salesperson Code	string	None.
Shipment Method Code	string	None.
Notes	string	None.
Preferred Bank Account Code	string	None.
VAT Bus. Posting Group	string	None.
HOR Block Reason Code	string	None.
Credit Limit (LCY)	decimal number	None.
Balance (LCY)	decimal number	None.
Customer Price Group	string	None.
Customer Disc. Group	string	None.
Customer Addresses	Collection of CustomerAddress	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "No.": "sample string 1",
    "Name": "sample string 2",
    "Address": "sample string 3",
    "City": "sample string 4",
    "County": "sample string 5",
    "Post Code": "sample string 6",
    "Country/Region Code": "sample string 7",
    "VAT Registration No.": "sample string 8",
    "Fiscal Code": "sample string 9",
    "Payment Method Code": "sample string 10",
    "Payment Terms Code": "sample string 11",
    "Salesperson Code": "sample string 12",
    "Shipment Method Code": "sample string 13",
    "Notes": "sample string 14",
    "Preferred Bank Account Code": "sample string 15",
    "VAT Bus. Posting Group": "sample string 16",
    "HOR Block Reason Code": "sample string 17",
    "Credit Limit (LCY)": 18.1,
    "Balance (LCY)": 19.1,
    "Customer Price Group": "sample string 20",
    "Customer Disc. Group": "sample string 21",
    "Customer Addresses": [
      {
        "Code": "sample string 1",
        "Address": "sample string 2",
        "Name": "sample string 3",
        "City": "sample string 4",
        "County": "sample string 5",
        "Post Code": "sample string 6",
        "Shipment Method Code": "sample string 7",
        "Salesperson Code": "sample string 8"
      },
      {
        "Code": "sample string 1",
        "Address": "sample string 2",
        "Name": "sample string 3",
        "City": "sample string 4",
        "County": "sample string 5",
        "Post Code": "sample string 6",
        "Shipment Method Code": "sample string 7",
        "Salesperson Code": "sample string 8"
      }
    ]
  },
  {
    "No.": "sample string 1",
    "Name": "sample string 2",
    "Address": "sample string 3",
    "City": "sample string 4",
    "County": "sample string 5",
    "Post Code": "sample string 6",
    "Country/Region Code": "sample string 7",
    "VAT Registration No.": "sample string 8",
    "Fiscal Code": "sample string 9",
    "Payment Method Code": "sample string 10",
    "Payment Terms Code": "sample string 11",
    "Salesperson Code": "sample string 12",
    "Shipment Method Code": "sample string 13",
    "Notes": "sample string 14",
    "Preferred Bank Account Code": "sample string 15",
    "VAT Bus. Posting Group": "sample string 16",
    "HOR Block Reason Code": "sample string 17",
    "Credit Limit (LCY)": 18.1,
    "Balance (LCY)": 19.1,
    "Customer Price Group": "sample string 20",
    "Customer Disc. Group": "sample string 21",
    "Customer Addresses": [
      {
        "Code": "sample string 1",
        "Address": "sample string 2",
        "Name": "sample string 3",
        "City": "sample string 4",
        "County": "sample string 5",
        "Post Code": "sample string 6",
        "Shipment Method Code": "sample string 7",
        "Salesperson Code": "sample string 8"
      },
      {
        "Code": "sample string 1",
        "Address": "sample string 2",
        "Name": "sample string 3",
        "City": "sample string 4",
        "County": "sample string 5",
        "Post Code": "sample string 6",
        "Shipment Method Code": "sample string 7",
        "Salesperson Code": "sample string 8"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BCCONNECTOR.Models">
  <Customers>
    <Address>sample string 3</Address>
    <BalanceLCY>19.1</BalanceLCY>
    <City>sample string 4</City>
    <CountryRegionCode>sample string 7</CountryRegionCode>
    <County>sample string 5</County>
    <CreditLimitLCY>18.1</CreditLimitLCY>
    <CustomerAddresses>
      <CustomerAddress>
        <Address>sample string 2</Address>
        <City>sample string 4</City>
        <Code>sample string 1</Code>
        <County>sample string 5</County>
        <Name>sample string 3</Name>
        <PostCode>sample string 6</PostCode>
        <SalespersonCode>sample string 8</SalespersonCode>
        <ShipmentMethodCode>sample string 7</ShipmentMethodCode>
      </CustomerAddress>
      <CustomerAddress>
        <Address>sample string 2</Address>
        <City>sample string 4</City>
        <Code>sample string 1</Code>
        <County>sample string 5</County>
        <Name>sample string 3</Name>
        <PostCode>sample string 6</PostCode>
        <SalespersonCode>sample string 8</SalespersonCode>
        <ShipmentMethodCode>sample string 7</ShipmentMethodCode>
      </CustomerAddress>
    </CustomerAddresses>
    <CustomerDiscGroup>sample string 21</CustomerDiscGroup>
    <CustomerPriceGroup>sample string 20</CustomerPriceGroup>
    <FiscalCode>sample string 9</FiscalCode>
    <HORBlockReasonCode>sample string 17</HORBlockReasonCode>
    <Name>sample string 2</Name>
    <No>sample string 1</No>
    <Notes>sample string 14</Notes>
    <PaymentMethodCode>sample string 10</PaymentMethodCode>
    <PaymentTermsCode>sample string 11</PaymentTermsCode>
    <PostCode>sample string 6</PostCode>
    <PreferredBankAccountCode>sample string 15</PreferredBankAccountCode>
    <SalespersonCode>sample string 12</SalespersonCode>
    <ShipmentMethodCode>sample string 13</ShipmentMethodCode>
    <VATBusPostingGroup>sample string 16</VATBusPostingGroup>
    <VATRegistrationNo>sample string 8</VATRegistrationNo>
  </Customers>
  <Customers>
    <Address>sample string 3</Address>
    <BalanceLCY>19.1</BalanceLCY>
    <City>sample string 4</City>
    <CountryRegionCode>sample string 7</CountryRegionCode>
    <County>sample string 5</County>
    <CreditLimitLCY>18.1</CreditLimitLCY>
    <CustomerAddresses>
      <CustomerAddress>
        <Address>sample string 2</Address>
        <City>sample string 4</City>
        <Code>sample string 1</Code>
        <County>sample string 5</County>
        <Name>sample string 3</Name>
        <PostCode>sample string 6</PostCode>
        <SalespersonCode>sample string 8</SalespersonCode>
        <ShipmentMethodCode>sample string 7</ShipmentMethodCode>
      </CustomerAddress>
      <CustomerAddress>
        <Address>sample string 2</Address>
        <City>sample string 4</City>
        <Code>sample string 1</Code>
        <County>sample string 5</County>
        <Name>sample string 3</Name>
        <PostCode>sample string 6</PostCode>
        <SalespersonCode>sample string 8</SalespersonCode>
        <ShipmentMethodCode>sample string 7</ShipmentMethodCode>
      </CustomerAddress>
    </CustomerAddresses>
    <CustomerDiscGroup>sample string 21</CustomerDiscGroup>
    <CustomerPriceGroup>sample string 20</CustomerPriceGroup>
    <FiscalCode>sample string 9</FiscalCode>
    <HORBlockReasonCode>sample string 17</HORBlockReasonCode>
    <Name>sample string 2</Name>
    <No>sample string 1</No>
    <Notes>sample string 14</Notes>
    <PaymentMethodCode>sample string 10</PaymentMethodCode>
    <PaymentTermsCode>sample string 11</PaymentTermsCode>
    <PostCode>sample string 6</PostCode>
    <PreferredBankAccountCode>sample string 15</PreferredBankAccountCode>
    <SalespersonCode>sample string 12</SalespersonCode>
    <ShipmentMethodCode>sample string 13</ShipmentMethodCode>
    <VATBusPostingGroup>sample string 16</VATBusPostingGroup>
    <VATRegistrationNo>sample string 8</VATRegistrationNo>
  </Customers>
</ArrayOfCustomers>