ContaFiAPI Client

Facturacion extends ApiBase
in package

Módulo que permite gestionar proveeedores, compras y ventas con facturación (DTE).

Table of Contents

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 proveeedores, compras y ventas con facturación (DTE).
consume()  : $this
Realiza una solicitud HTTP a la API.
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.
listadoClientes()  : ResponseInterface
Recurso que permite obtener el listado paginado de clientes asociados a ventas.
listadoCompras()  : ResponseInterface
Recurso que permite obtener el listado paginado de documentos tributarios electrónicos asociados a compras.
listadoProveedores()  : ResponseInterface
Recurso que permite obtener el listado paginado de proveedores asociados a compras.
listadoVentas()  : ResponseInterface
Recurso que permite obtener el listado paginado de documentos tributarios electrónicos asociados a ventas.
post()  : ResponseInterface
Realiza una solicitud POST a la API.
put()  : ResponseInterface
Realiza una solicitud PUT a la API.
resumenVentasSinDetalle()  : ResponseInterface
Recurso que permite obtener el listado paginado de resumenes asociados a ventas.
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.

Properties

$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

Methods

__construct()

Módulo que permite gestionar proveeedores, compras y ventas con facturación (DTE).

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.

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

listadoClientes()

Recurso que permite obtener el listado paginado de clientes asociados a ventas.

public listadoClientes() : ResponseInterface
Return values
ResponseInterface —

Respuesta con el listado de clientes de ventas.

listadoCompras()

Recurso que permite obtener el listado paginado de documentos tributarios electrónicos asociados a compras.

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

Estado del documento en el registro de compras.

$filtros : array<string|int, mixed>

Filtros de búsqueda.

Return values
ResponseInterface —

Respuesta con el listado paginado de DTEs de compras, con detalle.

listadoProveedores()

Recurso que permite obtener el listado paginado de proveedores asociados a compras.

public listadoProveedores() : ResponseInterface
Return values
ResponseInterface —

Respuesta con el listado de proveedores de compras.

listadoVentas()

Recurso que permite obtener el listado paginado de documentos tributarios electrónicos asociados a ventas.

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

Filtros de búsqueda.

Return values
ResponseInterface —

Respuesta con el listado paginado de DTEs de ventas, con detalle.

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

resumenVentasSinDetalle()

Recurso que permite obtener el listado paginado de resumenes asociados a ventas.

public resumenVentasSinDetalle(string $periodo) : ResponseInterface
Parameters
$periodo : string

Periodo donde obtener el listado de resumen de ventas.

Return values
ResponseInterface —

Respuesta con el listado paginado de ventas.

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.

Tags
throws
ApiException

Lanza una excepción con detalles del error.

Return values
ApiException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results