La API de Factura Gorila maneja diferentes tipos de datos simples y complejos.

 

Tipos de datos simple

  1. Número entero: Número sin decimales.
  2. Número decimal: Número que puede o no incluir decimales.
  3. Cadena: Cualquier secuencia de caracteres.
  4. Fechas: Tienen el formato YYYY-mm-ddTHH:MM:SS 
  5. Boleanos: Se aceptan como cadenas de texto “true” y “false”
  6. Binario: Son archivos adjuntos

 

Tipos de dato complejos

Los tipos datos complejos son una agrupación de datos simples y otros datos complejos.

 

Consulta

Todos los puntos que retornan una lista de resultados están envueltos en un objeto de Tipo Consulta.

El objeto consulta incluye los datos solicitados, y además, incluye otra información útil para procesar estos datos. Como por ejemplo el número total de resultados, el número total de páginas, la cantidad de elementos por página.

TotalResultados

  • Tipo: Número entero.
  • Descripción: Máxima cantidad de posibles resultados en la consulta actual.
  • Observaciones: Ninguna.

 

CantidadPorPagina

  • Tipo: Número entero.
  • Descripción: Retorna el número máximo de elementos que son retornados por página.
  • Observaciones: Algunos puntos del servicio no están paginados, en tal caso el valor de esta propiedad siempre será igual a cero.

 

TotalDePaginas

  • Tipo: Número entero.
  • Descripción: Máxima cantidad de paginas de resultados posibles en la consulta actual.
  • Observaciones: Se calcula utilizando el TotalResultados y CantidadPorPagina. Algunos puntos del servicio no están paginados, en tal caso, esta propiedad siempre será igual a 1.

 

PaginaActual

  • Tipo: Número entero.
  • Descripción: Número de página actual.
  • Observaciones: Este número es base cero, osea la pagina cero es la primer página.

 

TipoDatoResultado

  • Tipo: Cadena.

  • Descripción: Es una cadena que describe el nombre del tipo de dato que se retorna en la lista. Puede ser “Concepto”, “Factura” o “Cliente”.
  • Observaciones: Es un metadato que determinar de que tipo es la lista de los Resultados.

 

Resultados

  • Tipo: Lista, el tipo de cada elemento de la lista varía dependiendo del punto del servicio.
  • Descripción: Lista con los datos requeridos.
  • Observaciones: Es una lista de los objetos requeridos, su tipo varía en base al punto consultado. Por ejemplo si se consulta los Conceptos, entonces contiene una lista de objetos tipo Concepto, si se consulta facturas, entonces es una lista de objetos tipo Factura.

 

Usuario

El objeto usuario tiene la siguientes propiedades:

 

NombreDeUsuario

  • Tipo: Cadena
  • Descripción: El nombre de usuario utilizado para acceder al sistema de Factura Gorila
  • Observaciones: Puede ser útil para mostrar en alguna parte de la aplicación cliente

 

FacturasDisponibles

  • Tipo: Número entero
  • Descripción: Determina la cantidad de facturas puede realizar el cliente
  • Observaciones: Este valor puede ser muy útil para avisar al usuario que esta por terminarse sus facturas disponibles

 

DireccionLogo

  • Tipo: Cadena
  • Descripción: Es una dirección URL absoluta donde se puede descargar el Logo del Usuario
  • Observaciones: Los usuarios de Factura Gorila pueden configurar el Logo de su empresa para que aparezca en sus facturas. Con esta URL se puede descargar esta imagen para ser mostrado en algún lugar de la aplicación cliente. La imagen puede estar en jpg o png y el tamaño y calidad puede variar dependiendo de qué imagen configuró el usuario, por tal, la aplicación cliente es responsable de ajustar el tamaño o calidad de la imagen como le convenga.

 

MetodosDePago

  • Tipo: Listado de tipo MetodoDePago
  • Descripción: Es una lista con los Métodos de pago disponibles para el usuario
  • Observaciones: Esta lista es útil durante el proceso de Facturación o cuando se hace un pago a una Factura existente. La propiedades que tiene cada elemento de tipo MetodoDePago se explican en la siguiente sección.

 

Monedas

  • Tipo: Listado de tipo Moneda
  • Descripción: Es una lista con los tipos de monedas con los cuales un usuario puede Facturar.
  • Observaciones: Esta lista es útil durante la Facturación y el registro de pagos. Dependiendo de la configuración, el usuario puede facturar en Pesos Mexicanos (MXN) o en Dólares Americanos (USD). Para todos los usuarios, se incluye al menos la moneda MXN, pero de acuerdo a la configuración podría estar incluido también USD. Es deseable que los desarrolladores estén atentos a esta lista en caso de que el cliente desee facturar en Dólares. Las propiedades que tiene cada elemento de tipo Moneda se explican en la siguiente sección.

 

UsaCodigoBidimensional

  • Tipo: Boleano
  • Descripción: Bandera que indica si el usuario utiliza o no Código bidimensional.
  • Observaciones: Factura Gorila soporta 2 métodos de facturación. El primero es Comprobante Fiscal Digital por Internet (CFDI) y el segundo es Código Bidimensional (CBB), explicar las características de cada modo de facturación está fuera del alcance de este documento. Este valor es útil durante el proceso de Facturación; en caso de ser true, la aplicación cliente necesita preguntar al usuario que código bidimensional desea utilizar de entre una lista de disponibles.

 

CodigosBidimensionales

  • Tipo: Lista de tipo CodigoBidimensional
  • Descripción: Esta es una lista de todos los código .
  • Observaciones: Ninguna.

 

FacturacionReciente

  • Tipo: FacturacionReciente
  • Descripción: Objeto que encapsula un resumen con los últimos valores de Facturación.
  • Observaciones: FacturacionReciente contiene un resumen, dividido en periodos (por mes), de los datos de la facturación. Cada período incluye la cantidad pagada o por pagar basado en los datos de las facturas y los pagos registrados para las mismas. En el sitio web de Factura Gorila, se utilizan estos datos para mostrar un gráfica sobre el estado actual de entradas y salidas de dinero. Es responsabilidad de la aplicación cliente si decide o no mostrar esta información y en qué forma presentarla.

 

CuentasBancarias

  • Tipo: Lista de CuentaBancaria
  • Descripción: Una lista con las cuentas Bancarias registradas en el sistema.
  • Observaciones: Es útil durante el control de pagos y también son incluidas en el mensaje al enviar una Factura (esto es opcional). Siempre hay al menos una cuenta, sin embargo, puede que el número no sea válido o que la longitud sea solo de 4 número en vez de 16. La aplicación cliente debe estar preparada en caso de que el usuario haya introducido valores falsos o incompletos, ya que algunos usuarios no están cómodos divulgando sus números de cuenta. Lo que sugerimos en Factura Gorila es que se introduzca al menos los últimos 4 dígitos de la cuenta.

 

