Skip to main content
POST
/realms/{realmId}/organizations/{organizationId}/tax-document/download-batch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required

Body

application/json
type
enum<string>
Available options:
PDF,
XML
taxDocumentIds
string[]
Minimum array length: 1
Minimum string length: 1
filters
object

Response

200 - application/json

Successful response

fileName
string
required

Suggested name of the zip (also signed into the URL's Content-Disposition).

url
string
required

Presigned S3 GET of the zip; expires — see expiresInSeconds.

expiresInSeconds
number
required
total
number
required

Documents the request resolved to (matched by filter, or requested by id).

included
number
required

Files actually inside the zip.

missing
object[]
required

Everything requested/matched that is NOT in the zip, and why. Also listed in the zip's manifest.csv.