With our community of partners, you can get expert advice and training so you can be up and running in no time! SETUP PARTNERS

API Documentation

Invoice Methods

GET current Return a list of current invoices
GET get/[invoice number] Detailed information for a specific invoice
GET draft Return a list of draft invoices
GET job/[job number] Returns a list of invoices for a specific job
GET list Return a list of current and archived invoices
GET payments/[invoice number] Return a list of payments for an invoice
PARAMETERS
detailed=true Optional Return detailed information on invoice.  See GET get/[invoice number] method for example of detailed invoice response.
EXAMPLE URL
https://api.workflowmax.com/invoice.api/current?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Invoices>
    <Invoice>
      <ID>I000123</ID> 
      <Type>Progress Invoice</Type> 
      <Status>Approved</Status>   <!-- Approved, Paid, Draft, Cancelled -->
      <JobText>J000123</JobText>
      <Date>2007-09-15T00:00:00</Date> 
      <DueDate>2007-09-22T00:00:00</DueDate> 
      <Amount>200.00</Amount> 
      <AmountTax>25.00</AmountTax> 
      <AmountIncludingTax>225.00</AmountIncludingTax> 
      <AmountPaid>100.00</AmountPaid> 
      <AmountOutstanding>125.00</AmountOutstanding> 
      <Client>
        <ID>5</ID> 
        <Name>A C Smith Limited</Name> 
      </Client>
      <Contact>
        <ID>512</ID> 
        <Name>Andy Smith</Name> 
      </Contact>
    </Invoice>
  </Invoices>
</Response>
EXAMPLE URL
https://api.workflowmax.com/invoice.api/get/I000123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Job Invoice Response
<Response>
  <Status>OK</Status> 
  <Invoice>
      <ID>I000123</ID> 
      <Type>Progress Invoice</Type> 
      <Status>Approved</Status>   <!-- Approved, Paid, Draft, Cancelled -->
      <JobText>J000123</JobText>
      <Date>2007-09-15T00:00:00</Date> 
      <DueDate>2007-09-22T00:00:00</DueDate> 
      <Amount>200.00</Amount> 
      <AmountTax>25.00</AmountTax> 
      <AmountIncludingTax>225.00</AmountIncludingTax> 
      <AmountPaid>100.00</AmountPaid> 
      <AmountOutstanding>125.00</AmountOutstanding> 
      <Client>
        <ID>5</ID> 
        <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <ID>512</ID> 
      <Name>Andy Smith</Name> 
    </Contact>
    <Jobs>
      <Job>
        <ID>J000345</ID> 
        <Name>Brochure Design</Name> 
        <Description></Description> 
        <ClientOrderNumber />
        <Tasks>
          <Task>
            <Name>Design</Name> 
            <Description></Description> 
            <Minutes>60</Minutes> 
            <BillableRate>150</BillableRate> 
            <Billable>Yes</Billable> 
            <Amount>150.00</Amount> 
            <AmountTax>18.75</AmountTax> 
            <AmountIncludingTax>168.75</AmountIncludingTax> 
          </Task>
        </Tasks>
        <Costs>
          <Cost>
            <Description>Courier</Description> 
            <Code>COURIER</Code> 
            <Billable>Yes</Billable> 
            <Quantity>1</Quantity> 
            <UnitCost>50.00</UnitCost> 
            <UnitPrice>50.00</UnitPrice> 
            <Amount>50.00</Amount> 
            <AmountTax>6.25</AmountTax> 
            <AmountIncludingTax>56.25</AmountIncludingTax> 
          </Cost>
        </Costs>
      </Job>
    </Jobs>
  </Invoice>
</Response>
Example Miscellaneous Invoice Response
<Response>
  <Status>OK</Status> 
  <Invoice>
      <ID>I000123</ID> 
      <Type>Miscellaneous</Type> 
      <Status>Approved</Status>   <!-- Approved, Paid, Draft, Cancelled -->
      <JobText>J000123</JobText>
      <Date>2007-09-15T00:00:00</Date> 
      <DueDate>2007-09-22T00:00:00</DueDate> 
      <Amount>200.00</Amount> 
      <AmountTax>25.00</AmountTax> 
      <AmountIncludingTax>225.00</AmountIncludingTax> 
      <AmountPaid>100.00</AmountPaid> 
      <AmountOutstanding>125.00</AmountOutstanding> 
      <Client>
        <ID>5</ID> 
        <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <ID>512</ID> 
      <Name>Andy Smith</Name> 
    </Contact>
    <Tasks>
      <Task>
        <Name>Design</Name> 
        <Description></Description> 
        <Minutes>60</Minutes> 
        <BillableRate>150</BillableRate> 
        <Billable>Yes</Billable> 
        <Amount>150.00</Amount> 
        <AmountTax>18.75</AmountTax> 
        <AmountIncludingTax>168.75</AmountIncludingTax> 
      <Task>
    </Tasks>
    <Costs>
      <Cost>
        <Description>Courier</Description> 
        <Code>COURIER</Code> 
        <Billable>Yes</Billable> 
        <Quantity>1</Quantity> 
        <UnitCost>50.00</UnitCost> 
        <UnitPrice>50.00</UnitPrice> 
        <Amount>50.00</Amount> 
        <AmountTax>6.25</AmountTax> 
        <AmountIncludingTax>56.25</AmountIncludingTax> 
     <Cost>
    </Costs>
  </Invoice>
</Response>
PARAMETERS
detailed=true Optional Return detailed information on invoice.  See GET get/[invoice number] method for example of detailed invoice response.
EXAMPLE URL
https://api.workflowmax.com/invoice.api/draft?apiKey=[your API key]&accountKey=[WorkflowMax account key]
EXAMPLE URL
https://api.workflowmax.com/invoice.api/job/J000001?apiKey=[your API key]&accountKey=[WorkflowMax account key]
PARAMETERS
from=YYYYMMDD Required Return invoices created on or after this date.
to=YYYYMMDD Required Return invoices created on or before this date.
detailed=true Optional Return detailed information on invoice.  See GET get/[invoice number] method for example of detailed invoice response.
EXAMPLE URL
GET https://api.workflowmax.com/invoice.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]&from=20090801&to=20090901
EXAMPLE URL
https://api.workflowmax.com/invoice.api/payments/I000123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Payments>
    <Payment>
      <Date>2007-09-15T00:00:00</Date> 
      <Amount>200.00</Amount> 
      <Reference>ABC-1234</Reference> 
    </Payment>
  </Payments>
</Response>