RegimenesFiscales

  • Tipo: Lista de tipo RegimenFiscal
  • Descripción: Lista que tiene todos los regímenes fiscales que aplican para el usuario.
  • Observaciones: Esta lista es útil durante la creación de la factura. En necesario que la aplicación cliente le permita al usuario seleccionar un régimen fiscal de entre la lista. Siempre hay al menos 1 elemento en esta lista.

 

Sucursales

  • Tipo: Lista de tipo Sucursal
  • Descripción: Lista con todas las sucursales configuradas.
  • Observaciones: Esta lista es útil durante la creación de la factura. En necesario que la aplicación cliente le permita al usuario seleccionar una sucursal de entre la lista. Siempre hay al menos 1 elemento en esta lista.

 

ConfiguracionCompleta

  • Tipo: Boleano.
  • Descripción: Bandera que indica que el usuario cumple con los requerimientos necesarios para emprezar a facturar.
  • Observaciones: Esta bandera indica que el usuario tiene completa la configuración de los requerimientos necesarios para emprezar a facturar.

 

FechaCaducidadCFDI

  • Tipo: Fecha
  • Descripción: Dato que indica la fecha hasta la cual es válido el certificado de sello digital.
  • Observaciones: Este dato señala la fecha hasta la cual el usuario  puede seguir facturando con el certificado de sello digital actual, al término de la cual debe solicitar otro certificado ante el SAT.

 

UnidadesDeMedida

  • Tipo: Lista de tipo UnidadDeMedida.
  • Descripción: Lista con todas la unidades de medida configuradas.
  • Observaciones: Esta lista es útil a la hora de facturar, se utiliza al momento de agregar  los conceptos al detalle de la factura.

 

FechaVigencia

  • Tipo: Dato de tipo Fecha.
  • Descripción: Fecha hasta la cual tiene disponible el servicio de Factura Gorila.
  • Observaciones: Es util seguir el valor de este campo, ya que señala la el limite hasta el cual puede seguir utilizando el servicio.

 

TipoDeImpuestos

  • Tipo:Lista de tipo Impuesto.
  • Descripción: Lista con todos los impuestos configurados.
  • Observaciones: Esta lista es útil al momento de estar agregando los conceptos a la factura, para hacer los cálculos respectivos correspondientes a los totales de impuestos aplicados, así como el subtotal y el total de la factura.

 

TipoDocumento

  • Tipo: Tipo Cadena.
  • Descripción: Cadena de texto cuyos valores posibles son Factura o Recibo de Hororarios.
  • Observaciones: Este valor señala el tipo de documento que el usuario puede hacer y se establece al momento de registrarse en el servicio de Factura Gorila.

 

MetodoDePago

El objeto MetodoDePago define la forma en la que se puede o se podrá realizar un Pago a una Factura. Los métodos de pago son susceptibles a cambios en base a la configuración, pero es poco común. La aplicación cliente debe mostrar una lista de Métodos de pagos para que el usuario pueda seleccionar durante la creación de la factura o al capturar un poco.  Tiene las siguientes propiedades:

 

MetodoDePagoId

  • Tipo: Número entero.
  • Descripción: Identificador único para un MetodoDePago.
  • Observaciones: Este valor se pide durante la creación de la factura o al capturar un Pago.

Descripcion

  • Tipo: Cadena.
  • Descripción: Descripción para el usuario del Método de pago.
  • Observaciones: Sirve para mostrar el método de pago al usuario de manera amigable.

 

Moneda

El tipo de dato Moneda define la moneda que se puede utilizar en la API de Factura Gorila. Sus propiedades son:

 

MonedaId

  • Tipo: Número entero
  • Descripción: Identificador único para cada tipo de Moneda.
  • Observaciones: Identificador de control.

 

Descripcion

  • Tipo: Cadena
  • Descripción: Descripción formal de la moneda.
  • Observaciones: Este valor contiene el nombre completo de la Moneda. Por ejemplo, en MXN sería “Pesos mexicanos”.

 

Nombre

  • Tipo: Cadena
  • Descripción: Descripción natural en plural de la moneda.
  • Observaciones: Contiene el nombre de la moneda en forma menos formal. Por ejemplo, en MXN sería “Pesos”.

 

NombreCorto

  • Tipo: Cadena
  • Descripción: Código de moneda estándar.
  • Observaciones: Contiene el código estándar utilizado para describir una moneda. Por ejemplo MXN o USD. Durante la facturación y al realizar un pago se pide que se envíe el nombre corto para definir el tipo de moneda.

 

TipoDeCambio

  • Tipo: Númerico decimal.
  • Descripción: Es la cotización de la moneda seleccionada en pesos mexicanos.
  • Observaciones: Este valor contiene el valor en MXN de la moneda actual. Por ejemplo, si la moneda fuera USD, este campo sería igual a el valor de 1 USD en MXN. Este valor es el que utiliza el sistema actualmente y esta sujeto a cambio diario.

 

CodigoBidimensional

El objeto CodigoBidimensional describe un código bidimensional que podrá ser utilizado durante la facturación. CodigoBidimensional solo existe cuando el Usuario.UsaCodigoBidimensional es igual a “true”. Durante la creación de la factura, el usuario debe seleccionar un CodigoBidimensional. Tiene las siguientes propiedades:

 

CodigoBidimensionalId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para un CodigoBidimensional.
  • Observaciones: Este valor se pide durante la creación de la factura o al capturar un Pago.

 

Descripcion

  • Tipo: Cadena.
  • Descripción: Descripción para el usuario del Código bidimensional.
  • Observaciones: Sirve para mostrar el método de pago al usuario de manera amigable.

 

FoliosConsumidos

  • Tipo: Número entero.
  • Descripción: Número que indica el total de folios utilizados del rango de folios solicitados con el certificado de código bidimensional.
  • Observaciones: Este dato es útil ha tomar en cuenta ya que señala cuantos folios se han utilizados de los solicitados, ya que al consumirse la totalidad será necesario hacer el requerimientos de nuevos folios.

 

FoliosRestantes

  • Tipo: Número entero.
  • Descripción: Dato que indica el número de folios disponibles.
  • Observaciones: Este dato es solo informativo para que el usuario tenga a la mano el número de disponibles.

 

