Skip to main content
GET
Download a tax document
Choose the file with type. The files exist only once the document is AUTHORIZED: before that, the request answers 404. Open the returned url within 1 hour, and the browser saves the file under the returned fileName.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization that owns the tax document.

Format: UUID

taxDocumentId
string<uuid>
required

ID of the tax document to download.

Format: UUID

Query Parameters

type
enum<string>
required

Which file to download: the PDF of the document or its XML.

Available options:
PDF,
XML

Response

Successful response

A temporary link to one file of a tax document.

fileName
string
required

Name of the file: NFSe-<number> once the document has its NFSe number, else RPS-<series>-<number>, else the ID of the document, followed by the extension (.pdf or .xml). Files of TEST documents are prefixed with HOMOLOGACAO-.

Example:

"NFSe-2874.xml"

url
string
required

Temporary download link, valid for 1 hour. Opening it makes the browser save the file.

Example:

"https://files.example.com/nfse/xml/3d6f9a2b-1c4e-4f8a-9b7d-5e2c1a0f8b63.xml?X-Signature=abc123"