Skip to content

ExportApi.md

Latest commit

 

History

History
120 lines (82 loc) · 4.5 KB

ExportApi.md

File metadata and controls

120 lines (82 loc) · 4.5 KB

invoicetronic_sdk.ExportApi

All URIs are relative to https://api.invoicetronic.com

Method HTTP request Description
export_get GET /export Export invoices as a ZIP archive

export_get

export_get(type=type, company_id=company_id, year=year, month=month, quarter=quarter, document_date_from=document_date_from, document_date_to=document_date_to)

Export invoices as a ZIP archive

Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.).

Sent invoices are only included when they have reached a definitive state (e.g., Consegnato for private recipients, AccettatoDalDestinatario, DecorrenzaTermini, etc.). Invoices still being processed by SDI are excluded.

Received invoices are always included. Unread invoices are automatically marked as read and counted as operations.

Period filters

You can filter by period using either:

  • year + month (e.g., year=2026&month=3 for March 2026)
  • year + quarter (e.g., year=2026&quarter=1 for Q1 Jan-Mar)
  • document_date_from / document_date_to for a custom date range

These options are mutually exclusive. The year parameter alone is not valid and requires either month or quarter.

Response

Returns 200 with a ZIP archive, or 204 No Content if no invoices match the given filters. Files in the archive are organized by company VAT number ({vat}/send/, {vat}/receive/).

Rate limiting

This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a 429 Too Many Requests response.

Example

  • Basic Authentication (Basic):
import invoicetronic_sdk
from invoicetronic_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.invoicetronic.com
# See configuration.py for a list of all supported configuration parameters.
configuration = invoicetronic_sdk.Configuration(
    host = "https://api.invoicetronic.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = invoicetronic_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with invoicetronic_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = invoicetronic_sdk.ExportApi(api_client)
    type = 'type_example' # str |  (optional)
    company_id = 56 # int | Company id (optional)
    year = 56 # int |  (optional)
    month = 56 # int |  (optional)
    quarter = 56 # int |  (optional)
    document_date_from = '2013-10-20T19:20:30+01:00' # datetime | UTC ISO 8601 (2024-11-29T12:34:56Z) (optional)
    document_date_to = '2013-10-20T19:20:30+01:00' # datetime | UTC ISO 8601 (2024-11-29T12:34:56Z) (optional)

    try:
        # Export invoices as a ZIP archive
        api_instance.export_get(type=type, company_id=company_id, year=year, month=month, quarter=quarter, document_date_from=document_date_from, document_date_to=document_date_to)
    except Exception as e:
        print("Exception when calling ExportApi->export_get: %s\n" % e)

Parameters

Name Type Description Notes
type str [optional]
company_id int Company id [optional]
year int [optional]
month int [optional]
quarter int [optional]
document_date_from datetime UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]
document_date_to datetime UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

HTTP response details

Status code Description Response headers
200 OK -
204 No Content -
400 Bad Request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]