Listar Cartera

Permite obtener el listado de registros de cartera registrados en el sistema de forma paginada. Este endpoint soporta filtros por código de cliente, código de vendedor, código de cobrador, número de documento, tipo de documento, fecha de creación y fecha de modificación, así como ordenamiento configurable.

Método: GET

Endpoint

https://api.ventasremotas.com/v1/receivables

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	Requerido
Accept	application/json	Indica que la respuesta debe estar en formato JSON	No
Subscription-Key	{subscription_key}	Clave de suscripción para acceder a la API	Sí
Authorization	Bearer {access_token}	Token de acceso obtenido del endpoint /token	Sí

---

Parámetros de Consulta (Query Parameters)

Todos los parámetros son opcionales. Si no se especifican, se retornan todos los registros de cartera con la paginación por defecto.

Filtros

Parámetro	Tipo	Descripción
client_id	String	Filtra por código exacto de cliente. Longitud máxima: 18 caracteres.
seller_id	String	Filtra por código exacto de vendedor. Longitud máxima: 18 caracteres.
collector_id	String	Filtra por código exacto de cobrador. Longitud máxima: 18 caracteres.
document_number	String	Filtra por número exacto de documento. Longitud máxima: 50 caracteres.
document_type	String	Filtra por tipo exacto de documento. Longitud máxima: 10 caracteres.
created_from	Date	Retorna registros cuya fecha de creación es mayor o igual a este valor. Formato: YYYY-MM-DD.
modified_from	Date	Retorna registros cuya fecha de modificación es mayor o igual a este valor. Formato: YYYY-MM-DD.

Filtros de fecha

Los filtros created_from y modified_from se agrupan con un operador OR cuando se usan juntos. Esto significa que al enviar ambos filtros, se retornarán registros que cumplan cualquiera de las condiciones de fecha.

Ordenamiento

Parámetro	Tipo	Descripción
sort	String	Campo y dirección de ordenamiento. Por defecto: fecha de creación descendente.

Campos de ordenamiento disponibles

Valor	Descripción
created_at	Ordena por fecha de creación ascendente (ASC)
-created_at	Ordena por fecha de creación descendente (DESC)

Ordenamiento por defecto

Si no se especifica el parámetro sort, los resultados se ordenan por fecha de creación descendente (más recientes primero).

Paginación

Parámetro	Tipo	Por defecto	Restricciones	Descripción
page	Number	1	Mínimo: 1	Número de página (1-indexed)
limit	Number	100	Mínimo: 1, Máximo: 1000	Cantidad de resultados por página

---

Ejemplo de Solicitud

Petición básica (sin filtros)

curl -X GET "https://api.ventasremotas.com/v1/receivables" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por cliente

curl -X GET "https://api.ventasremotas.com/v1/receivables?client_id=CLI-001" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por vendedor y tipo de documento

curl -X GET "https://api.ventasremotas.com/v1/receivables?seller_id=VEN-010&document_type=FACTURA" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro de fecha y paginación

curl -X GET "https://api.ventasremotas.com/v1/receivables?created_from=2024-01-01&page=1&limit=50" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con ordenamiento ascendente

curl -X GET "https://api.ventasremotas.com/v1/receivables?sort=created_at&page=2&limit=100" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con múltiples filtros

curl -X GET "https://api.ventasremotas.com/v1/receivables?client_id=CLI-001&created_from=2024-01-01&modified_from=2024-06-01&sort=-created_at&limit=200" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

---

Ejemplo de Respuesta

200 - OK

{
    "data": [
        {
            "client_id": "CLI-001",
            "seller_id": "VEN-010",
            "collector_id": "COB-005",
            "document_type": "FACTURA",
            "document_number": "FV-2024-001520",
            "document_date": "2024-06-15T00:00:00",
            "due_date": "2024-07-15T00:00:00",
            "balance": 1500000.5,
            "observations": "Factura de venta mensual",
            "state": "Y",
            "withholding_base": 1260504.62,
            "tax_value": 239495.38,
            "base_balance": 1260504.62,
            "motivation": null,
            "corporate_client": "CORP-001",
            "withholdings": null,
            "invoice_url": "https://facturacion.ejemplo.com/docs/FV-2024-001520.pdf",
            "created_at": "2024-06-15T10:30:00",
            "updated_at": "2024-09-20T14:15:00"
        }
    ],
    "meta": {
        "totalItems": 3500,
        "itemCount": 100,
        "itemsPerPage": 100,
        "totalPages": 35,
        "currentPage": 1
    },
    "links": {
        "self": "https://api.ventasremotas.com/v1/receivables?page=1&limit=100",
        "first": "https://api.ventasremotas.com/v1/receivables?page=1&limit=100",
        "prev": null,
        "next": "https://api.ventasremotas.com/v1/receivables?page=2&limit=100",
        "last": "https://api.ventasremotas.com/v1/receivables?page=35&limit=100"
    }
}

