BHExpress API Client

Bhe extends ApiBase
in package

Módulo que permite gestionar las BHE registradas y/o sincronizadas en BHExpress.

Table of Contents

Methods

__construct()  : mixed
Módulo que permite gestionar las BHE registradas y/o sincronizadas en BHExpress.
anularBhe()  : ResponseInterface
Recurso que permite anular una Boleta de Honorarios Electrónica específica.
calcularMontoBruto()  : ResponseInterface
Recurso que permite calcular el monto bruto a partir de un monto líquido.
calcularMontoLiquido()  : ResponseInterface
Recurso que permite calcular el monto líquido a partir de un monto bruto.
consume()  : $this
Realiza una solicitud HTTP a la API.
delete()  : ResponseInterface|null
Realiza una solicitud DELETE a la API.
descargarPdfBhe()  : ResponseInterface
Recurso que permite descargar el PDF de una Boleta de Honorarios Electrónica específica.
emitirBhe()  : ResponseInterface
Recurso que permite emitir una nueva Boleta de Honorarios Electrónica.
enviarEmailBhe()  : ResponseInterface
Recurso que permite enviar por correo electrónico una BHE.
get()  : ResponseInterface|null
Realiza una solicitud GET a la API.
getBody()  : string
Obtiene el cuerpo de la última respuesta HTTP.
getBodyDecoded()  : array<string|int, mixed>
Obtiene el cuerpo de la última respuesta HTTP y lo decodifica de JSON.
getLastResponse()  : ResponseInterface|null
Obtiene la última respuesta recibida de la API.
getLastUrl()  : string|null
Obtiene la última URL utilizada en la solicitud HTTP.
listarBhes()  : ResponseInterface
Recurso que permite obtener el listado paginado de boletas de honorarios electrónicas emitidas.
obtenerDetalleBhe()  : ResponseInterface
Recurso que permite obtener el detalle de una boleta de honorarios electrónica emitida.
post()  : ResponseInterface|null
Realiza una solicitud POST a la API.
put()  : ResponseInterface|null
Realiza una solicitud PUT a la API.
setRut()  : $this
Establece el RUT del emisor.
setToken()  : $this
Establece el token de autenticación.
setUrl()  : $this
Establece la URL base de la API.
toArray()  : array<string|int, mixed>
Convierte la última respuesta HTTP en un arreglo asociativo.

Methods

__construct()

Módulo que permite gestionar las BHE registradas y/o sincronizadas en BHExpress.

public __construct([string|null $token = null ][, string|null $rut = null ][, string|null $url = null ]) : mixed
Parameters
$token : string|null = null

Token de autenticación del usuario. Si no se proporciona, se intentará obtener de una variable de entorno.

$rut : string|null = null

RUT del emisor de BHExpress. Si no se proporciona, se intentará obtener de una variable de entorno.

$url : string|null = null

URL base de la API. Si no se proporciona, se usará una URL por defecto.

anularBhe()

Recurso que permite anular una Boleta de Honorarios Electrónica específica.

public anularBhe(int $numeroBhe, int $causa) : ResponseInterface
Parameters
$numeroBhe : int

Número de la BHE registrada en BHExpress.

$causa : int

Causa de la anulación de la BHE.

Return values
ResponseInterface —

Respuesta con el encabezado de la boleta anulada.

calcularMontoBruto()

Recurso que permite calcular el monto bruto a partir de un monto líquido.

public calcularMontoBruto(int $liquido, string $periodo) : ResponseInterface
Parameters
$liquido : int

Monto líquido a convertir.

$periodo : string

Periodo para el cual calcular los totales.

Return values
ResponseInterface —

Respuesta con el monto bruto calculado.

calcularMontoLiquido()

Recurso que permite calcular el monto líquido a partir de un monto bruto.

public calcularMontoLiquido(int $bruto, string $periodo) : ResponseInterface
Parameters
$bruto : int

Monto bruto a convertir.

$periodo : string

Periodo para el cual calcular los totales.

Return values
ResponseInterface —

Respuesta con el monto líquido calculado.

consume()

Realiza una solicitud HTTP a la API.

public consume(string $resource[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $headers = [] ][, string|null $method = null ][, array<string|int, mixed> $options = [] ]) : $this

Este método envía una solicitud HTTP a la API de BHExpress, utilizando los parámetros especificados y manejando la autenticación y la respuesta.

Parameters
$resource : string

El recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed> = []

Datos a enviar en la solicitud (para métodos POST y PUT).

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$method : string|null = null

