ContaFiAPI Client

Bte extends ApiBase
in package

contafi

api

client

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

Properties

$apiPrefix : string: El prefijo para las rutas de la API.
$apiToken : string|null: El token de autenticación para la API.
$apiUrl : string: La URL base de la API de ContaFi.
$apiVersion : string: La versión de la API a utilizar.
$lastResponse : ResponseInterface|null: La última respuesta recibida de la API.
$lastUrl : string|null: La última URL utilizada en la solicitud HTTP.
$rutContribuyente : string|null: El RUT de contribuyente.

Methods

__construct() : mixed: Módulo que permite gestionar las BTE registradas y/o sincronizadas en ContaFi.
anular() : ResponseInterface: Recurso que permite anular una boleta de terceros electrónica previamente emitida.
calcularMontoBruto() : ResponseInterface: Recurso que permite calcular el monto bruto a partir del monto líquido.
calcularMontoLiquido() : ResponseInterface: Recurso que permite calcular el monto líquido a partir del monto bruto.
consume() : $this: Realiza una solicitud HTTP a la API.
datos() : ResponseInterface: Recurso para obtener los datos de una boleta de terceros electrónica emitida.
delete() : ResponseInterface: Realiza una solicitud DELETE a la API.
emitir() : ResponseInterface: Recurso que permite emitir una BTE.
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.
html() : ResponseInterface: Recurso para obtener el HTML de una boleta de terceros electrónica emitida.
listado() : ResponseInterface: Recurso que permite obtener el listado paginado de boletas de terceros electrónicas emitidas.
listarReceptores() : ResponseInterface: Recurso que permite obtener el listado paginado de receptores asociados a las BTE.
pdf() : ResponseInterface: Recurso para obtener el PDF de una boleta de terceros electrónica emitida.
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.
env() : string|null: Obtiene el valor de una variable de entorno.
getError() : object: Extrae información detallada sobre un error a partir de la última respuesta HTTP.
throwException() : ApiException: Lanza una ApiException con los detalles del último error.

$apiPrefix

El prefijo para las rutas de la API.


    private
        string
    $apiPrefix
     = '/api'

$apiToken

El token de autenticación para la API.


    private
        string|null
    $apiToken
     = null

$apiUrl

La URL base de la API de ContaFi.


    private
        string
    $apiUrl
     = 'https://contafi.cl'

$apiVersion

La versión de la API a utilizar.


    private
        string
    $apiVersion
     = '/v1'

$lastResponse

La última respuesta recibida de la API.


    private
        ResponseInterface|null
    $lastResponse
     = null

$lastUrl

La última URL utilizada en la solicitud HTTP.


    private
        string|null
    $lastUrl
     = null

$rutContribuyente

El RUT de contribuyente.


    private
        string|null
    $rutContribuyente
     = null

__construct()

Módulo que permite gestionar las BTE 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.

anular()

Recurso que permite anular una boleta de terceros electrónica previamente emitida.


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

Parameters

$numero : int: Número de la BTE a anular.
$body : array<string|int, mixed>: Datos a entregar (causa de anulación).

Return values

ResponseInterface —

Respuesta con la BTE anulada.

calcularMontoBruto()

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


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

Parameters

$liquido : int: Monto líquido a convertir.
$periodo : string: Periodo a considerar para la conversión.

Return values

ResponseInterface —

Respuesta con el valor bruto calculado.

calcularMontoLiquido()

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


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

Parameters

$bruto : int: Monto bruto a convertir.
$periodo : string: Periodo a considerar para la conversión.

Return values

ResponseInterface —

Respuesta con el valor 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 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.

Return values

$this —

Instancia actual del cliente para encadenar llamadas.

datos()

Recurso para obtener los datos de una boleta de terceros electrónica emitida.


    public
                    datos(int $numero) : ResponseInterface

Parameters

$numero : int: Número de la BTE a consultar.

Return values

ResponseInterface —

Respuesta con los datos de la BTE.

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

emitir()

Recurso que permite emitir una BTE.


    public
                    emitir(array<string|int, mixed> $body) : ResponseInterface

Parameters

$body : array<string|int, mixed>: Datos de la BTE a emitir.

Return values

ResponseInterface —

Respuesta con la BTE emitida.

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.

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.

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

html()

Recurso para obtener el HTML de una boleta de terceros electrónica emitida.


    public
                    html(int $numero) : ResponseInterface

Parameters

$numero : int: Número de la BTE a consultar.

Return values

ResponseInterface —

Respuesta con el contenido de la BTE en formato HTML.

listado()

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


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

Parameters

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

Return values

ResponseInterface —

Respuesta con el listado de BTEs emitidas.

listarReceptores()

Recurso que permite obtener el listado paginado de receptores asociados a las BTE.


    public
                    listarReceptores() : ResponseInterface

Return values

ResponseInterface —

Listado con los receptores asociados a las BTE.

pdf()

Recurso para obtener el PDF de una boleta de terceros electrónica emitida.


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

Parameters

$numero : int: Número de la BTE a consultar.
$filtros : array<string|int, mixed> = []: Filtros adicionales.

Return values

ResponseInterface —

Respuesta con el contenido de la BTE en formato PDF.

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

env()

Obtiene el valor de una variable de entorno.


    private
                    env(string $name) : string|null

Parameters

$name : string: Nombre de la variable de entorno.

Return values

string|null —

Valor de la variable de entorno o null si no está definida.

getError()

Extrae información detallada sobre un error a partir de la última respuesta HTTP.


    private
                    getError() : object

Este método analiza la última respuesta HTTP para extraer información detallada sobre un error que ocurrió durante la solicitud. Devuelve un objeto con los detalles del error, incluyendo el código y el mensaje.

Return values

object —

Detalles del error con propiedades 'code' y 'message'.

throwException()

Lanza una ApiException con los detalles del último error.


    private
                    throwException() : ApiException

Este método utiliza la información obtenida del método getError() para lanzar una ApiException con un mensaje de error detallado y un código de error asociado. Se utiliza para manejar errores de la API de manera uniforme en toda la clase.

Return values

ApiException

Bte extends ApiBase in package contafi api client

Table of Contents

Properties

Methods

Properties

$apiPrefix

$apiToken

$apiUrl

$apiVersion

$lastResponse

$lastUrl

$rutContribuyente

Methods

__construct()

Parameters

anular()

Parameters

Return values

calcularMontoBruto()

Parameters

Return values

calcularMontoLiquido()

Parameters

Return values

consume()

Parameters

Tags

Return values

datos()

Parameters

Return values

delete()

Parameters

Return values

emitir()

Parameters

Return values

get()

Parameters

Return values

getBody()

Tags

Return values

getBodyDecoded()

Tags

Return values

getLastResponse()

Return values

getLastUrl()

Return values

html()

Parameters

Return values

listado()

Parameters

Return values

listarReceptores()

Return values

pdf()

Parameters

Return values

post()

Parameters

Return values

put()

Parameters

Return values

setRut()

Parameters

Return values

setToken()

Parameters

Return values

setUrl()

Parameters

Return values

env()

Parameters

Return values

getError()

Bte extends ApiBase
in package

contafi

api

client