Baixar DAMDFE

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/fiscal/mdfe/{mdfe_uuid}/damdfe

downloadDamdfeBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

mdfe_uuidpath · stringObrigatório

UUID público do MDF-e.

Restrições

{
  "type": "string",
  "format": "uuid"
}

Respostas

200 Resposta HTTP

Arquivo PDF da DAMDFE.

`application/pdf`

Headers

X-Request-Id

Identificador de correlação da chamada.

Content-Disposition

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

422 Resposta HTTP

Pendência ou regra de negócio impediu a operação.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

429 Resposta HTTP

Limite por transportadora excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

Falha interna sem detalhes de integrações operacionais.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

503 Resposta HTTP

Não foi possível confirmar ou obter o resultado agora. Consulte antes de repetir comandos.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação

{
  "tags": [
    "MDF-e"
  ],
  "summary": "Baixar DAMDFE",
  "operationId": "downloadDamdfe",
  "responses": {
    "200": {
      "description": "Arquivo PDF da DAMDFE.",
      "headers": {
        "X-Request-Id": {
          "$ref": "#/components/headers/RequestId"
        },
        "Content-Disposition": {
          "schema": {
            "type": "string"
          }
        }
      },
      "content": {
        "application/pdf": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/BusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    },
    "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
    }
  },
  "method": "GET",
  "path": "/fiscal/mdfe/{mdfe_uuid}/damdfe",
  "parameters": [
    {
      "$ref": "#/components/parameters/MdfeUuid"
    }
  ]
}