Use the Utilities tool
The Utilities page provides you with a simple tool to retrieve the list of some of the resources stored in your Fatture in Cloud account.
This can be extremely useful for some use cases, such as:
- Retrieving your Company ID for an integration designed for internal use
- Retrieving the IDs of your resources to be used in a Zapier automation, without having to retrieve them from Zapier itself
đźŤÂ Available resources​
The tool will give you the possibility to retrieve the following types of resources without having to write a single line of code:
- VAT Types
- Payment Accounts
- Payment Methods
- Products
- Clients
- Suppliers
Additionally, it will provide you with quick access to the Company ID, making it easier to retrieve and insert it into your code.
If your integration is meant to be used with multiple Fatture in Cloud accounts we strongly suggest you use the API methods directly! The Utilities tool should be used only when your application is designed for internal usage only!
🗺 Usage guide​
In this section, we'll explain how to use the Utilities tool.
When you access the page, at first you'll notice a warning modal. It is only to remind you that this tool uses your API quotas, so you should use it carefully. Don't worry, just click on "Continue" and proceed with the next step.
The next step is the Permissions selection. Here you'll need to define which resources you need to retrieve using our tool.
As you can see, the Settings permission is always selected, as it is required for the correct functioning of the tool, while the Clients, Products, and Suppliers permissions are optional and you can select only if you need to.
Select the permissions that you need and then click the "Next" button.
The list of the resources available in the next steps is influenced by the selected permissions. For example, if you decide to NOT select the Clients permission, this kind of resource will not be available in the following steps.
Once you select the permissions, the page will show you the instructions to Connect the tool to your Fatture in Cloud account.
This is the most complicated step, so please be patient and follow the instructions!
First, we suggest you copy the code you can find on the page, so you won't need to return to the Utilities page in the next steps. Then, you can proceed to open the link to the Connection page.
Remember to NOT close the Utilities page, or you'll need to restart from the first step!
If you are not logged in to your Fatture in Cloud Account, first it will require you to log in, otherwise, this step will be skipped and your account will be used directly.
Next, you'll need to paste the code you can find on the Utilities page into the dedicated text box.
Then, the page will require you to confirm the selected permissions and the Companies that you want to connect.
Finally, the login flow is completed!!! You can just close this page and return to the Utilities page opened at the start.
Once you return to the Utilities tool page, it will automatically complete the login and proceed to the next step.
You're finally ready to start using the Utilities tool!!!
The first thing you'll need to do is to select one of the Companies controlled by your account. Once a company is selected, the related Company ID will be shown, and you'll be able to copy it and use it for your purposes.
The selected company will also be used to retrieve the resources listed on the page.
By clicking one of the buttons, a table will be shown containing all the resources retrieved from your account.
Please, note that if the request is paginated, it will be possible to select which page to show, so it will be possible to search for a certain resource.
If, instead, you want to retrieve the whole set of resources, you can export them by clicking one of the Export buttons.
A modal will be shown to let you decide if to download the current page of resources or the whole set, with the related number of API requests needed to download all the resources included in your account.
That's it! We hope this tool will prove useful for you!
🦴 How is it done?​
Our Utilities tool is based on our APIs, so if you want to create something similar here we explain how you can do it.
The Login and Permission section of the tool was created using our OAuth 2.0 Device Code flow. Since it is not generally available, you can just decide to use one of the other Authorization methods.
Once you retrieve the Access Token, you must obtain the Company ID. The method we used to get the companies list is the List User Companies method, and you can find a more detailed guide here.
Now you're finally ready to obtain all the resources using our APIs.
The methods we used are:
- List Vat Types
- List Payment Methods
- List Payment Accounts
- List Products*
- List Clients*
- List Suppliers*
The methods marked with * are paginated, so you'll need to perform multiple API requests to retrieve all the resources set. Please check the Pagination page for more details.
You can also check the Basics page to check how to further improve your functionalities.