Xero.PracticeManager (Xero v1.0.0)

Copy Markdown View Source

Xero Practice Manager API v3.1 – Accounting practice workflow management. Base URL: https://api.xero.com/practicemanager/3.1/ Scope: practicemanager

⚠️ All responses are XML regardless of input content type. Raw XML string is returned from all functions.

Job Status Values

"Prospect" | "NotStarted" | "InProgress" | "Overdue" | "Completed" | "Cancelled"

Priority Values

"Low" | "Normal" | "High"

Summary

Functions

create_category(t, tid, attrs)

create_client(t, tid, attrs)

create_job(t, tid, attrs)

Creates a new job. Required: client_id, name. Optional: assigned_to, due_date, budget_minutes, category_id, type_id, priority.

create_job_cost(t, tid, attrs)

create_job_note(t, tid, attrs)

create_staff(t, tid, attrs)

create_task(t, tid, attrs)

create_template(t, tid, attrs)

create_time(t, tid, attrs)

delete_category(t, tid, id)

delete_client(t, tid, id)

delete_job(t, tid, id)

Deletes a job.

delete_job_cost(t, tid, id)

delete_job_note(t, tid, id)

delete_task(t, tid, id)

delete_template(t, tid, id)

delete_time(t, tid, id)

export_invoices(t, tid, opts \\ [])

Exports invoices for a date range.

get_client(t, tid, id)

get_job(t, tid, id)

get_staff(t, tid, id)

list_categories(t, tid)

list_clients(t, tid, opts \\ [])

list_job_costs(t, tid, job_id)

list_job_notes(t, tid, id)

list_jobs(t, tid, opts \\ [])

Lists jobs with optional filters. Options: :state, :client_id, :staff_id, :page, :due_date, :from, :to, :job_number, :detailed

list_staff(t, tid, opts \\ [])

list_tasks(t, tid, opts \\ [])

list_templates(t, tid)

list_time(t, tid, opts \\ [])

update_category(t, tid, id, attrs)

update_client(t, tid, id, attrs)

update_job(t, tid, id, attrs)

update_job_cost(t, tid, id, attrs)

update_job_note(t, tid, id, attrs)

update_job_state(t, tid, id, state)

update_staff(t, tid, id, attrs)

update_task(t, tid, id, attrs)

update_template(t, tid, id, attrs)

update_time(t, tid, id, attrs)