← InicioFleetPay / Schema

ConfirmarEntregaSolicitacaoTransporteRequest

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Payload opcional para confirmación/cierre operacional de entrega vía API (POST /embarcador/solicitacoes-transporte/{id}/confirmar-entrega).

completed_atstring | null · date-timeOpcional

Fecha/hora ISO-8601 de finalización de la entrega/ruta (predeterminado now()). Acepta también el alias delivered_at.

delivered_atstring | null · date-timeOpcional

Alias opcional para completed_at.

receiver_namestring | nullOpcional

Nombre del receptor (opcional).

receiver_documentstring | nullOpcional

CPF/CNPJ o documento del receptor (opcional).

notesstring | nullOpcional

Observaciones de confirmación operacional o referencia del TMS/enrutador (opcional).

pay_document_idinteger | nullOpcional

ID del documento financiero (pay_documents.id) vinculado cuando se concilia vía API de documentos o proxy de webhook.

external_service_idstring | nullOpcional

Identificador externo de la ruta/servicio en el TMS o enrutador (ej.: route_id de Abbiamo).

Definición JSON Original (Descripciones en Portugués)
{
  "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)."
    }
  }
}