← InícioFleetPay / Schema

ConfirmarEntregaSolicitacaoTransporteRequest

Estrutura preservada do contrato versionado da API.

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

Payload opcional para confirmação/baixa operacional de entrega via API (POST /embarcador/solicitacoes-transporte/{id}/confirmar-entrega).

completed_atstring | null · date-timeOpcional

Data/hora ISO-8601 da conclusão da entrega/rota (default now()). Aceita também o alias delivered_at.

delivered_atstring | null · date-timeOpcional

Alias opcional para completed_at.

receiver_namestring | nullOpcional

Nome do recebedor (opcional).

receiver_documentstring | nullOpcional

CPF/CNPJ ou documento do recebedor (opcional).

notesstring | nullOpcional

Observações da confirmação operacional ou referência do TMS/roteirizador (opcional).

pay_document_idinteger | nullOpcional

ID do documento financeiro (pay_documents.id) vinculado quando conciliado via API de documentos ou proxy de webhook.

external_service_idstring | nullOpcional

Identificador externo da rota/serviço no TMS ou roteirizador (ex.: route_id da Abbiamo).

Definição JSON Completa
{
  "type": "object",
  "description": "Payload opcional para confirmação/baixa operacional de entrega via API (`POST /embarcador/solicitacoes-transporte/{id}/confirmar-entrega`).",
  "properties": {
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Data/hora ISO-8601 da conclusão da entrega/rota (default `now()`). Aceita também o alias `delivered_at`."
    },
    "delivered_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Alias opcional para `completed_at`."
    },
    "receiver_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Nome do recebedor (opcional)."
    },
    "receiver_document": {
      "type": [
        "string",
        "null"
      ],
      "description": "CPF/CNPJ ou documento do recebedor (opcional)."
    },
    "notes": {
      "type": [
        "string",
        "null"
      ],
      "description": "Observações da confirmação operacional ou referência do TMS/roteirizador (opcional)."
    },
    "pay_document_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ID do documento financeiro (`pay_documents.id`) vinculado quando conciliado via API de documentos ou proxy de webhook."
    },
    "external_service_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Identificador externo da rota/serviço no TMS ou roteirizador (ex.: `route_id` da Abbiamo)."
    }
  }
}