Detalle CAF

GET

/api/v1/billing/caf/{id}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.simplo.cl/api/v1/billing/caf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"),
    Headers =
    {
        { "X-Api-Key", "<X-Api-Key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.simplo.cl/api/v1/billing/caf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"))
    .header("X-Api-Key", "<X-Api-Key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://api.simplo.cl/api/v1/billing/caf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.simplo.cl/api/v1/billing/caf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-Api-Key: <X-Api-Key>'

Retorna el detalle de un CAF con rango de folios y disponibilidad.

Autenticación

ApiKeyAuth
BearerAuth

Parámetros

Parámetros de ruta

requerido

string format: uuid

UUID del CAF

Respuestas

200

CAF encontrado

application/json

object

requerido

string format: uuid

tipo_dte

requerido

Código SII del tipo de Documento Tributario Electrónico (33 factura, 39 boleta, 52 guía de despacho, 56/61 notas, 110-112 exportación). Detalle de cada tipo en la guía Tipos de DTE.

integer

Valores permitidos: 33 34 39 41 43 46 52 56 61 110 111 112

folio_desde

requerido

integer

folio_hasta

requerido

integer

folios_disponibles

requerido

Cantidad de folios aún no asignados

integer

ambiente

requerido

string

Valores permitidos: certificacion produccion

fecha_autorizacion

requerido

string format: date

is_active

requerido

boolean

created_at

requerido

string format: date-time

Example

{
  "tipo_dte": 33,
  "folio_desde": 1,
  "folio_hasta": 200,
  "folios_disponibles": 158,
  "ambiente": "certificacion"
}

401

Token o API key inválido o ausente

application/json

object

code

requerido

Código de error máquina-legible

string

message

requerido

Mensaje descriptivo del error. Este es el campo canónico para clientes nuevos.

string

error

Alias de compatibilidad de message mantenido hacia atrás.

string

details

Array<object>

object

field

requerido

Campo con error (dot notation para nested)

string

code

requerido

Código de validación

string

message

requerido

Mensaje descriptivo

string

action

Acción recomendada para el cliente

string

severity

Severidad opcional del error

string

Valores permitidos: critical error warning info

context

Contexto estructurado opcional para debugging

object

key

additional properties

any

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Error de validacion en los campos enviados",
  "details": [
    {
      "field": "receptor.rut",
      "code": "INVALID_RUT",
      "message": "RUT invalido: digito verificador no coincide"
    }
  ],
  "severity": "critical"
}

404

Recurso no encontrado

application/json

object

code

requerido

Código de error máquina-legible

string

message

requerido

Mensaje descriptivo del error. Este es el campo canónico para clientes nuevos.

string

error

Alias de compatibilidad de message mantenido hacia atrás.

string

details

Array<object>

object

field

requerido

Campo con error (dot notation para nested)

string

code

requerido

Código de validación

string

message

requerido

Mensaje descriptivo

string

action

Acción recomendada para el cliente

string

severity

Severidad opcional del error

string

Valores permitidos: critical error warning info

context

Contexto estructurado opcional para debugging

object

key

additional properties

any

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Error de validacion en los campos enviados",
  "details": [
    {
      "field": "receptor.rut",
      "code": "INVALID_RUT",
      "message": "RUT invalido: digito verificador no coincide"
    }
  ],
  "severity": "critical"
}