View source for Xero Practice Manager Endpoint: Clients

= Overview =
The Xero '''Practice Manager''' [[Endpoints|endpoint]] allows you to access a list of all categories within your Xero Practice manager.

= Fields =
The following fields are available for the Categories endpoint.

;DataFile
:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.

;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of a Client.

;Name
:A [[Field Type: Text|text field]] that provides the Clients' name.

;Title
:A [[Field Type: Text|text field]] that provides the Clients' name title.

;FirstName
:A [[Field Type: Text|text field]] that provides the Clients' first name.

;LastName
:A [[Field Type: Text|text field]] that provides the Clients' last name.

;OtherName
:A [[Field Type: Text|text field]] that provides the Clients' other name, if specified in Xero.

;Email
:A [[Field Type: Text|text field]] that provides the Clients' email.

;DateOfBirth
:A [[Field Type: Date|date field]] that provides the Clients' Date of Birth.

;Address
:A [[Field Type: Text|text field]] that provides the Clients' address.

;City
:A [[Field Type: Text|text field]] that provides the Clients' city.

;Region
:A [[Field Type: Text|text field]] that provides the Clients' address region.

;PostCode
:A [[Field Type: Text|text field]] that provides the Clients' postcode.

;Country
:A [[Field Type: Text|text field]] that provides the Clients' Country.

;PostalAddress
:A [[Field Type: Text|text field]] that provides the Clients' postal address, if specified in Xero.

;PostalCity
:A [[Field Type: Text|text field]] that provides the Clients' postal city if specified in Xero.

;PostalRegion
:A [[Field Type: Text|text field]] that provides the Clients' postal region, if specified in Xero.

;PostalPostCode
:A [[Field Type: Text|text field]] that provides the Clients' postal post code, if specified in Xero.

;PostalCountry
:A [[Field Type: Text|text field]] that provides the Clients' postal country, if specified in Xero.

;Phone
:A [[Field Type: Text|text field]] that provides the Clients' phone number.

;Fax
:A [[Field Type: Text|text field]] that provides the Clients' fax number.

;Website
:A [[Field Type: Text|text field]] that provides the Clients' website.

;ReferralSource
:A [[Field Type: Text|text field]] that provides the Clients' source of referral.

;ExportCode
:A [[Field Type: Text|text field]] that provides the Clients' export code.

;IsProspect
:A [[Field Type: Text|Yes/No field]] that indicates if a Client is a prospect client.

;IsArchived
:A [[Field Type: Text|Yes/No field]] that indicates if a Client is Archived in Xero.

;IsDeleted
:A [[Field Type: Text|Yes/No value field]] that indicates if a Client has been deleted from Xero.

;AccountManager
:A [[Field Type: Record|record field]] that provides information about Clients' Account Manager.

;JobManager
:A [[Field Type: Record|record field]] that provides information about Clients' Job Manager.

;TaxNumber
:A [[Field Type: Decimal|number field]] that provides the Clients' tax number.

;CompanyNumber
:A [[Field Type: Decimal|number field]] that provides the Clients' company phone number.

;BusinessNumber
:A [[Field Type: Decimal|numberfield]] that provides the Clients' Business phone number.

;BranchNumber
:A [[Field Type: Decimal|number field]] that provides the Branch number.

;BusinessStructure
:A [[Field Type: Text|text field]] that provides the Clients' Business Structure type.

;BalanceMonth
:A [[Field Type: Decimal|number field]] that provides the Clients' Balance month by month number.
:''e.g. 1 for Jan, 2 for Feb, etc''.

;GSTRegistered
:A [[Field Type: Text|Yes/No value field]] that indicates if the Client is registered for GST.

;PrepareGST
:A [[Field Type: Text|Yes/No value field]] that indicates if GST needs to be prepared for the Client.

;SignedTaxAuthority
:A [[Field Type: Text|Yes/No value field]] that indicates if Tax authority has signed off for the Client.
:''Note this field is applicable only for NZ clients''.

;AgencyStatus
:A [[Field Type: Text|text field]] that provides the Clients' agency status.
: Available values are '''Unlinked, With EOT''', or '''Without EOT'''.
:''Note this field is applicable only for NZ clients''.

;ReturnType
:A [[Field Type: Text|text field]] that provides the Clients' Tax return type.
: Available values are '''IR3, IR3NR, IR4, IR6, IR7, IR9''', or '''PTS'''.
:''Note this field is applicable only for NZ clients''.

;PrepareActivityStatement
:A [[Field Type: Text|Yes/No value field]] that indicates if the Clients' activity statement needs to be prepared.
:''Note this field is applicable only for AU clients''.

;PrepareTaxReturn
:A [[Field Type: Text|Yes/No value field]] that indicates if the Clients' Tax return needs to be prepared.
:''Note this field is applicable only for AU clients''.

;AutoBasOptInCriteria
:A [[Field Type: Record|record field]] that provides the Clients' BAS criteria.

;BankBSB
:A [[Field Type: Decimal|number field]] that provides the Clients' Bank BSB number.

;BankAccountName
:A [[Field Type: Text|text field]] that provides the Clients' Bank Account Name.

;BankAccountNumber
:A [[Field Type: Decimal|number field]] that provides the Clients' Bank Account number.

;BankName
:A [[Field Type: Text|text field]] that provides the Clients' Bank Name code.

;ActiveAtoClient
:A [[Field Type: Text|Yes/No field]] that indicates if the Client is an active ATO client.

