Baixar o XML arquivado

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

GET/fiscal/cte-subcontratacao/{access_key}/xml

getInboundCteXmlBase 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.

O XML exatamente como chegou, byte a byte. Não é reserializado pela FleetPay: um documento reescrito por nós deixaria de bater com a assinatura de quem o emitiu.

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

access_keypath · stringObrigatório

Chave de acesso do CT-e recebido, 44 dígitos.

Restrições

{
  "type": "string",
  "pattern": "^\\d{44}$"
}

Respostas

200 Resposta HTTP

XML do CT-e recebido.

`application/xml`

Headers

X-Request-Id

Identificador de correlação da chamada.

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.

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.

Definição Completa da Operação

{
  "tags": [
    "CT-e de subcontratação"
  ],
  "summary": "Baixar o XML arquivado",
  "description": "O XML exatamente como chegou, byte a byte. Não é reserializado pela FleetPay: um\ndocumento reescrito por nós deixaria de bater com a assinatura de quem o emitiu.\n",
  "operationId": "getInboundCteXml",
  "parameters": [
    {
      "$ref": "#/components/parameters/InboundCteAccessKey"
    }
  ],
  "responses": {
    "200": {
      "description": "XML do CT-e recebido.",
      "headers": {
        "X-Request-Id": {
          "$ref": "#/components/headers/RequestId"
        }
      },
      "content": {
        "application/xml": {
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/cte-subcontratacao/{access_key}/xml"
}