---
title: "Download de XMLs - Consultar."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-DocumentoFiscal-DownloadXml-downloadXmlId/get"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Download de XMLs - Consultar.

`GET` `/api/v1/DocumentoFiscal/DownloadXml/{downloadXmlId}`

Permite o acompanhamento do <strong>processamento de uma solicitação</strong> de download de arquivos XML previamente realizada. Através deste endpoint, o sistema consumidor pode verificar se os arquivos já foram compactados e estão <strong>prontos para baixar</strong>. 🔄 **ESTADOS**: A solicitação pode transitar entre os estados de *Pendente*, *EmProcessamento*, *Concluido*, *Expirado* ou *Falha*. O link de download só será preenchido quando o status for **Concluido**. 🔗 **DISPONIBILIDADE**: Uma vez gerado, o link para o arquivo .zip possui uma <strong>validade temporária</strong>. Certifique-se de realizar o download assim que o processamento for finalizado. ⚠️ **DICA**: Caso o status retorne como *Falha*, verifique os detalhes da mensagem para identificar se o intervalo de busca foi muito extenso ou se não foram encontrados documentos para os filtros informados.

## Path parameters

- `downloadXmlId` (string, uuid, required) - Identificador único (Ticket) da solicitação de download.

## Header parameters

- `DocumentoEmissor` (string, required) - Documento do emissor.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/DocumentoFiscal/DownloadXml/{downloadXmlId}:
    get:
      tags:
        - DocumentoFiscal
      summary: Download de XMLs - Consultar.
      description: >-
        Permite o acompanhamento do <strong>processamento de uma
        solicitação</strong> de download de arquivos XML previamente realizada. 

        Através deste endpoint, o sistema consumidor pode verificar se os
        arquivos já foram compactados e estão <strong>prontos para
        baixar</strong>.


        🔄 **ESTADOS**: A solicitação pode transitar entre os estados de
        *Pendente*, *EmProcessamento*, *Concluido*, *Expirado* ou *Falha*. O
        link de download só será preenchido quando o status for **Concluido**.


        🔗 **DISPONIBILIDADE**: Uma vez gerado, o link para o arquivo .zip
        possui uma <strong>validade temporária</strong>. Certifique-se de
        realizar o download assim que o processamento for finalizado.


        ⚠️ **DICA**: Caso o status retorne como *Falha*, verifique os detalhes
        da mensagem para identificar se o intervalo de busca foi muito extenso
        ou se não foram encontrados documentos para os filtros informados.
      parameters:
        - name: downloadXmlId
          in: path
          description: Identificador único (Ticket) da solicitação de download.
          required: true
          schema:
            type: string
            format: uuid
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/DownloadXmlViewModel"
            application/json:
              schema:
                $ref: "#/components/schemas/DownloadXmlViewModel"
            text/json:
              schema:
                $ref: "#/components/schemas/DownloadXmlViewModel"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    DownloadXmlViewModel:
      type: object
      properties:
        id:
          type: string
          description: Identificador da solicitação do download.
          format: uuid
        status:
          $ref: "#/components/schemas/StatusDownloadXmlModelEnum"
        dataSolicitacao:
          type: string
          description: Data de solicitação do download.
          format: date-time
        inscricaoEstadual:
          type: string
          description: Filtrar pela inscrição estadual do emissor da nota fiscal.
          nullable: true
        busca:
          type: string
          description: Filtro de busca genérica (dados do destinatário, transportador,
            chave de acesso, intermediador ou número do documento).
          nullable: true
        dataInicio:
          type: string
          description: Filtrar pela data de emissão da nota "a partir de".
          format: date
          nullable: true
        dataFim:
          type: string
          description: Filtrar pela data de emissão da nota "até".
          format: date
          nullable: true
        modelosDocumento:
          type: array
          items:
            $ref: "#/components/schemas/ModeloDocumentoDownloadXmlModelEnum"
          description: Filtrar pelo modelo do arquivo XML.
          nullable: true
        mensagemFalha:
          type: string
          description: Mensagem em caso de falha.
          nullable: true
        dataHoraProcessamento:
          type: string
          description: Data e hora do processamento.
          format: date-time
          nullable: true
        statusCallback:
          $ref: "#/components/schemas/StatusCallbackDownloadXmlModelEnum"
        urlCallback:
          type: string
          description: URL de callback do solicitante.
          nullable: true
        urlDownload:
          type: string
          description: Url com link de download dos arquivos XMLs.
          nullable: true
      additionalProperties: false
      description: Dados da solicitação de download do XML.
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
    StatusDownloadXmlModelEnum:
      enum:
        - Pendente
        - EmProcessamento
        - Concluido
        - Falha
        - Expirado
      type: string
      description: Status do processamento da solicitação de download de XML.
    ModeloDocumentoDownloadXmlModelEnum:
      enum:
        - Nfe
        - Nfce
      type: string
      description: Modelo de documentos solicitados para download.
    StatusCallbackDownloadXmlModelEnum:
      enum:
        - NaoRealizado
        - Sucesso
        - Falha
      type: string
      description: Status do envio de callback.
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```