Skip to main content

Crear tarea

El servicio de creación de tarea de ajuste permite fondear a tus colaboradores.

Método: POST
URL: api/adjustments/create-task
Headers requeridos:

Authorization: Bearer {token}
host_url:https://webhook.site/6e19b388-5b2b-4655-95dd-dd9c129c96bc

Códigos de Estado

CódigoEstadoDescripción
✅ 200200 OKLa solicitud fue exitosa.
⚠️ 422422 Unprocessable EntityError en los datos enviados.
❌ 500500 Internal Server ErrorError interno del servidor.

Campos requeridos

CampoTipoRequeridoDescripción
titleStringTítulo de la tarea.
descriptionStringDescripción de la tarea.
membershipsArrayLista de membresías a fondear.
membershipStringIdentificador único de la membresía.
amountNúmeroMonto a fondear para la membresía.

Ejemplo de request

{
"title": "FONDEO PAGOS 987",
"description": "PAGO 0011",
"memberships": [
{ "membership": "690010207", "amount": 1 },
{ "membership": "700008317", "amount": 1 },
{ "membership": "760010145", "amount": 1 },
{ "membership": "780009278", "amount": 1 },
{ "membership": "330023920", "amount": 1 }
]
}

Respuestas detalladas

  • 200 OK - Solicitud exitosa
  • Descripción: La solicitud se procesó correctamente.

Detalles de la tarea (task)

CampoTipoDescripción
uuidStringIdentificador único de la tarea.
titleStringTítulo de la tarea.
descriptionStringDescripción de la tarea.
tenant_idStringID del inquilino asociado a la tarea.
statusstringpending,authorized,processed
updated_atStringFecha y hora de la última actualización de la tarea.
created_atStringFecha y hora de creación de la tarea.

Detalles de la tarea (memberships)

CampoTipoDescripción
uuidStringIdentificador único de la membresía.
adjustment_task_idStringID de la tarea de ajuste relacionada.
membershipStringIdentificador de la membresía asociada.
amountNumberMonto asignado a la membresía.
statusStringpending,finished,error
updated_atStringFecha y hora de la última actualización de la membresía.
created_atStringFecha y hora de creación de la membresía.

Ejemplo de respuesta

{
"success": true,
"message": "Tarea creada correctamente",
"task": {
"uuid": "e81c3dcf-b59d-493b-b9d7-83feb4ef3973",
"title": "FONDEO PAGOS 14FEB",
"description": "PAGOS FEB 2025",
"tenant_id": "005f59a5-679b-44c5-869f-7c41933fad4e",
"updated_at": "2025-02-11T17:21:56.000000Z",
"created_at": "2025-02-11T17:21:56.000000Z"
},
"memberships": [
{
"uuid": "629ff966-7244-42a6-a6c7-fb69de0e8b44",
"adjustment_task_id": "e81c3dcf-b59d-493b-b9d7-83feb4ef3973",
"membership": "690010207",
"amount": 1,
"status": "pending",
"updated_at": "2025-02-11T17:21:56.000000Z",
"created_at": "2025-02-11T17:21:56.000000Z"
}
]
}

422 Unprocessable Entity - Error de validación

  • Descripción: Ocurre cuando los datos enviados en la solicitud no cumplen con las reglas de validación.
CampoTipoDescripción
successBooleanIndica si la solicitud fue exitosa (false).
messageStringMensaje general del error.
errorsArrayLista de errores de validación encontrados.

Detalles de los errores (errors)

CampoTipoDescripción
fieldStringNombre del campo que generó el error.
messageStringMensaje descriptivo del error de validación.
valueStringValor enviado que causó el error (si aplica).

Ejemplo de respuesta

{
"success": false,
"message": "Error al validar los datos.",
"errors": [
{
"field": "title",
"message": "El campo title es requerido.",
"value": ""
},
{
"field": "memberships.0.membership",
"message": "La membresía 69001020712 no pertenece al comercio indicado.",
"value": "69001020712"
}
]
}