FoliosInicio

  • Tipo: Número entero.
  • Descripción: Es el folio inicial del rango de folios pertenecientes al certificados de código bidimensional.
  • Observaciones: Este dato es solo informativo para que el usuario sepa a partir de que folio inicia la facturación del certificado de código bidimensional.

 

FoliosFin

  • Tipo:Número entero.
  • Descripción: Es el folio final rango de folios pertenecientes al certificados de código bidimensional.
  • Observaciones: Este dato es solo informativo para que el usuario sepa en que folio terminará la facturación del certificado de código bidimensional.

 

FechaDeAprobacion

  • Tipo: Tipo fecha.
  • Descripción: Dato que indica la fecha en que se aprobó el certificado de código bidimensional.
  • Observaciones: Este es capturado al momento de dar de alta el certificado de código bidimensional.

 

FechaDeExpiracion

  • Tipo: Tipo fecha.
  • Descripción: Este dato indica la fecha en que expira el certificado de código bidimensional.
  • Observaciones: Este dato es solo informativo para indicar hasta cuando es válido llevar a cabo la facturación con este certificado de código bidimensional.

 

FolioActual

  • Tipo:Número entero.
  • Descripción: Dato que indica el actual folio.
  • Observaciones: Este dato señala en qué folio esta actualmente el sistema de facturación.

 

Serie

  • Tipo: Tipo cadena.
  • Descripción: Dato que indica la serie asignada a este certificado de código bidimensional.
  • Observaciones: Este dato se captura al momento de dar de alta el certificado de código bidimensional.

 

SicofiId

  • Tipo: Tipo cadena.
  • Descripción: Dato que indica el número de aprobación otorgado por el SAT.
  • Observaciones: Este dato es útil al momento de imprimir la representación impresa de la factura ya que es un requisito su aparición en dicha representación.

 

CuentaBancaria

Contiene los datos que describen a una Cuenta Bancaria

 

CuentaBancariaId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para una CuentaBancaria.
  • Observaciones: Este valor se pide durante la creación de la factura o al capturar un Pago.

 

Banco

  • Tipo: Cadena.
  • Descripción: Nombre corto comercial de un Banco.
  • Observaciones: Este es el nombre corto comercial. Por ejemplo: “Banamex”, “Santander” o “HSBC”.

 

Cuenta

  • Tipo: Cadena.
  • Descripción: El número de cuenta.
  • Observaciones: Puede o no ser un número de cuenta válido y la longitud podría variar, dependiendo de como lo captura el usuario.

 

RegimenFiscal

Contiene los datos que describen a un Régimen Fiscal. El usuario debe de tener al menos un Régimen Fiscal.

 

RegimenFiscalId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para un RegimenFiscal.
  • Observaciones: Este valor se pide durante la creación de la factura.

 

Nombre

  • Tipo: Cadena.
  • Descripción: Nombre o descripción del Régimen Fiscal.
  • Observaciones: Descripción amigable para el usuario.

 

Sucursal

Contiene los datos que describen la dirección sucursal del usuario. Un usuario siempre tiene al menos una sucursal (una matriz) y puede tener n número de sucursales adicionales. Durante la creación de la factura se debe seleccionar una sucursal desde donde se emite la factura.

 

SucursalId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para una sucursal.
  • Observaciones: Este valor se pide durante la creación de la factura.

 

Nombre

  • Tipo: Cadena.
  • Descripción: Nombre o descripción de la sucursal.
  • Restriccion: Debe ser máximo 50 caracteres y es obligatorio.
  • Observaciones: Descripción amigable para el usuario.

 

Direccion

  • Tipo: Objeto tipo Direccion.
  • Descripción: Describe una dirección física para la sucursal.
  • Observaciones: La descripción del objeto Direccion se puede ver a continuación.

 

Serie

  • Tipo: Cadena.
  • Descripción: Describe la serie de la sucursal.
  • Observaciones: Típicamente es una letra para describir esta sucursal y deberia ser única para cada sucursal.

 

Folio

  • Tipo: Número entero.
  • Descripción: El número de folio actual para la sucursal.
  • Observaciones: Puede ser util de valor informatívo, sin embargo, no es del todo requerido, cuando el comprobante fiscal es CDFI, se toma este folio, de lo contrario cuando es código bidimensional se toma el folio del código bidimensional seleccionado.

 

Direccion

Un objeto Direccion tiene los datos de una dirección fiscal. Un cliente debe de tener al menos una dirección al momento de su creación o actualización.

 

DireccionId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para una dirección.
  • Restricciones: Siempre es mayor a cero, y de solo lectura.
  • Observaciones: Este valor se utiliza como control, no debe ser alterado por la aplicación cliente.

 

Calle

  • Tipo: Cadena.
  • Descripción: Nombre de la calle.
  • Restricciones: Obligatorio. Máximo 50 caracteres.
  • Observaciones: Ninguna.

 

Colonia

  • Tipo: Cadena.
  • Descripción: Nombre de la colonia.
  • Restricciones: Obligatorio. Máximo 50 caracteres.
  • Observaciones: Ninguna.

 

NombreMunicipio

  • Tipo: Cadena.
  • Descripción: Nombre del municipio.
  • Restricciones: Obligatorio. Máximo 50 caracteres.
  • Observaciones: Ninguna.

 

NombreEstado

  • Tipo: Cadena.
  • Descripción: Nombre del estado.
  • Restricciones: Obligatorio. Máximo 50 caracteres.
  • Observaciones: Ninguna.

 

NombrePoblacion

  • Tipo: Cadena.
  • Descripción: Nombre de la población.
  • Restricciones: Opcional. Máximo 50 caracteres.
  • Observaciones:Es el nombre de un poblado, ejido o asentamiento humano. Es opcional ya que no aplica para todas las direcciones.

 

NombrePais

  • Tipo: Cadena.
  • Descripción: Nombre del país.
  • Restricciones: Obligatorio. Máximo 50 caracteres.
  • Observaciones: Ninguna.

 

NumeroExterior

  • Tipo: Cadena.
  • Descripción: El número exterior.
  • Restricciones: Obligatorio.
  • Observaciones: Ninguna.

 

NumeroInterior

  • Tipo: Cadena.
  • Descripción: El número interior.
  • Restricciones: Opcional.
  • Observaciones: Solo aplica cuando se trata de un departamento o una oficina dentro de un complejo.

 

CodigoPostal

  • Tipo: Número entero.
  • Descripción: El código postal.
  • Restricciones: Obligatorio, es un número de 5 digitos.
  • Observaciones: Ninguna.

 

