Crear documento programado

curl --request POST \
  --url https://api.tupana.ai/v1/scheduled-documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dte_type": "33",
  "receiver_tax_id": "12345678-9",
  "frequency": "monthly",
  "amount": 100000,
  "details": [
    {
      "product_name": "Servicio mensual de consultoría",
      "quantity": 1,
      "unit_price": 100000,
      "description": "Consultoría especializada en tecnología",
      "unit_of_measurement": "UN"
    }
  ],
  "day_of_month": 15,
  "day_of_week": 1,
  "currency": "CLP",
  "status": "active",
  "max_occurrences": 12
}
'

{
  "id": 789,
  "sender": {
    "id": 123,
    "name": "Empresa Ejemplo SpA",
    "rut": "76543210-1"
  },
  "receiver": {
    "id": 456,
    "name": "Cliente ABC Ltda",
    "rut": "12345678-9"
  },
  "dte_type": {
    "id": 1,
    "code": "33",
    "description": "Factura Electrónica"
  },
  "frequency": "monthly",
  "frequency_display": "Mensual",
  "day_of_month": 15,
  "day_of_week": null,
  "next_execution": "2024-02-15T10:00:00Z",
  "status": "active",
  "status_display": "Activo",
  "amount": 100000,
  "currency": "CLP",
  "completed_occurrences": 5,
  "max_occurrences": null,
  "details": [
    {
      "id": 1,
      "product_name": "Servicio mensual de consultoría",
      "description": "Consultoría especializada en tecnología",
      "quantity": 1,
      "unit_price": 100000,
      "total": 100000,
      "unit_of_measurement": "UN"
    }
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-20T15:30:00Z"
}

POST

scheduled-documents

curl --request POST \
  --url https://api.tupana.ai/v1/scheduled-documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dte_type": "33",
  "receiver_tax_id": "12345678-9",
  "frequency": "monthly",
  "amount": 100000,
  "details": [
    {
      "product_name": "Servicio mensual de consultoría",
      "quantity": 1,
      "unit_price": 100000,
      "description": "Consultoría especializada en tecnología",
      "unit_of_measurement": "UN"
    }
  ],
  "day_of_month": 15,
  "day_of_week": 1,
  "currency": "CLP",
  "status": "active",
  "max_occurrences": 12
}
'

