La API de Pouki está en proceso de desarrollo y se puede obtener un acceso previo, para solicitar más información contáctanos en hola@generaweb.net
Funciona bajo el sistema de REST API. Todas las llamadas tienen como URL base https://cloud.pouki.com/api/v1 y deben de ser autentificadas enviando el header Authorization: Bearer {Access Key}. En las llamadas de tipo POST el cuerpo de la llamada tiene que ser enviado como datos de formulario. Todas las respuestas son enviadas en formato JSON a excepción que sea especificado de otra manera en el Endpoint.
Obtiene un listado de objetos tipo CuentaBancaria de la razón social seleccionada por el usuario autentificado.
Obtiene un objeto de tipo CFDI correspondiente al CFDI. En caso de no existir para el cliente se arroja un error.
Se obtienen los archivos XML del CFDI especificado y sus relacionados en formato ZIP.
Se obtiene la representación impresa del CFDI especificado en formato PDF.
Registra un nuevo CFDI en Pouki para el Cliente
Se deberá de enviar un objeto de tipo CFDI.
Obtiene un objeto de tipo CFDI correspondiente al CFDI. En caso de no existir para el cliente se arroja un error.
Escribe un listado de movimientos bancarios para una cuenta.
| Variable | Tipo | Descripción |
|---|---|---|
| {CuentaBancaria.UID} | String. Requerido | Identificador único de la cuenta bancaria en Pouki. |
| Variable | Tipo | Descripción |
|---|---|---|
| SaldoInicial | Double. Requerido | Saldo inicial a partir del cuál se registran los movimientos bancarios. |
| Movimientos | Array. Requerido | Arreglo de objetos tipo MovimientoBancario |
| Variable | Tipo | Descripción |
|---|---|---|
| Cuenta | String | UID de la cuenta bancaria afectada. |
| Periodo.Inicio | Fecha | Fecha del movimiento más antigüo recibido. |
| Periodo.Final | Fecha | Fecha del movimiento más actual recibido. |
| Saldos.Inicial.Calculado | Double | Saldo inicial calculado a la fecha del primer movimiento recibido. |
| Saldos.Inicial.Recibido | Double | Saldo inicial enviado en la llamada. |
| Saldos.Inicial.Diferencia | Double | Diferencia del saldo inicial enviado contra el calculado a la fecha del primer movimiento recibido. |
| Movimientos.Abonos.Cantidad | Entero | Cantidad de movimientos recibidos que abonan positivamente al saldo de la cuenta bancaria. |
| Movimientos.Abonos.Monto | Double | Suma de los montos de los movimientos recibidos que abonan positivamente al saldo de la cuenta bancaria. |
| Movimientos.Cargos.Cantidad | Entero | Cantidad de movimientos recibidos que afectan negativamente al saldo de la cuenta bancaria. |
| Movimientos.Cargos.Monto | Double | Suma de los montos de los movimientos recibidos que afectan negativamente al saldo de la cuenta bancaria. |
Representación de un CFDI
| Parámetro | Tipo | Descripción |
|---|---|---|
| UID | Integer. Obligatorio | Id único asignado por Pouki para identificar el CFDI. |
| UUID | String. Obligatorio | UUID del CFDI asignado por el SAT. En operaciones POST no debe de estar presente. |
| Fecha | Date. Obligatorio | Fecha de emisión del CFDI. |
| FechaTimbrado | Date. Opcional | Fecha en la que se timbró el CFDI. |
| Emisor | String. Obligatorio | RFC del Emisor. En operaciones de tipo POST se puede omitir y se tomará el correspondiente al Cliente autentificado. |
| Receptor | Objeto. Obligatorio | Objeto de tipo Receptor. |
| Tipo | String. Obligatorio | Tipo de comprobante, acepta alguno de los siguientes valores:
|
| Serie | String. Opcional | La serie a la que pertenece el consecutivo del folio |
| Folio | Integer. Opcional | El folio sobre el que se identifica el CFDI en una Serie. |
| MetodoDePago | String. Obligatorio | Debe de ser uno de los siguientes valores:
|
| FormaDePago | String. Opcional | Clave de la forma de pago de acuerdo a catálogo c_FormaPago del SAT. Sólo es obligatorio si el MetodoDePago tiene el valor PUE. |
| LugarExpedición | String. Obligatorio | Código postal en el que es emitido el CFDI. |
| UsoCFDI | String. Obligatorio | Clave del uso que se dará al CFDI de acuerdo al catálogo c_UsoCFDI del SAT. |
| Conceptos | Array. Obligatorio | Arreglo de objetos de tipo Concepto. |
| SubTotal | Double. Opcional | Expresa la suma de todos los parámetros Importe de todos los conceptos. |
| Descuento | Double. Opcional | Expresa la suma de todos los parámetros Descuento de todos los conceptos. |
| Total | Double. Opcional | Expresa el resultado del SubTotal, menos Descuento, más la suma de todos los Importe de los Impuestos trasladados, menos la suma de todos los Importe de los Impuestos retenidos. |
| Conciliaciones | Array. Opcional | Arreglo de objetos de tipo Conciliacion correspondiente a los movimientos bancarios que amparan el CFDI. |
| URL | String. Opcional | Expresa la URL del CFDI en Pouki. No debe de estar presente en operaciones POST. |
Representación de un Receptor de un CFDI
| Parámetro | Tipo | Descripción |
|---|---|---|
| RFC | String. Obligatorio | RFC del Receptor |
| Nombre | String. Opcional | Razón social del receptor, en operaciones de tipo POST es obligatorio sólo si es que no estaba previamente registrado el Receptor. |
| CP | String. Opcional | Código postal del Receptor, si se omite en operaciones POST se tomará el correspondiente a la dirección fiscal registrada. Obligatorio en operaciones POST si es que no estaba previamente registrado el Receptor. |
| RegimenFiscal | String. Opcional | Clave del régimen fiscal del Receptor de acuerdo al catálogo c_RegimenFiscal del SAT. Obligatorio en operaciones POST si es que no estaba previamente registrado el Receptor. |
Representación de un Concepto en un CFDI
| Parámetro | Tipo | Descripción |
|---|---|---|
| Cantidad | Double. Obligatorio | Cantidad de bienes o servicios entregados. |
| Clave | String. Obligatorio | Clave del producto o servicio de acuerdo al catálogo c_ClaveProdServ del SAT. |
| Unidad | String. Obligatorio | Clave de la unidad de medida correspondiente a la cantidad del concepto de acuerdo al catálogo c_ClaveUnidad del SAT. |
| Descripcion | String. Obligatorio | Descripción del bien o servicio. |
| ValorUnitario | Double. Obligatorio | Valor unitario del bien o servicio. |
| Importe | Double. Opcional | Valor que expresa el resultado de multiplicar la Cantidad por el ValorUnitario. |
| Descuento | Double. Opcional | Valor del total de descuentos aplicables al concepto. Valor por default: 0 |
| Impuestos | Array. Opcional | Arreglo de objetos de tipo Impuestos aplicables al concepto. Si se omite en operaciones tipo POST se tomarán los correspondientes al esquema de impuestos configurados para el Emisor en Pouki a menos que se especifique el parámetro ObjetoImpuestos con el valor 01 donde se expresa que el concepto no es objeto de impuestos. |
| ObjetoImpuestos | String. Opcional | Expresa si el concepto es objeto de impuestos y acepta uno de los siguientes valores:
|
Representación de los impuestos aplicables a un Concepto o a un CFDI
| Parámetro | Tipo | Descripción |
|---|---|---|
| Tipo | String. Obligatorio | Determina el tipo de impuesto y puede aceptar uno de los siguientes valores:
|
| Impuesto | String. Obligatorio | Clave del tipo de impuesto del catálogo c_Impuesto del SAT. |
| Tasa | Double. Obligatorio | Expresa la tasa del impuesto aplicable. Se debe de expresar como porcentaje, omitiendo el símbolo %, por ejemplo para el 16% se debe de poner el valor 16 |
| Importe | Double. Opcional | Es el importe del impuesto aplicable. |
Representación de una cuenta bancaria
| Parámetro | Tipo | Descripción |
|---|---|---|
| Banco | Integer. Obligatorio | Id del Banco correspondiente al catálogo c_Banco publicado por el SAT. |
| Nombre | String. Obligatorio | Nombre dado por el cliente para identificar la cuenta. |
| Tipo | String. Obligatorio | Define el tipo de cuenta, puede ser los valores chequera o tarjetaCredito. |
| UID | String. Obligatorio | Identificador único para la cuenta bancaria en Pouki. |
Representación de un movimiento de una cuenta bancaria
| Parámetro | Tipo | Descripción |
|---|---|---|
| Id | Integer. Obligatorio | Id numérico único para identificar al movimiento bancario en Pouki. En operaciones POST es opcional. |
| Fecha | Date. Obligatorio | Fecha del movimiento bancario. |
| Monto | Double. Obligatorio | Monto del movimiento, acepta montos positivos (abonos) y negativos (cargos). |
| Saldo | Double. Opcional | Saldo de la cuenta después de aplicar el movimiento. Sirve de referencia para validación de la información. |
| Medio | Integer. Obligatorio | Medio que se utilizó para realizar el movimiento, puede usar alguno de los siguientes valores: 1: Efectivo 2: Cheque 3: SPEI 4: Traspaso de fondos 5: Pago directo 99: Otro |
| IdBanco | String. Opcional | Id de referencia registrado en la banca electrónica para identificar el movimiento bancario. |
| Referencia | String. Opcional | Referencia registrada en la banca electrónica para identificar el movimiento bancario. |
| Concepto | String. Opcional | Concepto registrado en la banca electrónica. |
| Tipo | String. Obligatorio | Tipo de movimiento, puede tomar alguno de los siguientes valores: SPEI_Recibido, DepositoEnEfectivo, TEF_Recibido, PagoServicios, SPEI_Enviado, DispersionNomina, Comision, PagoIMSS, IVA, TEF_Enviado, MovimientoCancelado, Intereses, RetencionISR, TarjetaCredito o ChequeDepositado. Puede aceptar el tipo Pendiente para aquellos movimientos que estén pendientes de ser clasificados. |
Representación de una conciliación entre movimientos bancarios que amparen un CFDI.
| Parámetro | Tipo | Descripción |
|---|---|---|
| MovimientoBancario | Objeto. Obligatorio | Objeto de tipo MovimientoBancario correspondiente al movimiento bancario relacionado en la conciliación. |
| UID | String. Obligatorio | UID del CFDI amparado en la conciliación. |
| Monto | Double. Obligatorio | Monto amparado por la conciliación. |
Última actualización: Octubre 28, 2022.