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

Time Methods

Method Description
GET job/[job number] Returns a list of time sheet entries for a specific job
GET list Return a list of time sheet entries
GET staff/[uuid] Return a list of time sheet entries for a specific staff member
GET get/[uuid] Detailed information for a specific time entry
POST add Add a time sheet entry to a job
PUT update Update a time sheet entry on a job
DELETE delete/[uuid] Delete a specific time sheet entry

GET job/[job number]

Returns a list of time sheet entries for a specific job

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/job/J000001?from=20090801&to=20090901

Example Response

<Response>
  <Status>OK</Status> 
  <Times>
    <Time>
      <UUID>f5d334b2-c07f-424c-89b4-2c2aabc09edd</UUID>
      <Job>
        <ID>J000001</ID> 
        <Name>Brochure Template</Name> 
      </Job>
      <Task>
        <UUID>c894add0-ae78-43b9-a1bf-6f8112f42730</UUID>
        <Name>Design &amp; Layout</Name> 
      </Task>
      <Staff>
        <UUID>ca9b9d56-181f-4f3f-88b3-58976965f531</UUID>
        <Name>Chris Spence</Name> 
      </Staff>
      <Date>2008-10-29T00:00:00</Date> 
      <Minutes>240</Minutes> 
      <Note />
      <Billable>true</Billable>
      <!-- below values are included if the time entry was record with a start and end time -->
      <Start>13:00</Start>
      <End>17:00</End>
      <InvoiceTaskUUID /> <!-- if time was invoiced -->
    </Time>
    <Time>
      <UUID>cb47e50a-b6f9-445b-9b5b-7d67e46f4e2c</UUID>
      <Job>
        <ID>J000001</ID> 
        <Name>Brochure Template</Name> 
      </Job>
      <Task>
        <UUID>24cf5b5b-a8bb-46f7-ae31-0d5c10f28b14</UUID>
        <Name>Copywriting</Name> 
      </Task>
      <Staff>
        <UUID>4d6da699-bb50-4bd3-b263-bb91c94cbc13</UUID>
        <Name>John Smith</Name> 
      </Staff>
      <Date>2008-11-04T00:00:00</Date> 
      <Minutes>180</Minutes> 
      <Note /> 
      <Billable>true</Billable>
    </Time>
  </Times>
</Response>

GET list

Return a list of time sheet entries

Parameters

Parameter Required? Description
from=YYYYMMDD Required Return time sheet entries created on or after this date.
to=YYYYMMDD Required Return time sheet entries created on or before this date.

EXAMPLE URL

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

GET staff/[uuid]

Return a list of time sheet entries for a specific staff member

Parameters

Parameter Required? Description
from=YYYYMMDD Required Return time sheet entries created on or after this date.
to=YYYYMMDD Required Return time sheet entries created on or before this date.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/staff/9855318f-d027-4a2b-a6a4-92dfca0bd348?from=20090801&to=20090901

GET get/[uuid]

Detailed information for a specific time entry

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/get/f5d334b2-c07f-424c-89b4-2c2aabc09edd

Example Response

<Response>
  <Status>OK</Status> 
  <Time>
    <UUID>f5d334b2-c07f-424c-89b4-2c2aabc09edd</UUID>
    <Job>
      <ID>J000001</ID> 
      <Name>Brochure Template</Name> 
    </Job>
    <Task>
      <UUID>c894add0-ae78-43b9-a1bf-6f8112f42730</UUID>
      <Name>Design &amp; Layout</Name> 
    </Task>
    <Staff>
      <UUID>ca9b9d56-181f-4f3f-88b3-58976965f531</UUID>
      <Name>Chris Spence </Name> 
    </Staff>
    <Date>2008-10-29T00:00:00</Date> 
    <Minutes>240</Minutes> 
    <Note />
    <Billable>true</Billable>
    <!-- below values are included if the time entry was record with a start and end time -->
    <Start>13:00</Start>
    <End>17:00</End>
    <InvoiceTaskUUID /> <!-- if time was invoiced -->
  </Time>
</Response>

POST add

Add a time sheet entry to a job

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/add

Example Message for adding a time sheet entry by duration

<Timesheet>
  <Job>J000309</Job>
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20081030</Date>
  <Minutes>60</Minutes>
  <Note>Detailed note about the time sheet entry</Note>
</Timesheet>

Example Message for adding a time sheet entry by duration - negative time

<Timesheet>
  <Job>J000310</Job> 
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20141030</Date> 
  <Minutes>-60</Minutes>
  <Note>Negative time entry</Note> 
</Timesheet>

Example Message for adding a time sheet entry by start/end time

<Timesheet>
  <Job>J000311</Job> 
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20081030</Date> 
  <Start>13:00</Start> 
  <End>13:30</End> 
  <Note>Detailed note about the time sheet entry</Note> 
</Timesheet>

The response will include the detailed information of the time entry per the GET get/[identifier] method

PUT update

Update a time sheet entry on a job

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/update

Example Message for updating a time sheet entry by duration

<Timesheet>
  <UUID>f5d334b2-c07f-424c-89b4-2c2aabc09edd</UUID>
  <Job>J000309</Job>
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20081030</Date> 
  <Minutes>60</Minutes> 
  <Note>Detailed note about the time sheet entry</Note>
</Timesheet>

Example Message for updating a time sheet entry by duration - negative time

<Timesheet>
  <UUID>690cf982-1ca1-4c9e-a05c-a1029b921c57</UUID>
  <Job>J000310</Job> 
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20141030</Date> 
  <Minutes>-60</Minutes> 
  <Note>Negative time entry</Note> 
</Timesheet>

Example Message for updating a time sheet entry by start/end time

<Timesheet>
  <UUID>f5d334b2-c07f-424c-89b4-2c2aabc09edd</UUID>
  <Job>J000311</Job> 
  <TaskUUID>f73c82da-c1f3-4fa2-b2c3-eaa6397d300b</TaskUUID>
  <StaffUUID>fa0cb4d8-9b7f-42db-8b89-596681519afa</StaffUUID>
  <Date>20081030</Date> 
  <Start>13:00</Start> 
  <End>13:30</End> 
  <Note>Detailed note about the time sheet entry</Note> 
</Timesheet>

The response will include the detailed information of the time entry per the GET get/[identifier] method

DELETE delete/[uuid]

Delete a specific time sheet entry

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/time.api/delete/f5d334b2-c07f-424c-89b4-2c2aabc09edd