Xero Projects Endpoint: Projects
Jump to navigation
Jump to search
Overview
The Xero Projects endpoint provides the list of projects defined within Xero.
To make full use of the data in this endpoint may require using endpoints belonging to a Xero Accounting Model.
Fields
The following fields are available for the Projects endpoint.
- projectId
- A guid field that provides the id of the project.
- contactId
- A guid field that provides the id of the contact.
- This field links with the Contacts or ContactsExpanded endpoints of a Xero Accounting Model.
- name
- A text field that provides the name of the project.
- deadlineUtc
- A datetime field that provides the deadline date.
- status
- A text field that indicates the status of the project.
- Possible values are:
- INPROGRESS: Indicates the project is ongoing.
- CLOSED: Indicates the project is complete.
- currencyCode
- A text field that indicates the currency of the project.
- This field links with the Currencies endpoints of a Xero Accounting Model.
- minutesLogged
- A decimal field that provides the total number of minutes against all tasks of the project.
- minutesToBeInvoiced
- A decimal field that provides the total number of minutes yet to be invoiced across all chargeable tasks of the project.
- totalTaskAmount
- A record field that provides the total actual amounts of all tasks of the project.
- totalExpenseAmount
- A record field that provides the total actual amounts of all expenses of the project.
- taskAmountToBeInvoiced
- A record field that provides the total actual amounts yet to be invoiced across all chargeable tasks of the project.
- taskAmountInvoiced
- A record field that provides the total actual amounts already invoiced across all chargeable tasks of the project.
- expenseAmountToBeInvoiced
- A record field that provides the total actual amounts yet to be invoiced for all expenses of the project.
- expenseAmountInvoiced
- A record field that provides the total actual amounts already invoiced for all expenses of the project.
- projectAmountInvoiced
- A record field that provides the total actual amounts already invoiced for the project.
- deposit
- A record field that provides the total deposit amount received for the project.
- depositApplied
- A record field that provides the total deposit amount applied against invoices for the project.
- creditNoteAmount
- A record field that provides the total credit note recorded as credit notes for the project.
- totalInvoiced
- A record field that provides the total amount already invoiced for the project.
- totalToBeInvoiced
- A record field that provides the total amount yet to be invoiced for the project.
- estimate
- A record field that provides the estimate amount for the project.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints