Luftborn.EConomicSDK 3.0.1

EConomic SDK

Description

.Net Core SDK for EConomic API, it's a .Net core wrapper for EConomic APIs including APIs for invoices & orders & customers... etc, e-conomic addresses all your bookkeeping needs in one intuitive accounting program, and provide API gateway to access all accounting operations.

For more specific information about EConomic APIs, Please visit EConomic API sites which also include full API documentation and code samples.

https://restdocs.e-conomic.com/

Installation

Use the nuget package manager to install library.

Install-Package Luftborn.EConomicSDK -Version 3.0.1

Requirements

.Net Core v3
VSCode or VS
Nuget Package Manager

EConomicSDK Configuration

  Add below section to your application Startup.cs file.
  
  services.AddEconomicDependencies(AppSecretToken, AgreementGrantToken);
  

Or

services.AddEconomicDependencies();
services.AddOptions<EconomicConfiguration>()
	.Configure(options =>
	{
		options.AgreementGrantToken = AgreementGrantToken;
		options.AppSecretToken = AppSecretToken;
	});
  

EConomicSDK Usage

What's New:

remove Newtonsoft.Json and use System.Text.Json instead

search is improved via flent api builder

Ex:

var filter = FilterDefinitionBuilder.GreaterThan(nameof(CustomerResponseDTO.CustomerNumber), 1000);

var paramters = new SearchParametersBuilder()
	.LimitSize(10)
	.SkipPages(1)
	.SortDecending(nameof(CustomerResponseDTO.CustomerNumber))
	.AddFilter(filter)
	.Build();

var customersResult = await _customersClient.GetCustomersAsync(paramters);

this is equivalent to :

https://restapi.e-conomic.com/customers?skippages=1&pagesize=10&sort=~customernumber&filter=customernumber$gt:1000

Table of Contents

1. Get Accounts

2. Get Customers

3. Get Invoices

4. Create Draft Invoice

5. Delete Draft Invoice

6. Create Booked Invoice

   <a name="get-accounts"></a>

   1. Get Accounts / Account

    //create API service
    var accounts = new AccountsAPI();
   
    //get all accounts, using filter and sort
    var accountsResult = await accounts.GetAccounts("", "", "");
   
    //get one account by account number 
    var accountScheme = await accounts.GetByAccountNumber("1000");
   

   <a name="get-customers"></a>

   2. Get Customers / Customer

    // create customers API service
    var customersAPI = new CustomersAPI();
   
    // get all customers
    var customersResult = await customersAPI.GetCustomers("", "", "");
   
    // get customer by customer number
    var customerResult = await customersAPI.GetByCustomerNumber("1000");
   

   <a name="get-invoices"></a>

   3. Get Invoices / Invoice

    // create invoices API service
    var invoicesAPI = new InvoicesAPI();
   
    // get all invoices
    var invoices = await invoicesAPI.GetInvoices("", "", "");
   
    // get all draft invoices
    var invoices = await invoicesAPI.GetDraftInvoices();
   
    // get draft invoice by invoice number
    var invoice =  await invoicesAPI.GetDraftInvoice('765765765');
   

   <a name="draft-invoice"></a>

   4 Create Draft Invoice

    // draft invoice object
    var invoice = new DraftInvoicePost();
   
    // create draft invoice
    var result = await invoicesAPI.CreateDraftInvoice(invoice);
   

   <a name="delete-draft"></a>

   5 Delete Draft Invoice

    // delete draft invoice
    var deleteMessage = await invoicesAPI.DeleteDraftInvoice("1000")
   

   <a name="booked-invoice"></a>

   6 Create Booked Invoice

    // booked invoice object
    var bookedInvoice = new BookedDraftInvoice();
   
    // assgine bookedInvpice properties
    bookedInvoice.DraftInvoiceNumber = 1000;
    bookedInvoice.Self = new Uri("balabalaa");
   
    // booked draft invoice
    var bookedInvoice = await invoicesAPI.BookedDraftInvoice(invoice);
   

Contributing

Pull requests are welcome, Please open an issue first to discuss what you would like to change.

License

MIT