# bexio_api_client v2.0.0 - Table of Contents

> Bexio API Client for accessing the API described at https://docs.bexio.com.

## Modules

- [BexioApiClient](BexioApiClient.md): base functionality like refreshing the access token.
- [BexioApiClient.Accounting](BexioApiClient.Accounting.md): Bexio API for the accounting part of the API.

- [BexioApiClient.Accounting.Account](BexioApiClient.Accounting.Account.md): Bexio Account Module.

- [BexioApiClient.Accounting.AccountGroup](BexioApiClient.Accounting.AccountGroup.md): Bexio Account Group Module.

- [BexioApiClient.Accounting.BusinessYear](BexioApiClient.Accounting.BusinessYear.md): Bexio Business Year Module.

- [BexioApiClient.Accounting.CalendarYear](BexioApiClient.Accounting.CalendarYear.md): Bexio Calendar Year Module.

- [BexioApiClient.Accounting.Currency](BexioApiClient.Accounting.Currency.md): Bexio Currency Module.

- [BexioApiClient.Accounting.ExchangeRate](BexioApiClient.Accounting.ExchangeRate.md): Bexio Currency Exchange Rate Module.

- [BexioApiClient.Accounting.JournalEntry](BexioApiClient.Accounting.JournalEntry.md): Bexio Journal Entry Module.

- [BexioApiClient.Accounting.ManualEntry](BexioApiClient.Accounting.ManualEntry.md): Bexio Manual Entry Module.
- [BexioApiClient.Accounting.ManualEntryFile](BexioApiClient.Accounting.ManualEntryFile.md): Bexio Manual Entry File Module.
- [BexioApiClient.Accounting.ManualEntryLine](BexioApiClient.Accounting.ManualEntryLine.md): Bexio Manual Entry Line Module.
- [BexioApiClient.Accounting.Tax](BexioApiClient.Accounting.Tax.md): Bexio Tax Module.

- [BexioApiClient.Accounting.VatPeriod](BexioApiClient.Accounting.VatPeriod.md): Bexio Vat Period Module.

- [BexioApiClient.Banking](BexioApiClient.Banking.md): Bexio API for the banking part of the API.
- [BexioApiClient.Banking.BankAccount](BexioApiClient.Banking.BankAccount.md): Bank account shown on the banking component page (bexio API v3).

- [BexioApiClient.Banking.Payment](BexioApiClient.Banking.Payment.md): Payment in banking (bexio API v4).
- [BexioApiClient.Banking.PaymentPurchaseReference](BexioApiClient.Banking.PaymentPurchaseReference.md): Reference of the bill a bexio payment belongs to.

- [BexioApiClient.Banking.PaymentRecipient](BexioApiClient.Banking.PaymentRecipient.md): Recipient of a bexio payment.

- [BexioApiClient.Banking.PaymentRecipientAddress](BexioApiClient.Banking.PaymentRecipientAddress.md): Address of the recipient of a bexio payment.

- [BexioApiClient.Banking.PaymentSender](BexioApiClient.Banking.PaymentSender.md): Sender (the paying bank account) of a bexio payment.

- [BexioApiClient.BusinessActivities](BexioApiClient.BusinessActivities.md): Bexio API for the business activities, communication types and client services
part of the API.
- [BexioApiClient.BusinessActivities.BusinessActivity](BexioApiClient.BusinessActivities.BusinessActivity.md): Bexio Business Activity (client service) Module.

- [BexioApiClient.BusinessActivities.CommunicationType](BexioApiClient.BusinessActivities.CommunicationType.md): Bexio Communication Type (communication kind) Module.

- [BexioApiClient.Contacts](BexioApiClient.Contacts.md): Bexio API for the contacts part of the API.

- [BexioApiClient.Contacts.AdditionalAddress](BexioApiClient.Contacts.AdditionalAddress.md): Bexio Additional Address Module.

- [BexioApiClient.Contacts.Contact](BexioApiClient.Contacts.Contact.md): Bexio Contact Module.

- [BexioApiClient.Contacts.ContactRelation](BexioApiClient.Contacts.ContactRelation.md): Bexio Contact Relation Module.

- [BexioApiClient.Files](BexioApiClient.Files.md): Bexio API for the files part of the API

