← HomeFleetPay / Schema

ConfirmarEntregaSolicitacaoTransporteRequest

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Optional payload for operational delivery confirmation via API (POST /embarcador/solicitacoes-transporte/{id}/confirmar-entrega).

completed_atstring | null · date-timeOptional

ISO-8601 timestamp of delivery/route completion (default now()). Also accepts alias delivered_at.

delivered_atstring | null · date-timeOptional

Optional alias for completed_at.

receiver_namestring | nullOptional

Recipient name (optional).

receiver_documentstring | nullOptional

Recipient CPF/CNPJ or ID document (optional).

notesstring | nullOptional

Operational confirmation notes or TMS/router reference (optional).

pay_document_idinteger | nullOptional

Linked financial document ID (pay_documents.id) when reconciled via the Documents API or webhook proxy.

external_service_idstring | nullOptional

External route/service identifier in the TMS or router (e.g. route_id from Abbiamo).

Original JSON Definition (Portuguese Descriptions)
{
  "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)."
    }
  }
}