Xero Practice Manager Endpoint: JobsDetails: Difference between revisions
Jump to navigation
Jump to search
Created page with "= Overview = The Xero Practice Manager '''JobsDetails''' endpoint allows you to access a detailed list of all jobs within your Xero Practice manager. = Fields =..." |
mNo edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 68: | Line 68: | ||
==Contact Fields== | ==Contact Fields== | ||
;UUID | ;UUID | ||
:A [[Field Type: GUID|GUID field]] representing the internal id of the | :A [[Field Type: GUID|GUID field]] representing the internal id of the Contact. | ||
;Name | ;Name | ||
:A [[Field Type: Text|text field]] that provides the name of the | :A [[Field Type: Text|text field]] that provides the name of the Contact. | ||
| Line 122: | Line 122: | ||
;Billable | ;Billable | ||
:A [[Field Type: Boolean|boolean field]] that indicates whether the Task is Billable or not Billable. | :A [[Field Type: Boolean|boolean field]] that indicates whether the Task is Billable or not Billable. | ||
;Start Date | ;Start Date | ||
| Line 151: | Line 149: | ||
== Xero API == | == Xero API == | ||
For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/practice-manager-3-1/ | For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/practice-manager-3-1/jobs Xero API]. | ||
== Related Endpoints == | == Related Endpoints == | ||
:[[Xero Practice Manager Endpoints|Xero Practice Manager Endpoints]] | |||
:[[Xero Practice Manager Endpoint: Categories|Categories]] | :[[Xero Practice Manager Endpoint: Categories|Categories]] | ||
:[[Xero Practice Manager Endpoint: Clients|Clients]] | :[[Xero Practice Manager Endpoint: Clients|Clients]] | ||
| Line 162: | Line 161: | ||
:[[Xero Practice Manager Endpoint: Costs|Costs]] | :[[Xero Practice Manager Endpoint: Costs|Costs]] | ||
:[[Endpoint: DataFiles|DataFiles]] | :[[Endpoint: DataFiles|DataFiles]] | ||
:[[Xero Practice Manager Endpoint: InvoicesDetails|InvoicesDetails]] | |||
:[[Xero Practice Manager Endpoint: InvoicesDetailsCurrent|InvoicesDetailsCurrent]] | :[[Xero Practice Manager Endpoint: InvoicesDetailsCurrent|InvoicesDetailsCurrent]] | ||
:[[Xero Practice Manager Endpoint: InvoicesDetailsDraft|InvoicesDetailsDraft]] | :[[Xero Practice Manager Endpoint: InvoicesDetailsDraft|InvoicesDetailsDraft]] | ||
| Line 167: | Line 167: | ||
:[[Xero Practice Manager Endpoint: InvoicesSummaryCurrent|InvoicesSummaryCurrent]] | :[[Xero Practice Manager Endpoint: InvoicesSummaryCurrent|InvoicesSummaryCurrent]] | ||
:[[Xero Practice Manager Endpoint: InvoicesSummaryDraft|InvoicesSummaryDraft]] | :[[Xero Practice Manager Endpoint: InvoicesSummaryDraft|InvoicesSummaryDraft]] | ||
:[[Xero Practice Manager Endpoint: JobsDetailsCurrent|JobsDetailsCurrent]] | :[[Xero Practice Manager Endpoint: JobsDetailsCurrent|JobsDetailsCurrent]] | ||
:[[Xero Practice Manager Endpoint: JobsSummary|JobsSummary]] | :[[Xero Practice Manager Endpoint: JobsSummary|JobsSummary]] | ||
Latest revision as of 03:48, 31 January 2025
Overview
The Xero Practice Manager JobsDetails endpoint allows you to access a detailed list of all jobs within your Xero Practice manager.
Fields
The following fields are available for the JobsDetails endpoint.
- DataFile
- A record field that identifies the source data file for this record.
- UUID
- A GUID field representing the internal id of the Job.
- ID
- A text field that provides the Job ID.
- Name
- A text field that indicates the Name of the Job.
- Description
- A text field that provides the Job description.
- ClientOrderNumber
- A text field that provides the Client Order Number assigned to the Job.
- State
- A text field that provides the State of the Job.
- The value of the state element is that in the Interface Code field for each Job State as defined in Xero.
- Type
- A text field that indicates the type of the Job.
- Start Date
- A date field that provides the Job's Start Date.
- DueDate
- A date field that provides the Due date for the Job.
- Client
- A record field that provides information about the Client related to the Job.
- Contact
- A record field that provides information about the Contact related to the Job.
- Manager
- A record field that provides information about the Manager assigned to the Job.
- Partner
- A record field that provides information about the Partner/account manager assigned for the Job.
- Assigned
- A record field that provides information about the Staff assigned to the Job.
- Tasks
- A record field that lists Tasks related to a Job in Xero.
- Milestones
- A record field that provides information about relationships between Clients.
Client Fields
- UUID
- A GUID field representing the internal id of the Client.
- Name
- A text field that provides the name of the Client.
Contact Fields
- UUID
- A GUID field representing the internal id of the Contact.
- Name
- A text field that provides the name of the Contact.
Manager Fields
- UUID
- A GUID field representing the internal id of the Manager assigned to the Job.
- Name
- A text field that provides the name of the Manager assigned to the Job.
Partner Fields
- UUID
- A GUID field representing the internal id of the Partner/Account Manager assigned to the Job.
- Name
- A text field that provides the name of the Partner/Account Manager assigned to the Job.
Assigned Fields
- UUID
- A GUID field representing the internal id of the Staff assigned to the Job.
- Name
- A text field that provides the name of the Staff assigned to the Job.
Tasks Fields
- UUID
- A GUID field that provides the UUID of the record.
- TaskUUID
- A GUID field that provides the internal ID of the Task.
- Name
- A text field that provides the name of the Task.
- Description
- A text field that provides the description of the Task.
- EstimatedMinutes
- A integer field that indicates the number of Minutes estimated for the Task.
- ActualMinutes
- A integer field that indicates the number of Actual Minutes spent for the Task.
- Completed
- A boolean field that indicates whether the Task is completed.
- Billable
- A boolean field that indicates whether the Task is Billable or not Billable.
- Start Date
- A date field that provides the Task's Start Date.
- DueDate
- A date field that provides the Due date for the Task.
- Assigned
- A record field that provides information about the Staff assigned to the Task.
Milestones Fields
- UUID
- A GUID field that provides the internal ID of the Milestone.
- Date
- A date field that provides the Milestone date.
- Description
- A text field representing the Description of the Cost.
- Completed
- A boolean field that indicates whether the Milestone is completed or not completed.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Endpoints
- Xero Practice Manager Endpoints
- Categories
- Clients
- ClientsDetails
- ClientsGroups
- Costs
- DataFiles
- InvoicesDetails
- InvoicesDetailsCurrent
- InvoicesDetailsDraft
- InvoicesSummary
- InvoicesSummaryCurrent
- InvoicesSummaryDraft
- JobsDetailsCurrent
- JobsSummary
- JobsSummaryCurrent
- QuotesDetails
- QuotesDetailsCurrent
- QuotesDetailsDraft
- QuotesSummary
- QuotesSummaryCurrent
- QuotesSummaryDraft
- Staff
- Tasks
- Templates
- Times