API Documentation

Welcome on Direct Invoice's interactive API documentation.
In order to try the following API calls, you must provide a valid API key in the top right field of this window.

If you have any questions, please contact us we would be happy to help.


  • 2020-02-01: Added the mark_as_invoiced PATCH route on estimates.
  • 2020-01-27: Added the mark_as_refunded PATCH route on credit notes.
  • 2017-01-20: Added the structured_communication parameter on invoices creation. This must be a 12 digits value where the last 2 digits are a modulo 97 of the first 10 digits.
  • 2017-01-10: Added the mark_as_canceled PATCH route on invoices.
  • 2014-10-02: Added the phone_number parameter on companies.
  • 2014-10-02: Renamed the mobile_phone parameter on contacts to private_phone .
  • 2014-10-02: Removed the home_phone parameter on contacts.
  • 2014-08-19: Added the filters hash of parameters on invoices, estimates, credit notes and recurring invoices lists. You can now filter by statuses , company_id , date_range and term .
  • 2014-04-24: Added the pdf_link attribute on invoices, estimates and credit notes models.