When creating a new client ID and secret it is necessary to list which scopes should be granted to those credentials. In addition, when requesting an access token using a client ID and secret, the list of scopes can be further reduced as compared to the list of scopes of the credentials. It is not possible for an access token to obtain a scope that has not been granted to the client ID and secret.
List of currently supported scopes
Scope | Description |
---|---|
payable:read | Allows read-only access to payables |
payable-attachment:read | Allows retrieving documentary evidence (attachments) of payables |
settlement:read | Allows read-only access to settlements |
bank-fee:read | Allows read-only access to bank fees |
wallet-load:read | Allows read-only access to wallet loads |
wallet-summary:read | Allows retrieving the summary of the wallet (balances) |
user:read | Allows retrieving company users (members) |
supplier:read | Allows retrieving the list of suppliers |
cost-center:read | Allows read-only access to cost centers |
expense-category:read | Allows read-only access to expense categories |
analytical-field:read | Allows retrieving analytical fields and values |
experimental:accounting-export:read | (Experimental) Allows retrieving file-based purchase and bank journals |
experimental:webhooks:read | (Experimental) Allows retrieving configured web-hooks |
experimental:webhooks:write | (Experimental) Allows configuring web-hooks |