Scopes

Scopes define which endpoints your application has access to. You will specify your scopes when the user authorizes your application via the /oauth/authorize endpoint.

Available Scopes


ScopeDescription
read:companyGrants read-only access to company data.
write:companyAllows creating or updating company info.
write:accountAllows creating financial accounts.
write:transactionAllows creating transactions.
write:account_balanceAllows creating financial account balances.
write:benefitAllows creating company benefit policies.
write:departmentAllows creating departments.
write:locationAllows creating office locations.
write:workerAllows creating employees and contractors.
write:payrollAllows creating payrolls.
write:journalAllows creating and updating journal entries.
write:billAllows creating bills.
write:customerAllows creating customers.
write:integration_connectionAllows creating integration connections.
write:invoiceAllows creating invoices.
write:productAllows creating products.
write:requestAllows creating requests.
write:taskAllows creating tasks.
write:vendorAllows creating vendors.

If no scopes are provided, the read-only scopes (offline_access, read:company) will be used by default.