Xero website screenshot

Xero

Xero is a cloud-based accounting software platform that helps small and medium-sized businesses manage their finances. Xero provides a comprehensive developer platform with OAuth 2.0 APIs for accounting, payroll, assets, projects, files, bank feeds, and identity management. The Xero API enables third-party integrations to build custom accounting apps, automations, and business tools. Xero supports SDKs for .NET, Java, Node.js, PHP, Ruby, Python, and provides an MCP server for AI-assisted accounting workflows.

10 APIs 0 Features
AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

APIs

Xero Accounting API

Core accounting API for the Xero platform. Supports creating and managing accounts, invoices, credit notes, bank transactions, contacts, payments, purchase orders, and financial...

Xero Assets API

API for managing fixed assets in Xero. Supports registering and depreciating assets, managing asset types, and running depreciation calculations. Enables automated fixed asset l...

Xero Bank Feeds API

API for importing bank transaction data into Xero from financial institutions and fintech providers. Enables creation and management of bank feed connections and statement lines...

Xero Finance API

API providing access to financial statements, balance sheets, profit and loss reports, and cash flow summaries for Xero organizations. Supports bank statement accounting, accoun...

Xero Identity API

OAuth 2.0 authentication and authorization API for the Xero platform. Manages connections to Xero organizations, user identity, and refresh token lifecycle. Required for all Xer...

Xero Payroll Australia API

Payroll management API for Australian businesses using Xero. Supports managing employees, pay runs, pay slips, leave applications, payroll calendars, tax declarations, and super...

Xero Payroll New Zealand API

Payroll management API for New Zealand businesses using Xero. Supports managing employees, pay runs, pay slips, leave management, and compliance with New Zealand payroll regulat...

Xero Payroll United Kingdom API

Payroll management API for UK businesses using Xero. Supports managing employees, pay runs, pay slips, leave, and compliance with UK payroll regulations including PAYE, national...

Xero Projects API

Project tracking and time management API for Xero. Supports creating and managing projects, tasks, time entries, and expenses. Enables integration of project-based billing with ...

Xero Files API

File storage and management API for Xero. Supports uploading, organizing, and attaching files to accounting objects in Xero. Enables document management workflows integrated wit...

Collections

Xero Accounting API

OPEN

Xero Assets API

OPEN

Xero Bank Feeds API

OPEN

Xero Files API

OPEN

Xero Finance API

OPEN

Xero OAuth 2 Identity Service API

OPEN

Xero Payroll AU API

OPEN

Xero Payroll NZ

OPEN

Xero Payroll UK

OPEN

Xero Projects API

OPEN

GraphQL

Xero GraphQL

Xero does not currently offer a public GraphQL API. The Xero developer platform is built entirely on REST, with separate API surface areas for Accounting, Assets, Bank Feeds, Fi...

GRAPHQL

Pricing Plans

Xero Plans Pricing

1 plans

PLANS

Rate Limits

Xero Rate Limits

1 limits

RATE LIMITS

FinOps

Xero Finops

FINOPS

Event Specifications

Xero Webhooks

AsyncAPI 2.6 description of Xero's outbound webhook surface for the INVOICE and CONTACT event categories. Xero delivers event notifications by issuing HTTP POST requests with a ...

ASYNCAPI

JSON Structure

Xero Structure

0 properties

JSON STRUCTURE

Example Payloads

Xero Approveleaveapplication Example

6 fields

EXAMPLE

Xero Approvetimesheet Example

6 fields

EXAMPLE

Xero Createaccount Example

6 fields

EXAMPLE

Xero Createaccountattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createasset Example

6 fields

EXAMPLE

Xero Createassettype Example

6 fields

EXAMPLE

Xero Createbanktransactionattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createbanktransactions Example

6 fields

EXAMPLE

Xero Createbanktransfer Example

6 fields

EXAMPLE

Xero Createbanktransferattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createbatchpayment Example

6 fields

EXAMPLE

Xero Createbatchpaymenthistoryrecord Example

6 fields

EXAMPLE

Xero Createbenefit Example

6 fields

EXAMPLE

Xero Createbrandingthemepaymentservices Example

6 fields

EXAMPLE

Xero Createcontactattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createcontactgroup Example

6 fields

EXAMPLE

Xero Createcontactgroupcontacts Example

6 fields

EXAMPLE

Xero Createcontacts Example

6 fields

EXAMPLE