Método HTTP a utilizar (GET, POST, PUT, DELETE).

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Tags
throws
ApiException

Si se produce un error en la solicitud.

Return values
$this —

Instancia actual del cliente para encadenar llamadas.

delete()

Realiza una solicitud DELETE a la API.

public delete(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

descargarPdfBhe()

Recurso que permite descargar el PDF de una Boleta de Honorarios Electrónica específica.

public descargarPdfBhe(int $numeroBhe) : ResponseInterface
Parameters
$numeroBhe : int

Número de la BHE registrada en BHExpress.

Return values
ResponseInterface —

Respuesta con el contenido del PDF de la BHE.

emitirBhe()

Recurso que permite emitir una nueva Boleta de Honorarios Electrónica.

public emitirBhe(array<string|int, mixed> $datosBoleta) : ResponseInterface
Parameters
$datosBoleta : array<string|int, mixed>

Información detallada de la boleta a emitir.

Return values
ResponseInterface —

Respuesta con el encabezado y detalle de la boleta emitida.

enviarEmailBhe()

Recurso que permite enviar por correo electrónico una BHE.

public enviarEmailBhe(int $numeroBhe, string $email) : ResponseInterface
Parameters
$numeroBhe : int

Número de la BHE registrada en BHExpress.

$email : string

Correo del destinatario.

Return values
ResponseInterface —

Respuesta con la confirmación del envío del email.

get()

Realiza una solicitud GET a la API.

public get(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

getBody()

Obtiene el cuerpo de la última respuesta HTTP.

public getBody() : string

Este método devuelve el cuerpo de la respuesta de la última solicitud HTTP realizada utilizando este cliente API.

Tags
throws
ApiException

Si no hay respuesta previa o el cuerpo no se puede obtener.

Return values
string —

El cuerpo de la respuesta HTTP.

getBodyDecoded()

Obtiene el cuerpo de la última respuesta HTTP y lo decodifica de JSON.

public getBodyDecoded() : array<string|int, mixed>

Este método devuelve el cuerpo de la respuesta de la última solicitud HTTP realizada por este cliente API, decodificándolo de formato JSON a un arreglo asociativo de PHP.

Tags
throws
ApiException

Si no hay respuesta previa o el cuerpo no se puede decodificar.

Return values
array<string|int, mixed> —

El cuerpo de la respuesta HTTP decodificado como un arreglo.

getLastResponse()

Obtiene la última respuesta recibida de la API.

public getLastResponse() : ResponseInterface|null
Return values
ResponseInterface|null

getLastUrl()

Obtiene la última URL utilizada en la solicitud HTTP.

public getLastUrl() : string|null
Return values
string|null

listarBhes()

Recurso que permite obtener el listado paginado de boletas de honorarios electrónicas emitidas.

public listarBhes([array<string|int, mixed> $filtros = [] ]) : ResponseInterface
Parameters
$filtros : array<string|int, mixed> = []

Filtros para obtener BHEs específicas (opcional).

Return values
ResponseInterface —

Respuesta con el listado de boletas emitidas.

obtenerDetalleBhe()

Recurso que permite obtener el detalle de una boleta de honorarios electrónica emitida.

public obtenerDetalleBhe(int $numeroBhe) : ResponseInterface
Parameters
$numeroBhe : int

Número de la BHE emitida.

Return values
ResponseInterface —

Respuesta con el detalle de la boleta emitida.

post()

Realiza una solicitud POST a la API.

public post(string $resource, array<string|int, mixed> $data[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed>

Datos a enviar en la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

put()

Realiza una solicitud PUT a la API.

public put(string $resource, array<string|int, mixed> $data[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed>

Datos a enviar en la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

setRut()

Establece el RUT del emisor.

public setRut(string $rut) : $this
Parameters
$rut : string

RUT del emisor.

Return values
$this

setToken()

Establece el token de autenticación.

public setToken(string $token) : $this
Parameters
$token : string

Token de autenticación.

Return values
$this

setUrl()

Establece la URL base de la API.

public setUrl(string $url) : $this
Parameters
$url : string

URL base.

Return values
$this

toArray()

Convierte la última respuesta HTTP en un arreglo asociativo.

public toArray() : array<string|int, mixed>

Este método transforma la última respuesta HTTP recibida en un arreglo asociativo, que incluye información del estado HTTP, encabezados y el cuerpo de la respuesta, ya sea en formato de texto o decodificado de JSON.

Tags
throws
ApiException

Si se encuentra un error en el proceso.

Return values
array<string|int, mixed> —

Arreglo asociativo con la información de la respuesta.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results