Modelos

Agente

Propiedades

id

• tipo: integer
• descripcion: Id del agente.

codigo

• tipo: string
• descripcion: Código del agente.

nombre

• tipo: string
• descripcion: Nombre del agente.

tipo

• tipo: enum
• descripcion: Tipo del agente.
• valores posibles: Ventas, VentasCobro, Cobro, FiguraTransporte, MedioTransporte

datosExtra

• tipo: dictionary
• descripcion: Datos extra del agente.
• observaciones: Los datos extra es un diccionario del esquema completo de la tabla de agentes 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": "AGENTEPRUEBA",
  "nombre": "AGENTE DE PRUEBAS",
  "tipo": "VentasCobro",
  "datosExtra": {
    "CCOMISIONVENTAAGENTE": "5",
    "CCOMISIONCOBROAGENTE": "10",
    "CTEXTOEXTRA1": "Texto extra 1",
    "CTEXTOEXTRA2": "Texto extra 2",
    "CTEXTOEXTRA3": "Texto extra 3"
  }
}

Solicitudes

Buscar Agentes

ContpaqiRequest

$Type

• tipo: string
• valor: BuscarAgentesRequest

Model

id (opcional)

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

codigo (opcional)

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

sqlQuery (opcional)

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

Options

cargarDatosExtra

• 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": "BuscarAgentesRequest",
  "model": {
    "id": 1,
    "codigo": "AGENTEPRUEBA",
    "sqlQuery": "CNOMBREAGENTE = \u0027AGENTE DE PRUEBAS\u0027"
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

• tipo: string
• valor: BuscarAgentesResponse

Model

numeroRegistros

• tipo: integer
• descripcion: Número de registros encontrados.

agentes

• tipo: array de Agente
• descripcion: Lista de agentes encontrados.

Ejemplo

{
  "$type": "BuscarAgentesResponse",
  "model": {
    "numeroRegistros": 1,
    "agentes": [
      {
        "id": 0,
        "codigo": "AGENTEPRUEBA",
        "nombre": "AGENTE DE PRUEBAS",
        "tipo": "VentasCobro",
        "datosExtra": {
          "CCOMISIONVENTAAGENTE": "5",
          "CCOMISIONCOBROAGENTE": "10",
          "CTEXTOEXTRA1": "Texto extra 1",
          "CTEXTOEXTRA2": "Texto extra 2",
          "CTEXTOEXTRA3": "Texto extra 3"
        }
      }
    ]
  }
}

Crear Agente

ContpaqiRequest

$Type

• tipo: string
• valor: CrearAgenteRequest

Model

agente

• tipo: Agente
• descripcion: Agente a crear.

Options

cargarDatosExtra

• 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": "CrearAgenteRequest",
  "model": {
    "agente": {
      "id": 0,
      "codigo": "AGENTEPRUEBA",
      "nombre": "AGENTE DE PRUEBAS",
      "tipo": "VentasCobro",
      "datosExtra": {
        "CCOMISIONVENTAAGENTE": "5",
        "CCOMISIONCOBROAGENTE": "10",
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

• tipo: string
• valor: CrearAgenteResponse

Model

agente

• tipo: Agente
• descripcion: Agente creado.

Ejemplo

{
  "$type": "CrearAgenteResponse",
  "model": {
    "agente": {
      "id": 0,
      "codigo": "AGENTEPRUEBA",
      "nombre": "AGENTE DE PRUEBAS",
      "tipo": "VentasCobro",
      "datosExtra": {
        "CCOMISIONVENTAAGENTE": "5",
        "CCOMISIONCOBROAGENTE": "10",
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  }
}

Actualizar Agente

ContpaqiRequest

$Type

• tipo: string
• valor: ActualizarAgenteRequest

Model

codigoAgente

• tipo: string
• descripcion: Código del agente a actualizar.

datosAgente

• tipo: dictionary
• descripcion: Datos del agente a actualizar.
• observaciones: Los datos del agente es un diccionario donde la llave es el nombre del campo de la tabla de agentes 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

• 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": "ActualizarAgenteRequest",
  "model": {
    "codigoAgente": "AGENTEPRUEBA",
    "datosAgente": {
      "CCOMISIONVENTAAGENTE": "5",
      "CCOMISIONCOBROAGENTE": "10",
      "CTEXTOEXTRA1": "Texto extra 1",
      "CTEXTOEXTRA2": "Texto extra 2",
      "CTEXTOEXTRA3": "Texto extra 3"
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

• tipo: string
• valor: ActualizarAgenteResponse

Model

agente

• tipo: Agente
• descripcion: Agente actualizado.

Ejemplo

{
  "$type": "ActualizarAgenteResponse",
  "model": {
    "agente": {
      "id": 0,
      "codigo": "AGENTEPRUEBA",
      "nombre": "AGENTE DE PRUEBAS",
      "tipo": "VentasCobro",
      "datosExtra": {
        "CCOMISIONVENTAAGENTE": "5",
        "CCOMISIONCOBROAGENTE": "10",
        "CTEXTOEXTRA1": "Texto extra 1",
        "CTEXTOEXTRA2": "Texto extra 2",
        "CTEXTOEXTRA3": "Texto extra 3"
      }
    }
  }
}