Set up alerts for client management, job delivery, invoicing, and task adherence.
A Xero Practice Manager (XPM) object represents the core entities of a professional services client relationshipβincluding clients, their jobs, tasks, invoices, and time tracking. Together, these provide a full view of client engagements from onboarding through to billing and completion.
Key Entities & Properties
π§βπΌ Client (XPMClient)
Represents a client record in XPM.
Identifiers:
clientId,clientConnectTenantId,clientTenantId
Client Details:
clientName,clientAddress,clientCity,clientRegion,clientCountry,clientPostcodeclientPostalAddress,clientPostalCity,clientPostalRegion,clientPostalCountry,clientPostalPostcode
Contacts & Communication:
clientPhone,clientFax,clientWebsiteclientReferralSource
Status:
clientIsProspect,clientIsArchived,clientIsDeleted
Account Managers:
clientAccountManagerNameclientJobManagerName
Billing Client:
clientBillingClientName
Type:
clientTypeName,clientTypeCostMarkup,clientTypePaymentDay,clientTypePaymentTerm
Metadata:
clientCreationTime,clientSourceLink,clientWebUrl,clientExportCode
Includes collections:
Jobs (
XPMJob)Invoices (
XPMInvoice)
π Invoice (XPMInvoice)
Represents billing and revenue records.
invoiceIdPk,invoiceIdType & Status:
invoiceType,invoiceStatusDates:
invoiceDate,invoiceDueDate,invoiceCreationTimeAmounts:
invoiceAmount,invoiceAmountTax,invoiceAmountIncludingTaxinvoiceAmountPaid,invoiceAmountOutstanding
Client/Contact:
invoiceClientName,invoiceContactName
π Job (XPMJob)
Represents a client engagement/project.
Identifiers:
jobId,jobIdPk,jobTenantIdDetails:
jobName,jobDescription,jobState,jobClientOrderNumberDates:
jobStartDate,jobDueDate,jobCompletedDate,jobCreationTimeClient/Contacts:
jobClientName,jobContactNameManagement:
jobManagerName,jobPartnerNameLinks:
jobWebUrl
Child collections:
Tasks (
XPMJobTask)Notes (
XPMJobNote)
π Job Note (XPMJobNote)
Captures additional information attached to a job.
noteIdPknoteJobIdnoteTitle,noteText,noteFoldernoteDate,noteCreationTime,noteCreatedBy
β
Job Task (XPMJobTask)
Represents specific work items under a job.
taskIdPk,taskIdDetails:
taskName,taskDescription,taskEstimatedMinutes,taskActualMinutes,taskCompleted,taskBillable,taskFolderDates:
taskStartDate,taskDueDate,taskCreationTime
Child collection:
Task Times (
XPMJobTaskTime)
β±οΈ Job Task Time (XPMJobTaskTime)
Represents logged time entries against tasks.
timeIdPkJob/Task Link:
timeJobId,timeJobName,timeJobTaskNameStaff:
timeStaffNameDetails:
timeMinutes,timeNote,timeBillableDates:
timeDate,timeStart,timeEnd,timeCreationTimeInvoice Links:
timeInvoiceTaskNameWeblink:
timeWebUrl
π§ Task (XPMTask)
An alternative lightweight task DTO.
taskId,taskName,taskDescriptionestimatedMinutes,actualMinutes,completed,billable,folderstartDate,dueDate,taskCreationTime
