Features
Accountants
Pricing
Support
Log in
 

Soap API documentation

Method: listProjects()

Returns a list of projects.

Request

Field Type Description  
offset integer Used to return results from an offset starting point. The list of projects is limited to 1000 results. required

Response

Field Type Description  
projects[ ] array An array of projects. optional
projects[ ][id] integer The ID of the project. optional
projects[ ][description] string The description of the project optional
projects[ ] [projectName] string The name of the project. optional
projects[ ][status] string String identifying the project status; either "open", "closed" or "deleted". 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.local/api/accounting/soap/">
  <SOAP-ENV:Header>
    <ns1:authenticate>
      <apiKey>yourApiKey</apiKey>
    </ns1:authenticate>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns1:listProjects>
      <offset>0</offset>
    </ns1:listProjects>
  </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.local/api/accounting/soap/">
  <SOAP-ENV:Body>
    <ns1:listProjectsResponse>
      <return>
        <ns1:Project description="" id="1">
          <projectName>Office running costs</projectName>
          <status>open</status>
        </ns1:Project>
        <ns1:Project description="" id="2">
          <projectName>Advertising</projectName>
          <status>open</status>
        </ns1:Project>
        <ns1:Project description="" id="3">
          <projectName>Subscriptions</projectName>
          <status>open</status>
        </ns1:Project>
        <ns1:Project description="" id="4">
          <projectName>Commission</projectName>
          <status>open</status>
        </ns1:Project>
      </return>
    </ns1:listProjectsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Clear Books is proudly registered with the Financial Conduct Authority as an Account Information Services Provider (register no. 843585).