Conceptos

Modelos

Concepto

Propiedades

id

• tipo: interger
• descripción: Id del concepto de documento.

codigo

• tipo: string
• descripción: Código del concepto de documento.

nombre

• tipo: string
• descripción: Nombre del concepto de documento.

datosExtra

• tipo: dictionary
• descripcion: Datos extra del concepto de documento.
• observaciones: Los datos extra es un diccionario del esquema completo de la tabla de conceptos de documento 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": 1,
  "codigo": "FACTURAPRUEBA",
  "nombre": "FACTURA DE PRUEBAS",
  "datosExtra": {
    "CIDCONCEPTODOCUMENTO": "1",
    "CCODIGOCONCEPTO": "FACTURAPRUEBA",
    "CNOMBRECONCEPTO": "FACTURA DE PRUEBAS"
  }
}

Solicitudes

Buscar Conceptos

ContpaqiRequest

$Type

• tipo: string
• valor: BuscarConceptosRequest

Model

id (opcional)

• tipo: integer
• nullable: true
• descripcion: Parámetro para buscar conceptos por id.

codigo (opcional)

• tipo: string
• nullable: true
• descripcion: Parámetro para buscar conceptos por código.

sqlQuery (opcional)

• tipo: string
• nullable: true
• descripcion: Parámetro para buscar conceptos por SQL. El valor debe ser el WHERE clause y debes asegurarte de sanatizar tu SQL.

Options

cargarDatosExtra (opcional)

• tipo: boolean
• descripción: Indica si se deben cargar los datos extra del concepto de documento 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": "BuscarConceptosRequest",
  "model": {
    "id": 1,
    "codigo": "FACTURAPRUEBA",
    "sqlQuery": "CCODIGOCONCEPTO = \u0027PRUEBAFACTURA\u0027"
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

• tipo: string
• valor: BuscarConceptosResponse

Model

numeroRegistros

• tipo: integer
• descripción: Número de registros encontrados.

conceptos

• tipo: array de Concepto
• descripción: Lista de conceptos de documento encontrados.

Ejemplo

{
  "$type": "BuscarConceptosResponse",
  "model": {
    "numeroRegistros": 1,
    "conceptos": [
      {
        "id": 1,
        "codigo": "FACTURAPRUEBA",
        "nombre": "FACTURA DE PRUEBAS",
        "datosExtra": {
          "CIDCONCEPTODOCUMENTO": "1",
          "CCODIGOCONCEPTO": "FACTURAPRUEBA",
          "CNOMBRECONCEPTO": "FACTURA DE PRUEBAS"
        }
      }
    ]
  }
}