;ClientCode
:A [[Field Type: Text|text field]] that provides the Clients' code.

;Contacts
:A [[Field Type: Record|record field]] that provides the Clients' contact information.

;Notes
:A [[Field Type: Record|record field]] that provides notes recorded against a Client.

;Groups
:A [[Field Type: Record|record field]] that lists Client groups as specified in Xero.

;Relationships
:A [[Field Type: Record|record field]] that provides information about relationships between Clients.


== AccountManager Fields==
;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of the account manager for the client.

;Name
:A [[Field Type: Text|text field]] that provides the name of the account manager of the Client.


==JobManager Fields==
;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;Name
:A [[Field Type: Text|text field]] that provides the name of the job manager for the Client.


==AutoBasOptInCriteria Fields==
;Annually
:A [[Field Type: Text|Yes/No value field]] that indicates if Auto BAS Opt-in Criteria is Annually for the Client.

;Monthly
:A [[Field Type: Text|Yes/No  value field]] that indicates if Auto BAS Opt-in Criteria is Monthly for the Client.

;Quarterly
:A [[Field Type: Text|Yes/No value field]] that indicates if Auto BAS Opt-in Criteria is Quarterly for the Client.

;Opt-Out
:A [[Field Type: Text|Yes/No value field]] that indicates if client is set to opt out of Auto BAS.


==Contacts Fields==
;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;Name
:A [[Field Type: Text|text field]] that provides the name of the contact.

;Mobile
:A [[Field Type: Decimal|number field]] that provides the mobile number of the contact.

;Email
:A [[Field Type: Text|text field]] that provides the email of the contact.

;Phone
:A [[Field Type: Decimal|number field]] that provides the phone number of the contact.

;Salutation
:A [[Field Type: Text|text field]] that provides the salutation of the contact.

;Addressee
:A [[Field Type: Text|text field]] that provides the addressee for the contact.

;Position
:A [[Field Type: Text|text field]] that provides the position of the contact.

;IsPrimary
:A [[Field Type: Text|Yes/No field]] that indicates if the contact is a Primary Contact.

;IsDeleted
:A [[Field Type: Text|Yes/No field]] that indicates if the contact has been deleted.


==Notes Fields==
;Title
:A [[Field Type: Text|text field]] that provides the title of the note.

;Text
:A [[Field Type: Text|text field]] that provides the contents of the note.

;Folder
:A [[Field Type: Text|text field]] that provides the name of the folder the note is stored in.

;Date
:A [[Field Type: Date|date field]] that provides the created date of the note.

;CreatedBy
:A [[Field Type: Text|text field]] that provides the name of the creator of the note.


==Groups Fields==
;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;Name
:A [[Field Type: Text|text field]] representing the name of the job manager for the Client.


==Relationships Fields==
;UUID
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;Type
:A [[Field Type: Text|text field]] representing the internal id of the job manager for the Client.

;RelatedClient
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;NumberOfShares
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;Percentage
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;StartDate
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.

;EndDate
:A [[Field Type: GUID|GUID field]] representing the internal id of the job manager for the Client.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/practice-manager-3-1/clients Xero API].


== Related Endpoints ==

:[[Xero Practice Manager Endpoint: Categories|Categories]] 
:[[Xero Practice Manager Endpoint: ClientsDetails|ClientsDetails]] 
:[[Xero Practice Manager Endpoint: ClientsGroup|ClientsGroup]] 
:[[Xero Practice Manager Endpoint: Costs|Costs]] 
:[[Xero Practice Manager Endpoint: DataFiles|DataFiles]] 
:[[Xero Practice Manager Endpoint: InvoicesDetails|InvoicesDetails]] 
:[[Xero Practice Manager Endpoint: InvoicesDetailsCurrent|InvoicesDetailsCurrent]] 
:[[Xero Practice Manager Endpoint: InvoicesDetailsDraft|InvoicesDetailsDraft]] 
:[[Xero Practice Manager Endpoint: InvoicesSummary|InvoicesSummary]] 
:[[Xero Practice Manager Endpoint: InvoicesSummaryCurrent|InvoicesSummaryCurrent]]
:[[Xero Practice Manager Endpoint: InvoicesSummaryDraft|InvoicesSummaryDraft]]
:[[Xero Practice Manager Endpoint: JobsDetails|JobsDetails]]
:[[Xero Practice Manager Endpoint: JobsDetailsCurrent|JobsDetailsCurrent]]
:[[Xero Practice Manager Endpoint: JobsSummary|JobsSummary]]
:[[Xero Practice Manager Endpoint: JobsSummaryCurrent|JobsSummaryCurrent]]
:[[Xero Practice Manager Endpoint: QuotesDetails|QuotesDetails]]
:[[Xero Practice Manager Endpoint: QuotesDetailsCurrent|QuotesDetailsCurrent]]
:[[Xero Practice Manager Endpoint: QuotesDetailsDraft|QuotesDetailsDraft]]
:[[Xero Practice Manager Endpoint: QuotesSummary|QuotesSummary]] 
:[[Xero Practice Manager Endpoint: QuotesSummaryCurrent|QuotesSummaryCurrent]] 
:[[Xero Practice Manager Endpoint: QuotesSummaryDraft|QuotesSummaryDraft]] 
:[[Xero Practice Manager Endpoint: Staff|Staff]]
:[[Xero Practice Manager Endpoint: Tasks|Tasks]] 
:[[Xero Practice Manager Endpoint: Templates|Templates]] 
:[[Xero Practice Manager Endpoint: Times|Times]]