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

Modelos

Cliente

Propiedades

id

  • tipo: interger
  • descripcion: Id del cliente.

codigo

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

razonSocial

  • tipo: string
  • descripcion: Razón social del cliente.

rfc

  • tipo: string
  • descripcion: RFC del cliente.

tipo

  • tipo: string
  • descripcion: Tipo de cliente.
  • valores posibles: Cliente, ClienteProveedor, Proveedor

usoCfdi

  • tipo: string
  • descripcion: Uso de CFDI del cliente.

regimenFiscal

  • tipo: string
  • descripcion: Régimen fiscal del cliente.

direccionFiscal

  • tipo: Direccion
  • descripcion: Dirección fiscal del cliente.

datosExtra

  • tipo: dictionary
  • descripcion: Datos extra del cliente.
  • observaciones: Los datos extra es un diccionario del esquema completo de la tabla de clientes 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": "CLIENTEPRUEBA",
  "razonSocial": "CLIENTE DE PRUEBAS",
  "rfc": "XAXX010101000",
  "tipo": "ClienteProveedor",
  "usoCfdi": "S01",
  "regimenFiscal": "616",
  "direccionFiscal": {
    "id": 0,
    "tipoCatalogo": 0,
    "tipo": "Fiscal",
    "calle": "Pablo Villase\u00F1or",
    "numeroExterior": "435",
    "numeroInterior": "",
    "colonia": "Ladr\u00F3n de Guevara",
    "ciudad": "Guadalajara",
    "estado": "Jalisco",
    "codigoPostal": "44600",
    "pais": "M\u00E9xico",
    "datosExtra": {}
  },
  "datosExtra": {
    "CEMAIL1": "[email protected]",
    "CTEXTOEXTRA1": "Texto Extra 1",
    "CTEXTOEXTRA2": "Texto Extra 2",
    "CTEXTOEXTRA3": "Texto Extra 3"
  }
}

Solicitudes

Buscar Clientes

ContpaqiRequest

$Type

  • tipo: string
  • valor: BuscarClientesRequest

Model

id (opcional)
  • tipo: interger
  • nullable: true
  • descripcion: Parámetro para buscar clientes por Id.
codigo (opcional)
  • tipo: string
  • nullable: true
  • descripcion: Parametro para buscar clientes por código.
