← HomeFleetPay / Schema

ContraCteLote

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.

ContraCteLoteResult ↗

batch_idstring · uuidOptional

statusstringOptional

"processing" · "done" · "failed"

external_referencestring | nullOptional

totalintegerOptional

emittedintegerOptional

duplicatedintegerOptional

failedintegerOptional

em_nome_deobject | nullOptional

Present when the contracting carrier submitted the batch on behalf of the subcontractor; contains the issuer's CNPJ.

repasse_group_refstringOptional

Batch transfer-group reference (for legs, each driver has <batch_id>:m<driver_user_id>).

resultsarrayOptional

ContraCteLoteResult ↗

error_messagestring | nullOptional

created_atstring · date-timeOptional

finished_atstring | null · date-timeOptional

Original JSON Definition (Portuguese Descriptions)

{
  "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"
    }
  }
}