Almacenes - AndresRamos/ARSoftware.Contpaqi.Comercial.Api GitHub Wiki

Modelos

Almacen

Propiedades

id

  • tipo: interger
  • descripcion: Id del almacén.

codigo

  • tipo: string
  • descripcion: Código del almacén.

nombre

  • tipo: string
  • descripcion: Nombre del almacén.

datosExtra

  • tipo: dictionary
  • descripcion: Datos extra del almacén.
  • observaciones: Los datos extra es un diccionario del esquema completo de la tabla de almacenes en la base de datos, donde la llave es el nombre del campo en la base de datos y el valor es el valor del campo en la base de datos. Para conocer los campos disponibles y sus tipos, consulta la documentación del esquema de la base de datos de CONTPAQi Comercial.

Ejemplo

{
  "id": 0,
  "codigo": "ALMACENPRUEBA",
  "nombre": "ALMACEN DE PRUEBAS",
  "datosExtra": {
    "CTEXTOEXTRA1": "Texto extra 1",
    "CTEXTOEXTRA2": "Texto extra 2",
    "CTEXTOEXTRA3": "Texto extra 3"
  }
}

Solicitudes

Buscar Almacenes

ContpaqiRequest

$Type

  • tipo: string
  • valor: BuscarAlmacenesRequest

Model

id (opcional)
  • tipo: integer
  • nullable: true
  • descripcion: Parámetro para buscar almacenes por id.
codigo (opcional)
  • tipo: string
  • nullable: true
  • descripcion: Parámetro para buscar almacenes por código.
sqlQuery (opcional)
  • tipo: string
  • nullable: true
  • descripcion: Parámetro para buscar almacenes por SQL. El valor debe ser el WHERE clause y debes asegurarte de sanatizar tu SQL.

Options

cargarDatosExtra (opcional)
  • tipo: boolean
  • descripcion: Indica si se deben cargar los datos extra en la respuesta.
  • observaciones: Cargar los datos extra puede alentar el procesamiento de la solicitud ya que se carga el esquema completo de la base de datos de cada registro.

Ejemplo

{
  "$type": "BuscarAlmacenesRequest",
  "model": {
    "id": 1,
    "codigo": "ALMACENPRUEBA",
    "sqlQuery": "CNOMBREALMACEN = \u0027ALMACEN DE PRUEBAS\u0027"
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: BuscarAlmacenesResponse

Model

numeroRegistros
  • tipo: integer
  • descripcion: Número de registros encontrados.
almacenes
  • tipo: array de Almacen
  • descripcion: Lista de almacenes encontrados.

Ejemplo

{
  "$type": "BuscarAlmacenesResponse",
  "model": {
    "numeroRegistros": 1,
    "almacenes": [
      {
        "id": 0,
        "codigo": "ALMACENPRUEBA",
        "nombre": "ALMACEN DE PRUEBAS",
        "datosExtra": {
          "CTEXTOEXTRA1": "Texto extra 1",
          "CTEXTOEXTRA2": "Texto extra 2",
          "CTEXTOEXTRA3": "Texto extra 3"
        }
      }
    ]
  }
}

Crear Almacén

ContpaqiRequest

$Type

  • tipo: string
  • valor: CrearAlmacenRequest

Model

almacen
  • tipo: Almacen
  • descripcion: Almacén a crear.

Options

cargarDatosExtra (opcional)
  • tipo: boolean
  • descripcion: Indica si se deben cargar los datos extra en la respuesta.
  • observaciones: Cargar los datos extra puede alentar el procesamiento de la solicitud ya que se carga el esquema completo de la base de datos de cada registro.

Ejemplo

{
  "$type": "CrearAlmacenRequest",
  "model": {
    "almacen": {
      "id": 0,
      "codigo": "ALMACENPRUEBA",
      "nombre": "ALMACEN DE PRUEBAS",
      "datosExtra": {
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: CrearAlmacenResponse

Model

almacen
  • tipo: Almacen
  • descripcion: Almacén creado.

Ejemplo

{
  "$type": "CrearAlmacenResponse",
  "model": {
    "almacen": {
      "id": 0,
      "codigo": "ALMACENPRUEBA",
      "nombre": "ALMACEN DE PRUEBAS",
      "datosExtra": {
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  }
}

Actualizar Almacén

ContpaqiRequest

$Type

  • tipo: string
  • valor: ActualizarAlmacenRequest

Model

codigoAlmacen
  • tipo: string
  • descripcion: Código del almacén a actualizar.
datosAlmacen
  • tipo: dictionary
  • descripcion: Datos del almacén a actualizar.
  • observaciones: Los datos del almacén es un diccionario donde la llave es el nombre del campo de la tabla de almacenes en la base de datos y el valor es un valor valido del campo en la base de datos. Para conocer los campos disponibles y sus tipos, consulta la documentación del esquema de la base de datos de CONTPAQi Comercial.

Options

cargarDatosExtra (opcional)
  • tipo: boolean
  • descripcion: Indica si se deben cargar los datos extra en la respuesta.
  • observaciones: Cargar los datos extra puede alentar el procesamiento de la solicitud ya que se carga el esquema completo de la base de datos de cada registro.

Ejemplo

{
  "$type": "ActualizarAlmacenRequest",
  "model": {
    "codigoAlmacen": "ALMACENPRUEBA",
    "datosAlmacen": {
      "CTEXTOEXTRA1": "Texto extra 1",
      "CTEXTOEXTRA2": "Texto extra 2",
      "CTEXTOEXTRA3": "Texto extra 3"
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: ActualizarAlmacenResponse

Model

almacen
  • tipo: Almacen
  • descripcion: Almacén actualizado.

Ejemplo

{
  "$type": "ActualizarAlmacenResponse",
  "model": {
    "almacen": {
      "id": 0,
      "codigo": "ALMACENPRUEBA",
      "nombre": "ALMACEN DE PRUEBAS",
      "datosExtra": {
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  }
}