- [BexioApiClient.Files.File](BexioApiClient.Files.File.md): Bexio File Module.

- [BexioApiClient.Files.FileUsage](BexioApiClient.Files.FileUsage.md): Bexio File Usage Module.

- [BexioApiClient.Global.Paging](BexioApiClient.Global.Paging.md): Paging part of the response

- [BexioApiClient.GlobalArguments](BexioApiClient.GlobalArguments.md): Typespec and helpers for global usable arguments

- [BexioApiClient.Items](BexioApiClient.Items.md): Bexio API for the items & products part of the API

- [BexioApiClient.Items.Item](BexioApiClient.Items.Item.md): Bexio Items Module.

- [BexioApiClient.Others](BexioApiClient.Others.md): Bexio API for the other endpoints.

- [BexioApiClient.Others.CompanyProfile](BexioApiClient.Others.CompanyProfile.md): Bexio Company Profile Module.

- [BexioApiClient.Others.Country](BexioApiClient.Others.Country.md): Bexio Country Module.

- [BexioApiClient.Others.DocumentTemplate](BexioApiClient.Others.DocumentTemplate.md): Bexio Document Template Module.

- [BexioApiClient.Others.FictionalUser](BexioApiClient.Others.FictionalUser.md): Bexio Fictional User Module.

- [BexioApiClient.Others.Language](BexioApiClient.Others.Language.md): Bexio Language Module.

- [BexioApiClient.Others.Note](BexioApiClient.Others.Note.md): Bexio Note Module.

- [BexioApiClient.Others.Permission](BexioApiClient.Others.Permission.md): Bexio Permission Module.

- [BexioApiClient.Others.Todo](BexioApiClient.Others.Todo.md): Bexio Task Module, renamed to Todo in Elixir.

- [BexioApiClient.Others.User](BexioApiClient.Others.User.md): Bexio User Module.

- [BexioApiClient.Payroll](BexioApiClient.Payroll.md): Bexio API for the payroll part of the API (the `/4.0/payroll` endpoints).

- [BexioApiClient.Payroll.Absence](BexioApiClient.Payroll.Absence.md): Absence of a payroll employee.

- [BexioApiClient.Payroll.Address](BexioApiClient.Payroll.Address.md): Address of a payroll employee.

- [BexioApiClient.Payroll.Employee](BexioApiClient.Payroll.Employee.md): Payroll Employee.

- [BexioApiClient.Projects](BexioApiClient.Projects.md): Bexio API for the projects part of the API.

- [BexioApiClient.Projects.Milestone](BexioApiClient.Projects.Milestone.md): Bexio Milestone Module (part of a project under /3.0/projects).

- [BexioApiClient.Projects.Project](BexioApiClient.Projects.Project.md): Bexio Project Module.

- [BexioApiClient.Projects.ProjectState](BexioApiClient.Projects.ProjectState.md): Bexio Project Status Module.

- [BexioApiClient.Projects.ProjectType](BexioApiClient.Projects.ProjectType.md): Bexio Project Type Module.

- [BexioApiClient.Projects.WorkPackage](BexioApiClient.Projects.WorkPackage.md): Bexio Work Package Module (part of a project under /3.0/projects).

- [BexioApiClient.Purchase](BexioApiClient.Purchase.md): Purchase Part of the API

- [BexioApiClient.Purchase.Address](BexioApiClient.Purchase.Address.md): Address of a contact as embedded in purchase documents (bills, expenses).

- [BexioApiClient.Purchase.Bill](BexioApiClient.Purchase.Bill.md): Bill in purchase

- [BexioApiClient.Purchase.BillDiscount](BexioApiClient.Purchase.BillDiscount.md): Discount of a bill in purchase.

- [BexioApiClient.Purchase.BillLineItem](BexioApiClient.Purchase.BillLineItem.md): Line item of a bill in purchase.

- [BexioApiClient.Purchase.BillPayment](BexioApiClient.Purchase.BillPayment.md): Payment settings of a bill in purchase.

- [BexioApiClient.Purchase.DocumentNumber](BexioApiClient.Purchase.DocumentNumber.md): Result of a document number validation for purchase documents (bills, expenses).

- [BexioApiClient.Purchase.Expense](BexioApiClient.Purchase.Expense.md): Expense in purchase

