substringgmbh / bexio.net

Bexio .NET Core Wrapper for the API

⚠️ This is a work in progress

Bexio API

A simple REST API client in .NET 5.0 for Bexio which is a powerful cloud based software for business administrations.

Find official API documentation here

Status of this implementation

As this is still a work in progress, only some API calls are implemented and tested.

• Contacts
• Sales Order Management
• Purchase
• Accounting
• Banking
• Items & Products
• Projects & Time Tracking
• Files
• Other
  • Company Profile
  • Countries
  • Languages
  • Notes
  • Payment Types
  • Permissions
  • Tasks
  • Units
  • User Management

Installation & Usage

1. Obtain an api token from here
2. Check the Example project on how to use it

Authentication

We decided to use the direct API Token approach as described here. The Implementation of oauth 'Authorization Code Grant' flow is described in the official documentation but not implemented in this API client.

bexio.net's Issues

Split up BexioApi.cs into partial classes

I propose to split up the class BexioApi.cs into multiple partial classes based on data types to make it more maintainable.

Properly implement HTTP 503 error

Problem:

Response Status Code 503 does not indicate a faulty request but that the api server is currently not available. From documentation: 503 | The server is not available (maintenance work)

Approach 1: The user needs to get a result that indicates that the server is (currently) not available. (can be done right now, when throw-style is used via constructor)

Approach 2: The failed request should be reexecuted some time later. If that fails again, then the user gets to see the error.