Xero Projects

App · 17 actions

Manage projects, tasks and time entries in Xero Projects.

Actions

ActionWhat it does
Change project statusMark a Xero project as in progress or closed, by its project ID.
Create projectCreate a Xero project for a contact, with a name and an optional estimate and deadline.
Create taskAdd a task to a Xero project, with a name, a rate and how it is charged (by time, fixed price or not chargeable).
Create time entryLog time on a Xero project against a task for a project user, with the date, number of minutes and an optional description.
Delete taskDelete a task from a Xero project, by the project ID and task ID.
Delete time entryDelete a time entry from a Xero project, by the project ID and time entry ID.
Get projectGet one Xero project by its ID, with its contact, currency, estimate, deadline, minutes logged and task and expense totals.
Get taskGet one task on a Xero project by its ID, with its rate, charge type, estimate and the minutes and amount logged against it.
Get time entryGet one time entry on a Xero project by its ID, with the user, task, date, minutes logged and description.
List contactsList Xero contacts, a page at a time, to find the contact a project is for.
List project usersList the Xero users who can be assigned to projects, a page at a time, with each user's ID, name and email.
List projectsList Xero projects, a page at a time, optionally narrowed to certain project IDs, one contact or a project status.
List tasksList the tasks on a Xero project, a page at a time, optionally narrowed to certain task IDs or a charge type.
List time entriesList the time logged on a Xero project, a page at a time, filtered by user, task, invoice, contact, status, chargeable or a date range.
Update projectChange a Xero project's name, contact, estimate or deadline, found by its project ID.
Update taskChange a task on a Xero project, such as its name, rate, charge type or estimated minutes.
Update time entryChange a time entry on a Xero project, such as its user, task, date, minutes or description.

Change project status

Mark a Xero project as in progress or closed, by its project ID.

Inputs

Projectproject_idtextRequired
Project id.
StatusstatustextRequired
Status for projectOne of: INPROGRESS, CLOSED.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

Create project

Create a Xero project for a contact, with a name and an optional estimate and deadline. Returns the new project with its ID.

Inputs

Contactcontact_idtextRequired
Identifier of the contact this project was created for.
NamenametextRequired
Name of the project.
Estimate amountestimate_amountnumber
Estimate amount.
Deadline utcdeadline_utcdate and time
Deadline for the project. UTC Date Time in ISO-8601 format.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "contactId": "example",
    "creditNoteAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "currencyCode": "AED",
    "deadlineUtc": "example",
    "deposit": {
      "currency": "AED",
      "value": 1.0
    },
    "depositApplied": {
      "currency": "AED",
      "value": 1.0
    },
    "estimate": {
      "currency": "AED",
      "value": 1.0
    },
    "estimateAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "expenseAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "expenseAmountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "minutesLogged": 1,
    "minutesToBeInvoiced": 1,
    "name": "example",
    "projectAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "projectId": "example",
    "status": "INPROGRESS",
    "taskAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "taskAmountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "totalExpenseAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "totalTaskAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    }
  }
}

Create task

Add a task to a Xero project, with a name, a rate and how it is charged (by time, fixed price or not chargeable). Returns the new task with its ID.

Inputs

Projectproject_idtextRequired
Project id.
NamenametextRequired
Name of the task. Max length 100 characters.At most 100.
RaterateobjectRequired
Rate.
Charge typecharge_typetextRequired
Can be `TIME`, `FIXED` or `NON_CHARGEABLE`, defines how the task will be charged. Use `TIME` when you want to charge per hour and `FIXED` to charge as a fixed amount. If the task will not be charged use `NON_CHARGEABLE`.One of: TIME, FIXED, NON_CHARGEABLE (Non chargeable).
Estimate minutesestimate_minutesnumber
An estimated time to perform the task

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "amountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "amountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "chargeType": "TIME",
    "estimateMinutes": 1,
    "fixedMinutes": 1,
    "minutesInvoiced": 1,
    "minutesToBeInvoiced": 1,
    "name": "example",
    "nonChargeableMinutes": 1,
    "projectId": "example",
    "rate": {
      "currency": "AED",
      "value": 1.0
    },
    "status": "ACTIVE",
    "taskId": "example",
    "totalAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalMinutes": 1
  }
}

