API Reference bexio_api_client v#2.0.0
Copy MarkdownModules
base functionality like refreshing the access token.
Bexio API for the accounting part of the API.
Bexio Account Module.
Bexio Account Group Module.
Bexio Business Year Module.
Bexio Calendar Year Module.
Bexio Currency Module.
Bexio Currency Exchange Rate Module.
Bexio Journal Entry Module.
Bexio Manual Entry Module.
Bexio Manual Entry File Module.
Bexio Manual Entry Line Module.
Bexio Tax Module.
Bexio Vat Period Module.
Bexio API for the banking part of the API.
Bank account shown on the banking component page (bexio API v3).
Payment in banking (bexio API v4).
Reference of the bill a bexio payment belongs to.
Recipient of a bexio payment.
Address of the recipient of a bexio payment.
Sender (the paying bank account) of a bexio payment.
Bexio API for the business activities, communication types and client services part of the API.
Bexio Business Activity (client service) Module.
Bexio Communication Type (communication kind) 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.
Bexio File Usage 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 Document Template 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.
Bexio API for the payroll part of the API (the /4.0/payroll endpoints).
Absence of a payroll employee.
Address of a payroll employee.
Payroll Employee.
Bexio API for the projects part of the API.
Bexio Milestone Module (part of a project under /3.0/projects).
Bexio Project Module.
Bexio Project Status Module.
Bexio Project Type Module.
Bexio Work Package Module (part of a project under /3.0/projects).
Purchase Part of the API
Address of a contact as embedded in purchase documents (bills, expenses).
Bill in purchase
Discount of a bill in purchase.
Line item of a bill in purchase.
Payment settings of a bill in purchase.
Result of a document number validation for purchase documents (bills, expenses).
Expense in purchase
Outgoing payment for a bill in purchase
Purchase order (v3 API)
Req request step that fetches and caches access tokens for Bexio OAuth2 clients.
Behaviour for deciding whether and when to retry a Bexio API request.
This module implements the BexioApiClient.Req.RetryPolicy behaviour: it
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.
Repetition of an order
Payment of an invoice
Default Position (KbPositionCustom)
Discount Position (KbPositionDiscount)
Item Position (KbPositionCustom)
Pagebreak Position (KbPositionPagebreak)
Subposition Position (KbPositionSubposition)
Subtotal Position (KbPositionSubtotal)
Text Position (KbPositionText)
Reminder of an invoice
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.
Bexio API for the timesheets part of the API
Bexio Timesheet Module.
Bexio Timesheet Status Module.
Bexio Timesheet Tracking Module.