English

Menu

English

API

API

API Documentation

API Documentation

API Documentation

Changelog

  • 2025-10-02: Added the peppol_identifier attribute on Company model.

  • 2025-10-02: Added a new endpoint GET /api/v1/peppol_identifier_lookup.json to validate a Peppol identifier.

  • 2025-10-02: Added a new endpoint POST /api/v1/invoices/{id}/send_via_peppol.json to send an Invoice via Peppol.

  • 2025-10-02: Added a new endpoint POST /api/v1/credit_notes/{id}/send_via_peppol.json to send a Credit Note via Peppol.

  • 2025-10-02: Added a new endpoint GET /api/v1/peppol_sendings/{id}.json to retrieve the status of a Peppol sending.

  • 2023-10-08: Added the product_id attribute inside the lines hash of an Invoice, Estimate and Credit Note GET endpoints.

  • 2022-03-06: Added the payment_date attribute on Invoice model.

  • 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.

API Operations

To try the following API calls, you must provide a valid API key below.