Create time entry

Log time on a Xero project against a task for a project user, with the date, number of minutes and an optional description. Returns the new time entry.

Inputs

Projectproject_idtextRequired
Project id.
Project userproject_user_idtextRequired
The xero user identifier of the person logging the time.
Tasktask_idtextRequired
Identifier of the task that time entry is logged against.
Date utcdate_utcdate and timeRequired
Date time entry is logged on. UTC Date Time in ISO-8601 format.
DurationdurationnumberRequired
Number of minutes to be logged. Duration is between 1 and 59940 inclusively.
Descriptiondescriptiontext
An optional description of the time entry, will be set to null if not provided during update.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "dateEnteredUtc": "example",
    "dateUtc": "example",
    "description": "example",
    "duration": 1,
    "projectId": "example",
    "status": "ACTIVE",
    "taskId": "example",
    "timeEntryId": "example",
    "userId": "example"
  }
}

Delete task

Delete a task from a Xero project, by the project ID and task ID.

Inputs

Projectproject_idtextRequired
Project id.
Tasktask_idtextRequired
Task id.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

Delete time entry

Delete a time entry from a Xero project, by the project ID and time entry ID.

Inputs

Projectproject_idtextRequired
Project id.
Time entry idtime_entry_idtextRequired
Time entry id.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

Get project

Get one Xero project by its ID, with its contact, currency, estimate, deadline, minutes logged and task and expense totals.

Inputs

Projectproject_idtextRequired
Project id.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "contactId": "example",
    "creditNoteAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "currencyCode": "AED",
    "deadlineUtc": "example",
    "deposit": {
      "currency": "AED",
      "value": 1.0
    },
    "depositApplied": {
      "currency": "AED",
      "value": 1.0
    },
    "estimate": {
      "currency": "AED",
      "value": 1.0
    },
    "estimateAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "expenseAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "expenseAmountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "minutesLogged": 1,
    "minutesToBeInvoiced": 1,
    "name": "example",
    "projectAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "projectId": "example",
    "status": "INPROGRESS",
    "taskAmountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "taskAmountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "totalExpenseAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "totalTaskAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    }
  }
}

Get task

Get one task on a Xero project by its ID, with its rate, charge type, estimate and the minutes and amount logged against it.

Inputs

Projectproject_idtextRequired
Project id.
Tasktask_idtextRequired
Task id.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "amountInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "amountToBeInvoiced": {
      "currency": "AED",
      "value": 1.0
    },
    "chargeType": "TIME",
    "estimateMinutes": 1,
    "fixedMinutes": 1,
    "minutesInvoiced": 1,
    "minutesToBeInvoiced": 1,
    "name": "example",
    "nonChargeableMinutes": 1,
    "projectId": "example",
    "rate": {
      "currency": "AED",
      "value": 1.0
    },
    "status": "ACTIVE",
    "taskId": "example",
    "totalAmount": {
      "currency": "AED",
      "value": 1.0
    },
    "totalMinutes": 1
  }
}

Get time entry

Get one time entry on a Xero project by its ID, with the user, task, date, minutes logged and description.

Inputs

Projectproject_idtextRequired
Project id.
Time entry idtime_entry_idtextRequired
Time entry id.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "dateEnteredUtc": "example",
    "dateUtc": "example",
    "description": "example",
    "duration": 1,
    "projectId": "example",
    "status": "ACTIVE",
    "taskId": "example",
    "timeEntryId": "example",
    "userId": "example"
  }
}

List contacts

List Xero contacts, a page at a time, to find the contact a project is for. Returns each contact's ID and details.

Inputs

Pagepagenumber
Page.At least 1. Default: 1.
Page sizepage_sizenumber
Page size.From 1 to 1000. Default: 100.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "Contacts": []
  }
}

List project users

List the Xero users who can be assigned to projects, a page at a time, with each user's ID, name and email.

Inputs

Pagepagenumber
Page.Default: 1.
Page sizepage_sizenumber
Page size.From 1 to 500. Default: 50.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "items": [],
    "pagination": {
      "itemCount": 1,
      "page": 1,
      "pageCount": 1,
      "pageSize": 1
    }
  }
}

