← InicioFleetPay / Schema

ContraCteLote

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.

ContraCteLoteResult ↗

batch_idstring · uuidOpcional

statusstringOpcional

"processing" · "done" · "failed"

external_referencestring | nullOpcional

totalintegerOpcional

emittedintegerOpcional

duplicatedintegerOpcional

failedintegerOpcional

em_nome_deobject | nullOpcional

Presente cuando el contratante envió el lote en nombre de la subcontratada; contiene el CNPJ del emisor.

repasse_group_refstringOpcional

Referencia del grupo de transferencias del lote (en tramos, cada conductor tiene <batch_id>:m<driver_user_id>).

resultsarrayOpcional

ContraCteLoteResult ↗

error_messagestring | nullOpcional

created_atstring · date-timeOpcional

finished_atstring | null · date-timeOpcional

Definición JSON Original (Descripciones en Portugués)

{
  "type": "object",
  "properties": {
    "batch_id": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "enum": [
        "processing",
        "done",
        "failed"
      ]
    },
    "external_reference": {
      "type": [
        "string",
        "null"
      ]
    },
    "total": {
      "type": "integer"
    },
    "emitted": {
      "type": "integer"
    },
    "duplicated": {
      "type": "integer"
    },
    "failed": {
      "type": "integer"
    },
    "em_nome_de": {
      "type": [
        "object",
        "null"
      ],
      "description": "Presente quando o lote foi disparado pela contratante em nome da subcontratada; traz o CNPJ da emissora.",
      "properties": {
        "cnpj": {
          "type": "string"
        }
      }
    },
    "repasse_group_ref": {
      "type": "string",
      "description": "Referência do grupo de repasse do lote (nas pernas, cada motorista tem `<batch_id>:m<driver_user_id>`)."
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ContraCteLoteResult"
      }
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "finished_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}