POST 17.0/database/products/list

Description

Retrieve a list of Products

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ProductsUpdate
Name Description Type Additional information
ID

integer

None.
Description

string

String length: inclusive between 0 and 50
Price

decimal number

None.
TaxRateID

integer

None.
ShowVATOnStatements

byte

None.
CostCentreID

integer

None.
CreditCompanyAccount

byte

None.
Invoiced

byte

None.
TransferTo

byte

None.
ChargeLandlordPrice

decimal number

None.
ChargeLandlordProductID

integer

None.
OverseasTaxDeducted

byte

None.
ExternalAccountCode

string

String length: inclusive between 0 and 20
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "price": 1.0,
    "taxRateID": 1,
    "showVATOnStatements": 64,
    "costCentreID": 1,
    "creditCompanyAccount": 64,
    "invoiced": 64,
    "transferTo": 64,
    "chargeLandlordPrice": 1.0,
    "chargeLandlordProductID": 1,
    "overseasTaxDeducted": 64,
    "externalAccountCode": "sample string 2",
    "inActive": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "price": 1.0,
    "taxRateID": 1,
    "showVATOnStatements": 64,
    "costCentreID": 1,
    "creditCompanyAccount": 64,
    "invoiced": 64,
    "transferTo": 64,
    "chargeLandlordPrice": 1.0,
    "chargeLandlordProductID": 1,
    "overseasTaxDeducted": 64,
    "externalAccountCode": "sample string 2",
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfProductsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Price>1</Price>
    <TaxRateID>1</TaxRateID>
    <ShowVATOnStatements>64</ShowVATOnStatements>
    <CostCentreID>1</CostCentreID>
    <CreditCompanyAccount>64</CreditCompanyAccount>
    <Invoiced>64</Invoiced>
    <TransferTo>64</TransferTo>
    <ChargeLandlordPrice>1</ChargeLandlordPrice>
    <ChargeLandlordProductID>1</ChargeLandlordProductID>
    <OverseasTaxDeducted>64</OverseasTaxDeducted>
    <ExternalAccountCode>sample string 2</ExternalAccountCode>
    <InActive>64</InActive>
  </ProductsUpdate>
  <ProductsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Price>1</Price>
    <TaxRateID>1</TaxRateID>
    <ShowVATOnStatements>64</ShowVATOnStatements>
    <CostCentreID>1</CostCentreID>
    <CreditCompanyAccount>64</CreditCompanyAccount>
    <Invoiced>64</Invoiced>
    <TransferTo>64</TransferTo>
    <ChargeLandlordPrice>1</ChargeLandlordPrice>
    <ChargeLandlordProductID>1</ChargeLandlordProductID>
    <OverseasTaxDeducted>64</OverseasTaxDeducted>
    <ExternalAccountCode>sample string 2</ExternalAccountCode>
    <InActive>64</InActive>
  </ProductsUpdate>
</ArrayOfProductsUpdate>