Xero Createcreditnoteallocation Example

6 fields

EXAMPLE

Xero Createcreditnoteattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createcreditnotes Example

6 fields

EXAMPLE

Xero Createcurrency Example

6 fields

EXAMPLE

Xero Creatededuction Example

6 fields

EXAMPLE

Xero Createearningsrate Example

6 fields

EXAMPLE

Xero Createemployee Example

6 fields

EXAMPLE

Xero Createemployeeearningstemplate Example

6 fields

EXAMPLE

Xero Createemployeeleave Example

6 fields

EXAMPLE

Xero Createemployeeleavesetup Example

6 fields

EXAMPLE

Xero Createemployeeleavetype Example

6 fields

EXAMPLE

Xero Createemployeeopeningbalances Example

6 fields

EXAMPLE

Xero Createemployeepaymentmethod Example

6 fields

EXAMPLE

Xero Createemployees Example

6 fields

EXAMPLE

Xero Createemployeesalaryandwage Example

6 fields

EXAMPLE

Xero Createemployeestatutorysickleave Example

6 fields

EXAMPLE

Xero Createemployeeworkingpattern Example

6 fields

EXAMPLE

Xero Createemployment Example

6 fields

EXAMPLE

Xero Createexpenseclaims Example

6 fields

EXAMPLE

Xero Createfeedconnections Example

6 fields

EXAMPLE

Xero Createfileassociation Example

6 fields

EXAMPLE

Xero Createfolder Example

6 fields

EXAMPLE

Xero Createinvoiceattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createinvoices Example

6 fields

EXAMPLE

Xero Createitems Example

6 fields

EXAMPLE

Xero Createleaveapplication Example

6 fields

EXAMPLE

Xero Createleavetype Example

6 fields

EXAMPLE

Xero Createlinkedtransaction Example

6 fields

EXAMPLE

Xero Createmanualjournalattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createmanualjournals Example

6 fields

EXAMPLE

Xero Createmultipleemployeeearningstemplate Example

6 fields

EXAMPLE

Xero Createoverpaymentallocations Example

6 fields

EXAMPLE

Xero Createoverpaymenthistory Example

6 fields

EXAMPLE

Xero Createpayitem Example

6 fields

EXAMPLE

Xero Createpayment Example

6 fields

EXAMPLE

Xero Createpaymenthistory Example

6 fields

EXAMPLE

Xero Createpayments Example

6 fields

EXAMPLE

Xero Createpaymentservice Example

6 fields

EXAMPLE

Xero Createpayrollcalendar Example

6 fields

EXAMPLE

Xero Createpayrun Example

6 fields

EXAMPLE

Xero Createpayruncalendar Example

6 fields

EXAMPLE

Xero Createprepaymentallocations Example

6 fields

EXAMPLE

Xero Createprepaymenthistory Example

6 fields

EXAMPLE

Xero Createproject Example

6 fields

EXAMPLE

Xero Createpurchaseorderattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createpurchaseorders Example

6 fields

EXAMPLE

Xero Createquoteattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createquotes Example

6 fields

EXAMPLE

Xero Createreceipt Example

6 fields

EXAMPLE

Xero Createreceiptattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createreceipthistory Example

6 fields

EXAMPLE

Xero Createreimbursement Example

6 fields

EXAMPLE

Xero Createrepeatinginvoiceattachmentbyfilename Example

6 fields

EXAMPLE

Xero Createrepeatinginvoices Example

6 fields

EXAMPLE

Xero Createstatements Example

6 fields

EXAMPLE

Xero Createsuperannuation Example

6 fields

EXAMPLE

Xero Createsuperfund Example

6 fields

EXAMPLE

Xero Createtask Example

6 fields

EXAMPLE

Xero Createtaxrates Example

6 fields

EXAMPLE

Xero Createtimeentry Example

6 fields

EXAMPLE

Xero Createtimesheet Example

6 fields

EXAMPLE

Xero Createtimesheetline Example

6 fields

EXAMPLE

Xero Createtrackingcategory Example

6 fields

EXAMPLE

Xero Createtrackingoptions Example

6 fields

EXAMPLE

Xero Deleteaccount Example

6 fields

EXAMPLE

Xero Deletebatchpayment Example

6 fields

EXAMPLE

Xero Deletebatchpaymentbyurlparam Example

6 fields

EXAMPLE

Xero Deletecreditnoteallocations Example

6 fields

