PATCH
Activar o desactivar CAEs por filtro

Autorizaciones

connect.sid
string
cookie
requerido

Sesión por cookie de POST /v1/login, válida 1 hora. Ver Autenticación.

Parámetros de ruta

companyRut
string
predeterminado:219999990008
requerido
Ejemplo:

"219999990008"

Cuerpo

application/json

Campos a aplicar a todos los CAE que matcheen el filtro del querystring. Los que no se mandan quedan como estaban.

El filtro va en el querystring, no en el body. Sin filtro, el request alcanza todos los CAE de la empresa.

active
boolean

Activar o desactivar. Poner false además sella cancelAtDGIAt con la fecha actual si no venía seteada.

deleted
boolean
cancelAtDGIAt
string<date-time> | null

Fecha de cancelación ante DGI. Mandar null explícito la borra; omitir el campo la deja como estaba.

CAEEspecial
enum<string> | null

Mandar null explícito lo borra; omitirlo lo deja como estaba.

Opciones disponibles:
1,
2,
3,
4

Respuesta

OK

Envoltorio común a todas las respuestas. status no se deduce del código HTTP: hay al menos nueve lugares en el gateway que responden HTTP 200 con status: "FAIL" (por ejemplo CFE_NOT_FOUND y DGI_COMPANY_NOT_READY_YET). Un cliente tiene que leer status, no el código.

payload
requerido

Los datos de la respuesta. {} cuando el endpoint no devuelve nada.

status
enum<string>
requerido

De las 82 claves de mensaje del gateway, 29 son SUCCESS y 53 FAIL. Es lo que hay que mirar para saber si la llamada funcionó.

Opciones disponibles:
SUCCESS,
FAIL
message
object

Presente cuando la operación tiene algo que decir. Las lecturas simples responden sólo payload y status.