Download reports

Quaderno provides an asynchronous API to download CSV reports of your invoices, credit notes, and taxes collected within a specified time period.

To obtain a report, you will need to make at least two API calls: one to request the report and another to download it.

To request a report, specify the type of report and the time period you want to download. Here's an example of a tax_summary report request:

curl --request POST
  --url https://ACCOUNT_NAME.quadernoapp.com/api/reporting/requests \
  --header 'Authorization: Basic API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "report_type": "tax_summary",
  "parameters": {
      "from_date": "2023-01-01",
      "to_date": "2023-05-28"
  }
}'

You can find the report types in the corresponding API reference.

Upon submitting a correct request, you will receive a response with an id that identifies the report generation request.

Depending on the complexity of the report, it may take some time to generate. It is recommended that you register a webhook associated with the event reporting.request.succeeded to be automatically notified when the report is ready. You can do this from your Quaderno dashboard or via our Webhooks API.

To learn more about how to receive real-time events via webhooks, please consult this guide.

The webhook payload will contain the URL to download the report in CSV format in the report_url field. Alternatively, you could also get the URL with a GET call to quadernoapp.com/api/reporting/requests/{{id}}, where id identifies the report generation request.

Here is an example of a tax_summary report in CSV format:

country,tax_name,tax_rate,taxable_base,tax_amount,currency
GB,,VAT,21,-0.07,-0.01,GBP
BE,,TVA,21,743.76,156.15,EUR
US,CA,Sales tax,Multiple,58.68,6.02,USD
ES,,IVA,21,455.0,95.55,EUR