DireccionCompleta

  • Tipo:Cadena.
  • Descripción: Une todos los demás valores en una sola cadena de texto.
  • Restricciones: Sólo lectura.
  • Observaciones: Esta conformada por todos los demás datos provistos. La aplicación cliente puede utilizar este valor para mostrar fácilmente una descripción completa de la dirección.

 

FacturacionReciente

Contiene una lista de tipo detalle que describe la facturación reciente. Esta lista sirve para saber cuanto se ha facturado, y cuanto ha sido pagado de lo facturado en un periodo en particular.

 

Detalles

  • Tipo: Lista de tipo Detalle.
  • Descripción: Listado con los detalles de la facturación reciente.
  • Restricciones: Sólo lectura.
  • Observaciones: Cada detalle de la facturación reciente. La lista puede o no estar vacía, dependiendo de la actividad del usuario.

 

Detalle

Determina un periodo de facturación de un usuario y es utilizado en la lista de detalles de FacturacionReciente. Incluye la cantidad pagada y la cantidad por pagar de lo facturado en un periodo en particular.

 

Periodo

  • Tipo: Periodo.
  • Descripción: Describe un periodo en el que aplica este detalle.
  • Restricciones: Sólo lectura.
  • Observaciones: Sirve para determinar en qué periodo aplica este detalle.

 

Pagado

  • Tipo: Número decimal.
  • Descripción: Un total de cuánto fue pagado en este periodo.
  • Restricciones: Sólo lectura.
  • Observaciones: Esta es la sumatoria de todo el dinero de los pagos registrados en un periodo.

 

SinPagar

  • Tipo: Número decimal.
  • Descripción: Un total de cuanto fue facturado pero no se ha pagado.
  • Restricciones: Sólo lectura.
  • Observaciones: Esta es la sumatoria de todo el dinero que se facturó en un periodo pero que no ha sido pagado, o bien, del que no se ha registrado pago todavía.

 

Periodo

Determina un periodo de tiempo en particular, cada periodo cubre 1 mes en particular en un año en particular.

 

Año

  • Tipo: Número entero.
  • Descripción: Número del año de este periodo, es un número de 4 dígitos.
  • Restricciones: Sólo lectura.
  • Observaciones: El año del periodo.

Mes

  • Tipo: Número entero.
  • Descripción: Número del mes de este periodo.
  • Restricciones: Sólo lectura. Siempre es un número entre 1 y 12.
  • Observaciones: Número del mes en el que aplica este periodo. Siendo Enero igual a 1 y Diciembre igual a 12.

 

Concepto

El concepto son todos los bienes o servicios que puede proveer un usuario a sus clientes. El concepto define, entre otras cosas, una descripcion base, la unidad de medida, el precio base y los impuestos que aplica.

El importante recalcar las diferencias entre “Concepto” y “ConceptoFactura”. “Concepto” es objeto que define los metadatos de un bien o un servicio. Durante la creación de la factura, se crea un “ConceptoFactura”, que hace genera una relación entre el “Concepto” y la “Factura”, pero que además permite alterar datos como la descripción base y el precio en la “Factura”.

 

ConceptoId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para un Concepto.
  • Restricciones: Siempre es mayor a cero, y de solo lectura.
  • Observaciones: Este valor se utiliza como control, no debe ser alterado por la aplicación cliente.

 

Descripcion

  • Tipo: Cadena.
  • Descripción: Describe el producto o servicio.
  • Restricciones: Obligatoria. Máximo 150 letras.
  • Observaciones: La descripción de como se conoce el concepto de cara al público. Usualmente la descripción es un nombre o una frase corta, sin embargo, se puede dar el caso que se requiera escribir cientos o miles de caracteres. Este valor si se incluye en la factura.

 

Clave

  • Tipo: Cadena.
  • Descripción: Clave utilizada para identificar al concepto.
  • Restricciones: Obligatoria. Máximo 20 letras.
  • Observaciones: La clave es una descripción corta con la que el usuario puede identificar fácilmente un concepto. La clave no tiene un formato o tamaño estándar y varía entre negocios, es para uso interno y no esta incluida en el factura. Lo correcto de una Aplicación cliente es que debe permitir seleccionar conceptos de entre una lista de claves.

 

Precio

  • Tipo: Número decimal.
  • Descripción: Precio unitario del concepto.
  • Restricciones: Obligatorio.
  • Observaciones: Este valor es práctico cuando la aplicación cliente desea calcular los totales de la factura antes de ser creada. Este campo es solo un precio definido, el tipo de moneda a usar se define durante la creación de la factura. Por ejemplo, se puede definir que un producto tiene un precio de $10, pero durante la creación de la factura se define si ese es el precio en Pesos (MXN) o en Dólares (USD).

 

Tipo

  • Tipo: Cadena.
  • Descripción: Una cadena de texto que describe que tipo de concepto es. Puede ser Servicio o Producto.
  • Restricciones: Obligatorio. Máximo 8 letras.
  • Observaciones: El tipo solo puede ser ya sea Servicio o Producto, no aplica ningún otro valor, si no se reconoce el valor, se le considera Producto por defecto. Este valor es solo para definir el concepto, pero no afecta de ninguna forma los cálculos de la facturación.

 

UnidadDeMedida

  • Tipo: Cadena.
  • Descripción: Una cadena con la unidad de Medida del concepto.
  • Restricciones: Obligatorio. Máximo 12 letras.
  • Observaciones: Solo ciertos valores son aceptados como la unidad de medida, consulta la sección de “Catálogos útiles” para saber como obtener los posibles valores.

 

UnidadDeMedidaId

  • Tipo: Número entero.
  • Descripción: Un número identificador de la Unidad de Medida del concepto.
  • Restricciones: Obligatorio. Máximo 12 letras.
  • Observaciones: Solo ciertos valores son aceptados como la unidad de medida, consulta la sección de “Catálogos útiles” para saber como obtener los posibles valores.

 

IDsImpuestosAplica

  • Tipo: Cadena.
  • Descripción: Una cadena con los identificadores de los impuestos que aplica este concepto, separados por coma(,).
  • Restricciones: Sólo lectura.
  • Observaciones: Solo ciertos valores son aceptados como id de un impuestos, consulta la sección de “Catálogos útiles” para saber como obtener los posibles valores.

 

Cliente

Cliente es la persona o negocio a la que el Usuario le emite una factura.

 

