The fastest way to invoice your clients and track time.

Client API XML

Show the client create schema Client create schema

<?xml version="1.0" encoding="utf-8"?>
<Request Object="Client" Method="Create" xmlns="urn:InvoiceClarity-com:ClientCreate" >
  <Client>
    <JobTitle>CEO</JobTitle>
    <Title>Mr</Title>
    <FirstName>Fred</FirstName>
    <Surname>Flintstone</Surname>
    <CompanyName>Rocky</CompanyName>
    <Email>xx@dd.com</Email>
    <WebSite></WebSite>                      <!-- Optional -->
    <Password></Password>                    <!-- Optional will be autometically be created if not present -->
    <PhoneWork></PhoneWork>                  <!-- Optional -->
    <PhoneHome>(0123)456789</PhoneHome>      <!-- Optional -->
    <PhoneMobile>(0123)456789</PhoneMobile>  <!-- Optional -->
    <PhoneFax>(0123)456789</PhoneFax>        <!-- Optional -->
    <Notes>Notes go here</Notes>             <!-- Optional -->
    <Address1>1 Rocky Road</Address1>        <!-- Optional -->
    <Address2>Bedrock</Address2>             <!-- Optional -->
    <Address3>Bedrock </Address3>            <!-- Optional -->
    <Address4>Rockland</Address4>            <!-- Optional Zip code in US -->
    <Address5>534dd</Address5>               <!-- Optional Postcode in UK -->
    <SendLogin>true</SendLogin>              <!-- Optional default to false -->
    <SendAsPdf>true</SendAsPdf>              <!-- Optional default to false -->
    <CountryId>1</CountryId>                 <!-- Optional will default to country where company created -->
    <CurrencyId>1</CurrencyId>               <!-- Optional will default to country where company created  -->
  </Client>
</Request>

Client create response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <ClientId>12356</ClientId>
  <Errors>
    <Error description="Errors go here"></Error>
  </Errors>
</Response>

Show the client update schema Client update schema

<?xml version="1.0" encoding="utf-8"?>
<Request Object="Client" Method="Update" xmlns="urn:InvoiceClarity-com:ClientUpdate" >
  <Client>
    <ClientId>375</ClientId>
    <JobTitle>CIO</JobTitle>
    <Title>Mr</Title>
    <FirstName>Fred</FirstName>
    <Surname>Flintstone</Surname>
    <CompanyName>Rocky</CompanyName>
    <Email>Fred@InvoiceClarity.com</Email>
    <WebSite></WebSite>                      <!-- Optional -->
    <Password></Password>                    <!-- Optional will be autometically be created if not present -->
    <PhoneWork></PhoneWork>                  <!-- Optional -->
    <PhoneHome>(0123)456789</PhoneHome>      <!-- Optional -->
    <PhoneMobile>(0123)456789</PhoneMobile>  <!-- Optional -->
    <PhoneFax>(0123)456789</PhoneFax>        <!-- Optional -->
    <Notes>Notes go here</Notes>             <!-- Optional -->
    <Address1>1 Rocky Road</Address1>        <!-- Optional -->
    <Address2>Bedrock</Address2>             <!-- Optional -->
    <Address3>Bedrock </Address3>            <!-- Optional -->
    <Address4>Rockland</Address4>            <!-- Optional -->
    <Address5>534dd</Address5>               <!-- Optional -->
    <SendLogin>true</SendLogin>              <!-- Optional default to false -->
    <SendAsPdf>true</SendAsPdf>              <!-- Optional default to false -->
    <CountryId>1</CountryId>                 <!-- Optional will default to country where company created -->
    <CurrencyId>1</CurrencyId>               <!-- Optional will default to country where company created  -->
  </Client>
</Request>

Client update response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <ClientId>12356</ClientId>
  <Errors>
    <Error description="Error"></Error>
  </Errors>
</Response>

Show the client delete schema Client delete schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Client" Method="Delete" xmlns="urn:InvoiceClarity-com:ClientDelete" >
  <ClientId>80</ClientId>                          <!-- ClientId to delete -->
</Request>

Client delete response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <ClientId>12356</ClientId>
  <Errors>
    <Error description="Error"></Error>
  </Errors>
</Response>

Show the client list schema Client list schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Client" Method="List" xmlns="urn:InvoiceClarity-com:ClientList" >
  <Page>1</Page>                                  <!-- Page number of paging -->
  <PerPage>9</PerPage>                            <!-- Number of clients to return -->
  <ShowArchived>true</ShowArchived>               <!-- Show archived -->
  <ShowDeleted>true</ShowDeleted>                 <!-- Show deleted -->
</Request>

Client list response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <Clients page="1" total="5" >
    <Client>
      <ClientId>1</ClientId>
      <JobTitle>CEO</JobTitle>
      <Title>Mr</Title>
      <FirstName>Fred</FirstName>
      <Surname>Flintstone</Surname>
      <CompanyName>Rocky</CompanyName>
      <Email>xx@dd.com</Email>
      <WebSite></WebSite>
      <PhoneWork></PhoneWork>
      <PhoneHome>(0123)456789</PhoneHome>
      <PhoneMobile>(0123)456789</PhoneMobile>
      <PhoneFax>(0123)456789</PhoneFax>
      <Notes>Notes go here</Notes>
      <Address1>1 Rocky Road</Address1>
      <Address2>Bedrock</Address2>
      <Address3>Bedrock </Address3>
      <Address4>Rockland</Address4>
      <Address5>534dd</Address5>
      <SendAsPdf>true</SendAsPdf>
      <CountryId>1</CountryId>
      <CurrencyId>1</CurrencyId>
    </Client>
  </Clients>
  <Errors>
    <Error description="Error"></Error>
  </Errors>
</Response>

Show the client item schema Client item schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Client" Method="Item" xmlns="urn:InvoiceClarity-com:ClientItem" >
  <ClientId>80</ClientId>                        <!-- ClientId to get details -->
</Request>

Client item response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <Client>
    <ClientId>1</ClientId>
    <JobTitle>CEO</JobTitle>
    <Title>Mr</Title>
    <FirstName>Fred</FirstName>
    <Surname>Flintstone</Surname>
    <CompanyName>Rocky</CompanyName>
    <Email>xx@dd.com</Email>
    <WebSite></WebSite>
    <Password></Password>
    <PhoneWork></PhoneWork>
    <PhoneHome>(0123)456789</PhoneHome>
    <PhoneMobile>(0123)456789</PhoneMobile>
    <PhoneFax>(0123)456789</PhoneFax>
    <Notes>Notes go here</Notes>
    <Address1>1 Rocky Road</Address1>
    <Address2>Bedrock</Address2>
    <Address3>Bedrock </Address3>
    <Address4>Rockland</Address4>
    <Address5>534dd</Address5>
    <SendLogin>true</SendLogin>
    <SendAsPdf>true</SendAsPdf>
    <CountryId>1</CountryId>
    <CurrencyId>1</CurrencyId>
  </Client>
  <Errors>
    <Error description="Error"></Error>
  </Errors>
</Response>