← HomeFleetPay / Schema

ParcelaPorMdfeLinha

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.

ParcelaRepasse ↗

cte_uuidstring · uuidOptional

chave_ctestring | nullOptional

documento_idinteger | nullOptional

documento_numerostring | nullOptional

Financial document internal_id (source key in 1:1 mode; ROUTE:... for a leg).

resultadostringOptional

"liberada" · "ja_liberada" · "ordenada" · "ja_ordenada" · "recusada" · "ignorado"

motivostring | nullOptional

For recusada, the same code as the individual endpoint; for ignorado, sem_documento_financeiro or motorista_divergente.

mensagemstring | nullOptional

parcela—Optional

ParcelaRepasse ↗

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "properties": {
    "cte_uuid": {
      "type": "string",
      "format": "uuid"
    },
    "chave_cte": {
      "type": [
        "string",
        "null"
      ]
    },
    "documento_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "documento_numero": {
      "type": [
        "string",
        "null"
      ],
      "description": "O `internal_id` do documento financeiro (chave da origem no 1:1; `ROUTE:...` na perna)."
    },
    "resultado": {
      "type": "string",
      "enum": [
        "liberada",
        "ja_liberada",
        "ordenada",
        "ja_ordenada",
        "recusada",
        "ignorado"
      ]
    },
    "motivo": {
      "type": [
        "string",
        "null"
      ],
      "description": "Em `recusada`, o mesmo código do endpoint unitário; em `ignorado`, `sem_documento_financeiro` ou `motorista_divergente`."
    },
    "mensagem": {
      "type": [
        "string",
        "null"
      ]
    },
    "parcela": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ParcelaRepasse"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}