Soap API documentation

Method: deleteEntity

Delete an existing Customer or Supplier.

Request

Field	Type	Description
entityId	integer	The internal id of the entity	optional

Response

Field	Type	Description
The return value	boolean	If successful return true else false	optional

Examples

Request

<?xml version="1.0" encoding="UTF-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:cb="https://secure.clearbooks.co.uk/api/soap/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:enc="http://www.w3.org/2003/05/soap-encoding">
  <env:Header>
    <cb:authenticate apiKey="yourApiKey" />
  </env:Header>
  <env:Body>
    <env:deleteEntity env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
      <entityId xsi:type="xsd:int">10</entityId>
    </env:deleteEntity>
  </env:Body>
</env:Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
  xmlns:cb="https://secure.clearbooks.co.uk/api/soap/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:enc="http://www.w3.org/2003/05/soap-encoding">
  <env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc">
    <env:deleteEntityResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    </env:deleteEntityResponse>
  </env:Body>
</env:Envelope>