ClienteId

  • Tipo: Númerico entero.
  • Descripción: Identificador único para un Cliente.
  • Restricciones: Siempre es mayor a cero, y de solo lectura.
  • Observaciones: Este valor se utiliza como control, no debe ser alterado por la aplicación cliente.

 

RFC

  • Tipo: Cadena.
  • Descripción: RFC del cliente.
  • Restricciones: Obligatorio. Debe tener 12 o 13 caracteres.
  • Observaciones: La longitud del RFC determina si el cliente es una persona Física o Moral.

 

RazonSocial

 

  • Tipo: Cadena.
  • Descripción: La razón social de una persona Física o Moral.
  • Restricciones: Obligatorio. Máximo 150 caracteres.
  • Observaciones: Razon Social con que registrado ante el SAT.

 

Email

  • Tipo: Cadena.
  • Descripción: Dirección de correo electrónico del cliente.
  • Restricciones: Obligatorio. Debe ser una dirección de correo electrónico válido. Máximo 50 caracteres.
  • Observaciones: Este correo electrónico es al cual son enviadas las facturas, no solo debe tener un formato válido, sino que también debería existir.

 

NombreDeContacto

  • Tipo: Cadena.
  • Descripción: Nombre completo de la persona de contacto con el Cliente.
  • Restricciones: Obligatorio. Máximo 100 caracteres.
  • Observaciones: Este es el nombre de la persona con la que el usuario tiene contacto con la empresa cliente.

 

Telefono1

  • Tipo: Cadena.
  • Descripción: Primer teléfono del cliente.
  • Restricciones: Opcional. Máximo 20 caracteres.
  • Observaciones: El télefono de contacto, no es obligatorio y no es incluido en la factura.

 

Telefono2

  • Tipo: Cadena.
  • Descripción: Segundo teléfono del cliente.
  • Restricciones: Opcional. Máximo 20 caracteres.
  • Observaciones: El télefono de contacto, no es obligatorio y no es incluido en la factura.

 

Direcciones

  • Tipo: Lista de tipo Direccion.
  • Descripción: Es una lista que tiene todas las direcciones fiscales del cliente.
  • Restricciones: Debe de haber al menos una al crear o actualizar.
  • Observaciones: Las propiedades del objeto dirección se pueden ver a continuación. Si se desea por ejemplo borrar una dirección, la aplicación cliente debe de invocar el servicio de actualización pero sin la dirección en esta lista, de esta forma la dirección se marcará como borrada.

 

Factura

El objeto factura es el mas complejo y la parte central del sistema de Facturación. Incluye una relación con un cliente y una lista de Conceptos (a través de ConceptosFactura)

Serie

  • Tipo: Cadena.
  • Descripción: Serie de la factura.
  • Restricciones: Sólo lectura. Es diferente de vacío cuando la factura no esta en estado Borrador.
  • Observaciones: Es asignado automáticamente.

 

Folio

  • Tipo: Número entero.
  • Descripción: Es el número del folio consecutivo de la factura.
  • Restricciones: Sólo lectura. Es mayor a cero cuando la factura esta en algun estado diferente de borrador.
  • Observaciones: El número de folio es asignado por la API de Factura Gorila automáticamente luego de ser creada una factura, no puede ser alterado de ninguna forma por la aplicación cliente. A pesar de que el número de Folio en CFDI es una secuencia de caracteres, para uso interno aún se sigue utilizando de manera interna un valor numérico consecutivo. Esto es porque es más cómodo para lo usuarios seguir utilizando el sistema típico del número consecutivo.

 

FacturaId

  • Tipo: Número entero.
  • Descripción: Identificador único para esta factura.
  • Restricciones: Sólo lectura. Siempre es mayor a cero.
  • Observaciones: El sistema le asigna un identificador único a cada factura. Puede ser útil para poder consultar o editar una factura en particular.

 

RegimenFiscalId

  • Tipo: Número entero.
  • Descripción: Identificador único del Régimen Fiscal.
  • Restricciones: Obligatorio.
  • Observaciones: Durante la creación de una factura es necesario asignar un Régimen Fiscal. La lista de los posibles Regímenes Fiscales se puede obtener de la propiedad Usuario.RegimenesFiscales del objeto Usuario.

 

SucursalId

  • Tipo: Número entero.
  • Descripción: Identificador único de la sucursal.
  • Restricciones: Obligatorio.
  • Observaciones: Durante la creación de una factura es necesario asignar una sucursal desde la cual se emite la factura. La lista de posibles Sucursales se puede obtener de la propiedad Usuario.Sucursales del objeto Usuario.

 

ClienteId

  • Tipo: Número entero.
  • Descripción: Identificador único del cliente.
  • Restricciones: Obligatorio.
  • Observaciones: Durante la creación de una factura es necesario asignar un cliente al cual se le emite una factura. La lista de posibles clientes se puede obtener del punto Clientes.

 

DireccionId

  • Tipo: Número entero.
  • Descripción: Identificador único de la dirección fiscal.
  • Restricciones: Obligatorio.
  • Observaciones: Un cliente puede tener una o varias direcciones fiscales. Durante la creación de una factura es necesario asignar una dirección fiscal del cliente al cual se le emite una factura. La lista de posibles direcciones se obtienen de la propiedad Cliente.Direcciones del objeto Cliente. Cabe recalcar que del objeto Cliente debe de coincidir la propiedad Cliente.ClienteId con el asignado en la propiedad Factura.ClienteId.

 

Fecha

  • Tipo: Fecha.
  • Descripción: La fecha de la factura.
  • Restricciones: Obligatoria. En CFDI no puede ser menor a 2 dias del dia actual. En el caso de CBB debe ser alguna fecha del mes actual.
  • Observaciones: La fecha en la cual se emite la factura. Se recomienda a la aplicación cliente que por defecto llene este campo con la fecha actual, pero que permita al usuario editar la fecha. Para identificar el tipo de facturación se puede usar la propiedad Usuario.UsaCodigoBidimencional.

 

MetodoDePagoId

  • Tipo: Número entero.
  • Descripción: Identificador único del método de pago a utilizar para liquidar esta factura.
  • Restricciones: Obligatorio.
  • Observaciones: La lista posible de métodos de pago se puede obtener de la propiedad Usuario.MetodosDePago del objeto Usuario.

 

NumeroDeCuenta

  • Tipo: Cadena.
  • Descripción: El número de cuenta de la cual se hará el pago de la factura.
  • Restricciones: Opcional.
  • Observaciones: Este número de cuenta le pertenece al cliente.

 

