← HomeFleetPay / Schema

ContratarSolicitacaoTransporteRequest

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.

carrier_shipper_idinteger | nullOptional
shipper_negotiation_idinteger | nullOptional
requested_versioninteger | nullOptional
contract_acceptance_idinteger | nullOptional
acceptedboolean | nullOptional

Does not replace the formal acceptance term (ShipperContractAcceptance). If sent as true without formal acceptance evidence for the commercial version, the API rejects with 422 spot_formal_acceptance_required.

confirm_uncertaintiesboolean | nullOptional
expected_amount_centsinteger | nullOptional

Expected total amount in cents (optional). If provided and differs from the canonical server calculation for the accepted commercial version, the API responds 409 price_mismatch_with_server_calculation.

aggregated_carrier_company_idinteger | nullOptional

Optional ID of the indicated Aggregated Carrier (indicated_aggregated_carrier_company_id). Does not confirm operational fulfillment by itself; attendance_status stays awaiting_confirmation until confirmation by the authorized Transport Manager.

Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "properties": {
    "carrier_shipper_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "shipper_negotiation_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "requested_version": {
      "type": [
        "integer",
        "null"
      ]
    },
    "contract_acceptance_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "accepted": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Não substitui o termo de aceite formal (`ShipperContractAcceptance`). Se enviado como `true` sem evidência formal de aceite para a versão comercial, a API recusa com `422 spot_formal_acceptance_required`."
    },
    "confirm_uncertainties": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "expected_amount_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Valor total esperado em centavos (opcional). Se informado e divergir do cálculo canônico do servidor para a versão comercial aceita, a API responde `409 price_mismatch_with_server_calculation`."
    },
    "aggregated_carrier_company_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ID opcional do Transportador Agregado indicado (`indicated_aggregated_carrier_company_id`). Não confirma o atendimento operacional por si só; `attendance_status` permanece `awaiting_confirmation` até confirmação pelo Gestor de Transporte autorizado."
    }
  }
}