EXAMPLE

Xero Deleteemployeeearningstemplate Example

6 fields

EXAMPLE

Xero Deleteemployeeleave Example

6 fields

EXAMPLE

Xero Deleteemployeesalaryandwage Example

6 fields

EXAMPLE

Xero Deleteemployeeworkingpattern Example

6 fields

EXAMPLE

Xero Deletefeedconnections Example

6 fields

EXAMPLE

Xero Deleteoverpaymentallocations Example

6 fields

EXAMPLE

Xero Deletepayment Example

6 fields

EXAMPLE

Xero Deleteprepaymentallocations Example

6 fields

EXAMPLE

Xero Deletetimesheet Example

6 fields

EXAMPLE

Xero Deletetimesheetline Example

6 fields

EXAMPLE

Xero Deletetrackingcategory Example

6 fields

EXAMPLE

Xero Deletetrackingoptions Example

6 fields

EXAMPLE

Xero Emailinvoice Example

6 fields

EXAMPLE

Xero Getaccount Example

6 fields

EXAMPLE

Xero Getaccountattachments Example

6 fields

EXAMPLE

Xero Getaccounts Example

6 fields

EXAMPLE

Xero Getassetbyid Example

6 fields

EXAMPLE

Xero Getassets Example

6 fields

EXAMPLE

Xero Getassetsettings Example

6 fields

EXAMPLE

Xero Getassettypes Example

6 fields

EXAMPLE

Xero Getassociationsbyobject Example

6 fields

EXAMPLE

Xero Getbankstatementaccounting Example

6 fields

EXAMPLE

Xero Getbanktransaction Example

6 fields

EXAMPLE

Xero Getbanktransactionattachments Example

6 fields

EXAMPLE

Xero Getbanktransactions Example

6 fields

EXAMPLE

Xero Getbanktransfer Example

6 fields

EXAMPLE

Xero Getbanktransferattachments Example

6 fields

EXAMPLE

Xero Getbanktransfers Example

6 fields

EXAMPLE

Xero Getbatchpayment Example

6 fields

EXAMPLE

Xero Getbatchpaymenthistory Example

6 fields

EXAMPLE

Xero Getbatchpayments Example

6 fields

EXAMPLE

Xero Getbenefit Example

6 fields

EXAMPLE

Xero Getbenefits Example

6 fields

EXAMPLE

Xero Getbrandingtheme Example

6 fields

EXAMPLE

Xero Getbrandingthemepaymentservices Example

6 fields

EXAMPLE

Xero Getbrandingthemes Example

6 fields

EXAMPLE

Xero Getbudget Example

6 fields

EXAMPLE

Xero Getbudgets Example

6 fields

EXAMPLE

Xero Getcashvalidation Example

6 fields

EXAMPLE

Xero Getconnections Example

6 fields

EXAMPLE

Xero Getcontact Example

6 fields

EXAMPLE

Xero Getcontactattachments Example

6 fields

EXAMPLE

Xero Getcontactbycontactnumber Example

6 fields

EXAMPLE

Xero Getcontactcissettings Example

6 fields

EXAMPLE

Xero Getcontactgroup Example

6 fields

EXAMPLE

Xero Getcontactgroups Example

6 fields

EXAMPLE

Xero Getcontacts Example

6 fields

EXAMPLE

Xero Getcreditnote Example

6 fields

EXAMPLE

Xero Getcreditnoteattachments Example

6 fields

EXAMPLE

Xero Getcreditnotes Example

6 fields

EXAMPLE

Xero Getcurrencies Example

6 fields

EXAMPLE

Xero Getdeduction Example

6 fields

EXAMPLE

Xero Getdeductions Example

6 fields

EXAMPLE

Xero Getearningsorder Example

6 fields

EXAMPLE

Xero Getearningsorders Example

6 fields

EXAMPLE

Xero Getearningsrate Example

6 fields

EXAMPLE

Xero Getearningsrates Example

6 fields

EXAMPLE

Xero Getemployee Example

6 fields

EXAMPLE

Xero Getemployeeleave Example

6 fields

EXAMPLE

Xero Getemployeeleavebalances Example

6 fields

EXAMPLE

Xero Getemployeeleaveperiods Example

6 fields

EXAMPLE

Xero Getemployeeleaves Example

6 fields

EXAMPLE

Xero Getemployeeleavetypes Example

6 fields

EXAMPLE

Xero Getemployeeopeningbalances Example

