← InícioFleetPay / API

Anexar documentos fiscais (NF-e XML/PDF/ZIP ou CT-e) à solicitação

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

POST/embarcador/solicitacoes-transporte/{id}/documentos
anexarDocumentosSolicitacaoTransporteEmbarcadorBase 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.

Anexa arquivos XML de NF-e, PDF/DANFE ou ZIP (via multipart/form-data em arquivos[]) ou chaves de acesso à solicitação.

  • Em XML de NF-e, extrai chave de 44 dígitos, número/série, valor declarado, peso, volumes e municípios de origem/destino, preenchendo campos ausentes sem sobrescrever endereços operacionais já definidos e sem fingir contratação confirmada.
  • Em PDF/DANFE, extrai os campos identificáveis e marca uncertainty_flags + requires_confirmation=true (fiscal_status: nfe_pending_confirmation) quando peso, valor ou endereço não puderem ser extraídos com certeza.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "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

idpath · stringObrigatório
Restrições
{
  "type": "string"
}

Corpo da Requisição

Obrigatório

multipart/form-data

arquivosarrayOpcional

application/json

documentosarrayOpcional

Respostas

200 Resposta HTTP

Documentos anexados e estado fiscal atualizado

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
422 Resposta HTTP

Arquivo inválido ou erro de validação

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Anexar documentos fiscais (NF-e XML/PDF/ZIP ou CT-e) à solicitação",
  "description": "Anexa arquivos XML de NF-e, PDF/DANFE ou ZIP (via `multipart/form-data` em `arquivos[]`) ou chaves de acesso à solicitação.\n- Em **XML de NF-e**, extrai chave de 44 dígitos, número/série, valor declarado, peso, volumes e municípios de origem/destino, preenchendo campos ausentes sem sobrescrever endereços operacionais já definidos e sem fingir contratação confirmada.\n- Em **PDF/DANFE**, extrai os campos identificáveis e marca `uncertainty_flags` + `requires_confirmation=true` (`fiscal_status: nfe_pending_confirmation`) quando peso, valor ou endereço não puderem ser extraídos com certeza.\n",
  "operationId": "anexarDocumentosSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "properties": {
            "arquivos": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        }
      },
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "documentos": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "access_key": {
                    "type": "string",
                    "pattern": "^[0-9]{44}$"
                  },
                  "document_type": {
                    "type": "string",
                    "enum": [
                      "nfe",
                      "cte"
                    ]
                  },
                  "source_format": {
                    "type": "string",
                    "enum": [
                      "xml",
                      "pdf",
                      "manual_key",
                      "api"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Documentos anexados e estado fiscal atualizado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Arquivo inválido ou erro de validação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "contratacao-direta",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial"
  ],
  "method": "POST",
  "path": "/embarcador/solicitacoes-transporte/{id}/documentos"
}