The fastest way to invoice your clients and track time.

Recurring invoice API XML

Show the recurring invoice create schema Recurring create schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Recurring" Method="Create" xmlns="urn:InvoiceClarity-com:RecurringCreate" >
  <Recurring>
    <Occurance>1</Occurance>                     <!-- 0 = forever -->
    <Frequency>Month</Frequency>
    <RecurringStatus>Active</RecurringStatus>
    <FirstDate>2008-08-15</FirstDate>
    <PurchaseOrder>42342</PurchaseOrder>
    <Discount>8.25</Discount>
    <ClientId>91</ClientId>
    <Notes>Hello</Notes>
    <Terms>Please pay in 30 days. ( you better !!!! )</Terms>
    <Footer>Company details</Footer>
    <SendAsPdf>True</SendAsPdf>

    <InvoiceLines>
      <InvoiceLine>
        <ItemId>94</ItemId>
        <Name>Chairs</Name>
        <Description>big brown ones</Description>
        <UnitCost>1000</UnitCost>
        <Quantity>3</Quantity>
        <CompanyTax1></CompanyTax1>
        <CompanyTax2></CompanyTax2>
      </InvoiceLine>
      <InvoiceLine>
        <ItemId>95</ItemId>
        <Name>Dancing lessons</Name>
        <Description>Salsa</Description>
        <UnitCost>35</UnitCost>
        <Quantity>1</Quantity>
        <CompanyTax1></CompanyTax1>
        <CompanyTax2></CompanyTax2>
      </InvoiceLine>
    </InvoiceLines>
  </Recurring>
</Request>

Recurring create response

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

Show the recurring invoice update schema Recurring update schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Recurring" Method="Update" xmlns="urn:InvoiceClarity-com:RecurringUpdate" >
  <Recurring>
    <RecurringId>54</RecurringId>
    <Occurance>0</Occurance>                     <!-- 0 = forever -->
    <Frequency>Weekly</Frequency>
    <RecurringStatus>Active</RecurringStatus>
    <FirstDate>2008-02-20</FirstDate>
    <PurchaseOrder>342421</PurchaseOrder>
    <Discount>10.4</Discount>
    <ClientId>14</ClientId>
    <Notes>Notes go here</Notes>
    <Terms>Please pay in 30 days.</Terms>
    <Footer>Company details</Footer>
    <SendAsPdf>True</SendAsPdf>

    <InvoiceLines>
      <InvoiceLine>
        <Name>Lots of work</Name>
        <Description>It was hard</Description>
        <UnitCost>543</UnitCost>
        <Quantity>3</Quantity>
        <CompanyTax1></CompanyTax1>
        <CompanyTax2>1</CompanyTax2>
      </InvoiceLine>
      <InvoiceLine>
        <Name>And more changed</Name>
        <Description>It was even harder changed</Description>
        <UnitCost>14.35</UnitCost>
        <Quantity>1</Quantity>
        <CompanyTax1>1</CompanyTax1>
        <CompanyTax2></CompanyTax2>
      </InvoiceLine>
    </InvoiceLines>
  </Recurring>
</Request>

Recurring update response

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

Show the recurring invoice delete schema Recurring delete schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Recurring" Method="Delete" xmlns="urn:InvoiceClarity-com:RecurringDelete" >
  <Recurring>
    <RecurringId>11</RecurringId>
  </Recurring>
</Request>

Recurring delete response

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

Show the recurring invoice list schema Recurring list schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Recurring" Method="List" xmlns="urn:InvoiceClarity-com:RecurringList" >
    <Page>1</Page>                               <!-- Page number to display -->
    <PerPage>3</PerPage>                         <!-- Number of invoices per page -->
    <ShowArchived>true</ShowArchived>            <!-- Show archived -->
    <ShowDeleted>true</ShowDeleted>              <!-- Invoice deleted -->
    <RecurringStatus></RecurringStatus>          <!-- Optional  -->
    <ClientId></ClientId>                        <!-- Optional  -->
    <DateFrom>2008-05-07</DateFrom>              <!-- Optional date start  -->
    <DateTo>2008-05-07</DateTo>                  <!-- Optional date end  -->
  </Request>

Recurring list response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <Recurrings page="1" total="2" >
    <Recurring>
      <RecurringId>54</RecurringId>
      <InvoiceNumber>3321</InvoiceNumber>
      <InvoiceStatus>Viewed</InvoiceStatus>
      <Date>2008-02-20</Date>
      <PurchaseOrder>342421</PurchaseOrder>
      <Discount>10.4</Discount>
      <ClientId>14</ClientId>
      <Notes>Notes go here</Notes>
      <Terms>Please pay in 30 days.</Terms>
      <Footer>Company details</Footer>
      <SendAsPdf>True</SendAsPdf>

      <InvoiceLines>
        <InvoiceLine>
          <Name>Lots of work</Name>
          <Description>It was hard</Description>
          <UnitCost>543</UnitCost>
          <CompanyTax1>Tax1</CompanyTax1>
          <CompanyTax2></CompanyTax2>
        </InvoiceLine>
        <InvoiceLine>
          <Name>And more changed</Name>
          <Description>It was even harder changed</Description>
          <UnitCost>14.35</UnitCost>
          <CompanyTax1></CompanyTax1>
          <CompanyTax2>Tax2</CompanyTax2>
        </InvoiceLine>
      </InvoiceLines>
    </Recurring>
  </Recurrings>
  <Errors>
    <Error description="Errors go here"></Error>
  </Errors>
</Response>

Show the recurring invoice item schema Recurring item schema

<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Recurring" Method="Item" xmlns="urn:InvoiceClarity-com:RecurringItem" >
  <RecurringId>12</RecurringId>
</Request>

Recurring item response

<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
  <Recurring>
    <RecurringId>54</RecurringId>
    <InvoiceNumber>3321</InvoiceNumber>
    <InvoiceStatus>Viewed</InvoiceStatus>
    <Date>2008-02-20</Date>
    <PurchaseOrder>342421</PurchaseOrder>
    <Discount>10.4</Discount>
    <ClientId>14</ClientId>
    <Notes>Notes go here</Notes>
    <Terms>Please pay in 30 days.</Terms>
    <Footer>Company details</Footer>
    <SendAsPdf>True</SendAsPdf>

    <InvoiceLines>
      <InvoiceLine>
        <Name>Lots of work</Name>
        <Description>It was hard</Description>
        <UnitCost>543</UnitCost>
        <CompanyTax1>Tax1</CompanyTax1>
        <CompanyTax2></CompanyTax2>
      </InvoiceLine>
      <InvoiceLine>
        <Name>And more changed</Name>
        <Description>It was even harder changed</Description>
        <UnitCost>14.35</UnitCost>
        <CompanyTax1></CompanyTax1>
        <CompanyTax2>Tax2</CompanyTax2>
      </InvoiceLine>
    </InvoiceLines>
  </Recurring>
  <Errors>
    <Error description="Errors go here"></Error>
  </Errors>
</Response>