NAV Navbar
shell

Introducción

Bienvenido a la API de Clay! Esta documentación asume que eres desarrollador@ y que buscas integrar tus datos en Clay con alguno de tus sistemas.

Podrás encontrar documentación sobre los endpoints y, al lado derecho, encontrarás ejemplos que te puedan ayudar a ver cómo funciona cada uno.

Y si quieres jugar a través del browser, puedes hacerlo aquí.

Todo feedback es bienvenido. Puedes escribirnos a través del chat de la aplicación.

Autenticación

Para autorizar usa el siguiente código:

# La autenticación se hace pasando el Token a través del Header de la siguiente manera
curl "https://api.clay.cl/todosLosEndPoints"
  -H "Token: AquiVaTuTokenLaaaargo"

Asegúrate de cambiar AquiVaTuTokenLaaaargo por tu token real en Clay.

Clay usa API tokens para acceder a la información. Puedes obtener la tuya así.

La API espera que el token venga incluído en todos los requerimientos al servidor en el Header de la siguiente manera:

Token: AquiVaTuTokenLaaaargo

Obligaciones de Compra / Venta

Get Todas las Boletas de Honorarios

curl -X GET
  --header 'Accept: application/json'
  --header 'Token: AquiVaTuTokenLaaaargo'
  'https://api.clay.cl/v1/obligaciones/boletas_honorarios/?rut_receptor=55555555&dv_receptor=5&fecha_desde=2018-09-01'

Lo anterior retorna un JSON como el siguiente:

{
  "status": true,
  "data": {
    "records": {
      "total_records": 4,
      "last_updated_at": 1542655112.0,
      "items": 3,
      "limit": 25,
      "offset": 0
    },
    "items": [
      [
        {
          "fecha": 1540990800.0,
          "status": "vigente",
          "numero": "5",
          "type": "Boleta de Honorarios",
          "impuesto_retiene": "receptor",
          "emisor": {
            "rut": "1",
            "dv": "9",
            "razon_social": "PRISCILLA PEREZ"
          },
          "receptor": {
            "rut": "55555555",
            "dv": "5",
            "razon_social": "Mi Empresa SpA"
          },
          "total": {
            "total honorario": 188500.0,
            "impuesto": 20944.0,
            "total": 209444.0
          },
          "description": "APOYO SETUP OCTUBRE",
          "pdf": {
            "has": true,
            "reference": "https://cdn.clay.cl/BH--3unIDmuylargoasdfasdfasdfasd9f8asd9f87a9sd8f7a9ds87f9sa.pdf"
          }
        },
        {
          "fecha": 1541595600.0,
          "status": "vigente",
          "numero": "45",
          "type": "Boleta de Honorarios",
          "impuesto_retiene": "receptor",
          "emisor": {
            "rut": "1",
            "dv": "9",
            "razon_social": "Otra persona"
          },
          "receptor": {
            "rut": "55555555",
            "dv": "5",
            "razon_social": "Mi Empresa SpA"
          },
          "total": {
            "total honorario": 151515.0,
            "impuesto": 16835.0,
            "total": 168350.0
          },
          "description": "SERVICIOS DE MARKETING DIGITAL Y VENTAS",
          "pdf": {
            "has": true,
            "reference": "https://cdn.clay.cl/BH--3unIDmuylargoasdfasdfasdfasd9f8asd9f87a9sd8f7a9dssssdsa.pdf"
          }
        }
      ]
    ]
  }
}

Este endpoint retorna todas las Boletas de Honorarios y Boletas de Honorarios de Terceros de una empresa en un rango de fecha particular.

HTTPS Request

GET https://api.clay.cl/v1/obligaciones/boletas_honorarios/

Query Parameters

Parámetro Default Descripción
rut_receptor Obligatorio Esta es la empresa que estás analizando.
dv_receptor Obligatorio Dígito Verificador
rut_emisor Opcional El emisor de la Boleta, si no está trae todas.
dv_emisor Opcional Dígito Verificador
fecha_desde Obligatorio Desde qué fecha quieres obtener las Boletas (YYYY-MM-DD)
fecha_hasta Opcional Por defecto es hasta el día de hoy (YYYY-MM-DD)
limit Por defecto 25, máximo 50 Límite de resultados por consulta
offset Por defecto 0 Cuántos registros se debe saltar

Get Todos los Documentos Tributarios

curl -X GET
  --header 'Accept: application/json'
  --header 'Token: AquiVaTuTokenLaaaargo'
  'https://api.clay.cl/v1/obligaciones/documentos_tributarios/?rut_empresa=55555555&dv_empresa=5&fecha_desde=2018-09-01'

Lo anterior retorna un JSON como el siguiente:

{
  "status": true,
  "data": {
    "records": {
      "total_records": 99,
      "last_updated_at": 1543315012,
      "items": 25,
      "limit": 25,
      "offset": 0
    },
    "items": [
      [
        {
          "fecha_emision": 1514984400,
          "numero": "11682",
          "tipo": "Factura de Venta",
          "codigo": "33",
          "saldo_isoluto": 0,
          "pagado": true,
          "recibida": true,
          "emisor": {
            "rut": "97006000",
            "dv": "6",
            "razon_social": "BANCO DE CREDITO E INVERSIONES"
          },
          "receptor": {
            "rut": "76570751",
            "dv": "k",
            "razon_social": "CLAY TECHNOLOGIES SPA"
          },
          "total": {
            "neto": 2690,
            "exento": 0,
            "impuesto": 2690,
            "porcentaje_impuesto": "19",
            "otros_impuestos": 0,
            "total": 16849
          },
          "xml": {
            "has": false,
            "reference": null
          }
        },
        {
          "fecha_emision": 1515157200,
          "numero": "76",
          "tipo": "Factura de Venta",
          "codigo": "33",
          "saldo_isoluto": 0,
          "pagado": true,
          "recibida": true,
          "emisor": {
            "rut": "76361422",
            "dv": "0",
            "razon_social": "COWORK LABS SPA"
          },
          "receptor": {
            "rut": "76570751",
            "dv": "K",
            "razon_social": "CLAY TECHNOLOGIES SPA"
          },
          "total": {
            "neto": 1938,
            "exento": 0,
            "impuesto": 1938,
            "porcentaje_impuesto": "19.00",
            "otros_impuestos": 0,
            "total": 12138
          },
          "description": [
            {
              "item": "1",
              "description": "Arriendo Oficina<br/>Arriendo Oficina Enero",
              "quantity": 1,
              "unit": "GL",
              "unit_price": 10200,
              "total_price": 10200
            }
          ],
          "xml": {
            "has": true,
            "reference": "https://cdn.clay.cl/15398d2342342sdfsdc84060dc7ee9763e4cbf45d89a4.xml"
          }
        }
      ]
    ]
  }
}

Este endpoint retorna todos los Documentos Tributarios de una empresa en un rango de fecha particular.

HTTPS Request

GET https://api.clay.cl/v1/documentos_tributarios

Query Parameters

Parámetro Default Descripción
rut_empresa Obligatorio Esta es la empresa que estás analizando.
dv_empresa Obligatorio Dígito Verificador
fecha_desde Obligatorio Desde qué fecha quieres obtener los Documentos Tributarios (YYYY-MM-DD)
fecha_hasta Opcional Por defecto es hasta el día de hoy (YYYY-MM-DD)
recibida Opcional [true ó false] Si no se ingresa este dato, mostrará todas (si recibida = false => emitida)
limit Por defecto 25, máximo 50 Límite de resultados por consulta
offset Por defecto 0 Cuántos registros se debe saltar