Descripción de campos de respuesta

Objeto data[] (Registro de Cartera)

Cada elemento del array data contiene los siguientes campos:

Campo	Tipo	Descripción
client_id	String	Código del cliente asociado al documento de cartera
seller_id	String	Código del vendedor asociado al documento de cartera
collector_id	String	Código del cobrador asignado al documento
document_type	String	Tipo de documento (ej: “F”, “NC”)
document_number	String	Número del documento
document_date	DateTime	Fecha de emisión del documento. Formato: yyyy-MM-dd HH:mm:ss
due_date	DateTime	Fecha de vencimiento del documento. Formato: yyyy-MM-dd HH:mm:ss
balance	Number	Saldo actual del documento, valor incluye impuestos (puede ser null)
observations	String	Observaciones o notas adicionales (puede ser null)
state	String	Estado del registro de cartera: Y (Activo) o N (Inactivo)
withholding_base	Number	Valor a pagar antes de impuestos (valor base de factura) (puede ser null)
tax_value	Number	Valor de los impuestos generados en la factura (puede ser null)
base_balance	Number	Saldo inicial del documento, valor incluye impuestos (puede ser null)
motivation	String	Motivo o causal asociado al documento (puede ser null)
corporate_client	String	Código del cliente corporativo (puede ser null)
withholdings	String	JSON en formato string con las retenciones del documento (puede ser null)
invoice_url	String	URL de la factura electrónica o documento asociado (puede ser null)
created_at	DateTime	Fecha y hora de creación del registro. Formato: yyyy-MM-ddTHH:mm:ss
updated_at	DateTime	Fecha y hora de última modificación. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)

Objeto meta (Metadatos de paginación)

Campo	Tipo	Descripción
totalItems	Number	Cantidad total de registros de cartera que coinciden con los filtros
itemCount	Number	Cantidad de registros en la página actual
itemsPerPage	Number	Cantidad de items por página solicitados
totalPages	Number	Total de páginas disponibles
currentPage	Number	Número de la página actual

Objeto links (Enlaces de navegación)

Campo	Tipo	Descripción
self	String	URL de la página actual
first	String	URL de la primera página
prev	String	URL de la página anterior (null si es la primera página)
next	String	URL de la página siguiente (null si es la última página)
last	String	URL de la última página

Status 400

Los errores de validación de parámetros de consulta retornan un array de errores, donde cada error indica el parámetro problemático:

Filtro no válido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "invalid_param",
            "message": "The field is not a valid filter parameter"
        }
    ]
}

Valor de filtro vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "client_id",
            "message": "Value must not be empty"
        }
    ]
}

Fecha con formato inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "created_from",
            "message": "Value '15-01-2024' is not a valid date (expected format: YYYY-MM-DD)"
        }
    ]
}

Valor excede longitud máxima

{
    "statusCode": 400,
    "errors": [
        {
            "param": "client_id",
            "message": "Value exceeds maximum length of 18"
        }
    ]
}

Campo de ordenamiento inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The field 'invalid_field' is not a valid sort field."
        }
    ]
}

Parámetro sort vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The parameter must not be empty"
        }
    ]
}

Parámetro de paginación inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be a valid integer"
        }
    ]
}

Página menor al mínimo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be greater than or equal to 1"
        }
    ]
}

Límite excede el máximo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must be less than or equal to 1000"
        }
    ]
}

Límite vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must not be empty"
        }
    ]
}

Errores múltiples

El endpoint puede retornar múltiples errores de validación en una sola respuesta. Por ejemplo, si se envía un filtro inválido y un parámetro de paginación incorrecto al mismo tiempo, ambos errores aparecerán en el array de errors.

Tabla resumen de errores de validación

Errores de filtros:

Error	Aplica a
The field is not a valid filter parameter	Cualquier parámetro no reconocido
Value must not be empty	client_id, seller_id, collector_id, document_number, document_type
Value 'X' is not a valid date (expected format: YYYY-MM-DD)	created_from, modified_from
Value exceeds maximum length of X	client_id (18), seller_id (18), collector_id (18), document_number (50), document_type (10)

Errores de ordenamiento:

Error	Aplica a
The parameter must not be empty	sort
The field 'X' is not a valid sort field.	sort

Errores de paginación:

Error	Aplica a
The parameter must not be empty	page, limit
The parameter must be a valid integer	page, limit
The parameter must be greater than or equal to 1	page, limit
The parameter must be less than or equal to 1000	limit

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 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 o la base de datos. Si persisten, contacta al equipo de soporte.