https://github.com/develappersgmbh/billomatnet
C# wrapper for Billomat API
https://github.com/develappersgmbh/billomatnet
billomat billomat-api csharp dotnet-standard nuget wrapper
Last synced: 11 months ago
JSON representation
C# wrapper for Billomat API
- Host: GitHub
- URL: https://github.com/develappersgmbh/billomatnet
- Owner: DevelappersGmbH
- License: mit
- Created: 2017-12-06T12:56:49.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-06T16:05:42.000Z (over 2 years ago)
- Last Synced: 2024-12-06T04:39:36.719Z (over 1 year ago)
- Topics: billomat, billomat-api, csharp, dotnet-standard, nuget, wrapper
- Language: C#
- Homepage:
- Size: 1.36 MB
- Stars: 5
- Watchers: 10
- Forks: 5
- Open Issues: 107
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BillomatNet
This is an API client to access your data in [Billomat](https://www.billomat.com/). It is written as .NET Standard library to be used in .NET Framework projects and .NET Core projects as well.
## Status
### code and build
[](https://coveralls.io/github/DevelappersGmbH/BillomatNet?branch=master)
[](https://codeclimate.com/github/DevelappersGmbH/BillomatNet)
### issues
### release
[](https://opensource.org/licenses/MIT)
[](https://www.nuget.org/packages/Develappers.BillomatNet/)
## Usage
### Connect to your Billomat instance
First of all, you need an API Key for your user. To get one, please follow the [instructions](https://www.billomat.com/api/grundlagen/authentifizierung/).
BillomatNet is divided into several services, which correspond to the sections of the REST-API (e.g. InvoiceService for invoices, OfferService for offers and so on). Every service can be instanciated providing a configured HttpClient. But there's also a central entry point BillomatClient, so you just have to instanciate it with a valid configuration and access the configured service instance of your interest.
*Sample 1 (querying a filtered list of customers)*
```
var config = new Configuration
{
ApiKey = "your_api_key",
BillomatId = "your_billomat_id"
};
var billomatClient = new BillomatClient(config);
var service = billomatClient.Clients;
var query = new Query()
.AddFilter(x => x.Name, "GmbH")
.AddSort(x => x.City, SortOrder.Ascending);
var clients = await service.GetListAsync(query, CancellationToken.None);
```
All lists are paged. The result contains information about the current page and the total number of items available. The query object built in the sample above also allows to specify the page (if omitted, you will get the first page containing 100 items according to the API spec of Billomat).
*Sample 2 (querying a customer)*
```
var config = new Configuration
{
ApiKey = "your_api_key",
BillomatId = "your_billomat_id"
};
var billomatClient = new BillomatClient(config);
var service = billomatClient.Clients;
var client = await service.GetById(435363);
```
## Project Status
The REST-API itself contains a whole bunch of functionality. This wrapper is still under development. New functions will be added
successively. You can find detailed information about recent changes in [change log](CHANGELOG.md).
## Contribution
Bug reports and pull requests are welcome on [GitHub](https://github.com/DevelappersGmbH/BillomatNet). Please check the [contribution guide](CONTRIBUTING.md).This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to our [code of conduct](CODE_OF_CONDUCT.md).