Moneda

  • Tipo: Cadena.
  • Descripción: Código de la moneda utilizada en la factura.
  • Restricciones: Obligatorio.
  • Observaciones: Este valor especifica el tipo de moneda utilizada en la factura. El valor más común sería MXN (pesos mexicanos), pero otros se pueden utilizar como USD (dólares). La lista de posibles monedas se puede obtener de la propiedad Usuario.Monedas del objeto Usuario. Se debe asignar el valor Moneda.NombreCorto del objeto Moneda.

 

TipoDeCambio

  • Tipo: Número decimal.
  • Descripción: Valor en pesos en relación al valor de la moneda seleccionada.
  • Restricciones: Obligatorio. Cuando la moneda sea MXN, se especifica 1.
  • Observaciones: El tipo de cambio se utiliza para saber el valor del peso mexicano en relación a la moneda seleccionada.

 

CondicionesDePago

  • Tipo: Cadena.
  • Descripción: Condiciones en las cuales se debe completar el pago de la factura.
  • Restricciones: Opcional. Máximo 50 caracteres.
  • Observaciones: Usualmente sirve como mensaje del usuario hacia el cliente.

 

CodigoBidimencionalId

  • Tipo: Número entero.
  • Descripción: Identificador único de un código bidimensional.
  • Restricciones: Obligatorio cuando Usuario.UsaCodigoBidimencional es igual a true.
  • Observaciones: En caso de que el cliente utilice código bidimensional el usuario debe escoger un código bidimensional de entre los que tiene configurados. La lista de posibles códigos bidimensionales se pueden obtener de Usuario.CodigosBidimencionales del objeto Usuario.

 

CorreosAEnviarFactura

  • Tipo: Cadena.
  • Descripción: Lista de correos electrónicos separados por comas a los cuales se le enviará la factura.
  • Restricciones: Limitado a 300 caracteres. Si el dato EsBorrador es False y EnviarFactura es Verdadero, necesitará para el envio, de lo contrario solos e crea la factura.
  • Observaciones: Si se desea que se cree la factura y se envié es necesario especificar a que correo o correos se enviará, de lo contrario solo se creará la factura.

 

Etiquetas

  • Tipo: Cadena.
  • Descripción: Lista de etiquetas separadas por comas que describen esta factura.
  • Restricciones: Opcional.
  • Observaciones: Las facturas pueden incluir etiquetas para poder filtrarlas en base a ciertos criterios.

 

EstadoFactura

  • Tipo: Cadena.
  • Descripción: Describe el estado de la factura actual.
  • Restricciones: Sólo lectura. Puede ser sólo los valores “Borrador”, “Creada”, “Enviada”, “Pagada” y “Cancelada”. Vease el ciclo de vida de la factura para mas detalles.
  • Observaciones: Este valor define el estado de la factura actual, no puede ser alterado directamente.

 

NombreCliente

  • Tipo: Cadena.
  • Descripción: Nombre del cliente seleccionado en la propiedad ClienteId.
  • Restricciones: Sólo lectura.
  • Observaciones: Sirve para obtener el nombre del cliente de la factura actual.

 

EsBorrador

  • Tipo: Boleano.
  • Descripción: Sirve para indicar si la factura es o no borrador. Si se envía False, entonces la factura es creada de inmediato. Si se envia True, entonces la factura es marcada como borrador y solo es guardada si ser creada.
  • Restricciones: Opcional, False por defecto
  • Observaciones: Cuando es False, se timbra la factura y EstadoFactura cambia a “Creada”. A partir de este momento esta factura pasa a ser solo lectura.

 

EnviarAlCliente

  • Tipo: Boleano.
  • Descripción: Sirve para indicar si la factura debe ser enviada luego de ser creada. Este valor sólo es relevante cuando EsBorrador es igual a True. Si se envía True luego de ser creada la factura se envia al correo del cliente y todos los correos en la lista de CorreosAdicionales.
  • Restricciones: Opcional, False por defecto
  • Observaciones: Cuando este valor es True se envía la factura al correos configurados.

 

Totalmpuestos

  • Tipo: Número decimal.
  • Descripción: El valor total de los impuestos que aplican en esta factura.
  • Restricciones: Sólo lectura.
  • Observaciones: Puede ser utilizado para mostrar totales de la factura.

 

TotalFactura

  • Tipo: Número decimal.
  • Descripción: El total calculado para la factura actual.
  • Restricciones: Sólo lectura.
  • Observaciones: Puede ser utilizado para mostrar totales de la factura.

 

Conceptos

  • Tipo: Lista de tipo ConceptoFactura.
  • Descripción: La lista de conceptos o detalles que incluyen esta factura.
  • Restricciones: Obligatorio al menos 1.
  • Observaciones: Esta es la lista que relaciona los conceptos que tiene el Usuario configurados con una factura en particular. Una factura está obligada a tener al menos un ConceptoFactura en esta lista. Las propiedades del objeto ConceptoFactura están a continuación.

 

PorcentajeDescuento

  • Tipo: Número decimal.
  • Descripción: El porcentaje de descuento que es aplicado a la factura.
  • Restricciones: Ninguna.
  • Observaciones: Puede ser utilizado para mostrar totales de la factura.

 

EtiquetaDescuento

  • Tipo: Cadena.
  • Descripción: Texto que aparece en la representación impresa de la factura.
  • Restricciones: Texto limitado a 30 caracteres.
  • Observaciones: Por default aparece la leyenda de Descuento, si se envia cadena vacía.

 

MotivoDescuento

  • Tipo: Cadena.
  • Descripción: Dato con la explicación del descuento aplicado.
  • Restricciones: Opcional, limitado a 1000 caracteres.
  • Observaciones:Cadena de texto explicando el motivo del descuento.

 

NotasDelCliente

  • Tipo: Cadena.
  • Descripción: Dato con texto informativo para el cliente de la factura.
  • Restricciones: Opcional, limitado a 500 caracteres.
  • Observaciones: Cadena de texto con información para el receptor de la factura.

 

ConceptoFactura

Este tipo de dato describe la relación entre un objeto factura y un objeto concepto.

 

Index

  • Tipo: Número entero.
  • Descripción: Identificador único para cada ConceptoFactura.
  • Restricciones: Sólo lectura.
  • Observaciones: Es útil para diferenciar un ConceptoFactura.

 

ConceptoId

  • Tipo: Número entero.
  • Descripción: Identificador único del concepto.
  • Restricciones: Obligatorio.
  • Observaciones: Se le asigna un concepto a este detalle. Se debe acceder al punto Conceptos para saber los posibles valores.

 

