DotNetInvoice Forums

I'm excited about the API in 2.6. I looked for the docs, but could not find them. Have docs been made for the API yet? Or do we have to fend for ourself's on this one?

Hi Clarity,

We tried to keep our API classes as clean and simple as possible, so we didn't write additional documentation for them.  The following are the primary classes for the API: Client, Invoice, InvoiceDetail, InvoicePayment, InvoiceReminder, Payment, RecurringInvoice and StoredInvoiceDetail.  Each of those have an associated <classname>DA class that handles the database functions associated with those objects.

Please let us know if you come up with questions while you are looking at the classes for the API.  We'll definitely look into adding documentation if it appears to be needed.

---

---
Jeremy
DotNetInvoice Support

Ok, here's a question. I found the GetUserNameByClientId in the ClientDA class, but not the GetClientIdByUserName. This used to be in the functions class in 2.5, but I can't find it anywhere now.

 Also, I think docs & example code are critical for any API deployment, but you are right, most of the classes are fairly straight forward.

Hi Clarity,

We dropped the GetClientIdByUserName because the ClientID is now included in the profile object.  If you have the username, you can get the profile and we did our best to cut out duplicate functions.  If you need that function, you should be able to copy the code and stored procedure from v2.5 into your current version.

We are working on some simple docs for the API.  At this point, the DotNetInvoice code itself uses all of the API functions so it serves as example code.

If you or anyone else develops some code they think would be good to add to our documentation, please email it to us at support@dotnetinvoice.com.

---

---
Jeremy
DotNetInvoice Support

I was unaware that the code had been revamped to use all API. I didn't expect that ammount of revision in a minor update. Thanks!

API Docs are now available in .chm format for all v2.6 product owners. Unfortunately we cannot release the API unless you own the product due to the security implications.

To receive a copy of the API Docs please email support@dotnetinvoice.com.

---

---
Rob
DotNetInvoice Support