Your invoice documents are located in your servers and you would like to send them to Clearnox in order to include them in your reminders. This article will explain how to set up this feature.
Send the invoices massively through the Clearnox API
The public Clearnox API allows to send invoices massively to Clearnox, it provides two endpoints:
- The first one allows to retrieve the list of entries without any attached document, in order to let you send only the missing invoices with the second endpoint. It's recommended to use the pagination as mentioned in the API documentation.
- The second one allows to send the invoices pdf massively as a zipped file that contains the invoices documents and a metadata.json file with the list of documents and the associated booking entries.
The API documentation is available here and provides a "Try our API" button that allows to test the endpoints mentioned above.
The API authentication works with the same credentials as the connector, they are available either in the connector itself, or in the Clearnox interface in the menu "Configure > Connector Configuration" available for administrators.
API Set Up
Sending invoice documents requires the development of a module in charge of executing the following tasks:
- First API call to get the list of entries without invoice documents in Clearnox,
- Retrieve the invoice documents from the servers where they are located and build the zipped file,
- Second API call to send the zipped file built in the previous step.
We recommend to plan the execution of this module right after the data synchronisation.
To do this development there are multiple options depending on your situation:
- Develop it internally if you have software developers,
- Request this developement from your technical partner,
- Contact the sales team accountmanagers@clearnox.com who can help you find a technical partner.
View your invoices in Clearnox
Once you have sent the invoice documents through the Clearnox API, those documents are available in the client account blance, column "Invoices". When you click on the document icon, you can view and download the invoice associated to your entry.
Congratulations! your invoices are now available in your Clearnox account and you can integrate them in your reminders as explained here.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article