{
  "id": 789,
  "sender": {
    "id": 123,
    "name": "Empresa Ejemplo SpA",
    "rut": "76543210-1"
  },
  "receiver": {
    "id": 456,
    "name": "Cliente ABC Ltda",
    "rut": "12345678-9"
  },
  "dte_type": {
    "id": 1,
    "code": "33",
    "description": "Factura Electrónica"
  },
  "frequency": "monthly",
  "frequency_display": "Mensual",
  "day_of_month": 15,
  "day_of_week": null,
  "next_execution": "2024-02-15T10:00:00Z",
  "status": "active",
  "status_display": "Activo",
  "amount": 100000,
  "currency": "CLP",
  "completed_occurrences": 5,
  "max_occurrences": null,
  "details": [
    {
      "id": 1,
      "product_name": "Servicio mensual de consultoría",
      "description": "Consultoría especializada en tecnología",
      "quantity": 1,
      "unit_price": 100000,
      "total": 100000,
      "unit_of_measurement": "UN"
    }
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-20T15:30:00Z"
}

Crea un nuevo documento programado que se ejecutará automáticamente según la frecuencia especificada. Es ideal para automatizar facturas recurrentes a clientes específicos sin intervención manual.

Parámetros Requeridos

master_entity_id (integer): ID de la entidad maestra emisora
dte_type (string): Código del tipo de DTE (ej: ‘33’ para Factura Electrónica)
frequency (string): Frecuencia de ejecución (daily, weekly, monthly, quarterly)
amount (number): Monto total del documento
details (array): Lista de productos/servicios del documento

Parámetros Requeridos Adicionales

receiver_tax_id (string): RUT del receptor (formato: 12345678-9). El sistema buscará un cliente existente con este RUT. Si no existe, creará uno nuevo automáticamente.

Parámetros Opcionales

day_of_month (integer): Día del mes para ejecución (1-31, requerido para frecuencia monthly o quarterly)
day_of_week (integer): Día de la semana para ejecución (0=Lunes, 6=Domingo, requerido para frecuencia weekly)
currency (string): Moneda del documento. Valores permitidos: CLP, UF, USD, EUR. Por defecto: CLP
status (string): Estado inicial del documento programado. Valores: active, inactive. Por defecto: active
max_occurrences (integer): Número máximo de ejecuciones. Si es null o no se proporciona, el documento se ejecutará indefinidamente
receiver_address (string): Dirección del receptor (opcional, usado principalmente para facturas de exportación)
receiver_city (string): Ciudad del receptor (opcional, usado principalmente para facturas de exportación)
references (array): Referencias a otros documentos (máximo 3 referencias)
export_data (object): Datos de exportación (requerido para DTE 110 y 1110)
email_config (object): Configuración de envío de emails automáticos

Authorizations

Authorization

string

header

required

API Key para autenticación. Debe proporcionarse en el formato: 'Api-Key YOUR-API-KEY'

Query Parameters

master_entity_id

integer

required

ID de la entidad maestra emisora

Example:

123

Body

application/json

Datos del documento programado a crear

dte_type

string

required

Código del tipo de DTE (ej: '33' para Factura Electrónica)

Example:

"33"

receiver_tax_id

string

required

RUT del receptor (formato: 12345678-9). El sistema buscará un cliente existente con este RUT. Si no existe, creará uno nuevo automáticamente. Campo requerido.

Example:

"12345678-9"

frequency

enum<string>

required

Frecuencia de ejecución

Available options:

daily,

weekly,

monthly,

quarterly

Example:

"monthly"

amount

number

required

Monto total del documento

Required range: x >= 0

Example:

100000

details

object[]

required

Detalles/productos del documento

Minimum array length: 1

Show child attributes

details.product_name

string

required

Nombre del producto o servicio

Example:

"Servicio mensual de consultoría"

details.quantity

number

required

Cantidad

Required range: x >= 0.01

Example:

1

details.unit_price

number

required

Precio unitario

Required range: x >= 0

Example:

100000

details.description

string

Descripción detallada

Example:

"Consultoría especializada en tecnología"

details.unit_of_measurement

string

default:UN

Unidad de medida

Example:

"UN"

day_of_month

integer

Día del mes para ejecución (1-31, requerido para frecuencia mensual/trimestral)

Required range: 1 <= x <= 31

Example:

15

day_of_week

integer

Día de la semana para ejecución (0=Lunes, 6=Domingo, requerido para frecuencia semanal)

Required range: 0 <= x <= 6

Example:

1

currency

enum<string>

default:CLP

Moneda del documento

Available options:

CLP,

UF,

USD,

EUR

Example:

"CLP"

status

enum<string>

default:active

Estado inicial del documento programado

Available options:

active,

inactive

Example:

"active"

max_occurrences

integer

Número máximo de ejecuciones (opcional, null = infinito)

Required range: x >= 1

Example:

12

Response

Documento programado creado exitosamente

integer

ID único del documento programado

Example:

789

sender

object

Información de la entidad emisora

Show child attributes

sender.id

integer

Example:

123

sender.name

string

Example:

"Empresa Ejemplo SpA"

sender.rut

string

Example:

"76543210-1"

receiver

object

Información de la entidad receptora

Show child attributes

receiver.id

integer

Example:

456

receiver.name

string

Example:

"Cliente ABC Ltda"

receiver.rut

string

Example:

"12345678-9"

dte_type

object

Tipo de documento tributario

Show child attributes

dte_type.id

integer

Example:

1

dte_type.code

string

Example:

"33"

dte_type.description

string

Example:

"Factura Electrónica"

frequency

enum<string>

Frecuencia de ejecución

Available options:

daily,

weekly,

monthly,

quarterly

Example:

"monthly"

frequency_display

string

Frecuencia en formato legible

Example:

"Mensual"

day_of_month

integer | null

Día del mes para ejecución (1-31)

Example:

15

day_of_week

integer | null

Día de la semana para ejecución (0=Lunes, 6=Domingo)

Example:

null

next_execution

string<date-time>

Fecha y hora de la próxima ejecución

Example:

"2024-02-15T10:00:00Z"

status

enum<string>

Estado del documento programado

Available options:

active,

inactive,

completed

Example:

"active"

status_display

string

Estado en formato legible

Example:

"Activo"

amount

number

Monto del documento

Example:

100000

currency

enum<string>

Moneda del documento

Available options:

CLP,

UF,

USD,

EUR

Example:

"CLP"

completed_occurrences

integer

Número de veces que se ha ejecutado

Example:

5

max_occurrences

integer | null

Número máximo de ejecuciones

Example:

null

details

object[]

Detalles/productos del documento

Show child attributes

details.id

integer

ID único del detalle

Example:

1

details.product_name

string

Nombre del producto o servicio

Example:

"Servicio mensual de consultoría"

details.description

string

Descripción detallada

Example:

"Consultoría especializada en tecnología"

details.quantity

number

Cantidad

Example:

1

details.unit_price

number

Precio unitario

Example:

100000

details.total

number

Total de la línea

Example:

100000

details.unit_of_measurement

string

Unidad de medida

Example:

"UN"

created_at

string<date-time>

Fecha de creación

Example:

"2024-01-15T10:00:00Z"

updated_at

string<date-time>

Fecha de última actualización

Example:

"2024-01-20T15:30:00Z"

Listar documentos programados

⌘I

Entidades

Credenciales

Documentos

Documentos Programados

Crear documento programado

Parámetros Requeridos

Parámetros Requeridos Adicionales

Parámetros Opcionales

Authorizations

Query Parameters

Body

Response

Entidades

Credenciales

Documentos

Documentos Programados

​Parámetros Requeridos

​Parámetros Requeridos Adicionales

​Parámetros Opcionales

Authorizations

Query Parameters

Body

Response

Parámetros Requeridos

Parámetros Requeridos Adicionales

Parámetros Opcionales