Skip to content
RipsClouddevelopers

Create rips packages

POST/api/v1/workspaces/{workspaceId}/rips-packages

Operation ID: ripsPackages.create · Access: PAT with write scope and authorized workspace where applicable · Effect: write.

Read the rips packages workflow before this operation.

Saving creates a draft. It does not send RIPS or prove ministry acceptance. Package-type requirements are checked during validation and dispatch. Choose the correct package type.

Parameters

Section titled “Parameters”
Name In Required Type / allowed values
workspaceId path Yes string
idempotency-key header No string

Request body

Section titled “Request body”

Content type: application/json · Required: yes.

Schema: CreateRipsPackageInput. Browse schema fields.

Example: rips_sin_factura

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "rips_sin_factura",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": null,
    "tipoNota": "RS",
    "numNota": "RS-DEMO-001",
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 100000,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": null
}
Example: fev_rips

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "fev_rips",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "SETP990000001",
    "tipoNota": null,
    "numNota": null,
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 100000,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": {
    "documentKind": "invoice",
    "number": "SETP990000001"
  }
}
Example: nc_parcial

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nc_parcial",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "SETP990000001",
    "tipoNota": "NC",
    "numNota": "NC-DEMO-001",
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 100000,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": {
    "documentKind": "credit-note",
    "number": "NC-DEMO-001"
  },
  "sourcePackageId": "pkg-factura-aceptada"
}
Example: nc_total

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nc_total",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": null,
  "attachedDocument": {
    "documentKind": "credit-note",
    "number": "NC-DEMO-002"
  },
  "sourcePackageId": "pkg-factura-aceptada"
}
Example: nd

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nd",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "SETP990000001",
    "tipoNota": "ND",
    "numNota": "ND-DEMO-001",
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 100000,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": {
    "documentKind": "debit-note",
    "number": "ND-DEMO-001"
  },
  "sourcePackageId": "pkg-factura-aceptada"
}
Example: nota_ajuste

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nota_ajuste",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "SETP990000001",
    "tipoNota": "NA",
    "numNota": "NA-DEMO-001",
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 100000,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": null,
  "sourcePackageId": "pkg-factura-aceptada"
}
Example: capita_inicial

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "capita_inicial",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": null,
  "attachedDocument": {
    "documentKind": "invoice",
    "number": "CAP-DEMO-001"
  }
}
Example: capita_periodo

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "capita_periodo",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "CAP-DEMO-001",
    "tipoNota": null,
    "numNota": null,
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 0,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": {
    "documentKind": "invoice",
    "number": "CAP-DEMO-002"
  },
  "sourcePackageId": "pkg-capita-aceptada"
}
Example: capita_final

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "capita_final",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": {
    "numDocumentoIdObligado": "900123456",
    "numFactura": "CAP-DEMO-001",
    "tipoNota": null,
    "numNota": null,
    "usuarios": [
      {
        "tipoDocumentoIdentificacion": "CC",
        "numDocumentoIdentificacion": "1000000002",
        "tipoUsuario": "01",
        "fechaNacimiento": "1990-01-01",
        "codSexo": "F",
        "codPaisResidencia": "170",
        "codPaisOrigen": "170",
        "codMunicipioResidencia": "11001",
        "codZonaTerritorialResidencia": "01",
        "incapacidad": "NO",
        "consecutivo": 1,
        "servicios": {
          "consultas": [
            {
              "codPrestador": "110010000101",
              "fechaInicioAtencion": "2026-09-01 10:00",
              "numAutorizacion": null,
              "codConsulta": "890201",
              "modalidadGrupoServicioTecSal": "01",
              "grupoServicios": "01",
              "codServicio": 325,
              "finalidadTecnologiaSalud": "44",
              "causaMotivoAtencion": "38",
              "codDiagnosticoPrincipal": "Z000",
              "codDiagnosticoRelacionado1": null,
              "codDiagnosticoRelacionado2": null,
              "codDiagnosticoRelacionado3": null,
              "tipoDiagnosticoPrincipal": "01",
              "tipoDocumentoIdentificacion": "CC",
              "numDocumentoIdentificacion": "1000000001",
              "vrServicio": 0,
              "conceptoRecaudo": "05",
              "valorPagoModerador": 0,
              "numFEVPagoModerador": null,
              "consecutivo": 1
            }
          ]
        }
      }
    ]
  },
  "attachedDocument": null,
  "sourcePackageId": "pkg-capita-aceptada"
}
Example: nc_acuerdo_voluntades

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nc_acuerdo_voluntades",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": null,
  "attachedDocument": {
    "documentKind": "credit-note",
    "number": "NC-DEMO-003"
  },
  "sourcePackageId": "pkg-factura-aceptada"
}
Example: nc_capita

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "kind": "nc_capita",
  "origin": "upload",
  "ripsSourceProfile": "native-d558206",
  "rips": null,
  "attachedDocument": {
    "documentKind": "credit-note",
    "number": "NC-DEMO-004"
  },
  "sourcePackageId": "pkg-capita-aceptada"
}

Responses

Section titled “Responses”
HTTP Content Schema
201 application/json RipsPackage
400 application/json ApiError
401 application/json ApiError
403 application/json ApiError
404 application/json ApiError
409 application/json ApiError
413 application/json ApiError
415 application/json ApiError
422 application/json ApiError
428 application/json ApiError
500 application/json ApiError
502 application/json ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

cURL

Section titled “cURL”

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Save your authorized JSON input as request.json. Use the request schema and examples above; replace synthetic data before use.

Terminal window
curl --fail-with-body --request POST \
  "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/rips-packages" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json