List projects

List Xero projects, a page at a time, optionally narrowed to certain project IDs, one contact or a project status. Returns each project's name, contact, estimate and totals.

Inputs

Project idsproject_idslist
Project ids.
Contactcontact_idtext
Contact id.
Statesstatestext
States.
Pagepagenumber
Page.Default: 1.
Page sizepage_sizenumber
Page size.From 1 to 500. Default: 50.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "items": [],
    "pagination": {
      "itemCount": 1,
      "page": 1,
      "pageCount": 1,
      "pageSize": 1
    }
  }
}

List tasks

List the tasks on a Xero project, a page at a time, optionally narrowed to certain task IDs or a charge type. Returns each task's rate, estimate and time logged.

Inputs

Projectproject_idtextRequired
Project id.
Pagepagenumber
Page.
Page sizepage_sizenumber
Page size.
Task idstask_idstext
Task ids.
Charge typecharge_typetext
Can be `TIME`, `FIXED` or `NON_CHARGEABLE`, defines how the task will be charged. Use `TIME` when you want to charge per hour and `FIXED` to charge as a fixed amount. If the task will not be charged use `NON_CHARGEABLE`.One of: TIME, FIXED, NON_CHARGEABLE (Non chargeable).

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "items": [],
    "pagination": {
      "itemCount": 1,
      "page": 1,
      "pageCount": 1,
      "pageSize": 1
    }
  }
}

List time entries

List the time logged on a Xero project, a page at a time, filtered by user, task, invoice, contact, status, chargeable or a date range. Returns each entry's date, minutes and description.

Inputs

Projectproject_idtextRequired
Project id.
Project userproject_user_idtext
Project user id.
Tasktask_idtext
Task id.
Invoice idinvoice_idtext
Invoice id.
Contactcontact_idtext
Contact id.
Pagepagenumber
Page.
Page sizepage_sizenumber
Page size.
Statesstateslist
States.
Is chargeableis_chargeabletrue/false
Is chargeable.
Date after utcdate_after_utcdate and time
Date after utc.
Date before utcdate_before_utcdate and time
Date before utc.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {
    "items": [],
    "pagination": {
      "itemCount": 1,
      "page": 1,
      "pageCount": 1,
      "pageSize": 1
    }
  }
}

Update project

Change a Xero project's name, contact, estimate or deadline, found by its project ID.

Inputs

Projectproject_idtextRequired
Project id.
Contactcontact_idtext
Identifier of the contact this project was created for.
NamenametextRequired
Name of the project.
Estimate amountestimate_amountnumber
Estimate amount.
Deadline utcdeadline_utcdate and time
Deadline for the project. UTC Date Time in ISO-8601 format.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

Update task

Change a task on a Xero project, such as its name, rate, charge type or estimated minutes.

Inputs

Projectproject_idtextRequired
Project id.
Tasktask_idtextRequired
Task id.
NamenametextRequired
Name of the task. Max length 100 characters.At most 100.
RaterateobjectRequired
Rate.
Charge typecharge_typetextRequired
Can be `TIME`, `FIXED` or `NON_CHARGEABLE`, defines how the task will be charged. Use `TIME` when you want to charge per hour and `FIXED` to charge as a fixed amount. If the task will not be charged use `NON_CHARGEABLE`.One of: TIME, FIXED, NON_CHARGEABLE (Non chargeable).
Estimate minutesestimate_minutesnumber
An estimated time to perform the task

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

Update time entry

Change a time entry on a Xero project, such as its user, task, date, minutes or description.

Inputs

Projectproject_idtextRequired
Project id.
Time entry idtime_entry_idtextRequired
Time entry id.
Project userproject_user_idtextRequired
The xero user identifier of the person logging the time.
Tasktask_idtextRequired
Identifier of the task that time entry is logged against.
Date utcdate_utcdate and timeRequired
Date time entry is logged on. UTC Date Time in ISO-8601 format.
DurationdurationnumberRequired
Number of minutes to be logged. Duration is between 1 and 59940 inclusively.
Descriptiondescriptiontext
An optional description of the time entry, will be set to null if not provided during update.

Outputs

dataobject
Xero Projects response data.
Example output
{
  "data": {}
}

On this page