Descripcion

  • Tipo: Cadena.
  • Descripción: Es la descripción del concepto como aparece en la factura.
  • Restricciones: Obligatorio. Máximo 4000 caracteres.
  • Observaciones: Durante la creación de la factura, la descripción de los conceptos puede variar ligeramente a como fueron capturados inicialmente. Típicamente esta propiedad tiene el mismo valor de la propiedad Concepto.Descripcion del objeto Concepto, sin embargo la aplicación cliente debe dar la opción al usuario para que edite el valor. Cabe recalcar que la descripción en esta propiedad solo aplica a la factura actual y no altera de ninguna forma el objeto Concepto.

 

Cantidad

  • Tipo: Número decimal.
  • Descripción: Cantidad de unidades que se van a aplicar en el concepto actual.
  • Restricciones: Obligatorio. Mayor a cero.
  • Observaciones: Requerido para el cálculo de la factura.

 

PrecioUnitario

  • Tipo: Número decimal.
  • Descripción: Precio por unidad del concepto en la factura.
  • Restricciones: Obligatorio. No puede ser negativo
  • Observaciones: Es el precio a aplicar por unidad al concepto en la factura actual. Usualmente este valor es igual al de la propiedad Concepto.Precio, sin embargo, la aplicación cliente debe permitir al usuario poder editar el precio del concepto para aplicar a una factura en particular sin afectar el valor original del objeto Concepto.

 

Concepto

  • Tipo: Concepto.
  • Descripción: El objeto Concepto con el mismo ConceptoId.
  • Restricciones: Sólo lectura.
  • Observaciones: Esta propiedad es útil durante la lectura, es el objeto Concepto que corresponde al ConceptoId.

 

SubTotal

  • Tipo: Número decimal.
  • Descripción: Subtotal igual a PrecioUnitario*Cantidad.
  • Restricciones: Sólo lectura.
  • Observaciones: Este valor es útil durante la lectura, permite mostrar el subtotal calculado para el concepto actual en la factura.

 

Pago

Pago es un abono total o parcial a una factura. El pago contiene información de control que sirve para saber la cantidad y el mes cuando fue realizado, estos datos son mas tarde utlizados por el objeto FacturacionReciente que muestra concentrados de los datos. Adicionalmente, la suma de todos los pagos sirven para determinar si la Factura debe cambiar de estado a “Pagada”.

 

PagoId

  • Tipo: Número entero.
  • Descripción: Identificador único de un pago.
  • Restricciones: Solo lectura. Mayor a cero.
  • Observaciones: Asignado automáticamente por el sistema.

 

Cantidad

  • Tipo: Número decimal.
  • Descripción: Cantidad de dinero efectuada en el pago.
  • Restricciones: Obligatorio. Solo valores positivos.
  • Observaciones: Define la cantidad de dinero aplicada en el pago.

 

Notas

  • Tipo: Cadena.
  • Descripción: Alguna nota o descripción sobre el Pago.
  • Restricciones: Opcional. Máximo 500 caracteres.
  • Observaciones: Le permite al usuario registrar algún mensaje u observación adicional acerca de un pago.

 

Fecha

  • Tipo: Fecha.
  • Descripción: Fecha en la que fue efectuado un Pago.
  • Restricciones: Obligatorio.
  • Observaciones: Sirve para tener un control tiempo.

 

FacturaId

  • Tipo: Número entero.
  • Descripción: Identificador único para una Factura.
  • Restricciones: Obligatorio. Mayor a cero.
  • Observaciones: Este identificador sirve como relación entre un Pago y una Factura.

 

CuentaBancariaId

  • Tipo: Número entero.
  • Descripción: Identificador único para una CuentaBancaria.
  • Restricciones: Obligatorio. Mayor a cero.
  • Observaciones: Este identificador sirve como relación entre un Pago y una CuentaBancaria.

 

MetodoDePagoId

  • Tipo: Número entero.
  • Descripción: Identificador único de un MetodoDePago.
  • Restricciones: Obligatorio. Mayor a cero.
  • Observaciones: Este identificador sirve como relación entre un Pago y un MetodoDePago.

 

DescripcionCuentaBancaria

  • Tipo: Cadena.
  • Descripción: Descripción de la cuenta bancaria relacionada con la propiedad CuentaBancariaId.
  • Restricciones: Sólo lectura.
  • Observaciones: Durante la lectura esta propiedad es útil para mostrar el nombre de la cuenta a la cual se efectuó el pago.

 

DescripcionMetodoPago

  • Tipo: Cadena.
  • Descripción: Descripción del método de pago.
  • Restricciones: Sólo lectura.
  • Observaciones: Durante la lectura esta propiedad es útil para mostrar una descripción del método de pago utilizado para este pago.

 

Impuesto

El objeto impuesto define un impuesto a ser aplicado sobre un Concepto. El objeto Usuario incluye una lista con los tipos posibles de impuesto, adicionalmente se puede consultar el punto de servicio de impuestos (Vease Catálogos útiles)

 

ImpuestoId

  • Tipo: Número entero.
  • Descripción: Identificador único de cada impuesto.
  • Restricciones: Sólo lectura.
  • Observaciones: Número utilizado para identificar cada impuesto aplicado por el concepto.

 

DescripcionImpuesto

  • Tipo: Cadena.
  • Descripción: Descripción del impuesto.
  • Restricciones: Sólo lectura.
  • Observaciones: Texto que se utiliza para mostrar el impuesto aplicada por cada concepto.

 

Tasa

  • Tipo: Número decimal.
  • Descripción: Valor de la tasa de impuesto a aplicar.
  • Restricciones: Sólo lectura.
  • Observaciones: Durante la lectura esta propiedad es útil para los cálculos de los totales de la factura.

 

TipoImpuesto

  • Tipo: Cadena.
  • Descripción: Descripción del tipo de Impuesto, valores posibles Retencion y Traslado.
  • Restricciones: Sólo lectura.
  • Observaciones: Durante la lectura esta propiedad es útil para hacer los cálculos durante la elaboración de la factura.

 

UnidadDeMedida

Describe una unidad de medida para los conceptos. La lista de posibles unidades de medida se encuentra dentro del objeto Usuario, adicionalmente se puede consultar la lista por separado desde el punto de servicio de UnidadesDeMedida (Vease Catálogos útiles).

 

UnidaDeMedidaId

  • Tipo: Número entero.
  • Descripción: Identificador único de cada unidad de medida.
  • Restricciones: Sólo lectura.
  • Observaciones: Número utilizado para identificar la unidad de medida asignada al concepto.

 

