ContaFiAPI Client

Bhe extends ApiBase
in package

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

Table of Contents

Methods

__construct()  : mixed
Módulo que permite gestionar las BHE registradas y/o sincronizadas en ContaFi.
consume()  : $this
Realiza una solicitud HTTP a la API.
datos()  : ResponseInterface
Recurso para obtener los datos de una boleta de honorarios electrónica recibida.
delete()  : ResponseInterface
Realiza una solicitud DELETE a la API.
get()  : ResponseInterface
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.
listado()  : ResponseInterface
Recurso que permite obtener el listado paginado de boletas de honorarios electrónicas recibidas.
listarEmisores()  : ResponseInterface
Recurso que permite obtener el listado paginado de emisores asociados a las BHE.
observar()  : ResponseInterface
Recurso que permite observar una boleta de honorarios electrónica previamente recibida.
pdf()  : ResponseInterface
Recurso para obtener el PDF de una boleta de honorarios electrónica recibida.
post()  : ResponseInterface
Realiza una solicitud POST a la API.
put()  : ResponseInterface
Realiza una solicitud PUT a la API.
setRut()  : $this
Establece el RUT del contribuyente.
setToken()  : $this
Establece el token de autenticación.
setUrl()  : $this
Establece la URL base de la API.

Methods

__construct()

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

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 ContaFi. 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.

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 ContaFi, 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.

datos()

Recurso para obtener los datos de una boleta de honorarios electrónica recibida.

public datos(string $emisor, int $numero) : ResponseInterface
Parameters
$emisor : string

RUT del emisor de la BHE, sin puntos y con DV.

$numero : int

Número de la BHE.

Return values
ResponseInterface —

Respuesta con los datos de la BHE consultada.

delete()

Realiza una solicitud DELETE a la API.

public delete(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface
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

get()

Realiza una solicitud GET a la API.

public get(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface
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

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

listado()

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

public listado(array<string|int, mixed> $filtros) : ResponseInterface
Parameters
$filtros : array<string|int, mixed>

Filtros de búsqueda.

Return values
ResponseInterface —

Respuesta con el listado de BHEs recibidas.

listarEmisores()

Recurso que permite obtener el listado paginado de emisores asociados a las BHE.

public listarEmisores(string $nuevos) : ResponseInterface
Parameters
$nuevos : string

Emisores que ha emitido por primera vez una BHE en el período indicado

Return values
ResponseInterface —

Respuesta con el listado de emisores.

observar()

Recurso que permite observar una boleta de honorarios electrónica previamente recibida.

public observar(string $emisor, int $numero, array<string|int, mixed> $body) : ResponseInterface
Parameters
$emisor : string

RUT del emisor de la BHE, sin puntos y con DV.

$numero : int

Número de la BHE.

$body : array<string|int, mixed>

Datos de la observación de la BHE (causa).

Return values
ResponseInterface —

Respuesta con la BHE observada

pdf()

Recurso para obtener el PDF de una boleta de honorarios electrónica recibida.

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

RUT del emisor de la BHE, sin puntos y con DV.

$numero : int

Número de la BHE.

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

Filtros adicionales.

Return values
ResponseInterface —

Respuesta con los datos del PDF de la BHE consultada.

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
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

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
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

setRut()

Establece el RUT del contribuyente.

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

RUT del contribuyente.

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results