Integración a la API de Fabo - PHP

1.0.0 2023-09-18 17:42 UTC

This package is auto-updated.

Last update: 2024-12-18 20:40:45 UTC


README

Librería de acceso a la API de fabo.dev para PHP 8.0 o mayor.

Instalación

La instalación se realiza vía Composer:

composer require paperclip/fabo

Uso

El constructor de la clase Paperclip\Fabo\Fabo requiere dos parámetros:

  • $token, el token recibido cuando creas el acceso a la API de Fabo.
  • $url, la URL para acceder a la API de Fabo, también recibida cuando creas el acceso.

Al instanciar un objecto Paperclip\Fabo\Fabo, puedes ejecutar un comando de la API como método del objeto:

Cada método debes llamarlos con los parámetros requeridos por cada comando, usando parámetros con nombre.

Excepciones

Cuando la API retorna un error, se genera varias excepciones según el tipo de error. Todas las excepciones extienden Paperclip\Fabo\ExcepciónFabo:

  • Paperclip\Fabo\ExcepciónAutorización: Excepción lanzada cuando hubo un error en la fase de autorización, como un UUID o token inválido.
  • Paperclip\Fabo\ExcepciónNegociación: Excepción lanzada cuando hubo un error en la fase de negociaciación con la API, como error en la cabecera HTML del formato a usar, etc.
  • Paperclip\Fabo\ExcepciónParámetros: Excepción lanzada cuando hubo un error en los parámetros enviados a la API.
  • Paperclip\Fabo\ExcepciónFatal: Excepción lanzada cuando hubo un error no previsto en la API o en esta librería.

Ejemplo

Este código emite una factura electrónica:

<?php

use Paperclip\Fabo\{Fabo, ExcepciónFabo};

// Autocargador de Composer. Más información en https://getcomposer.org/doc/01-basic-usage.md#autoloading
require __DIR__ . '/vendor/autoload.php';

// Creamos el objecto Fabo con el token y la URL proporcionada al crear el acceso
// a la API.
$fabo = new Fabo(
    '5cfccd27b2bb0f0d3fc860c7a1fb723139464cae59195a5da55af9b7b2e7b703',
    'https://api1-pruebas.fabo.dev/v1/ebcf891b-9ec9-4409-a95f-cb8c3d803b17'
);

// Parámetros para la emisión de una factura
$parámetros = [

    // Estos datos son ficticios.
    'numero_doc' => 20123456786,
    'razon_social' => 'ABC CONSULTORES S.A.C',

    // f = Factura electrónica.
    'tipo' => 'f',
    'serie' => 'F001',
    'numero' => 21,
    'fecha' => '2021-01-26',
    'hora' => '07:23',

    // r = RUC
    'tipo_doc' => 'r',

    // PEN = Soles
    'moneda' => 'PEN',
    'items' => [
        [
			// NIU = Unidad genérica de bienes
            'unidad' => 'NIU',
            'cantidad' => 1,
            'codigo' => '98765',
            'descripcion' => 'ESCUDO DE VIBRANIUM',
            'precio_unitario' => 41,
            'valor_unitario' => 34.75,
            'valor_venta' => 34.75,
            'igv' => 6.25,

            // 10 = Gravado - operación onerosa
            'afectacion_igv' => 10,
        ],
        [
            'unidad' => 'NIU',
            'cantidad' => 1,
            'codigo' => '43210',
            'descripcion' => 'LAWGIVER MK II',
            'precio_unitario' => 49,
            'valor_unitario' => 41.53,
            'valor_venta' => 41.53,
            'igv' => 7.48,
            'afectacion_igv' => 10,
        ],
        [
            'unidad' => 'NIU',
            'cantidad' => 1,
            'codigo' => 'BP001',
            'descripcion' => 'BOLSA DE PLÁSTICO GRANDE',
            'precio_unitario' => 0.2,
            'valor_unitario' => 0.17,
            'igv' => 0.04,
            'afectacion_igv' => 10,
            'icbper' => 0.4,
        ]
    ],
];

try {
    // Emitimos el comprobante
    $resultado = $fabo->emitir(...$parámetros);
} catch (ExcepciónFabo $e) {
    // Si falla, generará una excepción. Obtenemos el resultado
    echo get_class($e) . ': ' . $e->getMessage() . PHP_EOL . PHP_EOL;

    // $resultado tendrá información del error.
    $resultado = $fabo->obtenerRespuesta();

    var_dump($resultado);
    exit;
}

// En este punto, el comprobante fue recibido satisfactoriamente por la API.
// El resultado del comando 'emitir' estará en la variable $resultado.
//
// Puedes ver más información sobre las variables del resultado en la URL
// https://docs.paperclip.com.pe/api-facturación/documentación/comando-emitir/#variables-de-retorno
//
echo "Comprobante emitido." . PHP_EOL . PHP_EOL;
var_dump($resultado);

Al ejecutar este código con un $token y $url válido, mostrará algo similiar a:

Comprobante emitido.

array(6) {
  ["valor_resumen"]=>
  string(28) "VoIsNKv3NWBtKeg86y2OmYhcxTU="
  ["codigo_descarga"]=>
  string(40) "aea292634674c89c3a75a8b66735a50cf6dc5896"
  ["codigo_documento"]=>
  string(29) "prueba-20452370108-01-F001-21"
  ["sunat_respuesta"]=>
  int(0)
  ["sunat_descripcion"]=>
  string(43) "La Factura numero F001-21, ha sido aceptada"
  ["sunat_observaciones"]=>
  array(0) {
  }
}