Modificar Cartera

Permite modificar uno o múltiples registros de cartera existentes en el sistema mediante una única petición. Este endpoint está diseñado para operaciones de actualización en lote (batch update), permitiendo actualizar hasta 10,000 registros por petición.

Método: POST

Endpoint

https://api.ventasremotas.com/v1/receivables/batch-update

Nota

Es necesario el envío del token de acceso Subscription-Key para hacer uso de este endpoint. Para ver cómo generar el token, vea Activación Suscripción a RSales API.

Encabezados de la solicitud

Header	Valor	Descripción
Content-Type	application/json	Indica que los datos se envían en formato JSON
Accept	application/json	Indica que la respuesta debe estar en formato JSON
Subscription-Key	{subscription_key}	Clave de suscripción para acceder a la API
Authorization	Bearer {access_token}	Token de acceso obtenido del endpoint /token

---

Parámetros del Cuerpo (Body)

El body debe ser un array de objetos, donde cada objeto representa un registro de cartera a actualizar.

Límites

Parámetro	Valor	Descripción
Mínimo de items	1	El array no puede estar vacío
Máximo de items	10,000	Número máximo de registros de cartera por petición

Campos

El cuerpo (Body) de la solicitud debe enviarse en formato JSON y debe incluir un array con los siguientes parámetros.

Importante

Todos los campos requeridos deben estar presentes en cada objeto del array, incluso los campos que admiten nulo (Nulo: Sí). Si un campo no aplica para un registro, envíelo con valor null. La actualización reemplaza todos los campos del registro de cartera, por lo que debe enviar el estado completo deseado.

Clave de identificación

Un registro de cartera se identifica de forma única por la combinación de client_id + seller_id + document_type + document_number. Solo se actualizarán los registros que ya existan con esa combinación.

Campo	Tipo	Nulo	Restricciones	Descripción
client_id	string (max 18)	No	No permite: espacio, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Código del cliente (identifica el registro a actualizar)
seller_id	string (max 18)	No	No permite: espacio, #, %, &, *, {`, `}, \, :, <, >, ?, /, +, .	Código del vendedor (identifica el registro a actualizar)
collector_id	string (max 18)	No	No permite: espacio, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Código del cobrador asignado al documento
document_type	string (max 50)	No		Tipo de documento (identifica el registro a actualizar)
document_number	string (max 20)	No		Número del documento (identifica el registro a actualizar)
document_date	datetime	No	Formato: YYYY-MM-DD HH:MM:SS	Fecha de emisión del documento
due_date	datetime	No	Formato: YYYY-MM-DD HH:MM:SS	Fecha de vencimiento del documento
balance	decimal (18, 2)	Sí		Saldo actual del documento, valor incluye impuestos
observations	string (max 500)	Sí		Observaciones o notas adicionales
state	string (max 1)	No	Valores permitidos: Y, N	Estado del registro de cartera (Activo/Inactivo)
withholding_base	decimal (18, 2)	Sí		Valor a pagar antes de impuestos (valor base de factura)
tax_value	decimal (18, 2)	Sí		Valor de los impuestos generados en la factura
base_balance	decimal (18, 2)	Sí		Saldo inicial del documento, valor incluye impuestos
motivation	string (max 100)	Sí		Motivo o causal asociado al documento
corporate_client	string (max 18)	Sí		Código del cliente corporativo
withholdings	string (max 1000)	Sí	JSON en formato string	Retenciones del documento
invoice_url	string (max 300)	Sí		URL de la factura electrónica o documento asociado

Formato de tipos de dato

• string (max N): Cadena de texto con longitud máxima de N caracteres.
• decimal (p, s): Número decimal donde p es la precisión total (dígitos enteros + decimales) y s es la escala (dígitos decimales).
  • Ejemplo: decimal (18, 2) permite hasta 16 dígitos enteros y 2 decimales (ej: 9999999999999999.99)
• datetime: Fecha y hora en formato YYYY-MM-DD HH:MM:SS (ej: 2024-06-15 10:30:00).

---

Ejemplo de Solicitud

Aquí tienes un ejemplo de cómo debería quedar el cuerpo de la solicitud en formato JSON:

[
  {
    "client_id": "CLI-001",
    "seller_id": "VEN-010",
    "collector_id": "COB-008",
    "document_type": "FACTURA",
    "document_number": "FV-2024-001520",
    "document_date": "2024-06-15 00:00:00",
    "due_date": "2024-07-15 00:00:00",
    "balance": 750000.25,
    "observations": "Abono parcial realizado el 2024-07-01",
    "state": "Y",
    "withholding_base": 1260504.62,
    "tax_value": 239495.38,
    "base_balance": 630252.31,
    "motivation": null,
    "corporate_client": "CORP-001",
    "withholdings": null,
    "invoice_url": "https://facturacion.ejemplo.com/docs/FV-2024-001520.pdf"
  }
]

---

Ejemplo de Respuesta

200 - OK

{
    "statusCode": 200,
    "message": "Receivables updated successfully"
}

Importante

Los registros de cartera que no existan en el sistema (la combinación de client_id + seller_id + document_type + document_number no coincide) serán ignorados sin generar error. Solo se actualizarán los registros que ya existen.

Status 400

{
    "statusCode": 400,
    "errors": [
        {
            "message": "Invalid JSON in request body"
        }
    ]
}

Status 415

{
    "statusCode": 415,
    "errors": [
        {
            "message": "Content-Type: application/json is required"
        }
    ]
}

Status 422

Errores globales (estructura del body)

Si el body no es un array:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body must be an array"
        }
    ]
}

Si el array está vacío:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body cannot be empty"
        }
    ]
}

Si excede el límite de 10,000 items:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Array exceeds maximum limit of 10000 items"
        }
    ]
}

Errores por item (validación de campos)

Los errores se agrupan por el índice del item en el array:

{
    "statusCode": 422,
    "errors": [
        {
            "index": 0,
            "errors": [
                {
                    "field": "document_number",
                    "message": "Field is required"
                },
                {
                    "field": "balance",
                    "message": "Field must be of type decimal"
                }
            ]
        },
        {
            "index": 2,
            "errors": [
                {
                    "field": "client_id",
                    "message": "Field exceeds maximum length of 18 characters"
                }
            ]
        }
    ]
}

Tipos de Errores de Validación por Campo

Errores de presencia y nulidad:

Error	Descripción
Field is required	El campo no fue enviado en el objeto (la clave no existe)
Field cannot be null or empty	El campo fue enviado con valor null o vacío y no acepta nulos
Unknown field	Se envió un campo que no existe en la configuración
Item must be an object	Un elemento del array no es un objeto JSON

Errores de tipo de dato:

Error	Descripción
Field must be a string	El valor no es una cadena de texto
Field must be of type decimal	El valor no es un número decimal válido
Field must be a valid decimal (e.g., 1.5, 10.25)	El formato del decimal es inválido
Field must be a valid decimal number	El valor no es un número decimal válido (NaN, Infinity)
Field must be a valid datetime (YYYY-MM-DD HH:MM:SS)	El valor no es una fecha/hora válida

Errores de longitud y precisión:

Error	Descripción
Field exceeds maximum length of X characters	La cadena excede la longitud máxima permitida
Field exceeds maximum of X integer digits (precision: P, scale: S)	El número excede los dígitos enteros permitidos
Field exceeds maximum of X decimal places	El número excede los decimales permitidos

Errores de valores permitidos:

Error	Descripción
Value must be one of: Y, N	El valor no está en la lista de valores permitidos

Errores de formato:

Error	Descripción
Field contains forbidden characters. The following are not allowed: space, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Los campos client_id, seller_id o collector_id contienen caracteres prohibidos

Status 423

{
    "statusCode": 423,
    "errors": [
        {
            "message": "Resource is locked and cannot be accessed."
        }
    ]
}

Recurso bloqueado

Este error ocurre cuando otra operación de creación o actualización de cartera con la misma Subscription-Key está en progreso. Espere a que la operación anterior finalice e intente nuevamente.

Status 500

Error de conexión a base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Error connecting to database"
        }
    ]
}

Error de operación en base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Database operation failed"
        }
    ]
}

Error en Redis

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Redis operation failed"
        }
    ]
}

Error en validaciones

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error in the validations"
        }
    ]
}

Error inesperado

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error"
        }
    ]
}

Error del Servidor

Estos errores indican problemas internos en el servidor, la base de datos o el servicio de cache. Si persisten, contacta al equipo de soporte.