Nombre

  • Tipo: Cadena.
  • Descripción: Nombre de la unidad de medida.
  • Restricciones: Sólo lectura.
  • Observaciones: Texto que se utiliza para mostrar el la unidad de medida asignada al concepto.

 

Municipio

Describe a un Municipio en particular. El nombre de un municipio es útil al capturar la dirección fiscal de un Cliente. La aplicación cliente no esta obligada a utilizar el objeto Municipio, ya que solo se requiere el nombre, sin embargo, la API puede entregar una lista de municipios de Mexico para faciliar el desarrollo (Vease Catálogos útiles)

 

MunicipioId

  • Tipo: Número entero.
  • Descripción: Identificador único de cada municipio de los estados de México.
  • Restricciones: Sólo lectura.
  • Observaciones: Ninguna.

 

Nombre

  • Tipo: Cadena.
  • Descripción: Nombre del municipio.
  • Restricciones: Sólo lectura.
  • Observaciones: Texto que se utiliza para mostrar el nombre del municipio.

 

Estado

Describe una Estado (Entidad federativa) en particular. El nombre de un Estado es útil al capturar la dirección fiscal de un Cliente. La aplicación cliente no esta obligada a utilizar el objeto Estado, ya que solo se requiere el nombre, sin embargo, la API puede entregar una lista de Estados de Mexico para faciliar el desarrollo (Vease Catálogos útiles).

 

EstadoId

  • Tipo: Número entero.
  • Descripción: Identificador único para un Estado de México.
  • Restricciones: Sólo lectura.
  • Observaciones: Número utilizado para identificar el Estado.

 

Nombre

  • Tipo: Cadena.
  • Descripción: Nombre del Estado.
  • Restricciones: Sólo lectura.
  • Observaciones: Texto que se utiliza para mostrar el nombre del Estado.

 

 

MiCuenta

El objeto MiCuenta, contiene datos relevantes sobre el usuario y sobre su negocio. Solo se utiliza durante la actualización de datos.

 

TipoDocumento

  • Tipo: Cadena.
  • Descripción: Define el tipo de documento que el usuario piensa emitir.
  • Restricciones: Obligatorio.
  • Observaciones: Solo se permite “Factura” o “ReciboDeHonorarios”.

 

RazonSocial

  • Tipo: Cadena.
  • Descripción: Es el nombre de la empresa o la persona Física.
  • Restricciones: Obligatorio. No debe ser mayor a 1000 caracteres.
  • Observaciones: El nombre legal de la empresa o persona Física. Es importante que se escriba tal cual aparece en el SAT ya que es relevante durante la creación de las facuras.

 

CorreoContacto

  • Tipo: Cadena.
  • Descripción: Una dirección de correo electrónico de contacto.
  • Restricciones: Obligatorio. No debe ser mayor a los 50 caracteres.
  • Observaciones: El correo de contacto se utiliza para que el servicio de soporte de Factura Gorila entre en contacto con el usuario, ya sea por algun problema o consulta que haya hecho el usuario, o bien, para cuando el personal de Factura Gorila requiere de dar información al usuario sobre su servicio. El correo de contacto puede o no ser el mismo en el campo Email.

 

NombreDeContacto

  • Tipo: Cadena.
  • Descripción: Nombre de una persona de contacto.
  • Restricciones: Obligatorio. No debe ser mayor a los 100 caracteres.
  • Observaciones: Es el nombre de una persona de contacto. Se utiliza este dato para que el servicio de soporte de Factura Gorila entre en contacto con el usuario.

 

Telefono1

  • Tipo: Cadena.
  • Descripción: Un numero de teléfono.
  • Restricciones: Opcional. No debe ser mayor a los 20 caracteres.
  • Observaciones: Un número de teléfono de contacto. Es utilizado por el servicio de soporte de Factura Gorila para contactarse con el usuario.

 

Telefono2

  • Tipo: Cadena.
  • Descripción: Un numero de teléfono.
  • Restricciones: Opcional. No debe ser mayor a los 20 caracteres.
  • Observaciones: Un segundo número de teléfono de contacto. Es utilizado por el servicio de soporte de Factura Gorila para contactarse con el usuario.

 

Calle

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina la calle.
  • Restricciones: Obligatorio. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NumeroExterior

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina el número exterior.
  • Restricciones: Obligatorio. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NumeroInterior

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina el número interior.
  • Restricciones: Opcional. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

Colonia

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina la colonia.
  • Restricciones: Obligatoria. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

CodigoPostal

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina el código postal.
  • Restricciones: Obligatoria. Debe ser de 5 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NombreEstado

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina del estado o entidad federativa.
  • Restricciones: Obligatoria. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NombreMunicipio

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina del municipio.
  • Restricciones: Obligatoria. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NombrePais

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina el país.
  • Restricciones: Obligatoria. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

 

NombrePoblacion

  • Tipo: Cadena.
  • Descripción: Forma parte de la dirección fiscal del usuario, determina la población.
  • Restricciones: Opcional. No debe ser mayor a los 50 caracteres.
  • Observaciones: También se utiliza para actualizar la sucursal matriz.

CertificadoDigital

El objeto CertificadoDigital contiene los campos necesarios para almacenar un Certificado Digital. Este objeto se utiliza durante el Registro.

 

ContenidoLlavePublica

  • Tipo: Binario (Arreglo de bytes).
  • Descripción: Es el contenido del archivo .cer, que forma parte del certificado digital.
  • Restricciones: Obligatorio.
  • Observaciones: Ninguna.

ContenidoLlavePrivada

  • Tipo: Binario (Arreglo de bytes).
  • Descripción: Es el contenido del archivo .key, que forma parte del certificado digital.
  • Restricciones: Obligatorio.
  • Observaciones: Ninguna.

ContraseñaLlavePrivada

  • Tipo: Cadena.
  • Descripción: Contraseña de la llave privada. Es sensible a mayúsculas y minúsculas.
  • Restricciones: Obligatorio.
  • Observaciones: Se requiere la contraseña para poder abrir el archivo.

 

Logo

El objeto Logo contiene solo un arreglo de bytes del archivo de logo. El archivo enviado debe ser un .jpg o un .png.

ContenidoArchivoLogo

  • Tipo: Binario (Arreglo de bytes).
  • Descripción: Es el contenido del archivo de imagen.
  • Restricciones: Obligatorio.
  • Observaciones: Debe ser jpg o png. El sistema de Factura Gorila utilizará una imagen de tamaño máximo de 180px X 140 px (anchoXalto), si la imagen es mas grande esta se redimensiona automáticamente.