- [BexioApiClient.Purchase.OutgoingPayment](BexioApiClient.Purchase.OutgoingPayment.md): Outgoing payment for a bill in purchase

- [BexioApiClient.Purchase.PurchaseOrder](BexioApiClient.Purchase.PurchaseOrder.md): Purchase order (v3 API)

- [BexioApiClient.Req.AccessTokenRefresher](BexioApiClient.Req.AccessTokenRefresher.md): Req request step that fetches and caches access tokens for Bexio OAuth2
clients.
- [BexioApiClient.Req.RetryPolicy](BexioApiClient.Req.RetryPolicy.md): Behaviour for deciding whether and when to retry a Bexio API request.
- [BexioApiClient.Req.RewriteDelay](BexioApiClient.Req.RewriteDelay.md): 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.
- [BexioApiClient.SalesOrderManagement](BexioApiClient.SalesOrderManagement.md): Bexio API for the sales order management part of the API.

- [BexioApiClient.SalesOrderManagement.Comment](BexioApiClient.SalesOrderManagement.Comment.md): Comment

- [BexioApiClient.SalesOrderManagement.Delivery](BexioApiClient.SalesOrderManagement.Delivery.md): Delivery

- [BexioApiClient.SalesOrderManagement.DocumentSetting](BexioApiClient.SalesOrderManagement.DocumentSetting.md): Comment

- [BexioApiClient.SalesOrderManagement.Invoice](BexioApiClient.SalesOrderManagement.Invoice.md): Quote

- [BexioApiClient.SalesOrderManagement.Order](BexioApiClient.SalesOrderManagement.Order.md): Order

- [BexioApiClient.SalesOrderManagement.OrderRepetition](BexioApiClient.SalesOrderManagement.OrderRepetition.md): Repetition of an order

- [BexioApiClient.SalesOrderManagement.Payment](BexioApiClient.SalesOrderManagement.Payment.md): Payment of an invoice

- [BexioApiClient.SalesOrderManagement.PositionDefault](BexioApiClient.SalesOrderManagement.PositionDefault.md): Default Position (KbPositionCustom)

- [BexioApiClient.SalesOrderManagement.PositionDiscount](BexioApiClient.SalesOrderManagement.PositionDiscount.md): Discount Position (KbPositionDiscount)

- [BexioApiClient.SalesOrderManagement.PositionItem](BexioApiClient.SalesOrderManagement.PositionItem.md): Item Position (KbPositionCustom)

- [BexioApiClient.SalesOrderManagement.PositionPagebreak](BexioApiClient.SalesOrderManagement.PositionPagebreak.md): Pagebreak Position (KbPositionPagebreak)

- [BexioApiClient.SalesOrderManagement.PositionSubposition](BexioApiClient.SalesOrderManagement.PositionSubposition.md): Subposition Position (KbPositionSubposition)

- [BexioApiClient.SalesOrderManagement.PositionSubtotal](BexioApiClient.SalesOrderManagement.PositionSubtotal.md): Subtotal Position (KbPositionSubtotal)

- [BexioApiClient.SalesOrderManagement.PositionText](BexioApiClient.SalesOrderManagement.PositionText.md): Text Position (KbPositionText)

- [BexioApiClient.SalesOrderManagement.Quote](BexioApiClient.SalesOrderManagement.Quote.md): Quote

- [BexioApiClient.SalesOrderManagement.Reminder](BexioApiClient.SalesOrderManagement.Reminder.md): Reminder of an invoice

- [BexioApiClient.SearchCriteria](BexioApiClient.SearchCriteria.md): 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.

- [BexioApiClient.Timesheets](BexioApiClient.Timesheets.md): Bexio API for the timesheets part of the API

- [BexioApiClient.Timesheets.Timesheet](BexioApiClient.Timesheets.Timesheet.md): Bexio Timesheet Module.

- [BexioApiClient.Timesheets.TimesheetStatus](BexioApiClient.Timesheets.TimesheetStatus.md): Bexio Timesheet Status Module.

- [BexioApiClient.Timesheets.Tracking](BexioApiClient.Timesheets.Tracking.md): Bexio Timesheet Tracking Module.

- Exceptions
  - [BexioApiClient.RefreshError](BexioApiClient.RefreshError.md)