6 fields

EXAMPLE

Xero Getemployeepaymentmethod Example

6 fields

EXAMPLE

Xero Getemployeepaytemplate Example

6 fields

EXAMPLE

Xero Getemployeepaytemplates Example

6 fields

EXAMPLE

Xero Getemployees Example

6 fields

EXAMPLE

Xero Getemployeesalaryandwage Example

6 fields

EXAMPLE

Xero Getemployeesalaryandwages Example

6 fields

EXAMPLE

Xero Getemployeestatutoryleavebalances Example

6 fields

EXAMPLE

Xero Getemployeestatutorysickleave Example

6 fields

EXAMPLE

Xero Getemployeetax Example

6 fields

EXAMPLE

Xero Getemployeeworkingpattern Example

6 fields

EXAMPLE

Xero Getemployeeworkingpatterns Example

6 fields

EXAMPLE

Xero Getexpenseclaim Example

6 fields

EXAMPLE

Xero Getexpenseclaims Example

6 fields

EXAMPLE

Xero Getfeedconnection Example

6 fields

EXAMPLE

Xero Getfeedconnections Example

6 fields

EXAMPLE

Xero Getfile Example

6 fields

EXAMPLE

Xero Getfileassociations Example

6 fields

EXAMPLE

Xero Getfiles Example

6 fields

EXAMPLE

Xero Getfinancialstatementbalancesheet Example

6 fields

EXAMPLE

Xero Getfinancialstatementcashflow Example

6 fields

EXAMPLE

Xero Getfinancialstatementcontactsexpense Example

6 fields

EXAMPLE

Xero Getfinancialstatementcontactsrevenue Example

6 fields

EXAMPLE

Xero Getfinancialstatementprofitandloss Example

6 fields

EXAMPLE

Xero Getfinancialstatementtrialbalance Example

6 fields

EXAMPLE

Xero Getfolder Example

6 fields

EXAMPLE

Xero Getfolders Example

6 fields

EXAMPLE

Xero Getinbox Example

6 fields

EXAMPLE

Xero Getinvoice Example

6 fields

EXAMPLE

Xero Getinvoiceattachments Example

6 fields

EXAMPLE

Xero Getinvoicereminders Example

6 fields

EXAMPLE

Xero Getinvoices Example

6 fields

EXAMPLE

Xero Getitem Example

6 fields

EXAMPLE

Xero Getitems Example

6 fields

EXAMPLE

Xero Getjournal Example

6 fields

EXAMPLE

Xero Getjournalbynumber Example

6 fields

EXAMPLE

Xero Getjournals Example

6 fields

EXAMPLE

Xero Getleaveapplication Example

6 fields

EXAMPLE

Xero Getleaveapplications Example

6 fields

EXAMPLE

Xero Getleaveapplicationsv2 Example

6 fields

EXAMPLE

Xero Getleavetype Example

6 fields

EXAMPLE

Xero Getleavetypes Example

6 fields

EXAMPLE

Xero Getlinkedtransaction Example

6 fields

EXAMPLE

Xero Getlinkedtransactions Example

6 fields

EXAMPLE

Xero Getmanualjournal Example

6 fields

EXAMPLE

Xero Getmanualjournalattachments Example

6 fields

EXAMPLE

Xero Getmanualjournals Example

6 fields

EXAMPLE

Xero Getonlineinvoice Example

6 fields

EXAMPLE

Xero Getorganisationactions Example

6 fields

EXAMPLE

Xero Getorganisationcissettings Example

6 fields

EXAMPLE

Xero Getorganisations Example

6 fields

EXAMPLE

Xero Getoverpayment Example

6 fields

EXAMPLE

Xero Getoverpayments Example

6 fields

EXAMPLE

Xero Getpayitems Example

6 fields

EXAMPLE

Xero Getpayment Example

6 fields

EXAMPLE

Xero Getpayments Example

6 fields

EXAMPLE

Xero Getpaymentservices Example

6 fields

EXAMPLE

Xero Getpayrollcalendar Example

6 fields

EXAMPLE

Xero Getpayrollcalendars Example

6 fields

EXAMPLE

Xero Getpayrun Example

6 fields

EXAMPLE

Xero Getpayruncalendar Example

6 fields

EXAMPLE

Xero Getpayruncalendars Example

6 fields

EXAMPLE

Xero Getpayruns Example

6 fields

EXAMPLE

Xero Getpayslip Example

