Operation:

Description:

GET /invoice_vouchers

Starts a download with all invoice objects for all clients in the specified period.

Request Parameters:

Description:

Annotation:

invoice_date_from / invoice_date_to:

(date string)

Specifies the period of time from which to retrieve the invoice objects. Format of the date according to ISO 8601: YYYY-MM-DD without exact time! The billing objects can only be accessed full-time. Thus, billing objects are provided up to only one day before API retrieval. If you specify a time or an invoice end date (invoice_date_to) greater than or equal to the date of the API call, an exception is returned accordingly.

mandatory

client_id: (int)

Filters out all invoice objects for a client if the URL can deliver multiple clients.

optional

shop_id: (int)

Filters out all invoice objects for a company.

optional

invoice_number: (string)

Filters out a billing object with the corresponding invoice number from all invoice objects.

optional

exclude_countries: (string)

Filters out all billing objects that are not from these billing countries. Invoicing countries should be listed in a comma-separated list of ISO codes.

optional

top: (int)

Specifies the maximum number of billing objects to be returned. As long as there are enough invoice objects, exactly this number of objects will be returned. Otherwise, the remaining number of existing invoice objects will be returned.

optional

skip: (int)

Specifies the number of invoice objects that should be skipped and thus not requested.

optional

Request Header:

(application/json)

Description:

Annotation:

Authorization:

Bearer {Token}

Term "Bearer" together with a JSON Web Token of the login endpoint. Required for authentication of the request.

mandatory

Response:

Returns a ZIP archive containing the individual PDF files for the retrieved invoice objects.