Xero API Integration | Coverage & Setup

Know what you can build.

Xero coverage in the Accounting API. Read and write support differ by resource.

Resource	Read	Write / notes
Onboarding	✓ Supported	Client-managed connection required; system ID: `xero`
Sales invoices	✓ List + individual	Creation not supported
Supplier invoices	✓ List + individual	Creation not supported
Customers	✓ List + individual	Read only
Suppliers	✓ List + individual	Read only
Journals	✓ List + individual	✓ Create
Chart of accounts	✓ Supported	Read only
Financial reports	Not supported / contact us	Not supported

Check the full API Coverage →

“Not supported / contact us” indicates an unavailable unified endpoint. Native API access depends on the separate Proxy.1 availability shown below.

View full endpoint coverage, including attachments and payments

Method	Resource	Support
`GET`	`accountingaccounts`	✓ Supported
`GET`	`accountingperiods`	✓ Supported
`GET`	`balancesheet`	Not supported / contact us
`GET`	`companyinformation`	✓ Supported
`GET`	`customers`	✓ Supported
`GET`	`customers/{customerId}`	✓ Supported
`GET`	`financialdimensions`	✓ Supported
`GET`	`incomestatement`	Not supported / contact us
`GET`	`journals`	✓ Supported
`GET`	`journals/{journalId}`	✓ Supported
`POST`	`journals`	✓ Supported
`GET`	`journals/{journalId}/attachments/{attachmentId}`	✓ Supported
`POST`	`journals/{journalId}/attachments`	✓ Supported
`GET`	`proxy/{systemUrl}`	✓ Supported
`POST`	`proxy/{systemUrl}`	✓ Supported
`PUT`	`proxy/{systemUrl}`	✓ Supported
`PATCH`	`proxy/{systemUrl}`	✓ Supported
`DELETE`	`proxy/{systemUrl}`	✓ Supported
`GET`	`salesinvoices`	✓ Supported
`GET`	`salesinvoices/{salesInvoiceId}`	✓ Supported
`POST`	`salesinvoices`	Not supported / contact us
`GET`	`salesinvoices/{salesInvoiceId}/attachments`	✓ Supported
`GET`	`salesinvoices/{salesInvoiceId}/attachments/{attachmentId}`	✓ Supported
`GET`	`salesinvoices/{salesInvoiceId}/attachments/printable`	✓ Supported
`POST`	`salesinvoices/{salesInvoiceId}/attachments`	✓ Supported
`POST`	`salesinvoices/{salesInvoiceId}/notes`	Not supported / contact us
`GET`	`salesinvoices/payments`	✓ Supported
`GET`	`salesinvoices/{salesInvoiceId}/payments`	✓ Supported
`POST`	`salesinvoices/{salesInvoiceId}/payments`	✓ Supported
`GET`	`supplierinvoices`	✓ Supported
`GET`	`supplierinvoices/{supplierInvoiceId}`	✓ Supported
`POST`	`supplierinvoices`	Not supported / contact us
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments`	✓ Supported
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments/{attachmentId}`	✓ Supported
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments/printable`	✓ Supported
`POST`	`supplierinvoices/{supplierInvoiceId}/attachments`	✓ Supported
`GET`	`supplierinvoices/payments`	✓ Supported
`GET`	`supplierinvoices/{supplierInvoiceId}/payments`	✓ Supported
`POST`	`supplierinvoices/{supplierInvoiceId}/payments`	✓ Supported
`GET`	`suppliers`	✓ Supported
`GET`	`suppliers/{supplierId}`	✓ Supported
`GET`	`trialbalances (V2)`	Not supported / contact us

Connection options and Proxy.1 availability

Platform capability	Availability
Zwapgrid-managed connection	Not supported (product decision)
Client-managed connection	✓ Supported
Custom scope selection	Not supported (product decision)
Proxy.1	✓ Supported

Read the system setup guide →

Need something beyond the unified endpoints?

The Proxy API can reach native Xero endpoints, subject to the underlying API and permissions. Discuss your requirements →

Useful data. Real product workflows.

Payment visibility

Read sales and supplier invoice payments to support reconciliation workflows.

Customer data

Bring customer records into your product using the unified schema. Check list and individual-record support above.

Your first Xero request

With an API key and an authorised consent, retrieve sales invoices through the Accounting API.

curl 'https://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices?Count=100&CurrentPage=1' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'x-correlation-id: YOUR_UNIQUE_GUID'

Replace the placeholders. Use a unique correlation ID per request. Page through results with Count (1–100) and CurrentPage (starting at 1).

Explore the API documentation →

Plan your invoice sync

Supported sales-invoice status filters: Paid, Unpaid, Overdue, Cancelled, Draft. Check the endpoint documentation before adding other filters. Schedule reads to suit your product’s freshness needs.

From a test connection to your next market.

Start with a 14-day trial. Create your account and use development keys to build and test.
Connect Xero. Configure and publish a System Setting using the system setup guide, then create a consent and obtain the customer’s authorisation.
Validate, then go live. We help with test installations and test data. Verify your required fields, permissions and workflows in the target system before production.

Reuse the unified interface as you expand to more systems and markets. Coverage and local requirements vary, so validate each new workflow.

Start your 14-day free trial → Talk to us about Xero →

Build Your

Xero

Integration in Days, Not Weeks