sqlQuery (opcional)
  • tipo: string
  • nullable: true
  • descripcion: Parámetro para buscar clientes 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": "BuscarClientesRequest",
  "model": {
    "id": 1,
    "codigo": "CLIENTEPRUEBA",
    "sqlQuery": "CRAZONSOCIAL = \u0027CLIENTE DE PRUEBAS\u0027"
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: BuscarClientesResponse

Model

numeroRegistros
  • tipo: interger
  • descripcion: Número de registros encontrados.
clientes
  • tipo: array de Cliente
  • descripcion: Lista de clientes encontrados.

Ejemplo

{
  "$type": "BuscarClientesResponse",
  "model": {
    "numeroRegistros": 1,
    "clientes": [
      {
        "id": 0,
        "codigo": "CLIENTEPRUEBA",
        "razonSocial": "CLIENTE DE PRUEBAS",
        "rfc": "XAXX010101000",
        "tipo": "ClienteProveedor",
        "usoCfdi": "S01",
        "regimenFiscal": "616",
        "direccionFiscal": {
          "id": 0,
          "tipoCatalogo": 0,
          "tipo": "Fiscal",
          "calle": "Pablo Villase\u00F1or",
          "numeroExterior": "435",
          "numeroInterior": "",
          "colonia": "Ladr\u00F3n de Guevara",
          "ciudad": "Guadalajara",
          "estado": "Jalisco",
          "codigoPostal": "44600",
          "pais": "M\u00E9xico",
          "datosExtra": {}
        },
        "datosExtra": {
          "CEMAIL1": "[email protected]",
          "CTEXTOEXTRA1": "Texto Extra 1",
          "CTEXTOEXTRA2": "Texto Extra 2",
          "CTEXTOEXTRA3": "Texto Extra 3"
        }
      }
    ]
  }
}

Crear Cliente

ContpaqiRequest

$Type

  • tipo: string
  • valor: CrearClienteRequest

Model

cliente
  • tipo: Cliente
  • descripcion: Cliente 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": "CrearClienteRequest",
  "model": {
    "cliente": {
      "id": 0,
      "codigo": "CLIENTEPRUEBA",
      "razonSocial": "CLIENTE DE PRUEBAS",
      "rfc": "XAXX010101000",
      "tipo": "ClienteProveedor",
      "usoCfdi": "S01",
      "regimenFiscal": "616",
      "direccionFiscal": {
        "id": 0,
        "tipoCatalogo": 0,
        "tipo": "Fiscal",
        "calle": "Pablo Villase\u00F1or",
        "numeroExterior": "435",
        "numeroInterior": "",
        "colonia": "Ladr\u00F3n de Guevara",
        "ciudad": "Guadalajara",
        "estado": "Jalisco",
        "codigoPostal": "44600",
        "pais": "M\u00E9xico",
        "datosExtra": {}
      },
      "datosExtra": {
        "CEMAIL1": "[email protected]",
        "CTEXTOEXTRA1": "Texto Extra 1",
        "CTEXTOEXTRA2": "Texto Extra 2",
        "CTEXTOEXTRA3": "Texto Extra 3"
      }
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: CrearClienteResponse

Model

cliente
  • tipo: Cliente
  • descripcion: Cliente creado.

Ejemplo

{
  "$type": "CrearClienteResponse",
  "model": {
    "cliente": {
      "id": 0,
      "codigo": "CLIENTEPRUEBA",
      "razonSocial": "CLIENTE DE PRUEBAS",
      "rfc": "XAXX010101000",
      "tipo": "ClienteProveedor",
      "usoCfdi": "S01",
      "regimenFiscal": "616",
      "direccionFiscal": {
        "id": 0,
        "tipoCatalogo": 0,
        "tipo": "Fiscal",
        "calle": "Pablo Villase\u00F1or",
        "numeroExterior": "435",
        "numeroInterior": "",
        "colonia": "Ladr\u00F3n de Guevara",
        "ciudad": "Guadalajara",
        "estado": "Jalisco",
        "codigoPostal": "44600",
        "pais": "M\u00E9xico",
        "datosExtra": {}
      },
      "datosExtra": {
        "CEMAIL1": "[email protected]",
        "CTEXTOEXTRA1": "Texto Extra 1",
        "CTEXTOEXTRA2": "Texto Extra 2",
        "CTEXTOEXTRA3": "Texto Extra 3"
      }
    }
  }
}

Actualizar Cliente

ContpaqiRequest

$Type

  • tipo: string
  • valor: ActualizarClienteRequest

Model

codigoCliente
  • tipo: string
  • descripcion: Código del cliente a actualizar.
datosCliente
  • tipo: dictionary
  • descripcion: Datos del cliente a actualizar.
  • observaciones: Los datos del cliente es un diccionario donde la llave es el nombre del campo de la tabla de clientes 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": "ActualizarClienteRequest",
  "model": {
    "codigoCliente": "CLIENTEPRUEBA",
    "datosCliente": {
      "CEMAIL1": "[email protected]",
      "CTEXTOEXTRA1": "Texto Extra 1",
      "CTEXTOEXTRA2": "Texto Extra 2",
      "CTEXTOEXTRA3": "Texto Extra 3"
    }
  },
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: ActualizarClienteResponse

Model

cliente
  • tipo: Cliente
  • descripcion: Cliente actualizado.

Ejemplo

{
  "$type": "ActualizarClienteResponse",
  "model": {
    "cliente": {
      "id": 0,
      "codigo": "CLIENTEPRUEBA",
      "razonSocial": "CLIENTE DE PRUEBAS",
      "rfc": "XAXX010101000",
      "tipo": "ClienteProveedor",
      "usoCfdi": "S01",
      "regimenFiscal": "616",
      "direccionFiscal": {
        "id": 0,
        "tipoCatalogo": 0,
        "tipo": "Fiscal",
        "calle": "Pablo Villase\u00F1or",
        "numeroExterior": "435",
        "numeroInterior": "",
        "colonia": "Ladr\u00F3n de Guevara",
        "ciudad": "Guadalajara",
        "estado": "Jalisco",
        "codigoPostal": "44600",
        "pais": "M\u00E9xico",
        "datosExtra": {}
      },
      "datosExtra": {
        "CEMAIL1": "[email protected]",
        "CTEXTOEXTRA1": "Texto Extra 1",
        "CTEXTOEXTRA2": "Texto Extra 2",
        "CTEXTOEXTRA3": "Texto Extra 3"
      }
    }
  }
}

Eliminar Cliente

ContpaqiRequest

$Type

  • tipo: string
  • valor: EliminarClienteRequest

Model

codigoCliente
  • tipo: string
  • descripcion: Código del cliente a eliminar.

Ejemplo

{
  "$type": "EliminarClienteRequest",
  "model": {
    "codigoCliente": "CLIENTEPRUEBA"
  },
  "options": {}
}

ContpaqiResponse

$Type

  • tipo: string
  • valor: EliminarClienteResponse

Ejemplo

{
  "$type": "EliminarClienteResponse",
  "model": {}
}