← InicioFleetPay / Schema

ContraCteLoteInput

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.

ctesarrayObligatorio

Cada elemento es la clave (string) o un objeto con chave y los campos opcionales.

minItems1
motoristaobjectObligatorio
placastringObligatorio
pattern"^[A-Za-z]{3}[0-9][A-Za-z0-9][0-9]{2}$"
valoresobjectOpcional
tipo_servicointeger | nullOpcional

ide/tpServ de los contra-CT-e del lote: 1 subcontratación (predeterminado), 2 redespacho, 3 redespacho intermedio. Puede sobrescribirse por clave (ctes[].tipo_servico) y por tramo (pernas[].tipo_servico). En 2/3, el recorrido (origem y destino) es obligatorio.

1 · 2 · 3 · null
repasseobjectOpcional

Opcional. Sin este bloque, el lote es solo fiscal: emite los contra-CT-e sin crear un grupo de transferencias, una cuota ni un ROUTE de tramo, y sin neutralizar la transferencia del documento de origen; las filas emitidas devuelven financeiro: "nenhum". Con el bloque, el CT-e de origen, en la cuenta de la contratante, se incorpora a su grupo de transferencias con estas cuotas y el conductor del lote: quien paga al conductor es la contratante y la subcontratada nunca recibe un documento financiero. El servicio de pagos envía el dinero a la cuenta del conductor persona física o a la Cuenta Operativa de su transportista persona jurídica. Requiere la adhesión de la contratante; sin ella, la fila devuelve financeiro: "nenhum" con motivo: contratante_sem_opt_in.

referencia_externastring | nullOpcional

Tu identificador, devuelto en external_reference.

maxLength64
subcontratadaobjectOpcional

En nombre de la subcontratada. La CONTRATANTE realiza la llamada con su propia clave de API y el lote se crea en la cuenta de la subcontratada de este CNPJ, utilizando su certificado, numeración, bandeja fiscal, conductor y vehículo. Requiere la autorización concedida por la subcontratada mediante POST /fiscal/cte-subcontratacao/autorizacoes; sin ella, devuelve 403 emissao_nao_autorizada; un CNPJ que no es cliente devuelve 404 subcontratada_nao_encontrada. Se acepta el propio CNPJ sin modificar el comportamiento. Con repasse, la adhesión de la contratante es implícita: ella misma solicitó la emisión.

Definición JSON Original (Descripciones en Portugués)
{
  "type": "object",
  "required": [
    "ctes",
    "motorista",
    "placa"
  ],
  "properties": {
    "ctes": {
      "type": "array",
      "minItems": 1,
      "description": "Cada item é a chave (string) ou um objeto com `chave` e os campos opcionais.",
      "items": {
        "oneOf": [
          {
            "type": "string",
            "minLength": 44,
            "maxLength": 44
          },
          {
            "$ref": "#/components/schemas/ContraCteLoteItem"
          }
        ]
      }
    },
    "motorista": {
      "type": "object",
      "required": [
        "cpf"
      ],
      "properties": {
        "cpf": {
          "type": "string",
          "description": "CPF do motorista (com ou sem pontuação). No lote de pernas é o padrão das pernas sem motorista próprio."
        }
      }
    },
    "placa": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}[0-9][A-Za-z0-9][0-9]{2}$"
    },
    "valores": {
      "type": "object",
      "properties": {
        "frete_bruto": {
          "type": "number",
          "minimum": 0.01,
          "description": "Rateia `total ÷ N` entre as chaves/pernas (resíduo de centavos nas últimas). Exclusivo com `valor` por chave/perna."
        }
      }
    },
    "origem": {
      "$ref": "#/components/schemas/ContraCteLoteRota"
    },
    "destino": {
      "$ref": "#/components/schemas/ContraCteLoteRota"
    },
    "tipo_servico": {
      "type": [
        "integer",
        "null"
      ],
      "enum": [
        1,
        2,
        3,
        null
      ],
      "description": "`ide/tpServ` dos contra-CT-e do lote: `1` subcontratação (padrão), `2` redespacho,\n`3` redespacho intermediário. Sobrescrevível por chave (`ctes[].tipo_servico`) e por\nperna (`pernas[].tipo_servico`). Em `2`/`3` o trecho (`origem` e `destino`) é obrigatório.\n"
    },
    "repasse": {
      "type": "object",
      "required": [
        "parcelas"
      ],
      "description": "**Opcional.** Sem este bloco o lote é **só fiscal**: emite os contra-CT-e e não cria grupo de\nrepasse, parcela, ROUTE de perna nem neutraliza o repasse da origem — as linhas emitidas voltam\ncom `financeiro: \"nenhum\"`. Com o bloco, o CT-e de origem — na conta da **contratante** — entra\nnum grupo de repasse dela com estas parcelas e o motorista do lote: quem paga o motorista é a\ncontratante, e a subcontratada nunca ganha documento financeiro. O payments manda o dinheiro\npara a conta de motorista (PF) ou para a Conta Operação da transportadora dele (PJ). Exige o\nopt-in da contratante; sem ele a linha volta `financeiro: \"nenhum\"` com\n`motivo: contratante_sem_opt_in`.\n",
      "properties": {
        "parcelas": {
          "type": "array",
          "minItems": 1,
          "maxItems": 3,
          "description": "Posições contíguas a partir de 1; percentuais somam 100.",
          "items": {
            "$ref": "#/components/schemas/ContraCteLoteParcela"
          }
        }
      }
    },
    "referencia_externa": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "description": "Identificador seu, devolvido em `external_reference`."
    },
    "subcontratada": {
      "type": "object",
      "required": [
        "cnpj"
      ],
      "description": "**Em nome da subcontratada.** A chamada é da CONTRATANTE (chave de API dela) e o lote nasce\nna conta da subcontratada deste CNPJ — certificado, numeração, caixa fiscal, motorista e\nveículo dela. Exige a autorização concedida pela subcontratada em\n`POST /fiscal/cte-subcontratacao/autorizacoes`; sem ela, `403 emissao_nao_autorizada`;\nCNPJ que não é cliente, `404 subcontratada_nao_encontrada`. O próprio CNPJ é aceito e não\nmuda nada. Com `repasse`, o opt-in da contratante é implícito: ela mesma pediu a emissão.\n",
      "properties": {
        "cnpj": {
          "type": "string",
          "description": "CNPJ da subcontratada (com ou sem pontuação)."
        }
      }
    }
  }
}