Site configuration¶

Note

For changes made in the site configuration to take effect the cache has to be cleared.

Example site configuration for bexio related properties¶

bexio:
  auth:
    urlSegmentChallenge: muhh
    clientId: 11111111-1111-1111-11111111111111111
    clientSecret: aaaaaaaaaaaaaaaaaaaa-aaaaa-aaaaaaaaaa-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
    scopes: ['openid', 'profile', 'contact_edit', 'offline_access', 'kb_invoice_edit', 'bank_payment_edit']
  eventListener:
    emailInvoicePayment:
      to:
        email: bookkeeping@bexio.ddev.site
        name: 'Hans Dampf'
  invoice:
    storageUid: 3
    new:
      userId: 1
      bankAccountId: 8
      currencyId: 2
    position:
      new:
        amount: 1
        unitId: 2
        unitPrice: 90.0
        accountId: 278
        taxId: 16
        type: KbPositionCustom
  user:
    storageUid: 2
    userGroupUid: 1
    linkMatchProperties: firstName, lastName, email

Authentication¶

Authentication related site properties¶

bexio:
  auth:
    urlSegmentChallenge: muhh
    clientId: 11111111-1111-1111-11111111111111111
    clientSecret: aaaaaaaaaaaaaaaaaaaa-aaaaa-aaaaaaaaaa-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
    scopes: ['openid', 'profile', 'contact_edit', 'offline_access', 'kb_invoice_edit', 'bank_payment_edit']

urlSegmentChallenge¶

Property

bexio.auth.urlSegmentChallenge

Data type

string

Description

Additional url segment used during the manual authentication process to challenge abuses. For security reasons prefer something cryptic like wdoufkyrkLoqaarxxvmdxyyj.

clientId¶

Property

bexio.auth.clientId

Data type

string

Description

The client ID provided by the bexio web site (see Admin - Create an app)

clientSecret¶

Property

bexio.auth.clientSecret

Data type

string

Description

The client secret provided by the bexio web site (see Admin - Create an app)

scopes¶

Property

bexio.auth.scopes

Data type

string

Description

See Bexio API scopes

User¶

User related site configuration properties¶

bexio:
  user:
    storageUid = 2
    userGroupUid = 1
    linkMatchProperties = firstName, lastName, email

storageUid¶

Property

bexio.user.storageUid

Data type

int/string

Description

Coma separated list of uid’s from pages where frontend users are located. The first item is used to store new records.

userGroupUid¶

Property

bexio.user.userGroupUid

Data type

int/string

Description

Coma separated list from user group uid’s that should be assigned to new frontend users.

linkMatchProperties¶

Property

bexio.user.linkMatchProperties

Data type

string

Description

Coma separated list of ields to be used when linking a bexio customer to a frontend user. Use a combination from the following properties: company, firstName, lastName, address, zip, city, country, telephone, email, www.

Invoice¶

The properties under the new keys (bexio.invoice.new, bexio.invoice.position.new) serve as default values when creating an invoice. When creating an invoice with the cli these properties can be modified. The meaning from the respective values can be looked up in the output from the console command Settings.

Invoice related site configuration properties¶

bexio:
  invoice:
    storageUid: 3
    new:
      userId: 1
      bankAccountId: 8
      currencyId: 2
    position:
      new:
        amount: 1
        unitId: 2
        unitPrice: 90.0
        accountId: 278
        taxId: 16
        type: KbPositionCustom

invoice.storageUid¶

Property

bexio.invoice.storageUid

Data type

int/string

Description

Coma separated list of uid’s from pages where invoices are located. The first item is used to store new records.

Event listeners¶

Event listeners related properties¶

bexio:
  eventListener:
    emailInvoicePayment:
      to:
        email: 'bookkeeping@bexio.ddev.site'
        name: 'Hans Dampf'

EmailInvoicePayments¶

to.email¶

Property

bexio.eventListener.emailInvoicePayment.to.email

Data type

string

Description

Email address used in EmailInvoicePayment event listener.

to.name¶

Property

bexio.eventListener.emailInvoicePayment.to.name

Data type

string

Description

Email name used in EmailInvoicePayment event listener.