Schema: CreateRipsPackageInput

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
kind	Yes	RipsPackageKind
origin	No	upload, guided
guidedContractVersion	No	1
rips	No	RipsDraftPayload
attachedDocument	No	AttachedDocumentInput
sourcePackageId	No	string or null
ripsSourceProfile	No	history, native-d558206, ministry-v003-20260715
ripsImportSource	No	RipsImportSource
inputProvenance	No	RipsInputProvenance

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/RipsPackageKind"
    },
    "origin": {
      "type": "string",
      "enum": [
        "upload",
        "guided"
      ],
      "default": "upload",
      "description": "guided usa el contrato guiado del portal (perfil nativo); upload conserva la declaración de origen."
    },
    "guidedContractVersion": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "rips": {
      "$ref": "#/components/schemas/RipsDraftPayload"
    },
    "attachedDocument": {
      "$ref": "#/components/schemas/AttachedDocumentInput"
    },
    "sourcePackageId": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 160,
      "pattern": "^[A-Za-z0-9._:-]+$",
      "description": "Paquete aceptado de referencia para notas de ajuste o débito."
    },
    "ripsSourceProfile": {
      "type": "string",
      "enum": [
        "history",
        "native-d558206",
        "ministry-v003-20260715"
      ]
    },
    "ripsImportSource": {
      "$ref": "#/components/schemas/RipsImportSource"
    },
    "inputProvenance": {
      "$ref": "#/components/schemas/RipsInputProvenance"
    }
  },
  "required": [
    "kind"
  ],
  "additionalProperties": false
}