6 fields

EXAMPLE

Xero Getpayslips Example

6 fields

EXAMPLE

Xero Getprepayment Example

6 fields

EXAMPLE

Xero Getprepayments Example

6 fields

EXAMPLE

Xero Getproject Example

6 fields

EXAMPLE

Xero Getprojects Example

6 fields

EXAMPLE

Xero Getprojectusers Example

6 fields

EXAMPLE

Xero Getpurchaseorder Example

6 fields

EXAMPLE

Xero Getpurchaseorderattachments Example

6 fields

EXAMPLE

Xero Getpurchaseorderbynumber Example

6 fields

EXAMPLE

Xero Getpurchaseorders Example

6 fields

EXAMPLE

Xero Getquote Example

6 fields

EXAMPLE

Xero Getquoteattachments Example

6 fields

EXAMPLE

Xero Getquotes Example

6 fields

EXAMPLE

Xero Getreceipt Example

6 fields

EXAMPLE

Xero Getreceiptattachments Example

6 fields

EXAMPLE

Xero Getreceipts Example

6 fields

EXAMPLE

Xero Getreimbursement Example

6 fields

EXAMPLE

Xero Getreimbursements Example

6 fields

EXAMPLE

Xero Getrepeatinginvoice Example

6 fields

EXAMPLE

Xero Getrepeatinginvoiceattachments Example

6 fields

EXAMPLE

Xero Getrepeatinginvoices Example

6 fields

EXAMPLE

Xero Getreportagedpayablesbycontact Example

6 fields

EXAMPLE

Xero Getreportagedreceivablesbycontact Example

6 fields

EXAMPLE

Xero Getreportbalancesheet Example

6 fields

EXAMPLE

Xero Getreportbanksummary Example

6 fields

EXAMPLE

Xero Getreportbudgetsummary Example

6 fields

EXAMPLE

Xero Getreportexecutivesummary Example

6 fields

EXAMPLE

Xero Getreporttenninetynine Example

6 fields

EXAMPLE

Xero Getreporttrialbalance Example

6 fields

EXAMPLE

Xero Getsettings Example

6 fields

EXAMPLE

Xero Getstatement Example

6 fields

EXAMPLE

Xero Getstatements Example

6 fields

EXAMPLE

Xero Getstatutorydeduction Example

6 fields

EXAMPLE

Xero Getstatutorydeductions Example

6 fields

EXAMPLE

Xero Getstatutoryleavesummary Example

6 fields

EXAMPLE

Xero Getsuperannuation Example

6 fields

EXAMPLE

Xero Getsuperannuations Example

6 fields

EXAMPLE

Xero Getsuperfund Example

6 fields

EXAMPLE

Xero Getsuperfundproducts Example

6 fields

EXAMPLE

Xero Getsuperfunds Example

6 fields

EXAMPLE

Xero Gettask Example

6 fields

EXAMPLE

Xero Gettasks Example

6 fields

EXAMPLE

Xero Gettaxratebytaxtype Example

6 fields

EXAMPLE

Xero Gettaxrates Example

6 fields

EXAMPLE

Xero Gettimeentries Example

6 fields

EXAMPLE

Xero Gettimeentry Example

6 fields

EXAMPLE

Xero Gettimesheet Example

6 fields

EXAMPLE

Xero Gettimesheets Example

6 fields

EXAMPLE

Xero Gettrackingcategories Example

6 fields

EXAMPLE

Xero Gettrackingcategory Example

6 fields

EXAMPLE

Xero Getuser Example

6 fields

EXAMPLE

Xero Getusers Example

6 fields

EXAMPLE

Xero Patchproject Example

6 fields

EXAMPLE

Xero Postsetup Example

6 fields

EXAMPLE

Xero Rejectleaveapplication Example

6 fields

EXAMPLE

Xero Reverttimesheet Example

6 fields

EXAMPLE

Xero Updateaccount Example

6 fields

EXAMPLE

Xero Updateaccountattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatebanktransaction Example

6 fields

EXAMPLE

Xero Updatebanktransactionattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatebanktransferattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatecontact Example

6 fields

EXAMPLE

Xero Updatecontactattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatecontactgroup Example

6 fields

EXAMPLE

Xero Updatecreditnote Example

6 fields

EXAMPLE

Xero Updatecreditnoteattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updateemployee Example

6 fields

EXAMPLE

Xero Updateemployeeearningstemplate Example

