Saltar al contenido principal

Cuentas — Crear y Actualizar

Crea cuentas nuevas y actualiza las existentes con actualizaciones parciales, productos y campos dinámicos.


Crear cuenta​

POST/apidev/v1/accounts
PermisoAPICLI_ACCOUNTS_WRITE
Límite de solicitudes10 solicitudes/min

Cuerpo de la solicitud​

CampoTipoRequeridoMáxDescripción
namestringSí200Nombre para mostrar de la cuenta.
external_codestringNo120Identificador del sistema externo.
statusstringNo10Estado de la cuenta.
business_namestringNo200Razón social.
tax_idstringNo60Número de identificación fiscal.
documentstringNo60Número de documento.
document_typenumberNo—Identificador del tipo de documento.
service_time_minnumberNo—Tiempo de servicio en el lugar por defecto para esta cuenta, en minutos. El planificador lo usa para estimar cuánto dura una parada en esta cuenta.
phonestringNo60Número de teléfono.
mobilestringNo60Teléfono móvil.
emailstringNo200Dirección de correo electrónico.
image_urlstringNo500URL de la imagen.
notesstringNo1000Notas de texto libre.
streetstringNo200Nombre de la calle.
door_numberstringNo20Número de puerta.
apartmentstringNo20Apartamento o unidad.
cornerstringNo200Esquina.
zip_codestringNo20Código postal.
latitudenumberNo—Coordenada de latitud.
longitudenumberNo—Coordenada de longitud.
country_idstringNo30ID del país.
department_idstringNo30ID del departamento.
client_idstringNo30ID del cliente asociado.
qr_codestringNo30Valor del código QR.
start_datestringNo30Fecha de inicio (ISO 8601).
end_datestringNo30Fecha de fin (ISO 8601).
birth_datestringNo30Fecha de nacimiento (ISO 8601).

Ejemplos de código​

curl -s -X POST "https://$TENANT/apidev/v1/accounts" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp",
"business_name": "Acme Corporation S.A.",
"tax_id": "214100001019",
"email": "contact@acme.com",
"phone": "+59821234567",
"street": "Av. Rivera",
"door_number": "1234",
"country_id": "1",
"department_id": "10",
"client_id": "982710394857200005",
"start_date": "2026-01-15"
}'

Respuesta de ejemplo​

{
"success": true,
"data": {
"id": "982710394857201664"
}
}

Actualizar cuenta​

Actualiza una cuenta existente. Solo se modifican los campos incluidos; los campos omitidos permanecen sin cambios. Enviá null para limpiar un campo que admita nulos.

Consultá Actualizaciones parciales para el patrón general.

PUT/apidev/v1/accounts/{id}
PermisoAPICLI_ACCOUNTS_WRITE
Límite de solicitudes10 solicitudes/min

Parámetros de ruta​

ParámetroTipoRequeridoDescripción
idstringSíIdentificador único de la cuenta.

Cuerpo de la solicitud​

Se aceptan todos los campos de Crear cuenta (ninguno requerido), incluido qr_code (string, máx 30 — enviá null para limpiarlo) y service_time_min (number — enviá null para limpiarlo). Además admite:

Arreglo products — Administra las asociaciones de productos:

AcciónCampos requeridosDescripción
addprovider_id, product_type_idAgrega un producto nuevo. Opcionales: coverage_id, start_date, end_date, status.
updateproduct_id + campos a cambiarActualiza un producto existente.
removeproduct_idElimina un producto.

Arreglo dynamic_fields — Establece o limpia campos personalizados:

CampoTipoRequeridoDescripción
field_idstringSíIdentificador del campo dinámico.
namestringNoNombre del campo.
typestringNoTipo del campo.
ordernumberNoOrden de visualización.
valueanyNoNuevo valor (o null para limpiar).

Ejemplos de código​

curl -s -X PUT "https://$TENANT/apidev/v1/accounts/982710394857201664" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
-H "Content-Type: application/json" \
-d '{
"email": "new-contact@acme.com",
"notes": "Upgraded to premium tier",
"products": [
{
"action": "add",
"provider_id": "982710394857200030",
"product_type_id": "8",
"coverage_id": "12",
"start_date": "2026-04-01",
"status": "A"
},
{
"action": "remove",
"product_id": "982710394857201700"
}
],
"dynamic_fields": [
{ "field_id": "10", "value": "Premium" },
{ "field_id": "11", "value": null }
]
}'

Respuesta de ejemplo​

{
"success": true,
"data": {
"id": "982710394857201664",
"updated_fields": ["email", "notes", "products", "dynamic_fields"]
},
"meta": {}
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos.
UNAUTHORIZED401tenant / Authorization / X-API-Key ausente, inválido o expirado
FORBIDDEN403El usuario no tiene el permiso requerido.
NOT_FOUND404Recurso no encontrado (endpoint de actualización).
RATE_LIMITED429Se superaron 10 solicitudes/min.
INTERNAL_ERROR500Error inesperado del servidor.