Scopes

Bokio uses scopes to control access to different resources and operations in the API. Scopes provide fine-grained permission control, allowing integrations to request only the specific access they need to function properly.

How Scopes Work

Scopes follow a consistent naming pattern: {resource}:{action}. For example:

  • journal-entries:read - Read access to journal entries
  • journal-entries:write - Write access to journal entries
  • invoices:read - Read access to invoices

When multiple scopes are required, they are combined in a space-delimited string format:

journal-entries:read journal-entries:write invoices:read

Best Practices

  • Principle of Least Privilege: Only request the scopes that are absolutely necessary for your integration to function
  • Separate Read/Write Access: Consider whether your integration truly needs write access or if read-only/write-only access is sufficient
  • Regular Review: Periodically review your integration's scope requirements as functionality evolves

Available Scopes

ResourceRead ScopeWrite ScopeDescription
Journal Entriesjournal-entries:readjournal-entries:writeAccess to accounting journal entries
Uploadsuploads:readuploads:writeAccess to uploaded documents and files
Invoicesinvoices:readinvoices:writeAccess to invoice data
Customerscustomers:readcustomers:writeAccess to customer information
Itemsitems:readitems:writeAccess to invoice line items and products
SIE Filessie:readRead-only access to SIE export files
Fiscal Yearsfiscal-years:readRead-only access to fiscal year information

📘

Support and Community

If you have any questions, issues, or feedback regarding the Bokio API, please reach out to [email protected] or join the Developer community. We appreciate any feedback you might have.