createEntity

Create a new Customer or Supplier

How to create a new Customer or Supplier.

Request

Field Description Additional info
entity company_name
entity contact_name Optional
entity building Optional
entity address1 Optional
entity address2 Optional
entity town Optional
entity country Optional
entity postcode Optional
entity email Optional
entity phone1 Optional
entity phone2 Optional
entity fax Optional
entity website Optional
entity external_id Optional
supplier default_account_code Optional
supplier default_vat_rate Optional
supplier default_credit_terms Optional
customer default_account_code Optional
customer default_vat_rate Optional
customer default_credit_terms Optional

Response

Field Description Additional info
The return value The internal id of the entity

Example

<?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:Header>
    <cb:authenticate apiKey="yourApiKey" />
  </env:Header>
  <env:Body>
    <env:createEntity env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
      <entity
        company_name="A new company"
        contact_name="Mr Contact Person"
        address1="address1"
        town="town"
        county="county"
        postcode="postcode"
        email="email@address.com"
        phone1="01234 567890"
        xsi:type="cb:Entity">
        <customer
          default_account_code="1001001"
          default_vat_rate="0.15"
          default_credit_terms="30"
          xsi:type="cb:EntityExtra" />
        <supplier
          default_account_code="1001001"
          default_vat_rate="0.15"
          default_credit_terms="30"
          xsi:type="cb:EntityExtra" />
      </entity>
    </env:createEntity>
  </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:createEntityResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
      <createEntityReturn xsi:type="xsd:int">18</createEntityReturn>
    </env:createEntityResponse>
  </env:Body>
</env:Envelope>