GET list | Return a list of all clients |
GET search | Return a list of all clients matching search query |
GET get/[id] | Detailed information for a specific client |
POST add | Add a client and contacts |
PUT update | Update a clients details |
PUT archive | Archive a client |
POST delete | Delete a client |
GET contact/[id] | Detailed information for a specific contact |
PUT contact/[id] | Update a contacts details |
POST contact | add a contact to a client |
DELETE contact/[id] | delete a contact |
GET documents/[id] | Return a list of documents for a client |
POST document | Add a document to a client |
POST addrelationship | Add a relationship between clients (Practice Manager only) |
POST updaterelationship | Update the relationship details between clients (Practice Manager only) |
POST deleterelationship | Delete the relationship between clients (Practice Manager only) |
From the 17th January 2018 third party applications will not have access to view the client tax number via the API (ie TFN number in Australia, IRD number in NZ, VAT number in UK and SSN number in the US). If your integration with Xero Practice Manager or WorkflowMax Premium relies on this data, you’ll no longer be able to use this number as it will be returned “masked” so only the last 3 digits will be visible. You will, however, still be able to post and update the number if you have it from another source.
detailed=true | Optional | Return detailed information of client. See GET get/[id] method for example of detailed client response. |
modifiedsince=yyyy-MM-ddTHH:mm:ss | Optional | Return clients modified since a particular date (UTC), e.g. 2012-06-05T06:00:00 |
query | Required | Search query |
detailed=true | Optional | Return detailed information of client. See GET get/[id] method for example of detailed client response. |
The response will include the detailed information of the client as per the GET get/[id] method
The response will include the detailed information of the client as per the GET get/[id] method
The response will include the detailed information of the client as per the GET get/[id] method
The response will include the detailed information of the contact as per the GET contact/[id] method