Empresas

Modelos

Empresa

Propiedades

id

• tipo: interger
• descripción: Id de la empresa.

nombre

• tipo: string
• descripción: Nombre de la empresa.

ruta

• tipo: string
• descripción: Ruta de la empresa.

baseDatos

• tipo: string
• descripción: Nombre de la base de datos de la empresa.

parametros

• tipo: Parametros
• descripción: Parámetros de la empresa.

Ejemplo

{
  "id": 0,
  "nombre": "Empresa de prueba",
  "ruta": "C:\\Compac\\Empresas\\adPRUEBAS_COMERCIAL",
  "baseDatos": "adPRUEBAS_COMERCIAL",
  "parametros": {
    "rfc": "XAXX010101000",
    "guidAdd": "7e07b968-c30d-4809-b059-e809e4ef64e1",
    "datosExtra": {
      "CIDEMPRESA": "1",
      "CNOMBREEMPRESA": "Empresa de prueba",
      "CRFCEMPRESA": "XAXX010101000",
      "CGUIDDSL": "7e07b968-c30d-4809-b059-e809e4ef64e1"
    }
  }
}

Parametros

Propiedades

rfc

• tipo: string
• descripción: RFC de la empresa.

guidAdd

• tipo: string
• descripción: Identificador global único de la empresa en el Administrador de Documentos Digitales (ADD).

datosExtra

• tipo: dictionary
• descripción: Datos extra de la empresa.
• observaciones: Los datos extra es un diccionario del esquema completo de la tabla de parametros 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

{
    "rfc": "XAXX010101000",
    "guidAdd": "7e07b968-c30d-4809-b059-e809e4ef64e1",
    "datosExtra": {
      "CIDEMPRESA": "1",
      "CNOMBREEMPRESA": "Empresa de prueba",
      "CRFCEMPRESA": "XAXX010101000",
      "CGUIDDSL": "7e07b968-c30d-4809-b059-e809e4ef64e1"
    }
  }

Solicitudes

Buscar Empresas

ContpaqiRequest

$Type

• tipo: string
• valor: BuscarEmpresasRequest

Model

El modelo de la solicitud es un objecto vacío.

Options

cargarDatosExtra

• tipo: boolean
• descripcion: Indica si se deben cargar los datos extra en la respuesta.

Ejemplo

{
  "$type": "BuscarEmpresasRequest",
  "model": {},
  "options": {
    "cargarDatosExtra": false
  }
}

ContpaqiResponse

$Type

• tipo: string
• valor: BuscarEmpresasResponse

Model

numeroRegistros

• tipo: interger
• descripcion - Número de registros encontrados.

empresas

• tipo: array de Empresas
• descripcion - Lista de empresas encontradas.

Ejemplo

{
  "$type": "BuscarEmpresasResponse",
  "model": {
    "numeroRegistros": 1,
    "empresas": [
      {
        "id": 0,
        "nombre": "Empresa de prueba",
        "ruta": "C:\\Compac\\Empresas\\adPRUEBAS_COMERCIAL",
        "baseDatos": "adPRUEBAS_COMERCIAL",
        "parametros": {
          "rfc": "XAXX010101000",
          "guidAdd": "7e07b968-c30d-4809-b059-e809e4ef64e1",
          "datosExtra": {
            "CIDEMPRESA": "1",
            "CNOMBREEMPRESA": "Empresa de prueba",
            "CRFCEMPRESA": "XAXX010101000",
            "CGUIDDSL": "7e07b968-c30d-4809-b059-e809e4ef64e1"
          }
        }
      }
    ]
  }
}