README.md

InvoiceXpressDotNet

InvoiceXpress API port to .net.

This implementation is based on the information at https://invoicexpress.com/api InvoiceXpress API from http://invoicexpress.com

The source code is almost totally generated with T4 Text Templates, to facilitate the generation of the data transfer objects.

The xml de/serialization is handled by XmlSerializer with some fiddling to make everything works.

How to use

First of all, you need a invoiceXpress account and a api key. From there you can get the following data needed to make the api calls

string _accountName = "your account name here";
string _apiKey = "your api key here";
string _accountId = "your accountId key here";

To use this api just call the nested static methods inside each module class, like so :

InvoiceXpress.Invoices

InvoiceXpress.Invoices.List(...);
InvoiceXpress.Invoices.Create(...);
InvoiceXpress.Invoices.Update(...);
...

InvoiceXpress.CreditNotes

InvoiceXpress.CreditNotes.List(...); 
InvoiceXpress.CreditNotes.Create(...); 
InvoiceXpress.CreditNotes.Update(...);
...

Examples

Invoices

Create and finalize a Invoice

var invoice = new InvoiceDto();
invoice.Date = DateTime.Today;
invoice.DueDate = DateTime.Today.AddMonths(1);

// Create/associate the customer
var client = new ClientDto();
client.Name = "Some Customer";
invoice.Client = client;
invoice.Observations = "Generated with InvoiceXpressDotNet";

// Create some items for the invoice
var item1 = new ItemDto();
item1.Name = "Some amazing product";
item1.UnitPrice = 100;
item1.Quantity = 1;
item1.Discount = 5.5F;

var item2 = new ItemDto();
item2.Name = "Some not so amazing product";
item2.UnitPrice = 0;
item2.Quantity = 1;

// add items to the invoice
invoice.Items = new ItemsDto { Items = new[] { item1, item2 } };

// create the invoice
InvoiceDto invoiceReturnData = InvoiceXpress.Invoices.Create(_apiKey, _accountName, invoice);

// consume the returned data
Console.WriteLine(invoiceReturnData);

// finalize the invoice
if (invoiceReturnData.Id.HasValue)
{
    var state = new InvoiceChangeStateDto { State = DocumentState.Finalized };
    var returnState = InvoiceXpress.Invoices.ChangeState(_apiKey, _accountName, invoiceReturnData.Id.Value, state);
    Console.WriteLine(returnState);
}

List Invoices

InvoicesDto invoices = InvoiceXpress.Invoices.List(_apiKey, _accountName);
foreach (InvoiceDto invoice in invoices.Items)
    Console.WriteLine(invoice.Id);

Get a Invoice

InvoiceDto invoice = InvoiceXpress.Invoices.Get(_apiKey, _accountName, invoiceId).Dump();
Console.WriteLine(invoice);

Get the invoice pdf

var pdfData = InvoiceXpress.Invoices.Pdf(_apiKey, _accountName, invoiceId);
// check if the pdf id ready to be downloaded, if not you will need to try again later
if (pdfData.IsPdfReady)
{
    string downloadTo = Path.Combine(Environment.GetFolderPath(System.Environment.SpecialFolder.Desktop), Guid.NewGuid() + ".pdf");
    using (var wc = new WebClient())
        wc.DownloadFile(pdfData.Pdfurl, downloadTo);
		
    //Process.Start(downloadTo);
}
else 
    Console.WriteLine("Document is not ready yet, try again later.");

Email a invoice to someone

var clientEmail = new EmailClientDto();
clientEmail.Email = "[email protected]";

var email = new EmailMessageDto();
email.Client = clientEmail;
email.Subject = "here is your invoice";
email.Body = "the invoice is attached to the message";

InvoiceXpress.Invoices.EmailInvoice(apiKey, accountName, invoiceId, email);

Invoice Receipt

Create and finalize a Invoice Receipt

pretty much the same as the Invoices.Create method

var invoiceReceipt = new InvoiceReceiptDto();
invoiceReceipt.Date = DateTime.Today;
invoiceReceipt.DueDate = DateTime.Today.AddMonths(1);

// Create/associate the customer
var client = new ClientDto();
client.Name = "Some Customer";
invoiceReceipt.Client = client;
invoiceReceipt.Observations = "Generated with InvoiceXpressDotNet";

// Create some items for the invoice
var product1 = new ItemDto();
product1.Name = "Some amazing product";
product1.UnitPrice = 200;
product1.Quantity = 1;
product1.Discount = 5.5F;

var gift = new ItemDto();
gift.Name = "Gift";
gift.UnitPrice = 0;
gift.Quantity = 1;

// add itens to the invoice
invoiceReceipt.Items = new ItemsDto { Items = new[] { product1, gift } };

// create the invoice
InvoiceReceiptDto createdInvoiceReceipt = InvoiceXpress.InvoiceReceipts.Create(_apiKey, _accountName, invoiceReceipt);
Console.WriteLine(createdInvoiceReceipt);

var stateChange = new InvoiceReceiptChangeStateDto { State = DocumentState.Finalized };
if (createdInvoiceReceipt.Id.HasValue)
{
    InvoiceReceiptChangeStateDto state = InvoiceXpress.InvoiceReceipts.ChangeState(_apiKey, _accountName, createdInvoiceReceipt.Id.Value, stateChange);
    Console.WriteLine(state)
}

The MIT License (MIT)

Copyright (c) 2016 EventKey, Lda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.