6 fields

EXAMPLE

Xero Updateemployeeleave Example

6 fields

EXAMPLE

Xero Updateemployeeopeningbalances Example

6 fields

EXAMPLE

Xero Updateemployeesalaryandwage Example

6 fields

EXAMPLE

Xero Updateemployeetax Example

6 fields

EXAMPLE

Xero Updateexpenseclaim Example

6 fields

EXAMPLE

Xero Updatefile Example

6 fields

EXAMPLE

Xero Updatefolder Example

6 fields

EXAMPLE

Xero Updateinvoice Example

6 fields

EXAMPLE

Xero Updateinvoiceattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updateitem Example

6 fields

EXAMPLE

Xero Updateleaveapplication Example

6 fields

EXAMPLE

Xero Updatelinkedtransaction Example

6 fields

EXAMPLE

Xero Updatemanualjournal Example

6 fields

EXAMPLE

Xero Updatemanualjournalattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updateorcreatebanktransactions Example

6 fields

EXAMPLE

Xero Updateorcreatecontacts Example

6 fields

EXAMPLE

Xero Updateorcreatecreditnotes Example

6 fields

EXAMPLE

Xero Updateorcreateemployees Example

6 fields

EXAMPLE

Xero Updateorcreateinvoices Example

6 fields

EXAMPLE

Xero Updateorcreateitems Example

6 fields

EXAMPLE

Xero Updateorcreatemanualjournals Example

6 fields

EXAMPLE

Xero Updateorcreatepurchaseorders Example

6 fields

EXAMPLE

Xero Updateorcreatequotes Example

6 fields

EXAMPLE

Xero Updateorcreaterepeatinginvoices Example

6 fields

EXAMPLE

Xero Updatepayrun Example

6 fields

EXAMPLE

Xero Updatepayslip Example

6 fields

EXAMPLE

Xero Updatepaysliplineitems Example

6 fields

EXAMPLE

Xero Updateproject Example

6 fields

EXAMPLE

Xero Updatepurchaseorder Example

6 fields

EXAMPLE

Xero Updatepurchaseorderattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatequote Example

6 fields

EXAMPLE

Xero Updatequoteattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatereceipt Example

6 fields

EXAMPLE

Xero Updatereceiptattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updaterepeatinginvoice Example

6 fields

EXAMPLE

Xero Updaterepeatinginvoiceattachmentbyfilename Example

6 fields

EXAMPLE

Xero Updatesuperfund Example

6 fields

EXAMPLE

Xero Updatetask Example

6 fields

EXAMPLE

Xero Updatetaxrate Example

6 fields

EXAMPLE

Xero Updatetimeentry Example

6 fields

EXAMPLE

Xero Updatetimesheet Example

6 fields

EXAMPLE

Xero Updatetimesheetline Example

6 fields

EXAMPLE

Xero Updatetrackingcategory Example

6 fields

EXAMPLE

Xero Updatetrackingoptions Example

6 fields

EXAMPLE

Xero Uploadfile Example

6 fields

EXAMPLE

Xero Uploadfiletofolder Example

6 fields

EXAMPLE

Resources

🔗
LinkedIn
LinkedIn
🌐
Portal
Portal
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
📦
SDKs
SDKs
🔗
Webhooks
Webhooks
📄
ChangeLog
ChangeLog
📰
Blog
Blog
💬
FAQ
FAQ
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
🟢
StatusPage
StatusPage
📝
Signup
Signup
👥
GitHubOrganization
GitHubOrganization
🔗
MCPServer
MCPServer

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Xero Projects API
  version: 11.1.0
