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

Method Description
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

GET current

Return a list of current invoices

Parameters

Parameter Required? Description
detailed=true Optional Return detailed information on invoice. See GET get/[invoice number] method for example of detailed invoice response.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/invoice.api/current

Example Response

<Response>
  <Status>OK</Status> 
  <Invoices>
    <Invoice>
      <ID>I000123</ID>
      <UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
      <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>
        <UUID>9298fafa-f1a4-494d-b62a-35aae4c7bb3e</UUID>
        <Name>A C Smith Limited</Name> 
      </Client>
      <Contact>
        <UUID>5d852206-b63f-4921-9267-12c0d95ef906</UUID>
        <Name>Andy Smith</Name> 
      </Contact>
    </Invoice>
  </Invoices>
</Response>

GET get/[invoice number]

Detailed information for a specific invoice

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/invoice.api/get/I000123

Example Job Invoice Response

<Response>
  <Status>OK</Status> 
  <Invoice>
    <ID>I000123</ID>
    <UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
    <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>
      <UUID>9298fafa-f1a4-494d-b62a-35aae4c7bb3e</UUID>
      <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <UUID>5d852206-b63f-4921-9267-12c0d95ef906</UUID>
      <Name>Andy Smith</Name> 
    </Contact>
    <Jobs>
      <Job>
        <ID>J000345</ID> 
        <Name>Brochure Design</Name> 
        <Description></Description> 
        <ClientOrderNumber />
        <Tasks>
          <Task>
            <UUID>5d852206-b63f-4921-9267-12c0d95ef906</UUID>
            <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>
            <Note>Note</Note> 
            <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>
    <UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
    <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>
      <UUID>9298fafa-f1a4-494d-b62a-35aae4c7bb3e</UUID>
      <Name>A C Smith Limited</Name> 
    </Client>
    <Contact>
      <UUID>5d85ee06-b63f-4921-9267-12c0d95eeeac</UUID>
      <Name>Andy Smith</Name> 
    </Contact>
    <Tasks>
      <Task>
        <UUID>eeff1206-b63f-4921-9267-12c0d95e1234</UUID>
        <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> 
        <Note>Note</Note>
        <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>

GET draft

Return a list of draft invoices

Parameters

Parameter Required? Description
detailed=true Optional Return detailed information on invoice. See GET get/[invoice number] method for example of detailed invoice response.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/invoice.api/draft

GET job/[job number]

Returns a list of invoices for a specific job

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/invoice.api/job/J000001

GET list

Return a list of current and archived invoices

Parameters

Parameter Required? Description
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

https://api.xero.com/workflowmax/3.0/invoice.api/list?from=20090801&to=20090901

GET payments/[invoice number]

Return a list of payments for an invoice

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/invoice.api/payments/I000123

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>