Skip to main content

Xero scopes by use case

Detailed guidance on access scopes required for the Xero partnership certification

Checkpoint 7: Scopes, part of the Xero App Partner certification program, requires that apps have the minimal access to data as required by their use case.

To comply, you must define the access scopes you need for your intended use case. During the app review, Xero will ask you to justify your use of scopes and explain why you are accessing the related data.

We have mapped out the Xero scopes that apply to each specific Codat use case in the table below. You will also need these scope regardless of the use case:

  • offline_access
  • accounting.settings
Xero Partnership TypeCodat Use CaseSuggested Xero Scopes
Financial Services - Bank FeedsReconciling bank transactionsbankfeeds
Financial Services - LendingLending - Loan qualificationaccounting.reports.read
accounting.transactions
accounting.contacts
accounting.attachments
accounting.reports.bankstatement.read
Financial Services - LendingLending - Invoice financeaccounting.reports.read
accounting.transactions
accounting.contacts
accounting.attachments
accounting.reports.bankstatement.read
App Store and Financial Services - Bank FeedsManaging expensesaccounting.transactions
accounting.contacts
accounting.attachments
bankfeeds
App StoreDashboardingRead-only configuration required. Please work with your implementation specialist to configure scopes.
App StoreAutomating payablesaccounting.transactions
accounting.contacts
accounting.attachments
App StoreAutomating receivablesaccounting.transactions
accounting.contacts
accounting.attachments
App StoreIntegrating commerce dataaccounting.journals.read
accounting.transactions
accounting.contacts
App StoreManaging payrollaccounting.journals.read
accounting.transactions