items:
- info:
    name: Project
    type: folder
  items:
  - info:
      name: Xero Retrieves all projects
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectIds
        value: ''
        type: query
        description: Search for all projects that match a comma separated list of projectIds
      - name: contactID
        value: ''
        type: query
        description: Filter for projects for a specific contact
      - name: states
        value: ''
        type: query
        description: Filter for projects in a particular state (INPROGRESS or CLOSED)
      - name: page
        value: ''
        type: query
        description: set to 1 by default. The requested number of the page in paged response - Must be a number greater than
          0.
      - name: pageSize
        value: ''
        type: query
        description: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must
          be a number between 1 and 500.
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve, create and update projects.
  - info:
      name: Xero Create one or more new projects
      type: http
    http:
      method: POST
      url: https://api.xero.com/projects.xro/2.0/Projects
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Xero Create one or more new projects
  - info:
      name: Xero Retrieves a single project
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve a specific project using the projectId
  - info:
      name: Xero Updates a specific project
      type: http
    http:
      method: PUT
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to update a specific projects.
  - info:
      name: Xero creates a project for the specified contact
      type: http
    http:
      method: PATCH
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to update a specific projects.
  - info:
      name: Xero Retrieves a list of all project users
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/ProjectsUsers
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: page
        value: ''
        type: query
        description: set to 1 by default. The requested number of the page in paged response - Must be a number greater than
          0.
      - name: pageSize
        value: ''
        type: query
        description: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must
          be a number between 1 and 500.
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve the users on a projects.
  - info:
      name: Xero Retrieves all project tasks
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Tasks
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: page
        value: ''
        type: query
        description: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than
          0.
      - name: pageSize
        value: ''
        type: query
        description: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must
          be a number between 1 and 500.
      - name: taskIds
        value: ''
        type: query
        description: Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID}
      - name: chargeType
        value: ''
        type: query
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve a specific project
  - info:
      name: Xero Allows you to create a task
      type: http
    http:
      method: POST
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Tasks
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can create a task on a specified projectId
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to create a specific task
  - info:
      name: Xero Retrieves a single project task
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Tasks/:taskId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: taskId
        value: ''
        type: path
        description: You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID}
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve a specific project
  - info:
      name: Xero Allows you to update a task
      type: http
    http:
      method: PUT
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Tasks/:taskId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: taskId
        value: ''
        type: path
        description: You can specify an individual task by appending the id to the endpoint
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to update a specific task
  - info:
      name: Xero Allows you to delete a task
      type: http
    http:
      method: DELETE
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Tasks/:taskId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: taskId
        value: ''
        type: path
        description: You can specify an individual task by appending the id to the endpoint
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to delete a specific task
  - info:
      name: Xero Retrieves all time entries associated with a specific project
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Time
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: Identifier of the project, that the task (which the time entry is logged against) belongs to.
      - name: userId
        value: ''
        type: query
        description: The xero user identifier of the person who logged time.
      - name: taskId
        value: ''
        type: query
        description: Identifier of the task that time entry is logged against.
      - name: invoiceId
        value: ''
        type: query
        description: Finds all time entries for this invoice.
      - name: contactId
        value: ''
        type: query
        description: Finds all time entries for this contact identifier.
      - name: page
        value: ''
        type: query
        description: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than
          0.
      - name: pageSize
        value: ''
        type: query
        description: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must
          be a number between 1 and 500.
      - name: states
        value: ''
        type: query
        description: Comma-separated list of states to find. Will find all time entries that are in the status of whatever
          is specified.
      - name: isChargeable
        value: ''
        type: query
        description: Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`.
      - name: dateAfterUtc
        value: ''
        type: query
        description: ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field.
      - name: dateBeforeUtc
        value: ''
        type: query
        description: ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field.
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to retrieve the time entries associated with a specific project
  - info:
      name: Xero Creates a time entry for a specific project
      type: http
    http:
      method: POST
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Time
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to create a specific task
  - info:
      name: Xero Retrieves a single time entry for a specific project
      type: http
    http:
      method: GET
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Time/:timeEntryId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: timeEntryId
        value: ''
        type: path
        description: You can specify an individual time entry by appending the id to the endpoint
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to get a single time entry in a project
  - info:
      name: Xero Updates a time entry for a specific project
      type: http
    http:
      method: PUT
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Time/:timeEntryId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      - name: Idempotency-Key
        value: KEY_VALUE
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: timeEntryId
        value: ''
        type: path
        description: You can specify an individual time entry by appending the id to the endpoint
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to update time entry in a project
  - info:
      name: Xero Deletes a time entry for a specific project
      type: http
    http:
      method: DELETE
      url: https://api.xero.com/projects.xro/2.0/Projects/:projectId/Time/:timeEntryId
      headers:
      - name: Xero-Tenant-Id
        value: ''
      params:
      - name: projectId
        value: ''
        type: path
        description: You can specify an individual project by appending the projectId to the endpoint
      - name: timeEntryId
        value: ''
        type: path
        description: You can specify an individual task by appending the id to the endpoint
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://login.xero.com/identity/connect/authorize
        accessTokenUrl: https://identity.xero.com/connect/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Allows you to delete a specific time entry
bundled: true