Soap API documentation

Method: listEntities

Returns a list of customers and/or suppliers.

Request

Field	Type	Description
query id	integer	Set this field to an array of entity ids to be returned with or without other filter results.	optional
query type	string	Customers or suppliers. Leave empty for both	optional
query modifiedSince	string	Limit the response to only entities that have been added or modified since this date	optional
query offset	integer	The call only returns 1000 entities, use this to specify an offset	optional

Response

Field	Type	Description
entities[]	array	See entity from updateEntity	optional
entities[][statement_url]	string	The URL the customer/supplier can access to view statements	optional

Examples

Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="https://secure.clearbooks.co.uk/api/accounting/soap/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SOAP-ENV:Header>
    <ns1:authenticate>
      <apiKey>yourApiKey</apiKey>
    </ns1:authenticate>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns1:listEntities>
      <query type="customer" offset="0">
        <id>
          <xsd:int>2</xsd:int>
        </id>
      </query>
    </ns1:listEntities>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="https://secure.clearbooks.co.uk/api/accounting/soap/">
    <SOAP-ENV:Body>
        <ns1:listEntitiesResponse>
            <return>
                <ns1:Entity
                    id="2"
                    country="GB"
                    building="534"
                    address2=""
                    phone2=""
                    fax=""
                    website=""
                    date_modified="2017-11-03 12:46:42"
                    external_id=""
                    vat_number=""
                    company_number=""
                    statement_url="https://secure.clearbooks.co.uk/s/2:GpqN4eRkRPZik95_NNftgw">
                    <customer default_account_code="1001001" default_vat_rate="Manual" default_credit_terms="-1"/>
                    <bankAccount>
                        <bankName></bankName>
                        <name></name>
                        <sortcode></sortcode>
                        <accountNumber></accountNumber>
                    </bankAccount>
                    <company_name>Advertising Junctions</company_name>
                    <contact_name></contact_name>
                    <address1>Stockley Park</address1>
                    <town>Uxbridge</town>
                    <county>Middlesex</county>
                    <postcode>UB11 1HB</postcode>
                    <email>email@address.com</email>
                    <phone1></phone1>
                </ns1:Entity>
            </return>
        </ns1:listEntitiesResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>