API Reference bexio_api_client v0.7.0

modules

Modules

base functionality like refreshing the access token.

Bexio API for the accounting part of the API.

Bexio Account Module.

Bexio Account Group Module.

Bexio Calendar Year Module.

Bexio Currency Module.

Bexio Currency Exchange Rate Module.

Bexio Tax Module.

Bexio API for the contacts part of the API.

Bexio Additional Address Module.

Bexio Contact Module.

Bexio Contact Relation Module.

Bexio API for the files part of the API

Bexio File Module.

Paging part of the response

Typespec and helpers for global usable arguments

Bexio API for the items & products part of the API

Bexio Items Module.

Bexio API for the other endpoints.

Bexio Company Profile Module.

Bexio Country Module.

Bexio Fictional User Module.

Bexio Language Module.

Bexio Note Module.

Bexio Permission Module.

Bexio Task Module, renamed to Todo in Elixir.

Bexio User Module.

Purchase Part of the API

Bill in purchase

Plugin to fetch a new access token for the given refresh token.

This module just handles the normal Bexio API rate limit headers as well as the (observed) regular exceptions to retry. With status code 429 we try to read the header "ratelimit-reset" and send back the {:delay, delay} tuple. In case of 408, 500, 502, 503, 504 we fall back to the retry mechanism.

Bexio API for the sales order management part of the API.

Default Position (KbPositionCustom)

Discount Position (KbPositionDiscount)

Item Position (KbPositionCustom)

Pagebreak Position (KbPositionPagebreak)

Subposition Position (KbPositionSubposition)

Subtotal Position (KbPositionSubtotal)

Text Position (KbPositionText)

Some older endpoints implement search methods. Searching for these endpoint works by sending a POST request to the resource (e.g.: POST /contact/search or POST /country/search). The search parameters must be provided in the body of the POST request.